CategoryRepository Class Reference

Inheritance diagram for CategoryRepository:

Public Member Functions
	__construct (\Magento\Catalog\Model\CategoryFactory $categoryFactory, \Magento\Catalog\Model\ResourceModel\Category $categoryResource, \Magento\Store\Model\StoreManagerInterface $storeManager)
	save (\Magento\Catalog\Api\Data\CategoryInterface $category)
	delete (\Magento\Catalog\Api\Data\CategoryInterface $category)
	deleteByIdentifier ($categoryId)
Public Member Functions inherited from CategoryRepositoryInterface
	save (\Magento\Catalog\Api\Data\CategoryInterface $category)
	get ($categoryId, $storeId=null)
	delete (\Magento\Catalog\Api\Data\CategoryInterface $category)

Protected Member Functions
	validateCategory (Category $category)

Protected Attributes
	$instances = []
	$storeManager
	$categoryFactory
	$categoryResource
	$metadataPool
	$useConfigFields = ['available_sort_by', 'default_sort_by', 'filter_price_range']

Detailed Description

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 18 of file CategoryRepository.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Catalog\Model\CategoryFactory	$categoryFactory,
		\Magento\Catalog\Model\ResourceModel\Category	$categoryResource,
		\Magento\Store\Model\StoreManagerInterface	$storeManager
	)

Parameters

\Magento\Catalog\Model\CategoryFactory	$categoryFactory
\Magento\Catalog\Model\ResourceModel\Category	$categoryResource
\Magento\Store\Model\StoreManagerInterface	$storeManager

Definition at line 62 of file CategoryRepository.php.

      {
        $this->categoryFactory = $categoryFactory;
        $this->categoryResource = $categoryResource;
        $this->storeManager = $storeManager;
    }

Member Function Documentation

delete()

delete

(

\Magento\Catalog\Api\Data\CategoryInterface

$category

)

{}

Definition at line 151 of file CategoryRepository.php.

    {
        try {
            $categoryId = $category->getId();
            $this->categoryResource->delete($category);
        } catch (\Exception $e) {
            throw new StateException(
                __(
                    'Cannot delete category with id %1',
                    $category->getId()
                ),
                $e
            );
        }
        unset($this->instances[$categoryId]);
        return true;
    }

deleteByIdentifier()

deleteByIdentifier

(

$categoryId

)

{Delete category by identifier

Parameters

int

$categoryId

Returns

bool Will returned True if deleted

Exceptions

}

Implements CategoryRepositoryInterface.

Definition at line 172 of file CategoryRepository.php.

    {
        $category = $this->get($categoryId);
        return  $this->delete($category);
    }

save()

save

(

\Magento\Catalog\Api\Data\CategoryInterface

$category

)

{}

Definition at line 75 of file CategoryRepository.php.

    {
        $storeId = (int)$this->storeManager->getStore()->getId();
        $existingData = $this->getExtensibleDataObjectConverter()
            ->toNestedArray($category, [], \Magento\Catalog\Api\Data\CategoryInterface::class);
        $existingData = array_diff_key($existingData, array_flip(['path', 'level', 'parent_id']));
        $existingData['store_id'] = $storeId;

        if ($category->getId()) {
            $metadata = $this->getMetadataPool()->getMetadata(
                CategoryInterface::class
            );

            $category = $this->get($category->getId(), $storeId);
            $existingData[$metadata->getLinkField()] = $category->getData(
                $metadata->getLinkField()
            );

            if (isset($existingData['image']) && is_array($existingData['image'])) {
                if (!empty($existingData['image']['delete'])) {
                    $existingData['image'] = null;
                } else {
                    if (isset($existingData['image'][0]['name']) && isset($existingData['image'][0]['tmp_name'])) {
                        $existingData['image'] = $existingData['image'][0]['name'];
                    } else {
                        unset($existingData['image']);
                    }
                }
            }
        } else {
            $parentId = $category->getParentId() ?: $this->storeManager->getStore()->getRootCategoryId();
            $parentCategory = $this->get($parentId, $storeId);
            $existingData['path'] = $parentCategory->getPath();
            $existingData['parent_id'] = $parentId;
        }
        $category->addData($existingData);
        try {
            $this->validateCategory($category);
            $this->categoryResource->save($category);
        } catch (\Exception $e) {
            throw new CouldNotSaveException(
                __(
                    'Could not save category: %1',
                    $e->getMessage()
                ),
                $e
            );
        }
        unset($this->instances[$category->getId()]);
        return $this->get($category->getId(), $storeId);
    }

validateCategory()

validateCategory ( Category  $category )

protected

Validate category process

Parameters

Category

$category

Returns

void

Exceptions

Definition at line 185 of file CategoryRepository.php.

    {
        $useConfigFields = [];
        foreach ($this->useConfigFields as $field) {
            if (!$category->getData($field)) {
                $useConfigFields[] = $field;
            }
        }
        $category->setData('use_post_data_config', $useConfigFields);
        $validate = $category->validate();
        if ($validate !== true) {
            foreach ($validate as $code => $error) {
                if ($error === true) {
                    $attribute = $this->categoryResource->getAttribute($code)->getFrontend()->getLabel();
                    throw new \Magento\Framework\Exception\LocalizedException(
                        __('The "%1" attribute is required. Enter and try again.', $attribute)
                    );
                } else {
                    throw new \Magento\Framework\Exception\LocalizedException(__($error));
                }
            }
        }
        $category->unsetData('use_post_data_config');
    }

Field Documentation

$categoryFactory

$categoryFactory

protected

Definition at line 33 of file CategoryRepository.php.

$categoryResource

$categoryResource

protected

Definition at line 38 of file CategoryRepository.php.

$instances

$instances = []

protected

Definition at line 23 of file CategoryRepository.php.

$metadataPool

$metadataPool

protected

Definition at line 43 of file CategoryRepository.php.

$storeManager

$storeManager

protected

Definition at line 28 of file CategoryRepository.php.

$useConfigFields

$useConfigFields = ['available_sort_by', 'default_sort_by', 'filter_price_range']

protected

Definition at line 55 of file CategoryRepository.php.

---

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

• vendor/magento/module-catalog/Model/CategoryRepository.php