Inheritance diagram for Category:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Catalog\Api\CategoryAttributeRepositoryInterface $metadataService, \Magento\Catalog\Model\ResourceModel\Category\Tree $categoryTreeResource, \Magento\Catalog\Model\ResourceModel\Category\TreeFactory $categoryTreeFactory, \Magento\Store\Model\ResourceModel\Store\CollectionFactory $storeCollectionFactory, \Magento\Framework\UrlInterface $url, \Magento\Catalog\Model\ResourceModel\Product\CollectionFactory $productCollectionFactory, \Magento\Catalog\Model\Config $catalogConfig, \Magento\Framework\Filter\FilterManager $filter, Indexer\Category\Flat\State $flatState, \Magento\CatalogUrlRewrite\Model\CategoryUrlPathGenerator $categoryUrlPathGenerator, UrlFinderInterface $urlFinder, \Magento\Framework\Indexer\IndexerRegistry $indexerRegistry, CategoryRepositoryInterface $categoryRepository, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	getUseFlatResource ()

	getUrlInstance ()

	getTreeModel ()

	getTreeModelInstance ()

	move ($parentId, $afterCategoryId)

	getDefaultAttributeSetId ()

	getProductCollection ()

	getAttributes ($noDesignAttributes=false)

	getProductsPosition ()

	getStoreIds ()

	getStoreId ()

	setStoreId ($storeId)

	getUrl ()

	getCategoryIdUrl ()

	formatUrlKey ($str)

	getImageUrl ($attributeCode='image')

	getParentCategory ()

	getParentId ()

	getParentIds ()

	getCustomDesignDate ()

	getDesignAttributes ()

	getAllChildren ($asArray=false)

	getChildren ($recursive=false, $isActive=true, $sortByPosition=false)

	getPathInStore ()

	checkId ($id)

	getPathIds ()

	getLevel ()

	verifyIds (array $ids)

	hasChildren ()

	getRequestPath ()

	getName ()

	beforeDelete ()

	getAnchorsAbove ()

	getProductCount ()

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

	getParentCategories ()

	getChildrenCategories ()

	getParentDesignCategory ()

	isInRootCategoryList ()

	getAvailableSortBy ()

	getAvailableSortByOptions ()

	getDefaultSortBy ()

	validate ()

	afterSave ()

	reindex ()

	afterDeleteCommit ()

	getIdentities ()

	getPath ()

	getPosition ()

	getChildrenCount ()

	getCreatedAt ()

	getUpdatedAt ()

	getIsActive ()

	getCategoryId ()

	getDisplayMode ()

	getIncludeInMenu ()

	getUrlKey ()

	getChildrenData ()

	__toArray ()

	setParentId ($parentId)

	setName ($name)

	setIsActive ($isActive)

	setPosition ($position)

	setLevel ($level)

	setUpdatedAt ($updatedAt)

	setCreatedAt ($createdAt)

	setPath ($path)

	setAvailableSortBy ($availableSortBy)

	setIncludeInMenu ($includeInMenu)

	setProductCount ($productCount)

	setChildrenData (array $childrenData=null)

	getExtensionAttributes ()

	setExtensionAttributes (\Magento\Catalog\Api\Data\CategoryExtensionInterface $extensionAttributes)

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	lockAttribute ($attributeCode)

	unlockAttribute ($attributeCode)

	unlockAttributes ()

	getLockedAttributes ()

	hasLockedAttributes ()

	isLockedAttribute ($attributeCode)

	setData ($key, $value=null)

	unsetData ($key=null)

	getResourceCollection ()

	loadByAttribute ($attribute, $value, $additionalAttributes=' *')

	getStore ()

	getWebsiteStoreIds ()

	setAttributeDefaultValue ($attributeCode, $value)

	getAttributeDefaultValue ($attributeCode)

	setExistsStoreValueFlag ($attributeCode)

	getExistsStoreValueFlag ($attributeCode)

	beforeSave ()

	isDeleteable ()

	setIsDeleteable ($value)

	isReadonly ()

	setIsReadonly ($value)

Public Member Functions inherited from AbstractExtensibleModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	getCustomAttributes ()

	getCustomAttribute ($attributeCode)

	setCustomAttributes (array $attributes)

	setCustomAttribute ($attributeCode, $attributeValue)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	setId ($value)

	__sleep ()

	__wakeup ()

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Public Member Functions inherited from CategoryInterface
	getId ()

	setId ($id)

	getChildren ()

Public Member Functions inherited from CategoryTreeInterface
	getId ()

	setId ($id)

Data Fields
const	ENTITY = 'catalog_category'

const	DM_PRODUCT = 'PRODUCTS'

const	DM_PAGE = 'PAGE'

const	DM_MIXED = 'PRODUCTS_AND_PAGE'

const	ROOT_CATEGORY_ID = 0

const	TREE_ROOT_ID = 1

const	CACHE_TAG = 'cat_c'

Data Fields inherited from CustomAttributesDataInterface
const	CUSTOM_ATTRIBUTES = 'custom_attributes'

Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'

Data Fields inherited from CategoryInterface
const	KEY_PARENT_ID = 'parent_id'

const	KEY_NAME = 'name'

const	KEY_IS_ACTIVE = 'is_active'

const	KEY_POSITION = 'position'

const	KEY_LEVEL = 'level'

const	KEY_UPDATED_AT = 'updated_at'

const	KEY_CREATED_AT = 'created_at'

const	KEY_PATH = 'path'

const	KEY_AVAILABLE_SORT_BY = 'available_sort_by'

const	KEY_INCLUDE_IN_MENU = 'include_in_menu'

const	KEY_PRODUCT_COUNT = 'product_count'

const	KEY_CHILDREN_DATA = 'children_data'

const	ATTRIBUTES

Protected Member Functions
	_construct ()

	getCustomAttributesCodes ()

	_getResource ()

Protected Member Functions inherited from AbstractExtensibleModel
	filterCustomAttributes ($data)

	initializeCustomAttributes ()

	convertCustomAttributeValues (array &$customAttributes)

	getCustomAttributesCodes ()

	_setExtensionAttributes (\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes)

	_getExtensionAttributes ()

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_eventPrefix = 'catalog_category'

	$_eventObject = 'category'

	$_cacheTag = self::CACHE_TAG

	$_url

	$_resource

	$_urlRewrite

	$_useFlatResource = false

	$_designAttributes

	$interfaceAttributes = CategoryInterface::ATTRIBUTES

	$_treeModel = null

	$filter

	$_catalogConfig

	$_productCollectionFactory

	$_storeCollectionFactory

	$_categoryTreeFactory

	$flatState

	$categoryUrlPathGenerator

	$urlFinder

	$indexerRegistry

	$categoryRepository

	$metadataService

Protected Attributes inherited from AbstractModel
	$_defaultValues

	$_storeValuesFlags

	$_lockedAttributes = []

	$_isDeleteable = true

	$_isReadonly = false

	$_storeManager

Protected Attributes inherited from AbstractExtensibleModel
	$extensionAttributesFactory

	$extensionAttributes

	$customAttributeFactory

	$customAttributesCodes = null

	$customAttributesChanged = false

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Catalog category

@api @method Category setAffectedProductIds(array $productIds) @method array getAffectedProductIds() @method Category setMovedCategoryId(array $productIds) @method int getMovedCategoryId() @method Category setAffectedCategoryIds(array $categoryIds) @method array getAffectedCategoryIds() @method Category setUrlKey(string $urlKey) @method Category setUrlPath(string $urlPath) @method Category getSkipDeleteChildren() @method Category setSkipDeleteChildren(boolean $value) @method Category setChangedProductIds(array $categoryIds) Set products ids that inserted or deleted for category @method array getChangedProductIds() Get products ids that inserted or deleted for category

@SuppressWarnings(PHPMD.LongVariable) @SuppressWarnings(PHPMD.ExcessivePublicCount) @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 42 of file Category.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory,
		AttributeValueFactory	$customAttributeFactory,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Catalog\Api\CategoryAttributeRepositoryInterface	$metadataService,
		\Magento\Catalog\Model\ResourceModel\Category\Tree	$categoryTreeResource,
		\Magento\Catalog\Model\ResourceModel\Category\TreeFactory	$categoryTreeFactory,
		\Magento\Store\Model\ResourceModel\Store\CollectionFactory	$storeCollectionFactory,
		\Magento\Framework\UrlInterface	$url,
		\Magento\Catalog\Model\ResourceModel\Product\CollectionFactory	$productCollectionFactory,
		\Magento\Catalog\Model\Config	$catalogConfig,
		\Magento\Framework\Filter\FilterManager	$filter,
		Indexer\Category\Flat\State	$flatState,
		\Magento\CatalogUrlRewrite\Model\CategoryUrlPathGenerator	$categoryUrlPathGenerator,
		UrlFinderInterface	$urlFinder,
		\Magento\Framework\Indexer\IndexerRegistry	$indexerRegistry,
		CategoryRepositoryInterface	$categoryRepository,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory
AttributeValueFactory	$customAttributeFactory
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Catalog\Api\CategoryAttributeRepositoryInterface	$metadataService
\Magento\Catalog\Model\ResourceModel\Category\Tree	$categoryTreeResource
\Magento\Catalog\Model\ResourceModel\Category\TreeFactory	$categoryTreeFactory
\Magento\Store\Model\ResourceModel\Store\CollectionFactory	$storeCollectionFactory
\Magento\Framework\UrlInterface	$url
\Magento\Catalog\Model\ResourceModel\Product\CollectionFactory	$productCollectionFactory
Config	$catalogConfig
\Magento\Framework\Filter\FilterManager	$filter
Indexer\Category\Flat\State	$flatState
\Magento\CatalogUrlRewrite\Model\CategoryUrlPathGenerator	$categoryUrlPathGenerator
UrlFinderInterface	$urlFinder
\Magento\Framework\Indexer\IndexerRegistry	$indexerRegistry
CategoryRepositoryInterface	$categoryRepository
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 239 of file Category.php.

       {
         $this->metadataService = $metadataService;
         $this->_treeModel = $categoryTreeResource;
         $this->_categoryTreeFactory = $categoryTreeFactory;
         $this->_storeCollectionFactory = $storeCollectionFactory;
         $this->_url = $url;
         $this->_productCollectionFactory = $productCollectionFactory;
         $this->_catalogConfig = $catalogConfig;
         $this->filter = $filter;
         $this->flatState = $flatState;
         $this->categoryUrlPathGenerator = $categoryUrlPathGenerator;
         $this->urlFinder = $urlFinder;
         $this->indexerRegistry = $indexerRegistry;
         $this->categoryRepository = $categoryRepository;
         parent::__construct(
             $context,
             $registry,
             $extensionFactory,
             $customAttributeFactory,
             $storeManager,
             $resource,
             $resourceCollection,
             $data
         );
     }

Member Function Documentation

◆ __toArray()

__toArray ( )

Return Data Object data in array format.

Returns: array

Todo:: refactor with converter for AbstractExtensibleModel

Definition at line 1252 of file Category.php.

     {
         $data = $this->_data;
         $hasToArray = function ($model) {
             return is_object($model) && method_exists($model, '__toArray') && is_callable([$model, '__toArray']);
         };
         foreach ($data as $key => $value) {
             if ($hasToArray($value)) {
                 $data[$key] = $value->__toArray();
             } elseif (is_array($value)) {
                 foreach ($value as $nestedKey => $nestedValue) {
                     if ($hasToArray($nestedValue)) {
                         $value[$nestedKey] = $nestedValue->__toArray();
                     }
                 }
                 $data[$key] = $value;
             }
         }
         return $data;
     }

◆ _construct()

_construct ( )

protected

Initialize resource mode

Returns: void

Definition at line 292 of file Category.php.

     {
         // If Flat Index enabled then use it but only on frontend
         if ($this->flatState->isAvailable()) {
             $this->_init(\Magento\Catalog\Model\ResourceModel\Category\Flat::class);
             $this->_useFlatResource = true;
         } else {
             $this->_init(\Magento\Catalog\Model\ResourceModel\Category::class);
         }
     }

◆ _getResource()

_getResource ( )

protected

Exceptions

Definition at line 321 of file Category.php.

     {
         return parent::_getResource();
     }

◆ afterDeleteCommit()

afterDeleteCommit ( )

Init indexing process after category delete

Returns: \Magento\Framework\Model\AbstractModel

Definition at line 1129 of file Category.php.

     {
         $this->reindex();
         return parent::afterDeleteCommit();
     }

◆ afterSave()

afterSave ( )

Add reindexCallback

Returns: \Magento\Catalog\Model\Category

Definition at line 1092 of file Category.php.

     {
         $result = parent::afterSave();
         $this->_getResource()->addCommitCallback([$this, 'reindex']);
         return $result;
     }

◆ beforeDelete()

beforeDelete ( )

Before delete process

Exceptions

Definition at line 905 of file Category.php.

     {
         if ($this->getResource()->isForbiddenToDelete($this->getId())) {
             throw new \Magento\Framework\Exception\LocalizedException(__('Can\'t delete root category.'));
         }
         return parent::beforeDelete();
     }

◆ checkId()

checkId ( $id )

Check category id existing

Parameters

int $id

Returns: bool

Definition at line 824 of file Category.php.

     {
         return $this->_getResource()->checkId($id);
     }

◆ formatUrlKey()

formatUrlKey ( $str )

Format URL key from name or defined key

Parameters

string $str

Returns: string

Definition at line 647 of file Category.php.

     {
         return $this->filter->translitUrl($str);
     }

◆ getAllChildren()

getAllChildren ( $asArray = false )

Get all children categories IDs

Parameters

boolean $asArray return result as array instead of comma-separated list of IDs

Returns: array|string

Definition at line 776 of file Category.php.

     {
         $children = $this->getResource()->getAllChildren($this);
         if ($asArray) {
             return $children;
         } else {
             return implode(',', $children);
         }
     }

◆ getAnchorsAbove()

getAnchorsAbove ( )

Retrieve anchors above

Returns: array

Definition at line 918 of file Category.php.

     {
         $anchors = [];
         $path = $this->getPathIds();
 
         if (in_array($this->getId(), $path)) {
             unset($path[array_search($this->getId(), $path)]);
         }
 
         if ($this->_useFlatResource) {
             $anchors = $this->_getResource()->getAnchorsAbove($path, $this->getStoreId());
         } else {
             if (!$this->_registry->registry('_category_is_anchor_attribute')) {
                 $model = $this->_getAttribute('is_anchor');
                 $this->_registry->register('_category_is_anchor_attribute', $model);
             }
 
             $isAnchorAttribute = $this->_registry->registry('_category_is_anchor_attribute');
             if ($isAnchorAttribute) {
                 $anchors = $this->getResource()->findWhereAttributeIs($path, $isAnchorAttribute, 1);
             }
         }
         return $anchors;
     }

◆ getAttributes()

getAttributes ( $noDesignAttributes = false )

Retrieve all customer attributes

Parameters

bool $noDesignAttributes

Returns: array

Todo:: Use with Flat Resource @SuppressWarnings(PHPMD.UnusedLocalVariable)

Definition at line 482 of file Category.php.

     {
         $result = $this->getResource()->loadAllAttributes($this)->getSortedAttributes();
 
         if ($noDesignAttributes) {
             foreach ($result as $k => $a) {
                 if (in_array($k, $this->_designAttributes)) {
                     unset($result[$k]);
                 }
             }
         }
 
         return $result;
     }

◆ getAvailableSortBy()

getAvailableSortBy ( )

Retrieve Available int Product Listing sort by

Returns: null|array

Implements CategoryInterface.

Definition at line 1020 of file Category.php.

     {
         $available = $this->getData(self::KEY_AVAILABLE_SORT_BY);
         if (empty($available)) {
             return [];
         }
         if ($available && !is_array($available)) {
             $available = explode(',', $available);
         }
         return $available;
     }

◆ getAvailableSortByOptions()

getAvailableSortByOptions ( )

Retrieve Available Product Listing Sort By code as key, value - name

Returns: array

Definition at line 1038 of file Category.php.

     {
         $availableSortBy = [];
         $defaultSortBy = $this->_catalogConfig->getAttributeUsedForSortByArray();
         if ($this->getAvailableSortBy()) {
             foreach ($this->getAvailableSortBy() as $sortBy) {
                 if (isset($defaultSortBy[$sortBy])) {
                     $availableSortBy[$sortBy] = $defaultSortBy[$sortBy];
                 }
             }
         }
 
         if (!$availableSortBy) {
             $availableSortBy = $defaultSortBy;
         }
 
         return $availableSortBy;
     }

◆ getCategories()

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

Retrieve categories by parent

Parameters

int	$parent
int	$recursionLevel
bool	$sorted
bool	$asCollection
bool	$toLoad

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

Definition at line 968 of file Category.php.

     {
         $categories = $this->getResource()->getCategories($parent, $recursionLevel, $sorted, $asCollection, $toLoad);
         return $categories;
     }

◆ getCategoryId()

getCategoryId ( )

Returns: int|null

Definition at line 1207 of file Category.php.

     {
         return $this->getData('category_id');
     }

◆ getCategoryIdUrl()

getCategoryIdUrl ( )

Retrieve category id URL

Returns: string

Definition at line 632 of file Category.php.

     {
         Profiler::start('REGULAR: ' . __METHOD__, ['group' => 'REGULAR', 'method' => __METHOD__]);
         $urlKey = $this->getUrlKey() ? $this->getUrlKey() : $this->formatUrlKey($this->getName());
         $url = $this->getUrlInstance()->getUrl('catalog/category/view', ['s' => $urlKey, 'id' => $this->getId()]);
         Profiler::stop('REGULAR: ' . __METHOD__);
         return $url;
     }

◆ getChildren()

getChildren	(	$recursive = `false`,
		$isActive = `true`,
		$sortByPosition = `false`
	)

Retrieve children ids comma separated

Parameters

boolean	$recursive
boolean	$isActive
boolean	$sortByPosition

Returns: string

Definition at line 794 of file Category.php.

     {
         return implode(',', $this->getResource()->getChildren($this, $recursive, $isActive, $sortByPosition));
     }

◆ getChildrenCategories()

getChildrenCategories ( )

Return children categories of current category

Returns: \Magento\Catalog\Model\ResourceModel\Category\Collection|\Magento\Catalog\Model\Category[]

Definition at line 989 of file Category.php.

     {
         return $this->getResource()->getChildrenCategories($this);
     }

◆ getChildrenCount()

getChildrenCount ( )

Returns: int

Definition at line 1174 of file Category.php.

     {
         return $this->getData('children_count');
     }

◆ getChildrenData()

getChildrenData ( )

Returns: \Magento\Catalog\Api\Data\CategoryTreeInterface[]|null

Implements CategoryTreeInterface.

Definition at line 1239 of file Category.php.

     {
         return $this->getData(self::KEY_CHILDREN_DATA);
     }

◆ getCreatedAt()

getCreatedAt ( )

Returns: string|null

Implements CategoryInterface.

Definition at line 1182 of file Category.php.

     {
         return $this->getData('created_at');
     }

◆ getCustomAttributesCodes()

getCustomAttributesCodes ( )

protected

{}

Definition at line 306 of file Category.php.

     {
         if ($this->customAttributesCodes === null) {
             $this->customAttributesCodes = $this->getEavAttributesCodes($this->metadataService);
             $this->customAttributesCodes = array_diff($this->customAttributesCodes, CategoryInterface::ATTRIBUTES);
         }
         return $this->customAttributesCodes;
     }

◆ getCustomDesignDate()

getCustomDesignDate ( )

Retrieve dates for custom design (from & to)

Returns: array

Definition at line 731 of file Category.php.

     {
         $result = [];
         $result['from'] = $this->getData('custom_design_from');
         $result['to'] = $this->getData('custom_design_to');
 
         return $result;
     }

◆ getDefaultAttributeSetId()

getDefaultAttributeSetId ( )

Retrieve default attribute set id

Returns: int

Definition at line 454 of file Category.php.

     {
         return $this->getResource()->getEntityType()->getDefaultAttributeSetId();
     }

◆ getDefaultSortBy()

getDefaultSortBy ( )

Retrieve Product Listing Default Sort By

Returns: string

Definition at line 1062 of file Category.php.

     {
         if (!($sortBy = $this->getData('default_sort_by'))) {
             $sortBy = $this->_catalogConfig->getProductListDefaultSortBy($this->getStoreId());
         }
         $available = $this->getAvailableSortByOptions();
         if (!isset($available[$sortBy])) {
             $sortBy = array_keys($available);
             $sortBy = $sortBy[0];
         }
 
         return $sortBy;
     }

◆ getDesignAttributes()

getDesignAttributes ( )

Retrieve design attributes array

Returns: array

Definition at line 745 of file Category.php.

     {
         $result = [];
         foreach ($this->_designAttributes as $attrName) {
             $result[] = $this->_getAttribute($attrName);
         }
         return $result;
     }

◆ getDisplayMode()

getDisplayMode ( )

Returns: string|null

Definition at line 1215 of file Category.php.

     {
         return $this->getData('display_mode');
     }

◆ getExtensionAttributes()

getExtensionAttributes ( )

{Retrieve existing extension attributes object or create a new one.

Returns: \Magento\Catalog\Api\Data\CategoryExtensionInterface|null

}

Returns: \Magento\Catalog\Api\Data\CategoryExtensionInterface|null

Implements CategoryInterface.

Definition at line 1421 of file Category.php.

     {
         return $this->_getExtensionAttributes();
     }

◆ getIdentities()

getIdentities ( )

Get identities

Returns: array

Implements IdentityInterface.

Definition at line 1140 of file Category.php.

     {
         $identities = [
             self::CACHE_TAG . '_' . $this->getId(),
         ];
         if (!$this->getId() || $this->hasDataChanges()
             || $this->isDeleted() || $this->dataHasChangedFor(self::KEY_INCLUDE_IN_MENU)
         ) {
             $identities[] = self::CACHE_TAG;
             $identities[] = Product::CACHE_PRODUCT_CATEGORY_TAG . '_' . $this->getId();
         }
         return $identities;
     }

◆ getImageUrl()

getImageUrl ( $attributeCode = 'image' )

Parameters

string $attributeCode

Returns: bool|string

Exceptions

Definition at line 657 of file Category.php.

     {
         $url = false;
         $image = $this->getData($attributeCode);
         if ($image) {
             if (is_string($image)) {
                 $store = $this->_storeManager->getStore();
 
                 $isRelativeUrl = substr($image, 0, 1) === '/';
 
                 $mediaBaseUrl = $store->getBaseUrl(
                     \Magento\Framework\UrlInterface::URL_TYPE_MEDIA
                 );
 
                 if ($isRelativeUrl) {
                     $url = $image;
                 } else {
                     $url = $mediaBaseUrl
                         . ltrim(\Magento\Catalog\Model\Category\FileInfo::ENTITY_MEDIA_PATH, '/')
                         . '/'
                         . $image;
                 }
             } else {
                 throw new \Magento\Framework\Exception\LocalizedException(
                     __('Something went wrong while getting the image url.')
                 );
             }
         }
         return $url;
     }

◆ getIncludeInMenu()

getIncludeInMenu ( )

Returns: bool|null

Implements CategoryInterface.

Definition at line 1223 of file Category.php.

     {
         return $this->getData(self::KEY_INCLUDE_IN_MENU);
     }

◆ getIsActive()

getIsActive ( )

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Implements CategoryInterface.

Definition at line 1199 of file Category.php.

     {
         return $this->getData(self::KEY_IS_ACTIVE);
     }

◆ getLevel()

getLevel ( )

Retrieve level

Returns: int

Implements CategoryInterface.

Definition at line 850 of file Category.php.

     {
         if (!$this->hasLevel()) {
             return count(explode('/', $this->getPath())) - 1;
         }
         return $this->getData(self::KEY_LEVEL);
     }

◆ getName()

getName ( )

Retrieve Name data wrapper

Returns: string

Implements CategoryInterface.

Definition at line 894 of file Category.php.

     {
         return $this->_getData(self::KEY_NAME);
     }

◆ getParentCategories()

getParentCategories ( )

Return parent categories of current category

Returns: \Magento\Framework\DataObject[]|\Magento\Catalog\Model\Category[]

Return parent categories of category

Parameters

\Magento\Catalog\Model\Category $category

Returns: \Magento\Framework\DataObject[]

Definition at line 979 of file Category.php.

     {
         return $this->getResource()->getParentCategories($this);
     }

◆ getParentCategory()

getParentCategory ( )

Get parent category object

Returns: \Magento\Catalog\Model\Category

Definition at line 693 of file Category.php.

     {
         if (!$this->hasData('parent_category')) {
             $this->setData('parent_category', $this->categoryRepository->get($this->getParentId()));
         }
         return $this->_getData('parent_category');
     }

◆ getParentDesignCategory()

getParentDesignCategory ( )

Return parent category of current category with own custom design settings

Returns: \Magento\Catalog\Model\Category

Definition at line 999 of file Category.php.

     {
         return $this->getResource()->getParentDesignCategory($this);
     }

◆ getParentId()

getParentId ( )

Get parent category identifier

Returns: int

Implements CategoryInterface.

Definition at line 706 of file Category.php.

     {
         $parentId = $this->getData(self::KEY_PARENT_ID);
         if (isset($parentId)) {
             return $parentId;
         }
         $parentIds = $this->getParentIds();
         return intval(array_pop($parentIds));
     }

◆ getParentIds()

getParentIds ( )

Get all parent categories ids

Returns: array

Definition at line 721 of file Category.php.

     {
         return array_diff($this->getPathIds(), [$this->getId()]);
     }

◆ getPath()

getPath ( )

@codeCoverageIgnoreStart

Returns: string|null

Implements CategoryInterface.

Definition at line 1158 of file Category.php.

     {
         return $this->getData(self::KEY_PATH);
     }

◆ getPathIds()

getPathIds ( )

Get array categories ids which are part of category path Result array contain id of current category because it is part of the path

Returns: array

Definition at line 835 of file Category.php.

     {
         $ids = $this->getData('path_ids');
         if ($ids === null) {
             $ids = explode('/', $this->getPath());
             $this->setData('path_ids', $ids);
         }
         return $ids;
     }

◆ getPathInStore()

getPathInStore ( )

Retrieve Stores where isset category Path Return comma separated string

Returns: string

Definition at line 805 of file Category.php.

     {
         $result = [];
         $path = array_reverse($this->getPathIds());
         foreach ($path as $itemId) {
             if ($itemId == $this->_storeManager->getStore()->getRootCategoryId()) {
                 break;
             }
             $result[] = $itemId;
         }
         return implode(',', $result);
     }

◆ getPosition()

getPosition ( )

Returns: int|null

Implements CategoryInterface.

Definition at line 1166 of file Category.php.

     {
         return $this->getData(self::KEY_POSITION);
     }

◆ getProductCollection()

getProductCollection ( )

Get category products collection

Returns: \Magento\Framework\Data\Collection\AbstractDb

Parameters

\Magento\Catalog\Model\Category	$category
int	$storeId

Returns: $this

Definition at line 464 of file Category.php.

     {
         $collection = $this->_productCollectionFactory->create()->setStoreId(
             $this->getStoreId()
         )->addCategoryFilter(
             $this
         );
         return $collection;
     }

◆ getProductCount()

getProductCount ( )

Retrieve count products of category

Returns: int

Implements CategoryTreeInterface.

Definition at line 948 of file Category.php.

     {
         if (!$this->hasData(self::KEY_PRODUCT_COUNT)) {
             $count = $this->_getResource()->getProductCount($this);
             $this->setData(self::KEY_PRODUCT_COUNT, $count);
         }
 
         return $this->getData(self::KEY_PRODUCT_COUNT);
     }

◆ getProductsPosition()

getProductsPosition ( )

Retrieve array of product id's for category

The array returned has the following format: array($productId => $position)

Returns: array

Definition at line 505 of file Category.php.

     {
         if (!$this->getId()) {
             return [];
         }
 
         $array = $this->getData('products_position');
         if ($array === null) {
             $array = $this->getResource()->getProductsPosition($this);
             $this->setData('products_position', $array);
         }
         return $array;
     }

◆ getRequestPath()

getRequestPath ( )

Retrieve Request Path

Returns: string

Definition at line 884 of file Category.php.

     {
         return $this->_getData('request_path');
     }

◆ getStoreId()

getStoreId ( )

Return store id.

If store id is underfined for category return current active store id

Returns: integer

Definition at line 569 of file Category.php.

     {
         if ($this->hasData('store_id')) {
             return (int)$this->_getData('store_id');
         }
         return (int)$this->_storeManager->getStore()->getId();
     }

◆ getStoreIds()

getStoreIds ( )

Retrieve array of store ids for category

Returns: array

Definition at line 524 of file Category.php.

     {
         if ($this->getInitialSetupFlag()) {
             return [];
         }
 
         $storeIds = $this->getData('store_ids');
         if ($storeIds) {
             return $storeIds;
         }
 
         if (!$this->getId()) {
             return [];
         }
 
         $nodes = [];
         foreach ($this->getPathIds() as $id) {
             $nodes[] = $id;
         }
 
         $storeIds = [];
         $storeCollection = $this->_storeCollectionFactory->create()->loadByCategoryIds($nodes);
         foreach ($storeCollection as $store) {
             $storeIds[$store->getId()] = $store->getId();
         }
 
         $entityStoreId = $this->getStoreId();
         if (!in_array($entityStoreId, $storeIds)) {
             array_unshift($storeIds, $entityStoreId);
         }
         if (!in_array(0, $storeIds)) {
             array_unshift($storeIds, 0);
         }
 
         $this->setData('store_ids', $storeIds);
         return $storeIds;
     }

◆ getTreeModel()

getTreeModel ( )

Retrieve category tree model

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

Definition at line 352 of file Category.php.

     {
         return $this->_categoryTreeFactory->create();
     }

◆ getTreeModelInstance()

getTreeModelInstance ( )

Enter description here...

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

Definition at line 362 of file Category.php.

     {
         return $this->_treeModel;
     }

◆ getUpdatedAt()

getUpdatedAt ( )

Returns: string|null

Implements CategoryInterface.

Definition at line 1190 of file Category.php.

     {
         return $this->getData(self::KEY_UPDATED_AT);
     }

◆ getUrl()

getUrl ( )

Get category url

Returns: string

Definition at line 598 of file Category.php.

     {
         $url = $this->_getData('url');
         if ($url === null) {
             Profiler::start('REWRITE: ' . __METHOD__, ['group' => 'REWRITE', 'method' => __METHOD__]);
             if ($this->hasData('request_path') && $this->getRequestPath() != '') {
                 $this->setData('url', $this->getUrlInstance()->getDirectUrl($this->getRequestPath()));
                 Profiler::stop('REWRITE: ' . __METHOD__);
                 return $this->getData('url');
             }
 
             $rewrite = $this->urlFinder->findOneByData([
                 UrlRewrite::ENTITY_ID => $this->getId(),
                 UrlRewrite::ENTITY_TYPE => CategoryUrlRewriteGenerator::ENTITY_TYPE,
                 UrlRewrite::STORE_ID => $this->getStoreId(),
             ]);
             if ($rewrite) {
                 $this->setData('url', $this->getUrlInstance()->getDirectUrl($rewrite->getRequestPath()));
                 Profiler::stop('REWRITE: ' . __METHOD__);
                 return $this->getData('url');
             }
 
             $this->setData('url', $this->getCategoryIdUrl());
             Profiler::stop('REWRITE: ' . __METHOD__);
             return $this->getData('url');
         }
         return $url;
     }

◆ getUrlInstance()

getUrlInstance ( )

Retrieve URL instance

Returns: \Magento\Framework\UrlInterface

Definition at line 342 of file Category.php.

     {
         return $this->_url;
     }

◆ getUrlKey()

getUrlKey ( )

Returns: string|null

Definition at line 1231 of file Category.php.

     {
         return $this->getData('url_key');
     }

◆ getUseFlatResource()

getUseFlatResource ( )

Get flat resource model flag

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 332 of file Category.php.

     {
         return $this->_useFlatResource;
     }

◆ hasChildren()

hasChildren ( )

Retrieve Is Category has children flag

Returns: bool

Definition at line 874 of file Category.php.

     {
         return $this->_getResource()->getChildrenAmount($this) > 0;
     }

◆ isInRootCategoryList()

isInRootCategoryList ( )

Check category is in Root Category list

Returns: bool

Definition at line 1009 of file Category.php.

     {
         // TODO there are bugs in resource models' methods, store_id set to model o/andr to resource model are ignored
         return $this->getResource()->isInRootCategoryList($this);
     }

◆ move()

move	(	$parentId,
		$afterCategoryId
	)

Move category

Parameters

int	$parentId	new parent category id
null \| int	$afterCategoryId	category id after which we have put current category

Returns: $this

Exceptions

Validate new parent category id. (category model is used for backward compatibility in event params)

Setting affected category ids for third party engine index refresh

Definition at line 375 of file Category.php.

     {
         try {
             $parent = $this->categoryRepository->get($parentId, $this->getStoreId());
         } catch (NoSuchEntityException $e) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __(
                     'Sorry, but we can\'t find the new parent category you selected.'
                 ),
                 $e
             );
         }
 
         if (!$this->getId()) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __('Sorry, but we can\'t find the new category you selected.')
             );
         } elseif ($parent->getId() == $this->getId()) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __(
                     'We can\'t move the category because the parent category name matches the child category name.'
                 )
             );
         }
 
         $this->setMovedCategoryId($this->getId());
         $oldParentId = $this->getParentId();
         $oldParentIds = $this->getParentIds();
 
         $eventParams = [
             $this->_eventObject => $this,
             'parent' => $parent,
             'category_id' => $this->getId(),
             'prev_parent_id' => $oldParentId,
             'parent_id' => $parentId,
         ];
 
         $this->_getResource()->beginTransaction();
         try {
             $this->_eventManager->dispatch($this->_eventPrefix . '_move_before', $eventParams);
             $this->getResource()->changeParent($this, $parent, $afterCategoryId);
             $this->_eventManager->dispatch($this->_eventPrefix . '_move_after', $eventParams);
             $this->_getResource()->commit();
 
             // Set data for indexer
             $this->setAffectedCategoryIds([$this->getId(), $oldParentId, $parentId]);
         } catch (\Exception $e) {
             $this->_getResource()->rollBack();
             throw $e;
         }
         $this->_eventManager->dispatch('category_move', $eventParams);
         if ($this->flatState->isFlatEnabled()) {
             $flatIndexer = $this->indexerRegistry->get(Indexer\Category\Flat\State::INDEXER_ID);
             if (!$flatIndexer->isScheduled()) {
                 $flatIndexer->reindexList([$this->getId(), $oldParentId, $parentId]);
             }
         }
         $productIndexer = $this->indexerRegistry->get(Indexer\Category\Product::INDEXER_ID);
         if (!$productIndexer->isScheduled()) {
             $productIndexer->reindexList(array_merge($this->getPathIds(), $oldParentIds));
         }
         $this->_eventManager->dispatch('clean_cache_by_tags', ['object' => $this]);
         $this->_cacheManager->clean([self::CACHE_TAG]);
 
         return $this;
     }

◆ reindex()

reindex ( )

Init indexing process after category save

Returns: void

Definition at line 1104 of file Category.php.

     {
         if ($this->flatState->isFlatEnabled()) {
             $flatIndexer = $this->indexerRegistry->get(Indexer\Category\Flat\State::INDEXER_ID);
             if (!$flatIndexer->isScheduled()) {
                 $idsList = [$this->getId()];
                 if ($this->dataHasChangedFor('url_key')) {
                     $idsList = array_merge($idsList, explode(',', $this->getAllChildren()));
                 }
                 $flatIndexer->reindexList($idsList);
             }
         }
         $productIndexer = $this->indexerRegistry->get(Indexer\Category\Product::INDEXER_ID);
         if (!$productIndexer->isScheduled()
             && (!empty($this->getAffectedProductIds()) || $this->dataHasChangedFor('is_anchor'))
         ) {
             $productIndexer->reindexList($this->getPathIds());
         }
     }

◆ setAvailableSortBy()

setAvailableSortBy ( $availableSortBy )

Parameters

string[]|string $availableSortBy

Returns: $this

Implements CategoryInterface.

Definition at line 1382 of file Category.php.

     {
         return $this->setData(self::KEY_AVAILABLE_SORT_BY, $availableSortBy);
     }

◆ setChildrenData()

setChildrenData ( array $childrenData = null )

Parameters

Implements CategoryTreeInterface.

Definition at line 1411 of file Category.php.

     {
         return $this->setData(self::KEY_CHILDREN_DATA, $childrenData);
     }

◆ setCreatedAt()

setCreatedAt ( $createdAt )

Parameters

string $createdAt

Returns: $this

Implements CategoryInterface.

Definition at line 1364 of file Category.php.

     {
         return $this->setData(self::KEY_CREATED_AT, $createdAt);
     }

◆ setExtensionAttributes()

setExtensionAttributes ( \Magento\Catalog\Api\Data\CategoryExtensionInterface $extensionAttributes )

{Set an extension attributes object.

Parameters

\Magento\Catalog\Api\Data\CategoryExtensionInterface $extensionAttributes

Returns: $this

}

Parameters

\Magento\Catalog\Api\Data\CategoryExtensionInterface $extensionAttributes

Returns: $this

Implements CategoryInterface.

Definition at line 1432 of file Category.php.

     {
         return $this->_setExtensionAttributes($extensionAttributes);
     }

◆ setIncludeInMenu()

setIncludeInMenu ( $includeInMenu )

Parameters

bool $includeInMenu

Returns: $this

Implements CategoryInterface.

Definition at line 1391 of file Category.php.

     {
         return $this->setData(self::KEY_INCLUDE_IN_MENU, $includeInMenu);
     }

◆ setIsActive()

setIsActive ( $isActive )

Set whether category is active

Parameters

bool $isActive

Returns: $this

Implements CategoryInterface.

Definition at line 1324 of file Category.php.

     {
         return $this->setData(self::KEY_IS_ACTIVE, $isActive);
     }

◆ setLevel()

setLevel ( $level )

Set category level

Parameters

int $level

Returns: $this

Implements CategoryInterface.

Definition at line 1346 of file Category.php.

     {
         return $this->setData(self::KEY_LEVEL, $level);
     }

◆ setName()

setName ( $name )

Set category name

Parameters

string $name

Returns: $this

Implements CategoryInterface.

Definition at line 1313 of file Category.php.

     {
         return $this->setData(self::KEY_NAME, $name);
     }

◆ setParentId()

setParentId ( $parentId )

Set parent category ID

Parameters

int $parentId

Returns: $this

Implements CategoryInterface.

Definition at line 1302 of file Category.php.

     {
         return $this->setData(self::KEY_PARENT_ID, $parentId);
     }

◆ setPath()

setPath ( $path )

Parameters

string $path

Returns: $this

Implements CategoryInterface.

Definition at line 1373 of file Category.php.

     {
         return $this->setData(self::KEY_PATH, $path);
     }

◆ setPosition()

setPosition ( $position )

Set category position

Parameters

int $position

Returns: $this

Implements CategoryInterface.

Definition at line 1335 of file Category.php.

     {
         return $this->setData(self::KEY_POSITION, $position);
     }

◆ setProductCount()

setProductCount ( $productCount )

Set product count

Parameters

int $productCount

Returns: $this

Implements CategoryTreeInterface.

Definition at line 1402 of file Category.php.

     {
         return $this->setData(self::KEY_PRODUCT_COUNT, $productCount);
     }

◆ setStoreId()

setStoreId ( $storeId )

Set store id

Parameters

int | string $storeId

Returns: $this

Definition at line 583 of file Category.php.

     {
         if (!is_numeric($storeId)) {
             $storeId = $this->_storeManager->getStore($storeId)->getId();
         }
         $this->setData('store_id', $storeId);
         $this->getResource()->setStoreId($storeId);
         return $this;
     }

◆ setUpdatedAt()

setUpdatedAt ( $updatedAt )

Parameters

string $updatedAt

Returns: $this

Implements CategoryInterface.

Definition at line 1355 of file Category.php.

     {
         return $this->setData(self::KEY_UPDATED_AT, $updatedAt);
     }

◆ validate()

validate ( )

Validate attribute values

Exceptions

Definition at line 1082 of file Category.php.

     {
         return $this->_getResource()->validate($this);
     }

◆ verifyIds()

verifyIds ( array $ids )

Verify category ids

Parameters

array $ids

Returns: bool

Definition at line 864 of file Category.php.

     {
         return $this->getResource()->verifyIds($ids);
     }

Field Documentation

◆ $_cacheTag

$_cacheTag = self::CACHE_TAG

protected

Definition at line 90 of file Category.php.

◆ $_catalogConfig

$_catalogConfig

protected

Definition at line 162 of file Category.php.

◆ $_categoryTreeFactory

$_categoryTreeFactory

protected

Definition at line 183 of file Category.php.

◆ $_designAttributes

$_designAttributes

protected

Initial value:

= [
        'custom_design',
        'custom_design_from',
        'custom_design_to',
        'page_layout',
        'custom_layout_update',
        'custom_apply_to_products',
    ]

Definition at line 125 of file Category.php.

◆ $_eventObject

$_eventObject = 'category'

protected

Definition at line 83 of file Category.php.

◆ $_eventPrefix

$_eventPrefix = 'catalog_category'

protected

#-

Definition at line 76 of file Category.php.

◆ $_productCollectionFactory

$_productCollectionFactory

protected

Definition at line 169 of file Category.php.

◆ $_resource

$_resource

protected

Definition at line 103 of file Category.php.

◆ $_storeCollectionFactory

$_storeCollectionFactory

protected

Definition at line 176 of file Category.php.

◆ $_treeModel

$_treeModel = null

protected

Definition at line 148 of file Category.php.

◆ $_url

$_url

protected

Definition at line 97 of file Category.php.

◆ $_urlRewrite

$_urlRewrite

protected

Definition at line 111 of file Category.php.

◆ $_useFlatResource

$_useFlatResource = false

protected

Definition at line 118 of file Category.php.

◆ $categoryRepository

$categoryRepository

protected

Definition at line 208 of file Category.php.

◆ $categoryUrlPathGenerator

$categoryUrlPathGenerator

protected

Definition at line 193 of file Category.php.

◆ $filter

$filter

protected

Definition at line 155 of file Category.php.

◆ $flatState

$flatState

protected

Definition at line 188 of file Category.php.

◆ $indexerRegistry

$indexerRegistry

protected

Definition at line 203 of file Category.php.

◆ $interfaceAttributes

$interfaceAttributes = CategoryInterface::ATTRIBUTES

protected

Definition at line 141 of file Category.php.

◆ $metadataService

$metadataService

protected

Definition at line 213 of file Category.php.

◆ $urlFinder

$urlFinder

protected

Definition at line 198 of file Category.php.

◆ CACHE_TAG

const CACHE_TAG = 'cat_c'

Definition at line 73 of file Category.php.

◆ DM_MIXED

const DM_MIXED = 'PRODUCTS_AND_PAGE'

Definition at line 60 of file Category.php.

◆ DM_PAGE

const DM_PAGE = 'PAGE'

Definition at line 58 of file Category.php.

◆ DM_PRODUCT

const DM_PRODUCT = 'PRODUCTS'

#+ Category display modes

Definition at line 56 of file Category.php.

◆ ENTITY

const ENTITY = 'catalog_category'

Entity code. Can be used as part of method name for entity processing

Definition at line 51 of file Category.php.

◆ ROOT_CATEGORY_ID

const ROOT_CATEGORY_ID = 0

#- Id of root category

Definition at line 66 of file Category.php.

◆ TREE_ROOT_ID

const TREE_ROOT_ID = 1

Id of category tree root

Definition at line 71 of file Category.php.

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

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toArray()

◆ _construct()

◆ _getResource()

◆ afterDeleteCommit()

◆ afterSave()

◆ beforeDelete()

◆ checkId()

◆ formatUrlKey()

◆ getAllChildren()

◆ getAnchorsAbove()

◆ getAttributes()

◆ getAvailableSortBy()

◆ getAvailableSortByOptions()

◆ getCategories()

◆ getCategoryId()

◆ getCategoryIdUrl()

◆ getChildren()

◆ getChildrenCategories()

◆ getChildrenCount()

◆ getChildrenData()

◆ getCreatedAt()

◆ getCustomAttributesCodes()

◆ getCustomDesignDate()

◆ getDefaultAttributeSetId()

◆ getDefaultSortBy()

◆ getDesignAttributes()

◆ getDisplayMode()

◆ getExtensionAttributes()

◆ getIdentities()

◆ getImageUrl()

◆ getIncludeInMenu()

◆ getIsActive()

◆ getLevel()

◆ getName()

◆ getParentCategories()

◆ getParentCategory()

◆ getParentDesignCategory()

◆ getParentId()

◆ getParentIds()

◆ getPath()

◆ getPathIds()

◆ getPathInStore()

◆ getPosition()

◆ getProductCollection()

◆ getProductCount()

◆ getProductsPosition()

◆ getRequestPath()

◆ getStoreId()

◆ getStoreIds()

◆ getTreeModel()

◆ getTreeModelInstance()

◆ getUpdatedAt()

◆ getUrl()

◆ getUrlInstance()

◆ getUrlKey()

◆ getUseFlatResource()

◆ hasChildren()

◆ isInRootCategoryList()

◆ move()

◆ reindex()

◆ setAvailableSortBy()

◆ setChildrenData()

◆ setCreatedAt()

◆ setExtensionAttributes()

◆ setIncludeInMenu()

◆ setIsActive()

◆ setLevel()

◆ setName()

◆ setParentId()

◆ setPath()

◆ setPosition()