Products Class Reference

Inheritance diagram for Products:

Public Member Functions
	__construct (Builder $searchCriteriaBuilder, Search $searchQuery, Filter $filterQuery, SearchFilter $searchFilter)
	resolve (Field $field, $context, ResolveInfo $info, array $value=null, array $args=null)

Detailed Description

Products field resolver, used for GraphQL request processing.

Definition at line 23 of file Products.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Builder	$searchCriteriaBuilder,
		Search	$searchQuery,
		Filter	$filterQuery,
		SearchFilter	$searchFilter
	)

Parameters

Builder	$searchCriteriaBuilder
Search	$searchQuery
Filter	$filterQuery
SearchFilter	$searchFilter

Definition at line 51 of file Products.php.

      {
        $this->searchCriteriaBuilder = $searchCriteriaBuilder;
        $this->searchQuery = $searchQuery;
        $this->filterQuery = $filterQuery;
        $this->searchFilter = $searchFilter;
    }

Member Function Documentation

resolve()

resolve	(	Field	$field,
			$context,
		ResolveInfo	$info,
		array	$value = null,
		array	$args = null
	)

Fetches the data from persistence models and format it according to the GraphQL schema.

Parameters

\Magento\Framework\GraphQl\Config\Element\Field	$field
ContextInterface	$context
ResolveInfo	$info
array | null	$value
array | null	$args

Exceptions

Implements ResolverInterface.

Definition at line 66 of file Products.php.

      {
        $searchCriteria = $this->searchCriteriaBuilder->build($field->getName(), $args);
        $searchCriteria->setCurrentPage($args['currentPage']);
        $searchCriteria->setPageSize($args['pageSize']);
        if (!isset($args['search']) && !isset($args['filter'])) {
            throw new GraphQlInputException(
                __("'search' or 'filter' input argument is required.")
            );
        } elseif (isset($args['search'])) {
            $layerType = Resolver::CATALOG_LAYER_SEARCH;
            $this->searchFilter->add($args['search'], $searchCriteria);
            $searchResult = $this->searchQuery->getResult($searchCriteria, $info);
        } else {
            $layerType = Resolver::CATALOG_LAYER_CATEGORY;
            $searchResult = $this->filterQuery->getResult($searchCriteria, $info);
        }
        //possible division by 0
        if ($searchCriteria->getPageSize()) {
            $maxPages = ceil($searchResult->getTotalCount() / $searchCriteria->getPageSize());
        } else {
            $maxPages = 0;
        }

        $currentPage = $searchCriteria->getCurrentPage();
        if ($searchCriteria->getCurrentPage() > $maxPages && $searchResult->getTotalCount() > 0) {
            $currentPage = new GraphQlInputException(
                __(
                    'currentPage value %1 specified is greater than the number of pages available.',
                    [$maxPages]
                )
            );
        }

        $data = [
            'total_count' => $searchResult->getTotalCount(),
            'items' => $searchResult->getProductsSearchResult(),
            'page_info' => [
                'page_size' => $searchCriteria->getPageSize(),
                'current_page' => $currentPage
            ],
            'layer_type' => $layerType
        ];

        return $data;
    }

---

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

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