Inheritance diagram for Category:

Public Member Functions
	__construct (\Magento\Eav\Model\Entity\Context $context, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Catalog\Model\Factory $modelFactory, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\Catalog\Model\ResourceModel\Category\TreeFactory $categoryTreeFactory, \Magento\Catalog\Model\ResourceModel\Category\CollectionFactory $categoryCollectionFactory, Processor $indexerProcessor, $data=[], \Magento\Framework\Serialize\Serializer\Json $serializer=null)

	getEntityType ()

	getCategoryProductTable ()

	setStoreId ($storeId)

	getStoreId ()

	deleteChildren (\Magento\Framework\DataObject $object)

	getProductsPosition ($category)

	getChildrenCount ($categoryId)

	checkId ($entityId)

	verifyIds (array $ids)

	getChildrenAmount ($category, $isActiveFlag=true)

	getIsActiveAttributeId ()

	findWhereAttributeIs ($entityIdsFilter, $attribute, $expectedValue)

	getProductCount ($category)

	getCategories ($parent, $recursionLevel=0, $sorted=false, $asCollection=false, $toLoad=true)

	getParentDesignCategory ($category)

	getChildrenCategories ($category)

	getChildren ($category, $recursive=true)

	getAllChildren ($category)

	isInRootCategoryList ($category)

	isForbiddenToDelete ($categoryId)

	getCategoryPathById ($categoryId)

	changeParent (\Magento\Catalog\Model\Category $category, \Magento\Catalog\Model\Category $newParent, $afterCategoryId=null)

	countVisible ()

	load ($object, $entityId, $attributes=[])

	delete ($object)

	save (\Magento\Framework\Model\AbstractModel $object)

Public Member Functions inherited from AbstractResource
	__construct (\Magento\Eav\Model\Entity\Context $context, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Catalog\Model\Factory $modelFactory, $data=[])

	getDefaultStoreId ()

	getAttributeRawValue ($entityId, $attribute, $store)

Public Member Functions inherited from AbstractEntity
	__construct (Context $context, $data=[])

	setConnection ($connection)

	getConnection ()

	getIdFieldName ()

	getTable ($alias)

	setType ($type)

	getEntityType ()

	getType ()

	getTypeId ()

	unsetAttributes ($attributes=null)

	addAttribute (AbstractAttribute $attribute, $object=null)

	isPartialLoad ($flag=null)

	isPartialSave ($flag=null)

	loadAllAttributes ($object=null)

	getSortedAttributes ($setId=null)

	attributesCompare ($firstAttribute, $secondAttribute)

	getAttributesByCode ()

	getAttributesByTable ()

	getEntityTable ()

	getLinkField ()

	getEntityIdField ()

	getValueEntityIdField ()

	getValueTablePrefix ()

	getEntityTablePrefix ()

	isAttributeStatic ($attribute)

	validate ($object)

	setNewIncrementId (DataObject $object)

	checkAttributeUniqueValue (AbstractAttribute $attribute, $object)

	getDefaultAttributeSourceModel ()

	load ($object, $entityId, $attributes=[])

	save (\Magento\Framework\Model\AbstractModel $object)

	saveAttribute (DataObject $object, $attributeCode)

	delete ($object)

	getDefaultAttributes ()

	afterLoad (DataObject $object)

	beforeSave (DataObject $object)

	afterSave (DataObject $object)

	beforeDelete (DataObject $object)

	afterDelete (DataObject $object)

Public Member Functions inherited from AbstractResource
	__construct ()

	getConnection ()

	beginTransaction ()

	addCommitCallback ($callback)

	commit ()

	rollBack ()

	getValidationRulesBeforeSave ()

Protected Member Functions
	_getTree ()

	_beforeDelete (\Magento\Framework\DataObject $object)

	_afterDelete (DataObject $object)

	_beforeSave (\Magento\Framework\DataObject $object)

	_afterSave (\Magento\Framework\DataObject $object)

	_savePath ($object)

	_getMaxPosition ($path)

	_saveCategoryProducts ($category)

	_processPositions ($category, $newParent, $afterCategoryId)

Protected Member Functions inherited from AbstractResource
	_getDefaultAttributeModel ()

	_isApplicableAttribute ($object, $attribute)

	_isCallableAttributeInstance ($instance, $method, $args)

	_getLoadAttributesSelect ($object, $table)

	_prepareLoadSelect (array $selects)

	_saveAttributeValue ($object, $attribute, $value)

	_insertAttribute ($object, $attribute, $value)

	_updateAttribute ($object, $attribute, $valueId, $value)

	_updateAttributeForStore ($object, $attribute, $value, $storeId)

	_deleteAttributes ($object, $table, $info)

	_getOrigObject ($object)

	_canUpdateAttribute (AbstractAttribute $attribute, $value, array &$origData)

Protected Member Functions inherited from AbstractEntity
	_construct ()

	_getConfig ()

	_isApplicableAttribute ($object, $attribute)

	_isCallableAttributeInstance ($instance, $method, $args)

	loadAttributesMetadata ($attributes)

	_loadModelAttributes ($object)

	_prepareLoadSelect (array $selects)

	_getLoadRowSelect ($object, $rowId)

	_getLoadAttributesSelect ($object, $table)

	_setAttributeValue ($object, $valueRow)

	processSave ($object)

	_getOrigObject ($object)

	_collectSaveData ($newObject)

	_canUpdateAttribute (AbstractAttribute $attribute, $v, array &$origData)

	_getStaticFieldProperties ($field)

	_prepareStaticValue ($key, $value)

	_insertAttribute ($object, $attribute, $value)

	_updateAttribute ($object, $attribute, $valueId, $value)

	_saveAttribute ($object, $attribute, $value)

	_processAttributeValues ()

	_prepareValueForSave ($value, AbstractAttribute $attribute)

	_deleteAttributes ($object, $table, $info)

	getAttributeRow ($entity, $object, $attribute)

	evaluateDelete ($object, $id, $connection)

	_afterLoad (DataObject $object)

	_beforeSave (DataObject $object)

	_afterSave (DataObject $object)

	_beforeDelete (DataObject $object)

	_afterDelete (DataObject $object)

	_getDefaultAttributeModel ()

	_getDefaultAttributes ()

	_isAttributeValueEmpty (AbstractAttribute $attribute, $value)

	getAttributeLoader ()

	loadAttributesForObject ($attributes, $object=null)

Protected Member Functions inherited from AbstractResource
	_construct ()

	_serializeField (DataObject $object, $field, $defaultValue=null, $unsetEmpty=false)

	_unserializeField (DataObject $object, $field, $defaultValue=null)

	_prepareDataForTable (DataObject $object, $table)

	_prepareTableValueForSave ($value, $type)

	_getColumnsForEntityLoad (\Magento\Framework\Model\AbstractModel $object, $tableName)

	getSerializer ()

Protected Attributes
	$_tree

	$_categoryProductTable

	$_isActiveAttributeId = null

	$_storeId = null

	$_eventManager = null

	$_categoryCollectionFactory

	$_categoryTreeFactory

	$entityManager

	$aggregateCount

Protected Attributes inherited from AbstractResource
	$_storeManager

	$_modelFactory

Protected Attributes inherited from AbstractEntity
	$attributeLoader

	$connectionName

	$_type

	$_attributesByCode = []

	$_attributesByTable = []

	$_staticAttributes = []

	$_entityTable

	$_describeTable = []

	$_entityIdField

	$linkIdField

	$_valueEntityIdField

	$_valueTablePrefix

	$_entityTablePrefix

	$_isPartialLoad = false

	$_isPartialSave = false

	$_sortingSetId = null

	$_attributeValuesToDelete = []

	$_attributeValuesToSave = []

	$_resource

	$_eavConfig

	$_attrSetEntity

	$_localeFormat

	$_resourceHelper

	$_universalFactory

	$transactionManager

	$objectRelationProcessor

Protected Attributes inherited from AbstractResource
	$serializer

	$_logger

Additional Inherited Members
Static Protected Attributes inherited from AbstractEntity
static	$_attributeBackendTables = []

Detailed Description

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 21 of file Category.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Eav\Model\Entity\Context	$context,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Catalog\Model\Factory	$modelFactory,
		\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Magento\Catalog\Model\ResourceModel\Category\TreeFactory	$categoryTreeFactory,
		\Magento\Catalog\Model\ResourceModel\Category\CollectionFactory	$categoryCollectionFactory,
		Processor	$indexerProcessor,
			$data = `[]`,
		\Magento\Framework\Serialize\Serializer\Json	$serializer = `null`
	)

Category constructor.

Parameters

\Magento\Eav\Model\Entity\Context	$context
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Catalog\Model\Factory	$modelFactory
\Magento\Framework\Event\ManagerInterface	$eventManager
Category\TreeFactory	$categoryTreeFactory
Category\CollectionFactory	$categoryCollectionFactory
Processor	$indexerProcessor
array	$data
\Magento\Framework\Serialize\Serializer\Json \| null	$serializer

Definition at line 104 of file Category.php.

       {
         parent::__construct(
             $context,
             $storeManager,
             $modelFactory,
             $data
         );
         $this->_categoryTreeFactory = $categoryTreeFactory;
         $this->_categoryCollectionFactory = $categoryCollectionFactory;
         $this->_eventManager = $eventManager;
         $this->connectionName  = 'catalog';
         $this->indexerProcessor = $indexerProcessor;
         $this->serializer = $serializer ?: \Magento\Framework\App\ObjectManager::getInstance()
             ->get(\Magento\Framework\Serialize\Serializer\Json::class);
     }

Member Function Documentation

◆ _afterDelete()

_afterDelete ( DataObject $object )

protected

Mark Category indexer as invalid to be picked up by cron.

Parameters

DataObject $object

Returns: $this

Definition at line 216 of file Category.php.

     {
         $this->indexerProcessor->markIndexerAsInvalid();
         return parent::_afterDelete($object);
     }

◆ _afterSave()

_afterSave ( \Magento\Framework\DataObject $object )

protected

Process category data after save category object save related products ids and update path value

Parameters

\Magento\Framework\DataObject $object

Returns: $this

Add identifier for new category

Definition at line 306 of file Category.php.

     {
         if (substr($object->getPath(), -1) == '/') {
             $object->setPath($object->getPath() . $object->getId());
             $this->_savePath($object);
         }
 
         $this->_saveCategoryProducts($object);
         return parent::_afterSave($object);
     }

◆ _beforeDelete()

_beforeDelete ( \Magento\Framework\DataObject $object )

protected

Process category data before delete update children count for parent category delete child categories

Parameters

\Magento\Framework\DataObject $object

Returns: $this

Definition at line 203 of file Category.php.

     {
         parent::_beforeDelete($object);
         $this->getAggregateCount()->processDelete($object);
         $this->deleteChildren($object);
     }

◆ _beforeSave()

_beforeSave ( \Magento\Framework\DataObject $object )

protected

Process category data before saving prepare path and increment children count for parent categories

Parameters

\Magento\Framework\DataObject $object

Returns: $this @SuppressWarnings(PHPMD.NPathComplexity) @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 259 of file Category.php.

     {
         parent::_beforeSave($object);
 
         if (!$object->getChildrenCount()) {
             $object->setChildrenCount(0);
         }
         $object->setAttributeSetId(
             $object->getAttributeSetId() ?: $this->getEntityType()->getDefaultAttributeSetId()
         );
         if ($object->isObjectNew()) {
             if ($object->getPosition() === null) {
                 $object->setPosition($this->_getMaxPosition($object->getPath()) + 1);
             }
             $path = explode('/', $object->getPath());
             $level = count($path)  - ($object->getId() ? 1 : 0);
             $toUpdateChild = array_diff($path, [$object->getId()]);
 
             if (!$object->hasPosition()) {
                 $object->setPosition($this->_getMaxPosition(implode('/', $toUpdateChild)) + 1);
             }
             if (!$object->hasLevel()) {
                 $object->setLevel($level);
             }
             if (!$object->hasParentId() && $level) {
                 $object->setParentId($path[$level - 1]);
             }
             if (!$object->getId()) {
                 $object->setPath($object->getPath() . '/');
             }
 
             $this->getConnection()->update(
                 $this->getEntityTable(),
                 ['children_count' => new \Zend_Db_Expr('children_count+1')],
                 ['entity_id IN(?)' => $toUpdateChild]
             );
         }
         return $this;
     }

◆ _getMaxPosition()

_getMaxPosition ( $path )

protected

Get maximum position of child categories by specific tree path

Parameters

string $path

Returns: int

Definition at line 345 of file Category.php.

     {
         $connection = $this->getConnection();
         $positionField = $connection->quoteIdentifier('position');
         $level = count(explode('/', $path));
         $bind = ['c_level' => $level, 'c_path' => $path . '/%'];
         $select = $connection->select()->from(
             $this->getTable('catalog_category_entity'),
             'MAX(' . $positionField . ')'
         )->where(
             $connection->quoteIdentifier('path') . ' LIKE :c_path'
         )->where(
             $connection->quoteIdentifier('level') . ' = :c_level'
         );
 
         $position = $connection->fetchOne($select, $bind);
         if (!$position) {
             $position = 0;
         }
         return $position;
     }

◆ _getTree()

_getTree ( )

protected

Retrieve category tree object

Returns: \Magento\Framework\Data\Tree\Db

Definition at line 187 of file Category.php.

     {
         if (!$this->_tree) {
             $this->_tree = $this->_categoryTreeFactory->create()->load();
         }
         return $this->_tree;
     }

◆ _processPositions()

_processPositions	(	$category,
		$newParent,
		$afterCategoryId
	)

protected

Process positions of old parent category children and new parent category children. Get position for moved category

Parameters

\Magento\Catalog\Model\Category	$category
\Magento\Catalog\Model\Category	$newParent
null \| int	$afterCategoryId

Returns: int

Prepare position value

Definition at line 992 of file Category.php.

     {
         $table = $this->getEntityTable();
         $connection = $this->getConnection();
         $positionField = $connection->quoteIdentifier('position');
 
         $bind = ['position' => new \Zend_Db_Expr($positionField . ' - 1')];
         $where = [
             'parent_id = ?' => $category->getParentId(),
             $positionField . ' > ?' => $category->getPosition(),
         ];
         $connection->update($table, $bind, $where);
 
         if ($afterCategoryId) {
             $select = $connection->select()->from($table, 'position')->where('entity_id = :entity_id');
             $position = $connection->fetchOne($select, ['entity_id' => $afterCategoryId]);
             $position += 1;
         } else {
             $position = 1;
         }
 
         $bind = ['position' => new \Zend_Db_Expr($positionField . ' + 1')];
         $where = ['parent_id = ?' => $newParent->getId(), $positionField . ' >= ?' => $position];
         $connection->update($table, $bind, $where);
 
         return $position;
     }

◆ _saveCategoryProducts()

_saveCategoryProducts ( $category )

protected

Save category products relation

Parameters

\Magento\Catalog\Model\Category $category

Returns: $this @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

new category-product relationships

Example re-save category

old category-product relationships

Find product ids which are presented in both arrays and saved before (check $oldProducts array)

Delete products from category

Add products to category

Update product positions in category

Setting affected products to category for third party engine index refresh

Definition at line 375 of file Category.php.

     {
         $category->setIsChangedProductList(false);
         $id = $category->getId();
         $products = $category->getPostedProducts();
 
         if ($products === null) {
             return $this;
         }
 
         $oldProducts = $category->getProductsPosition();
 
         $insert = array_diff_key($products, $oldProducts);
         $delete = array_diff_key($oldProducts, $products);
 
         $update = array_intersect_key($products, $oldProducts);
         $update = array_diff_assoc($update, $oldProducts);
 
         $connection = $this->getConnection();
 
         if (!empty($delete)) {
             $cond = ['product_id IN(?)' => array_keys($delete), 'category_id=?' => $id];
             $connection->delete($this->getCategoryProductTable(), $cond);
         }
 
         if (!empty($insert)) {
             $data = [];
             foreach ($insert as $productId => $position) {
                 $data[] = [
                     'category_id' => (int)$id,
                     'product_id' => (int)$productId,
                     'position' => (int)$position,
                 ];
             }
             $connection->insertMultiple($this->getCategoryProductTable(), $data);
         }
 
         if (!empty($update)) {
             $newPositions = [];
             foreach ($update as $productId => $position) {
                 $delta = $position - $oldProducts[$productId];
                 if (!isset($newPositions[$delta])) {
                     $newPositions[$delta] = [];
                 }
                 $newPositions[$delta][] = $productId;
             }
 
             foreach ($newPositions as $delta => $productIds) {
                 $bind = ['position' => new \Zend_Db_Expr("position + ({$delta})")];
                 $where = ['category_id = ?' => (int)$id, 'product_id IN (?)' => $productIds];
                 $connection->update($this->getCategoryProductTable(), $bind, $where);
             }
         }
 
         if (!empty($insert) || !empty($delete)) {
             $productIds = array_unique(array_merge(array_keys($insert), array_keys($delete)));
             $this->_eventManager->dispatch(
                 'catalog_category_change_products',
                 ['category' => $category, 'product_ids' => $productIds]
             );
 
             $category->setChangedProductIds($productIds);
         }
 
         if (!empty($insert) || !empty($update) || !empty($delete)) {
             $category->setIsChangedProductList(true);
 
             $productIds = array_keys($insert + $delete + $update);
             $category->setAffectedProductIds($productIds);
         }
         return $this;
     }

◆ _savePath()

_savePath ( $object )

protected

Update path field

Parameters

\Magento\Catalog\Model\Category $object

Returns: $this

Definition at line 326 of file Category.php.

     {
         if ($object->getId()) {
             $this->getConnection()->update(
                 $this->getEntityTable(),
                 ['path' => $object->getPath()],
                 ['entity_id = ?' => $object->getId()]
             );
             $object->unsetData('path_ids');
         }
         return $this;
     }

◆ changeParent()

changeParent	(	\Magento\Catalog\Model\Category	$category,
		\Magento\Catalog\Model\Category	$newParent,
			$afterCategoryId = `null`
	)

Move category to another parent node

Parameters

\Magento\Catalog\Model\Category	$category
\Magento\Catalog\Model\Category	$newParent
null \| int	$afterCategoryId

Returns: $this

Decrease children count for all old category parent categories

Increase children count for new category parents

Update children nodes path

Update moved category data

Definition at line 913 of file Category.php.

       {
         $childrenCount = $this->getChildrenCount($category->getId()) + 1;
         $table = $this->getEntityTable();
         $connection = $this->getConnection();
         $levelFiled = $connection->quoteIdentifier('level');
         $pathField = $connection->quoteIdentifier('path');
 
         $connection->update(
             $table,
             ['children_count' => new \Zend_Db_Expr('children_count - ' . $childrenCount)],
             ['entity_id IN(?)' => $category->getParentIds()]
         );
 
         $connection->update(
             $table,
             ['children_count' => new \Zend_Db_Expr('children_count + ' . $childrenCount)],
             ['entity_id IN(?)' => $newParent->getPathIds()]
         );
 
         $position = $this->_processPositions($category, $newParent, $afterCategoryId);
 
         $newPath = sprintf('%s/%s', $newParent->getPath(), $category->getId());
         $newLevel = $newParent->getLevel() + 1;
         $levelDisposition = $newLevel - $category->getLevel();
 
         $connection->update(
             $table,
             [
                 'path' => new \Zend_Db_Expr(
                     'REPLACE(' . $pathField . ',' . $connection->quote(
                         $category->getPath() . '/'
                     ) . ', ' . $connection->quote(
                         $newPath . '/'
                     ) . ')'
                 ),
                 'level' => new \Zend_Db_Expr($levelFiled . ' + ' . $levelDisposition)
             ],
             [$pathField . ' LIKE ?' => $category->getPath() . '/%']
         );
         $data = [
             'path' => $newPath,
             'level' => $newLevel,
             'position' => $position,
             'parent_id' => $newParent->getId(),
         ];
         $connection->update($table, $data, ['entity_id = ?' => $category->getId()]);
 
         // Update category object to new data
         $category->addData($data);
         $category->unsetData('path_ids');
 
         return $this;
     }

◆ checkId()

checkId ( $entityId )

Check if category id exist

Parameters

int $entityId

Returns: bool

Definition at line 517 of file Category.php.

     {
         $select = $this->getConnection()->select()->from(
             $this->getEntityTable(),
             'entity_id'
         )->where(
             'entity_id = :entity_id'
         );
         $bind = ['entity_id' => $entityId];
 
         return $this->getConnection()->fetchOne($select, $bind);
     }

◆ countVisible()

countVisible ( )

Get total number of persistent categories in the system, excluding the default category

Returns: int

Definition at line 1028 of file Category.php.

     {
         $connection = $this->getConnection();
         $select = $connection->select();
         $select->from($this->getEntityTable(), 'COUNT(*)')->where('parent_id != ?', 0);
         return (int)$connection->fetchOne($select);
     }

◆ delete()

delete ( $object )

{}

Definition at line 1067 of file Category.php.

     {
         $this->getEntityManager()->delete($object);
         $this->_eventManager->dispatch(
             'catalog_category_delete_after_done',
             ['product' => $object, 'category' => $object]
         );
         return $this;
     }

◆ deleteChildren()

deleteChildren ( \Magento\Framework\DataObject $object )

Delete children categories of specific category

Parameters

\Magento\Framework\DataObject $object

Returns: $this

Add deleted children ids to object This data can be used in after delete event

Definition at line 228 of file Category.php.

     {
         if ($object->getSkipDeleteChildren()) {
             return $this;
         }
 
         $categories = $this->_categoryCollectionFactory->create();
         $categories->addAttributeToFilter('path', ['like' => $object->getPath() . '/%']);
         $childrenIds = $categories->getAllIds();
         foreach ($categories as $category) {
             $category->setSkipDeleteChildren(true);
             $category->delete();
         }
 
         $object->setDeletedChildrenIds($childrenIds);
         return $this;
     }

◆ findWhereAttributeIs()

findWhereAttributeIs	(	$entityIdsFilter,
		$attribute,
		$expectedValue
	)

Return entities where attribute value is

Parameters

array \| int	$entityIdsFilter
\Magento\Eav\Model\Entity\Attribute	$attribute
mixed	$expectedValue

Returns: array

Definition at line 617 of file Category.php.

     {
         // @codingStandardsIgnoreStart
         $serializeData = $this->serializer->serialize($entityIdsFilter);
         $entityIdsFilterHash = md5($serializeData);
         // @codingStandardsIgnoreEnd
 
         if (!isset($this->entitiesWhereAttributesIs[$entityIdsFilterHash][$attribute->getId()][$expectedValue])) {
             $linkField = $this->getLinkField();
             $bind = ['attribute_id' => $attribute->getId(), 'value' => $expectedValue];
             $selectEntities = $this->getConnection()->select()->from(
                 ['ce' => $this->getTable('catalog_category_entity')],
                 ['entity_id']
             )->joinLeft(
                 ['ci' => $attribute->getBackend()->getTable()],
                 "ci.{$linkField} = ce.{$linkField} AND attribute_id = :attribute_id",
                 ['value']
             )->where(
                 'ci.value = :value'
             )->where(
                 'ce.entity_id IN (?)',
                 $entityIdsFilter
             );
             $this->entitiesWhereAttributesIs[$entityIdsFilterHash][$attribute->getId()][$expectedValue] =
                 $this->getConnection()->fetchCol($selectEntities, $bind);
         }
 
         return $this->entitiesWhereAttributesIs[$entityIdsFilterHash][$attribute->getId()][$expectedValue];
     }

◆ getAllChildren()

getAllChildren ( $category )

Return all children ids of category (with category id)

Parameters

\Magento\Catalog\Model\Category $category

Returns: array

Definition at line 841 of file Category.php.

     {
         $children = $this->getChildren($category);
         $myId = [$category->getId()];
         $children = array_merge($myId, $children);
 
         return $children;
     }

◆ getCategories()

getCategories	(	$parent,
		$recursionLevel = `0`,
		$sorted = `false`,
		$asCollection = `false`,
		$toLoad = `true`
	)

Retrieve categories

Parameters

integer	$parent
integer	$recursionLevel
boolean \| string	$sorted
boolean	$asCollection
boolean	$toLoad

Returns: \Magento\Framework\Data\Tree\Node\Collection|\Magento\Catalog\Model\ResourceModel\Category\Collection

Definition at line 680 of file Category.php.

     {
         $tree = $this->_categoryTreeFactory->create();
         /* @var $tree \Magento\Catalog\Model\ResourceModel\Category\Tree */
         $nodes = $tree->loadNode($parent)->loadChildren($recursionLevel)->getChildren();
 
         $tree->addCollectionData(null, $sorted, $parent, $toLoad, true);
 
         if ($asCollection) {
             return $tree->getCollection();
         }
         return $nodes;
     }

◆ getCategoryPathById()

getCategoryPathById ( $categoryId )

Get category path value by its id

Parameters

int $categoryId

Returns: string

Definition at line 892 of file Category.php.

     {
         $select = $this->getConnection()->select()->from(
             $this->getEntityTable(),
             ['path']
         )->where(
             'entity_id = :entity_id'
         );
         $bind = ['entity_id' => (int)$categoryId];
 
         return $this->getConnection()->fetchOne($select, $bind);
     }

◆ getCategoryProductTable()

getCategoryProductTable ( )

Category product table name getter

Returns: string

Definition at line 149 of file Category.php.

     {
         if (!$this->_categoryProductTable) {
             $this->_categoryProductTable = $this->getTable('catalog_category_product');
         }
         return $this->_categoryProductTable;
     }

◆ getChildren()

getChildren	(	$category,
		$recursive = `true`
	)

Return children ids of category

Parameters

\Magento\Catalog\Model\Category	$category
boolean	$recursive

Returns: array

Definition at line 798 of file Category.php.

     {
         $linkField = $this->getLinkField();
         $attributeId = $this->getIsActiveAttributeId();
         $backendTable = $this->getTable([$this->getEntityTablePrefix(), 'int']);
         $connection = $this->getConnection();
         $checkSql = $connection->getCheckSql('c.value_id > 0', 'c.value', 'd.value');
         $bind = [
             'attribute_id' => $attributeId,
             'store_id' => $category->getStoreId(),
             'scope' => 1,
             'c_path' => $category->getPath() . '/%',
         ];
         $select = $this->getConnection()->select()->from(
             ['m' => $this->getEntityTable()],
             'entity_id'
         )->joinLeft(
             ['d' => $backendTable],
             "d.attribute_id = :attribute_id AND d.store_id = 0 AND d.{$linkField} = m.{$linkField}",
             []
         )->joinLeft(
             ['c' => $backendTable],
             "c.attribute_id = :attribute_id AND c.store_id = :store_id AND c.{$linkField} = m.{$linkField}",
             []
         )->where(
             $checkSql . ' = :scope'
         )->where(
             $connection->quoteIdentifier('path') . ' LIKE :c_path'
         );
         if (!$recursive) {
             $select->where($connection->quoteIdentifier('level') . ' <= :c_level');
             $bind['c_level'] = $category->getLevel() + 1;
         }
 
         return $connection->fetchCol($select, $bind);
     }

◆ getChildrenAmount()

getChildrenAmount	(	$category,
		$isActiveFlag = `true`
	)

Get count of active/not active children categories

Parameters

\Magento\Catalog\Model\Category	$category
bool	$isActiveFlag

Returns: int

Definition at line 560 of file Category.php.

     {
         $storeId = $this->_storeManager->getStore()->getId();
         $attributeId = $this->getIsActiveAttributeId();
         $table = $this->getTable([$this->getEntityTablePrefix(), 'int']);
         $connection = $this->getConnection();
         $checkSql = $connection->getCheckSql('c.value_id > 0', 'c.value', 'd.value');
         $linkField = $this->getLinkField();
         $bind = [
             'attribute_id' => $attributeId,
             'store_id' => $storeId,
             'active_flag' => $isActiveFlag,
             'c_path' => $category->getPath() . '/%',
         ];
         $select = $connection->select()->from(
             ['m' => $this->getEntityTable()],
             ['COUNT(m.entity_id)']
         )->joinLeft(
             ['d' => $table],
             "d.attribute_id = :attribute_id AND d.store_id = 0 AND d.{$linkField} = m.{$linkField}",
             []
         )->joinLeft(
             ['c' => $table],
             "c.attribute_id = :attribute_id AND c.store_id = :store_id AND c.{$linkField} = m.{$linkField}",
             []
         )->where(
             'm.path LIKE :c_path'
         )->where(
             $checkSql . ' = :active_flag'
         );
 
         return $this->getConnection()->fetchOne($select, $bind);
     }

◆ getChildrenCategories()

getChildrenCategories ( $category )

Return child categories

Parameters

\Magento\Catalog\Model\Category $category

Returns: \Magento\Catalog\Model\ResourceModel\Category\Collection

Definition at line 766 of file Category.php.

     {
         $collection = $category->getCollection();
         /* @var $collection \Magento\Catalog\Model\ResourceModel\Category\Collection */
         $collection->addAttributeToSelect(
             'url_key'
         )->addAttributeToSelect(
             'name'
         )->addAttributeToSelect(
             'all_children'
         )->addAttributeToSelect(
             'is_anchor'
         )->addAttributeToFilter(
             'is_active',
             1
         )->addIdFilter(
             $category->getChildren()
         )->setOrder(
             'position',
             \Magento\Framework\DB\Select::SQL_ASC
         )->joinUrlRewrite();
 
         return $collection;
     }

◆ getChildrenCount()

getChildrenCount ( $categoryId )

Get children categories count

Parameters

int $categoryId

Returns: int

Definition at line 498 of file Category.php.

     {
         $select = $this->getConnection()->select()->from(
             $this->getEntityTable(),
             'children_count'
         )->where(
             'entity_id = :entity_id'
         );
         $bind = ['entity_id' => $categoryId];
 
         return $this->getConnection()->fetchOne($select, $bind);
     }

◆ getEntityType()

getEntityType ( )

Entity type getter and lazy loader

Returns: \Magento\Eav\Model\Entity\Type

Exceptions

Definition at line 136 of file Category.php.

     {
         if (empty($this->_type)) {
             $this->setType(\Magento\Catalog\Model\Category::ENTITY);
         }
         return parent::getEntityType();
     }

◆ getIsActiveAttributeId()

getIsActiveAttributeId ( )

Get "is_active" attribute identifier

Returns: int

Definition at line 599 of file Category.php.

     {
         if ($this->_isActiveAttributeId === null) {
             $this->_isActiveAttributeId = (int)$this->_eavConfig
                 ->getAttribute($this->getEntityType(), 'is_active')
                 ->getAttributeId();
         }
         return $this->_isActiveAttributeId;
     }

◆ getParentDesignCategory()

getParentDesignCategory ( $category )

Return parent category of current category with own custom design settings

Parameters

\Magento\Catalog\Model\Category $category

Returns: \Magento\Catalog\Model\Category

Definition at line 726 of file Category.php.

     {
         $pathIds = array_reverse($category->getPathIds());
         $collection = $category->getCollection()->setStore(
             $this->_storeManager->getStore()
         )->addAttributeToSelect(
             'custom_design'
         )->addAttributeToSelect(
             'custom_design_from'
         )->addAttributeToSelect(
             'custom_design_to'
         )->addAttributeToSelect(
             'page_layout'
         )->addAttributeToSelect(
             'custom_layout_update'
         )->addAttributeToSelect(
             'custom_apply_to_products'
         )->addFieldToFilter(
             'entity_id',
             ['in' => $pathIds]
         )->addAttributeToFilter(
             'custom_use_parent_settings',
             [['eq' => 0], ['null' => 0]],
             'left'
         )->addFieldToFilter(
             'level',
             ['neq' => 0]
         )->setOrder(
             'level',
             'DESC'
         )->load();
         return $collection->getFirstItem();
     }

◆ getProductCount()

getProductCount ( $category )

Get products count in category

Parameters

\Magento\Catalog\Model\Category $category

Returns: int

Definition at line 653 of file Category.php.

     {
         $productTable = $this->_resource->getTableName('catalog_category_product');
 
         $select = $this->getConnection()->select()->from(
             ['main_table' => $productTable],
             [new \Zend_Db_Expr('COUNT(main_table.product_id)')]
         )->where(
             'main_table.category_id = :category_id'
         );
 
         $bind = ['category_id' => (int)$category->getId()];
         $counts = $this->getConnection()->fetchOne($select, $bind);
 
         return intval($counts);
     }

◆ getProductsPosition()

getProductsPosition ( $category )

Get positions of associated to category products

Parameters

\Magento\Catalog\Model\Category $category

Returns: array

Definition at line 479 of file Category.php.

     {
         $select = $this->getConnection()->select()->from(
             $this->getCategoryProductTable(),
             ['product_id', 'position']
         )->where(
             'category_id = :category_id'
         );
         $bind = ['category_id' => (int)$category->getId()];
 
         return $this->getConnection()->fetchPairs($select, $bind);
     }

◆ getStoreId()

getStoreId ( )

Return store id

Returns: integer

Definition at line 174 of file Category.php.

     {
         if ($this->_storeId === null) {
             return $this->_storeManager->getStore()->getId();
         }
         return $this->_storeId;
     }

◆ isForbiddenToDelete()

isForbiddenToDelete ( $categoryId )

Check category is forbidden to delete. If category is root and assigned to store group return false

Parameters

integer $categoryId

Returns: boolean

Definition at line 870 of file Category.php.

     {
         $select = $this->getConnection()->select()->from(
             $this->getTable('store_group'),
             ['group_id']
         )->where(
             'root_category_id = :root_category_id'
         );
         $result = $this->getConnection()->fetchOne($select, ['root_category_id' => $categoryId]);
 
         if ($result) {
             return true;
         }
         return false;
     }

◆ isInRootCategoryList()

isInRootCategoryList ( $category )

Check is category in list of store categories

Parameters

\Magento\Catalog\Model\Category $category

Returns: boolean

Definition at line 856 of file Category.php.

     {
         $rootCategoryId = $this->_storeManager->getStore()->getRootCategoryId();
 
         return in_array($rootCategoryId, $category->getParentIds());
     }

◆ load()

load	(	$object,
		$entityId,
		$attributes = `[]`
	)

Reset firstly loaded attributes

Parameters

\Magento\Framework\DataObject	$object
integer	$entityId
array \| null	$attributes

Returns: $this

Definition at line 1044 of file Category.php.

     {
         $this->_attributes = [];
         $select = $this->_getLoadRowSelect($object, $entityId);
         $row = $this->getConnection()->fetchRow($select);
 
         if (is_array($row)) {
             $object->addData($row);
         } else {
             $object->isObjectNew(true);
         }
 
         $this->loadAttributesForObject($attributes, $object);
         $object = $this->getEntityManager()->load($object, $entityId);
         if (!$this->getEntityManager()->has($object)) {
             $object->isObjectNew(true);
         }
         return $this;
     }

◆ save()

save ( \Magento\Framework\Model\AbstractModel $object )

Save entity's attributes into the object's resource

Parameters

\Magento\Framework\Model\AbstractModel $object

Returns: $this

Exceptions

Definition at line 1084 of file Category.php.

     {
         $this->getEntityManager()->save($object);
         return $this;
     }

◆ setStoreId()

setStoreId ( $storeId )

Set store Id

Parameters

integer $storeId

Returns: $this

Definition at line 163 of file Category.php.

     {
         $this->_storeId = $storeId;
         return $this;
     }

◆ verifyIds()

verifyIds ( array $ids )

Check array of category identifiers

Parameters

array $ids

Returns: array

Definition at line 536 of file Category.php.

     {
         if (empty($ids)) {
             return [];
         }
 
         $select = $this->getConnection()->select()->from(
             $this->getEntityTable(),
             'entity_id'
         )->where(
             'entity_id IN(?)',
             $ids
         );
 
         return $this->getConnection()->fetchCol($select);
     }

Field Documentation

◆ $_categoryCollectionFactory

$_categoryCollectionFactory

protected

Definition at line 68 of file Category.php.

◆ $_categoryProductTable

$_categoryProductTable

protected

Definition at line 35 of file Category.php.

◆ $_categoryTreeFactory

$_categoryTreeFactory

protected

Definition at line 75 of file Category.php.

◆ $_eventManager

$_eventManager = null

protected

Definition at line 61 of file Category.php.

◆ $_isActiveAttributeId

$_isActiveAttributeId = null

protected

Definition at line 47 of file Category.php.

◆ $_storeId

$_storeId = null

protected

Definition at line 54 of file Category.php.

◆ $_tree

$_tree

protected

Definition at line 28 of file Category.php.

◆ $aggregateCount

$aggregateCount

protected

Definition at line 85 of file Category.php.

◆ $entityManager

$entityManager

protected

Definition at line 80 of file Category.php.

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

vendor/magento/module-catalog/Model/ResourceModel/Category.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _afterDelete()

◆ _afterSave()

◆ _beforeDelete()

◆ _beforeSave()

◆ _getMaxPosition()

◆ _getTree()

◆ _processPositions()

◆ _saveCategoryProducts()

◆ _savePath()

◆ changeParent()

◆ checkId()

◆ countVisible()

◆ delete()

◆ deleteChildren()

◆ findWhereAttributeIs()

◆ getAllChildren()

◆ getCategories()

◆ getCategoryPathById()

◆ getCategoryProductTable()

◆ getChildren()

◆ getChildrenAmount()

◆ getChildrenCategories()

◆ getChildrenCount()

◆ getEntityType()

◆ getIsActiveAttributeId()

◆ getParentDesignCategory()

◆ getProductCount()

◆ getProductsPosition()

◆ getStoreId()

◆ isForbiddenToDelete()

◆ isInRootCategoryList()

◆ load()

◆ save()

◆ setStoreId()

◆ verifyIds()

Field Documentation

◆ $_categoryCollectionFactory

◆ $_categoryProductTable

◆ $_categoryTreeFactory

◆ $_eventManager

◆ $_isActiveAttributeId

◆ $_storeId

◆ $_tree

◆ $aggregateCount

◆ $entityManager