TddWizard\Fixtures\Catalog\OptionBuilder

Complexity

Total Complexity

11

Size/Duplication

Total Lines	195
Duplicated Lines	0 %

Test Coverage

Coverage

79.69%

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__clone()	0	3	1
A	withLabel()	0	8	1
A	withIsDefault()	0	6	1
A	withStoreId()	0	6	1
A	__construct()	0	10	1
A	withSortOrder()	0	6	1
A	getOptionId()	0	21	3
A	build()	0	15	1
A	anOptionFor()	0	25	1

<?php
declare(strict_types=1);

namespace TddWizard\Fixtures\Catalog;

use Magento\Catalog\Api\ProductAttributeRepositoryInterface;
use Magento\Catalog\Model\Product;
use Magento\Eav\Api\AttributeOptionManagementInterface;
use Magento\Eav\Api\Data\AttributeOptionLabelInterface;
use Magento\Eav\Model\Entity\Attribute\Option as AttributeOption;
use Magento\TestFramework\Helper\Bootstrap;

The type Magento\TestFramework\Helper\Bootstrap was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * Create a source-model option for an attribute.
 *
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
class OptionBuilder
{

    /**
     * @var AttributeOptionManagementInterface
     */
    private $optionManagement;

    /**
     * @var AttributeOption
     */
    private $option;

    /**
     * @var AttributeOptionLabelInterface
     */
    private $optionLabel;

    /**
     * @var string
     */
    private $attributeCode;

    /**
     * OptionBuilder constructor.
     *
     * @param AttributeOptionManagementInterface $optionManagement
     * @param AttributeOption $option
     * @param AttributeOptionLabelInterface $optionLabel
     * @param string $attributeCode
     */
    public function __construct(
        AttributeOptionManagementInterface $optionManagement,
        AttributeOption $option,
        AttributeOptionLabelInterface $optionLabel,
        string $attributeCode
    ) {
        $this->optionManagement = $optionManagement;
        $this->option = $option;
        $this->optionLabel = $optionLabel;
        $this->attributeCode = $attributeCode;
    }

    /**
     * Clone the builder.
     */
    public function __clone()
    {
        $this->option = clone $this->option;
    }

    /**
     * Create an option.
     *
     * @param string $attributeCode
     * @return OptionBuilder
     * @throws \Magento\Framework\Exception\InputException
     * @throws \Magento\Framework\Exception\StateException
     */
    public static function anOptionFor(string $attributeCode): OptionBuilder
    {
        $objectManager = Bootstrap::getObjectManager();
        /** @var AttributeOptionManagementInterface $optionManagement */
        $optionManagement = $objectManager->create(AttributeOptionManagementInterface::class);
        $items = $optionManagement->getItems(Product::ENTITY, $attributeCode);

Magento\Catalog\Model\Product::ENTITY of type string is incompatible with the type integer expected by parameter $entityType of Magento\Eav\Api\AttributeOptionManagementInterface::getItems().

        /** @var AttributeOptionLabelInterface $optionLabel */
        $optionLabel = $objectManager->create(AttributeOptionLabelInterface::class);
        $label = uniqid('Name ', true);
        $optionLabel->setStoreId(0);
        $optionLabel->setLabel($label);

        /** @var AttributeOption $option */
        $option = $objectManager->create(AttributeOption::class);
        $option->setLabel($label);
        $option->setStoreLabels([$optionLabel]);
        $option->setSortOrder(count($items) + 1);
        $option->setIsDefault(false);

        return new static(
            $optionManagement,
            $option,
            $optionLabel,
            $attributeCode
        );
    }

    /**
     * Set label.
     *
     * @param string $label
     * @return OptionBuilder
     */
    public function withLabel(string $label): OptionBuilder
    {
        $builder = clone $this;
        $builder->optionLabel->setLabel($label);
        $builder->option->setStoreLabels([$builder->optionLabel]);
        $builder->option->setLabel($label);

        return $builder;
    }

    /**
     * Set sort order.
     *
     * @param int $sortOrder
     * @return OptionBuilder
     */
    public function withSortOrder(int $sortOrder): OptionBuilder
    {
        $builder = clone $this;
        $builder->option->setSortOrder($sortOrder);

        return $builder;
    }

    /**
     * Set default.
     *
     * @param bool $isDefault
     * @return OptionBuilder
     */
    public function withIsDefault(bool $isDefault): OptionBuilder
    {
        $builder = clone $this;
        $builder->option->setIsDefault($isDefault);

        return $builder;
    }

    /**
     * Set store ID.
     *
     * @param int $storeId
     * @return OptionBuilder
     */
    public function withStoreId(int $storeId): OptionBuilder
    {
        $builder = clone $this;
        $builder->optionLabel->setStoreId($storeId);

        return $builder;
    }

    /**
     * Build the option and apply it to the attribute.
     *
     * @return AttributeOption
     * @throws \Magento\Framework\Exception\InputException
     * @throws \Magento\Framework\Exception\StateException
     */
    public function build(): AttributeOption
    {
        $builder = clone $this;

        // add the option
        $this->optionManagement->add(
            \Magento\Catalog\Model\Product::ENTITY,

Magento\Catalog\Model\Product::ENTITY of type string is incompatible with the type integer expected by parameter $entityType of Magento\Eav\Api\AttributeOptionManagementInterface::add().

            $builder->attributeCode,
            $builder->option
        );

        $optionId = $this->getOptionId();
        $builder->option->setId($optionId);

        return $builder->option;
    }

    /**
     * Get the option ID.
     *
     * @return int
     */
    private function getOptionId(): int
    {
        $objectManager = Bootstrap::getObjectManager();
        // the add option above does not return the option, so we need to retrieve it
        $attributeRepository = $objectManager->get(ProductAttributeRepositoryInterface::class);
        $attribute = $attributeRepository->get($this->attributeCode);
        $attributeValues[$attribute->getAttributeId()] = [];

$attributeValues was never initialized. Although not strictly required by PHP, it is generally a good practice to add $attributeValues = array(); before regardless.

        // We have to generate a new sourceModel instance each time through to prevent it from
        // referencing its _options cache. No other way to get it to pick up newly-added values.
        $tableFactory = $objectManager->get(\Magento\Eav\Model\Entity\Attribute\Source\TableFactory::class);

The type Magento\Eav\Model\Entity\Attribute\Source\TableFactory was not found. Maybe you did not declare it correctly or list all dependencies?

        $sourceModel = $tableFactory->create();
        $sourceModel->setAttribute($attribute);
        foreach ($sourceModel->getAllOptions() as $option) {
            $attributeValues[$attribute->getAttributeId()][$option['label']] = $option['value'];
        }
        if (isset($attributeValues[$attribute->getAttributeId()][$this->optionLabel->getLabel()])) {
            return (int)$attributeValues[$attribute->getAttributeId()][$this->optionLabel->getLabel()];
        }

        throw new \RuntimeException('Error building option');
    }
}