CategoryTree Class Reference

Public Member Functions
	__construct (CollectionFactory $collectionFactory, AttributesJoiner $attributesJoiner, DepthCalculator $depthCalculator, LevelCalculator $levelCalculator, MetadataPool $metadata, Hydrator $hydrator)
	getTree (ResolveInfo $resolveInfo, int $rootCategoryId)

Data Fields
const	DEPTH_OFFSET = 1

Detailed Description

Category tree data provider

Definition at line 24 of file CategoryTree.php.

Constructor & Destructor Documentation

__construct()

__construct	(	CollectionFactory	$collectionFactory,
		AttributesJoiner	$attributesJoiner,
		DepthCalculator	$depthCalculator,
		LevelCalculator	$levelCalculator,
		MetadataPool	$metadata,
		Hydrator	$hydrator
	)

Parameters

CollectionFactory	$collectionFactory
AttributesJoiner	$attributesJoiner
DepthCalculator	$depthCalculator
LevelCalculator	$levelCalculator
MetadataPool	$metadata
Hydrator	$hydrator

Definition at line 69 of file CategoryTree.php.

      {
        $this->collectionFactory = $collectionFactory;
        $this->attributesJoiner = $attributesJoiner;
        $this->depthCalculator = $depthCalculator;
        $this->levelCalculator = $levelCalculator;
        $this->metadata = $metadata;
        $this->hydrator = $hydrator;
    }

Member Function Documentation

getTree()

getTree	(	ResolveInfo	$resolveInfo,
		int	$rootCategoryId
	)

Parameters

ResolveInfo	$resolveInfo
int	$rootCategoryId

Returns

array

Definition at line 90 of file CategoryTree.php.

                                                                           : array
    {
        $categoryQuery = $resolveInfo->fieldNodes[0];
        $collection = $this->collectionFactory->create();
        $this->joinAttributesRecursively($collection, $categoryQuery);
        $depth = $this->depthCalculator->calculate($categoryQuery);
        $level = $this->levelCalculator->calculate($rootCategoryId);
        //Search for desired part of category tree
        $collection->addPathFilter(sprintf('.*/%s/[/0-9]*$', $rootCategoryId));
        $collection->addFieldToFilter('level', ['gt' => $level]);
        $collection->addFieldToFilter('level', ['lteq' => $level + $depth - self::DEPTH_OFFSET]);
        $collection->setOrder('level');
        $collection->getSelect()->orWhere(
            $this->metadata->getMetadata(CategoryInterface::class)->getIdentifierField() . ' = ?',
            $rootCategoryId
        );
        return $this->processTree($collection->getIterator());
    }

Field Documentation

DEPTH_OFFSET

const DEPTH_OFFSET = 1

In depth we need to calculate only children nodes, so the first wrapped node should be ignored

Definition at line 29 of file CategoryTree.php.

---

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

• vendor/magento/module-catalog-graph-ql/Model/Resolver/Products/DataProvider/CategoryTree.php