Repository Class Reference

Inheritance diagram for Repository:

Public Member Functions
	__construct (\Magento\Catalog\Model\ResourceModel\Attribute $attributeResource, \Magento\Catalog\Helper\Product $productHelper, \Magento\Framework\Filter\FilterManager $filterManager, \Magento\Eav\Api\AttributeRepositoryInterface $eavAttributeRepository, \Magento\Eav\Model\Config $eavConfig, \Magento\Eav\Model\Adminhtml\System\Config\Source\Inputtype\ValidatorFactory $validatorFactory, \Magento\Framework\Api\SearchCriteriaBuilder $searchCriteriaBuilder)
	get ($attributeCode)
	getList (\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria)
	save (\Magento\Catalog\Api\Data\ProductAttributeInterface $attribute)
	delete (\Magento\Catalog\Api\Data\ProductAttributeInterface $attribute)
	deleteById ($attributeCode)
	getCustomAttributesMetadata ($dataObjectClassName=null)
Public Member Functions inherited from ProductAttributeRepositoryInterface
	getList (\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria)

Protected Member Functions
	generateCode ($label)
	validateCode ($code)

Protected Attributes
	$attributeResource
	$eavAttributeRepository
	$eavConfig
	$inputtypeValidatorFactory
	$productHelper
	$filterManager
	$searchCriteriaBuilder

Detailed Description

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 16 of file Repository.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Catalog\Model\ResourceModel\Attribute	$attributeResource,
		\Magento\Catalog\Helper\Product	$productHelper,
		\Magento\Framework\Filter\FilterManager	$filterManager,
		\Magento\Eav\Api\AttributeRepositoryInterface	$eavAttributeRepository,
		\Magento\Eav\Model\Config	$eavConfig,
		\Magento\Eav\Model\Adminhtml\System\Config\Source\Inputtype\ValidatorFactory	$validatorFactory,
		\Magento\Framework\Api\SearchCriteriaBuilder	$searchCriteriaBuilder
	)

Parameters

\Magento\Catalog\Model\ResourceModel\Attribute	$attributeResource
\Magento\Catalog\Helper\Product	$productHelper
\Magento\Framework\Filter\FilterManager	$filterManager
\Magento\Eav\Api\AttributeRepositoryInterface	$eavAttributeRepository
\Magento\Eav\Model\Config	$eavConfig
\Magento\Eav\Model\Adminhtml\System\Config\Source\Inputtype\ValidatorFactory	$validatorFactory
\Magento\Framework\Api\SearchCriteriaBuilder	$searchCriteriaBuilder

Definition at line 62 of file Repository.php.

      {
        $this->attributeResource = $attributeResource;
        $this->productHelper = $productHelper;
        $this->filterManager = $filterManager;
        $this->eavAttributeRepository = $eavAttributeRepository;
        $this->eavConfig = $eavConfig;
        $this->inputtypeValidatorFactory = $validatorFactory;
        $this->searchCriteriaBuilder = $searchCriteriaBuilder;
    }

Member Function Documentation

delete()

delete

(

\Magento\Catalog\Api\Data\ProductAttributeInterface

$attribute

)

{Delete Attribute

Parameters

\Magento\Catalog\Api\Data\ProductAttributeInterface

$attribute

Returns

bool True if the entity was deleted (always true)

Exceptions

}

Implements ProductAttributeRepositoryInterface.

Definition at line 185 of file Repository.php.

    {
        $this->attributeResource->delete($attribute);
        return true;
    }

deleteById()

deleteById

(

$attributeCode

)

{Delete Attribute by id

Parameters

string

$attributeCode

Returns

bool

Exceptions

}

Implements ProductAttributeRepositoryInterface.

Definition at line 194 of file Repository.php.

    {
        $this->delete(
            $this->get($attributeCode)
        );
        return true;
    }

generateCode()

generateCode (   $label )

protected

Generate code from label

Parameters

string

$label

Returns

string

Definition at line 217 of file Repository.php.

    {
        $code = substr(preg_replace('/[^a-z_0-9]/', '_', $this->filterManager->translitUrl($label)), 0, 30);
        $validatorAttrCode = new \Zend_Validate_Regex(['pattern' => '/^[a-z][a-z_0-9]{0,29}[a-z0-9]$/']);
        if (!$validatorAttrCode->isValid($code)) {
            $code = 'attr_' . ($code ?: substr(md5(time()), 0, 8));
        }
        return $code;
    }

get()

get

(

$attributeCode

)

{Retrieve specific attribute

Parameters

string

$attributeCode

Returns

\Magento\Catalog\Api\Data\ProductAttributeInterface

Exceptions

}

Implements ProductAttributeRepositoryInterface.

Definition at line 83 of file Repository.php.

    {
        return $this->eavAttributeRepository->get(
            \Magento\Catalog\Api\Data\ProductAttributeInterface::ENTITY_TYPE_CODE,
            $attributeCode
        );
    }

getCustomAttributesMetadata()

getCustomAttributesMetadata

(

$dataObjectClassName = null

)

{Get custom attribute metadata for the given class or interfaces it implements.

Parameters

string | null

$dataObjectClassName

Data object class name

Returns

\Magento\Framework\Api\MetadataObjectInterface[]

} @SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements MetadataServiceInterface.

Definition at line 206 of file Repository.php.

    {
        return $this->getList($this->searchCriteriaBuilder->create())->getItems();
    }

getList()

getList

(

\Magento\Framework\Api\SearchCriteriaInterface

$searchCriteria

)

{}

Definition at line 94 of file Repository.php.

    {
        return $this->eavAttributeRepository->getList(
            \Magento\Catalog\Api\Data\ProductAttributeInterface::ENTITY_TYPE_CODE,
            $searchCriteria
        );
    }

save()

save

(

\Magento\Catalog\Api\Data\ProductAttributeInterface

$attribute

)

{Save attribute data

Parameters

\Magento\Catalog\Api\Data\ProductAttributeInterface

$attribute

Returns

\Magento\Catalog\Api\Data\ProductAttributeInterface

Exceptions

} @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Implements ProductAttributeRepositoryInterface.

Definition at line 107 of file Repository.php.

    {
        if ($attribute->getAttributeId()) {
            $existingModel = $this->get($attribute->getAttributeCode());

            if (!$existingModel->getAttributeId()) {
                throw NoSuchEntityException::singleField('attribute_code', $existingModel->getAttributeCode());
            }

            // Attribute code must not be changed after attribute creation
            $attribute->setAttributeCode($existingModel->getAttributeCode());
            $attribute->setAttributeId($existingModel->getAttributeId());
            $attribute->setIsUserDefined($existingModel->getIsUserDefined());
            $attribute->setFrontendInput($existingModel->getFrontendInput());

            $this->updateDefaultFrontendLabel($attribute, $existingModel);
        } else {
            $attribute->setAttributeId(null);

            if (!$attribute->getFrontendLabels() && !$attribute->getDefaultFrontendLabel()) {
                throw InputException::requiredField('frontend_label');
            }

            $frontendLabel = $this->updateDefaultFrontendLabel($attribute, null);

            $attribute->setAttributeCode(
                $attribute->getAttributeCode() ?: $this->generateCode($frontendLabel)
            );
            $this->validateCode($attribute->getAttributeCode());
            $this->validateFrontendInput($attribute->getFrontendInput());

            $attribute->setBackendType(
                $attribute->getBackendTypeByInput($attribute->getFrontendInput())
            );
            $attribute->setSourceModel(
                $this->productHelper->getAttributeSourceModelByInputType($attribute->getFrontendInput())
            );
            $attribute->setBackendModel(
                $this->productHelper->getAttributeBackendModelByInputType($attribute->getFrontendInput())
            );
            $attribute->setEntityTypeId(
                $this->eavConfig
                    ->getEntityType(\Magento\Catalog\Api\Data\ProductAttributeInterface::ENTITY_TYPE_CODE)
                    ->getId()
            );
            $attribute->setIsUserDefined(1);
        }
        if (!empty($attribute->getData(AttributeInterface::OPTIONS))) {
            $options = [];
            $sortOrder = 0;
            $default = [];
            $optionIndex = 0;
            foreach ($attribute->getOptions() as $option) {
                $optionIndex++;
                $optionId = $option->getValue() ?: 'option_' . $optionIndex;
                $options['value'][$optionId][0] = $option->getLabel();
                $options['order'][$optionId] = $option->getSortOrder() ?: $sortOrder++;
                if (is_array($option->getStoreLabels())) {
                    foreach ($option->getStoreLabels() as $label) {
                        $options['value'][$optionId][$label->getStoreId()] = $label->getLabel();
                    }
                }
                if ($option->getIsDefault()) {
                    $default[] = $optionId;
                }
            }
            $attribute->setDefault($default);
            if (count($options)) {
                $attribute->setOption($options);
            }
        }
        $this->attributeResource->save($attribute);
        return $this->get($attribute->getAttributeCode());
    }

validateCode()

validateCode (   $code )

protected

Validate attribute code

Parameters

string

$code

Returns

void

Exceptions

Definition at line 234 of file Repository.php.

    {
        $validatorAttrCode = new \Zend_Validate_Regex(['pattern' => '/^[a-z][a-z_0-9]{0,30}$/']);
        if (!$validatorAttrCode->isValid($code)) {
            throw InputException::invalidFieldValue('attribute_code', $code);
        }
    }

Field Documentation

$attributeResource

$attributeResource

protected

Definition at line 21 of file Repository.php.

$eavAttributeRepository

$eavAttributeRepository

protected

Definition at line 26 of file Repository.php.

$eavConfig

$eavConfig

protected

Definition at line 31 of file Repository.php.

$filterManager

$filterManager

protected

Definition at line 46 of file Repository.php.

$inputtypeValidatorFactory

$inputtypeValidatorFactory

protected

Definition at line 36 of file Repository.php.

$productHelper

$productHelper

protected

Definition at line 41 of file Repository.php.

$searchCriteriaBuilder

$searchCriteriaBuilder

protected

Definition at line 51 of file Repository.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-catalog/Model/Product/Attribute/Repository.php