Category Class Reference

Inheritance diagram for Category:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Catalog\Model\CategoryFactory $categoryFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\Data\CollectionFactory $dataCollectionFactory, CategoryRepositoryInterface $categoryRepository)
	getStoreCategories ($sorted=false, $asCollection=false, $toLoad=true)
	getCategoryUrl ($category)
	canShow ($category)
	canUseCanonicalTag ($store=null)
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	XML_PATH_USE_CATEGORY_CANONICAL_TAG = 'catalog/seo/category_canonical_tag'
const	XML_PATH_CATEGORY_ROOT_ID = 'catalog/category/root_id'

Protected Attributes
	$_storeCategories = []
	$_storeManager
	$_categoryFactory
	$_dataCollectionFactory
	$categoryRepository
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Additional Inherited Members
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Detailed Description

Catalog category helper

@SuppressWarnings(PHPMD.LongVariable)

Definition at line 19 of file Category.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Catalog\Model\CategoryFactory	$categoryFactory,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\Data\CollectionFactory	$dataCollectionFactory,
		CategoryRepositoryInterface	$categoryRepository
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Catalog\Model\CategoryFactory	$categoryFactory
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\Data\CollectionFactory	$dataCollectionFactory
CategoryRepositoryInterface	$categoryRepository

Definition at line 65 of file Category.php.

      {
        $this->_categoryFactory = $categoryFactory;
        $this->_storeManager = $storeManager;
        $this->_dataCollectionFactory = $dataCollectionFactory;
        $this->categoryRepository = $categoryRepository;
        parent::__construct($context);
    }

Member Function Documentation

canShow()

canShow

(

$category

)

Check if a category can be shown

Parameters

ModelCategory | int

$category

Returns

bool

Definition at line 141 of file Category.php.

    {
        if (is_int($category)) {
            try {
                $category = $this->categoryRepository->get($category);
            } catch (NoSuchEntityException $e) {
                return false;
            }
        } else {
            if (!$category->getId()) {
                return false;
            }
        }

        if (!$category->getIsActive()) {
            return false;
        }
        if (!$category->isInRootCategoryList()) {
            return false;
        }

        return true;
    }

canUseCanonicalTag()

canUseCanonicalTag

(

$store = null

)

Check if <link rel="canonical"> can be used for category

Parameters

null | string | bool | int | Store

$store

Returns

bool

Definition at line 171 of file Category.php.

    {
        return $this->scopeConfig->getValue(
            self::XML_PATH_USE_CATEGORY_CANONICAL_TAG,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
            $store
        );
    }

getCategoryUrl()

getCategoryUrl

(

$category

)

Retrieve category url

Parameters

ModelCategory

$category

Returns

string

Definition at line 127 of file Category.php.

    {
        if ($category instanceof ModelCategory) {
            return $category->getUrl();
        }
        return $this->_categoryFactory->create()->setData($category->getData())->getUrl();
    }

getStoreCategories()

getStoreCategories	(		$sorted = false,
			$asCollection = false,
			$toLoad = true
	)

Retrieve current store categories

Parameters

bool | string	$sorted
bool	$asCollection
bool	$toLoad

Returns

\Magento\Framework\Data\Tree\Node\Collection or \Magento\Catalog\Model\ResourceModel\Category\Collection or array

Check if parent node of the store still exists

Definition at line 88 of file Category.php.

    {
        $parent = $this->_storeManager->getStore()->getRootCategoryId();
        $cacheKey = sprintf('%d-%d-%d-%d', $parent, $sorted, $asCollection, $toLoad);
        if (isset($this->_storeCategories[$cacheKey])) {
            return $this->_storeCategories[$cacheKey];
        }

        $category = $this->_categoryFactory->create();
        /* @var $category ModelCategory */
        if (!$category->checkId($parent)) {
            if ($asCollection) {
                return $this->_dataCollectionFactory->create();
            }
            return [];
        }

        $recursionLevel = max(
            0,
            (int)$this->scopeConfig->getValue(
                'catalog/navigation/max_depth',
                \Magento\Store\Model\ScopeInterface::SCOPE_STORE
            )
        );
        $storeCategories = $category->getCategories($parent, $recursionLevel, $sorted, $asCollection, $toLoad);

        $this->_storeCategories[$cacheKey] = $storeCategories;
        return $storeCategories;
    }

Field Documentation

$_categoryFactory

$_categoryFactory

protected

Definition at line 44 of file Category.php.

$_dataCollectionFactory

$_dataCollectionFactory

protected

Definition at line 51 of file Category.php.

$_storeCategories

$_storeCategories = []

protected

Definition at line 30 of file Category.php.

$_storeManager

$_storeManager

protected

Definition at line 37 of file Category.php.

$categoryRepository

$categoryRepository

protected

Definition at line 56 of file Category.php.

XML_PATH_CATEGORY_ROOT_ID

const XML_PATH_CATEGORY_ROOT_ID = 'catalog/category/root_id'

Definition at line 23 of file Category.php.

XML_PATH_USE_CATEGORY_CANONICAL_TAG

const XML_PATH_USE_CATEGORY_CANONICAL_TAG = 'catalog/seo/category_canonical_tag'

Definition at line 21 of file Category.php.

---

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

• vendor/magento/module-catalog/Helper/Category.php