Result Class Reference

Inheritance diagram for Result:

Public Member Functions
	__construct (Context $context, Advanced $catalogSearchAdvanced, LayerResolver $layerResolver, UrlFactory $urlFactory, array $data=[])
	setListOrders ()
	setListModes ()
	setListCollection ()
	getSearchModel ()
	getResultCount ()
	getProductListHtml ()
	getFormUrl ()
	getSearchCriterias ()
Public Member Functions inherited from Template
	__construct (Template\Context $context, array $data=[])
	setTemplateContext ($templateContext)
	getTemplate ()
	setTemplate ($template)
	getTemplateFile ($template=null)
	getArea ()
	assign ($key, $value=null)
	fetchView ($fileName)
	getBaseUrl ()
	getObjectData (\Magento\Framework\DataObject $object, $key)
	getCacheKeyInfo ()
Public Member Functions inherited from AbstractBlock
	__construct (\Magento\Framework\View\Element\Context $context, array $data=[])
	getJsLayout ()
	getRequest ()
	getParentBlock ()
	setLayout (\Magento\Framework\View\LayoutInterface $layout)
	getLayout ()
	setNameInLayout ($name)
	getChildNames ()
	setAttribute ($name, $value=null)
	setChild ($alias, $block)
	addChild ($alias, $block, $data=[])
	unsetChild ($alias)
	unsetCallChild ($alias, $callback, $result, $params)
	unsetChildren ()
	getChildBlock ($alias)
	getChildHtml ($alias='', $useCache=true)
	getChildChildHtml ($alias, $childChildAlias='', $useCache=true)
	getBlockHtml ($name)
	insert ($element, $siblingName=0, $after=true, $alias='')
	append ($element, $alias='')
	getGroupChildNames ($groupName)
	getChildData ($alias, $key='')
	getUiId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)
	getJsId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)
	getUrl ($route='', $params=[])
	getViewFileUrl ($fileId, array $params=[])
	formatDate ( $date=null, $format=\IntlDateFormatter::SHORT, $showTime=false, $timezone=null)
	formatTime ( $time=null, $format=\IntlDateFormatter::SHORT, $showDate=false)
	getModuleName ()
	escapeHtml ($data, $allowedTags=null)
	escapeJs ($string)
	escapeHtmlAttr ($string, $escapeSingleQuote=true)
	escapeCss ($string)
	stripTags ($data, $allowableTags=null, $allowHtmlEntities=false)
	escapeUrl ($string)
	escapeXssInUrl ($data)
	escapeQuote ($data, $addSlashes=false)
	escapeJsQuote ($data, $quote='\'')
	getNameInLayout ()
	getCacheKeyInfo ()
	getCacheKey ()
	getVar ($name, $module=null)
	isScopePrivate ()
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 BlockInterface
	toHtml ()

Protected Member Functions
	_prepareLayout ()
	_getProductCollection ()
Protected Member Functions inherited from Template
	_construct ()
	_toHtml ()
	getRootDirectory ()
	getMediaDirectory ()
Protected Member Functions inherited from AbstractBlock
	_construct ()
	_prepareLayout ()
	_beforeToHtml ()
	_afterToHtml ($html)
	_toHtml ()
	_getNotFoundUrl ($route='', $params=['_direct'=> 'core/index/notFound'])
	getCacheTags ()
	getCacheLifetime ()
	_loadCache ()
	_saveCache ($data)
	_getSidPlaceholder ($cacheKey=null)
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)

Protected Attributes
	$_urlFactory
	$_catalogLayer
	$_catalogSearchAdvanced
Protected Attributes inherited from Template
	$_viewVars = []
	$_baseUrl
	$_jsUrl
	$_allowSymlinks
	$_filesystem
	$_template
	$templateEnginePool
	$_storeManager
	$_appState
	$directory
	$templateContext
	$pageConfig
	$resolver
	$validator
Protected Attributes inherited from AbstractBlock
	$_design
	$_session
	$_sidResolver
	$_nameInLayout
	$_layout
	$jsLayout = []
	$_request
	$_urlBuilder
	$_eventManager
	$_frontController
	$_assetRepo
	$_viewConfig
	$_cacheState
	$_logger
	$_escaper
	$filterManager
	$_localeDate
	$inlineTranslation
	$_isScopePrivate = false
	$_scopeConfig
	$_cache
Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Public Member Functions inherited from AbstractBlock
static	extractModuleName ($className)
Data Fields inherited from Template
const	XML_PATH_TEMPLATE_ALLOW_SYMLINK = 'dev/template/allow_symlink'
Data Fields inherited from AbstractBlock
const	CACHE_GROUP = \Magento\Framework\App\Cache\Type\Block::TYPE_IDENTIFIER
const	CACHE_KEY_PREFIX = 'BLOCK_'
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Advanced search result

@api

Since

100.0.2

Definition at line 22 of file Result.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Context	$context,
		Advanced	$catalogSearchAdvanced,
		LayerResolver	$layerResolver,
		UrlFactory	$urlFactory,
		array	$data = []
	)

Parameters

Context	$context
Advanced	$catalogSearchAdvanced
LayerResolver	$layerResolver
UrlFactory	$urlFactory
array	$data

Definition at line 52 of file Result.php.

      {
        $this->_catalogSearchAdvanced = $catalogSearchAdvanced;
        $this->_catalogLayer = $layerResolver->get();
        $this->_urlFactory = $urlFactory;
        parent::__construct($context, $data);
    }

Member Function Documentation

_getProductCollection()

_getProductCollection ( )

protected

Get product collection.

Returns

Collection

Definition at line 142 of file Result.php.

    {
        return $this->getSearchModel()->getProductCollection();
    }

_prepareLayout()

_prepareLayout ( )

protected

Definition at line 68 of file Result.php.

    {
        $this->pageConfig->getTitle()->set($this->getPageTitle());
        $breadcrumbs = $this->getLayout()->getBlock('breadcrumbs');
        if ($breadcrumbs) {
            $breadcrumbs->addCrumb(
                'home',
                [
                    'label' => __('Home'),
                    'title' => __('Go to Home Page'),
                    'link' => $this->_storeManager->getStore()->getBaseUrl()
                ]
            )->addCrumb(
                'search',
                ['label' => __('Catalog Advanced Search'), 'link' => $this->getUrl('*/*/')]
            )->addCrumb(
                'search_result',
                ['label' => __('Results')]
            );
        }
        return parent::_prepareLayout();
    }

getFormUrl()

getFormUrl

(

)

Get form URL.

Returns

string

Definition at line 186 of file Result.php.

    {
        return $this->_urlFactory->create()->addQueryParams(
            $this->getRequest()->getQueryValue()
        )->getUrl(
            '*/*/',
            ['_escape' => true]
        );
    }

getProductListHtml()

getProductListHtml

(

)

Get product list HTML.

Returns

string

Definition at line 176 of file Result.php.

    {
        return $this->getChildHtml('search_result_list');
    }

getResultCount()

getResultCount

(

)

Get result count.

Returns

mixed

Definition at line 162 of file Result.php.

    {
        if (!$this->getData('result_count')) {
            $size = $this->getSearchModel()->getProductCollection()->getSize();
            $this->setResultCount($size);
        }
        return $this->getData('result_count');
    }

getSearchCriterias()

getSearchCriterias

(

)

Get search criteria.

Returns

array

Definition at line 201 of file Result.php.

    {
        $searchCriterias = $this->getSearchModel()->getSearchCriterias();
        $middle = ceil(count($searchCriterias) / 2);
        $left = array_slice($searchCriterias, 0, $middle);
        $right = array_slice($searchCriterias, $middle);

        return ['left' => $left, 'right' => $right];
    }

getSearchModel()

getSearchModel

(

)

Set search model.

Returns

Advanced

Definition at line 152 of file Result.php.

    {
        return $this->_catalogSearchAdvanced;
    }

setListCollection()

setListCollection

(

)

Initialize list collection.

Returns

void

Definition at line 132 of file Result.php.

    {
        $this->getChildBlock('search_result_list')->setCollection($this->_getProductCollection());
    }

setListModes()

setListModes

(

)

Set view mode options

Returns

void

Definition at line 122 of file Result.php.

    {
        $this->getChildBlock('search_result_list')->setModes(['grid' => __('Grid'), 'list' => __('List')]);
    }

setListOrders()

setListOrders

(

)

Set order options

Returns

void

Definition at line 106 of file Result.php.

    {
        /* @var $category \Magento\Catalog\Model\Category */
        $category = $this->_catalogLayer->getCurrentCategory();

        $availableOrders = $category->getAvailableSortByOptions();
        unset($availableOrders['position']);

        $this->getChildBlock('search_result_list')->setAvailableOrders($availableOrders);
    }

Field Documentation

$_catalogLayer

$_catalogLayer

protected

Definition at line 36 of file Result.php.

$_catalogSearchAdvanced

$_catalogSearchAdvanced

protected

Definition at line 43 of file Result.php.

$_urlFactory

$_urlFactory

protected

Definition at line 29 of file Result.php.

---

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

• vendor/magento/module-catalog-search/Block/Advanced/Result.php