Advanced Class Reference

Inheritance diagram for Advanced:

Public Member Functions
	__construct (Context $context, Registry $registry, AttributeCollectionFactory $attributeCollectionFactory, Visibility $catalogProductVisibility, Config $catalogConfig, CurrencyFactory $currencyFactory, ProductFactory $productFactory, StoreManagerInterface $storeManager, ProductCollectionFactory $productCollectionFactory, AdvancedFactory $advancedFactory, array $data=[])
	addFilters ($values)
	getAttributes ()
	getProductCollection ()
	prepareProductCollection ($collection)
	getSearchCriterias ()
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)

Protected Member Functions
	addSearchCriteria ($attribute, $value)
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
	$_searchCriterias = []
	$_productCollection
	$_catalogConfig
	$_catalogProductVisibility
	$_attributeCollectionFactory
	$_storeManager
	$_productFactory
	$_currencyFactory
	$productCollectionFactory
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 advanced search model

@method int getEntityTypeId() @method \Magento\CatalogSearch\Model\Advanced setEntityTypeId(int $value) @method int getAttributeSetId() @method \Magento\CatalogSearch\Model\Advanced setAttributeSetId(int $value) @method string getTypeId() @method \Magento\CatalogSearch\Model\Advanced setTypeId(string $value) @method string getSku() @method \Magento\CatalogSearch\Model\Advanced setSku(string $value) @method int getHasOptions() @method \Magento\CatalogSearch\Model\Advanced setHasOptions(int $value) @method int getRequiredOptions() @method \Magento\CatalogSearch\Model\Advanced setRequiredOptions(int $value) @method string getCreatedAt() @method \Magento\CatalogSearch\Model\Advanced setCreatedAt(string $value) @method string getUpdatedAt() @method \Magento\CatalogSearch\Model\Advanced setUpdatedAt(string $value)

Author

Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m @SuppressWarnings(PHPMD.CouplingBetweenObjects) @api

Since

100.0.2

Definition at line 48 of file Advanced.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Context	$context,
		Registry	$registry,
		AttributeCollectionFactory	$attributeCollectionFactory,
		Visibility	$catalogProductVisibility,
		Config	$catalogConfig,
		CurrencyFactory	$currencyFactory,
		ProductFactory	$productFactory,
		StoreManagerInterface	$storeManager,
		ProductCollectionFactory	$productCollectionFactory,
		AdvancedFactory	$advancedFactory,
		array	$data = []
	)

Construct

Parameters

Context	$context
Registry	$registry
AttributeCollectionFactory	$attributeCollectionFactory
Visibility	$catalogProductVisibility
Config	$catalogConfig
CurrencyFactory	$currencyFactory
ProductFactory	$productFactory
StoreManagerInterface	$storeManager
ProductCollectionFactory	$productCollectionFactory
AdvancedFactory	$advancedFactory
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 130 of file Advanced.php.

      {
        $this->_attributeCollectionFactory = $attributeCollectionFactory;
        $this->_catalogProductVisibility = $catalogProductVisibility;
        $this->_catalogConfig = $catalogConfig;
        $this->_currencyFactory = $currencyFactory;
        $this->_productFactory = $productFactory;
        $this->_storeManager = $storeManager;
        $this->productCollectionFactory = $productCollectionFactory;
        parent::__construct(
            $context,
            $registry,
            $advancedFactory->create(),
            $this->productCollectionFactory->create(),
            $data
        );
    }

Member Function Documentation

addFilters()

addFilters

(

$values

)

Add advanced search filters to product collection

Parameters

array

$values

Returns

$this

Exceptions

LocalizedException

@SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 168 of file Advanced.php.

    {
        $attributes = $this->getAttributes();
        $allConditions = [];

        foreach ($attributes as $attribute) {
            /* @var $attribute Attribute */
            if (!isset($values[$attribute->getAttributeCode()])) {
                continue;
            }
            $value = $values[$attribute->getAttributeCode()];
            $preparedSearchValue = $this->getPreparedSearchCriteria($attribute, $value);
            if (false === $preparedSearchValue) {
                continue;
            }
            $this->addSearchCriteria($attribute, $preparedSearchValue);

            if ($attribute->getAttributeCode() == 'price') {
                $rate = 1;
                $store = $this->_storeManager->getStore();
                $currency = $store->getCurrentCurrencyCode();
                if ($currency != $store->getBaseCurrencyCode()) {
                    $rate = $store->getBaseCurrency()->getRate($currency);
                }

                $value['from'] = (isset($value['from']) && is_numeric($value['from']))
                    ? (float)$value['from'] / $rate
                    : '';
                $value['to'] = (isset($value['to']) && is_numeric($value['to']))
                    ? (float)$value['to'] / $rate
                    : '';
            }

            if ($attribute->getBackendType() == 'datetime') {
                $value['from'] = (isset($value['from']) && !empty($value['from']))
                    ? date('Y-m-d\TH:i:s\Z', strtotime($value['from']))
                    : '';
                $value['to'] = (isset($value['to']) && !empty($value['to']))
                    ? date('Y-m-d\TH:i:s\Z', strtotime($value['to']))
                    : '';
            }
            $condition = $this->_getResource()->prepareCondition(
                $attribute,
                $value,
                $this->getProductCollection()
            );
            if ($condition === false) {
                continue;
            }

            $table = $attribute->getBackend()->getTable();
            if ($attribute->getBackendType() == 'static') {
                $attributeId = $attribute->getAttributeCode();
            } else {
                $attributeId = $attribute->getId();
            }
            $allConditions[$table][$attributeId] = $condition;
        }
        if ($allConditions) {
            $this->_registry->register('advanced_search_conditions', $allConditions);
            $this->getProductCollection()->addFieldsToFilter($allConditions);
        } else {
            throw new LocalizedException(__('Enter a search term and try again.'));
        }

        return $this;
    }

addSearchCriteria()

addSearchCriteria (   $attribute,   $value  )

protected

Add search criteria.

Parameters

EntityAttribute	$attribute
mixed	$value

Returns

void

Definition at line 306 of file Advanced.php.

    {
        if (!empty($value)) {
            $this->_searchCriterias[] = ['name' => $attribute->getStoreLabel(), 'value' => $value];
        }
    }

getAttributes()

getAttributes

(

)

Retrieve array of attributes used in advanced search

Returns

array|\Magento\Catalog\Model\ResourceModel\Product\Attribute\Collection

Definition at line 241 of file Advanced.php.

    {
        $attributes = $this->getData('attributes');
        if ($attributes === null) {
            $product = $this->_productFactory->create();
            $attributes = $this->_attributeCollectionFactory
                ->create()
                ->addHasOptionsFilter()
                ->addDisplayInAdvancedSearchFilter()
                ->addStoreLabel($this->_storeManager->getStore()->getId())
                ->setOrder('main_table.attribute_id', 'asc')
                ->load();
            foreach ($attributes as $attribute) {
                $attribute->setEntity($product->getResource());
            }
            $this->setData('attributes', $attributes);
        }
        return $attributes;
    }

getProductCollection()

getProductCollection

(

)

Retrieve advanced search product collection

Returns

Collection

Definition at line 266 of file Advanced.php.

    {
        if ($this->_productCollection === null) {
            $collection = $this->productCollectionFactory->create();
            $this->prepareProductCollection($collection);
            if (!$collection) {
                return $collection;
            }
            $this->_productCollection = $collection;
        }

        return $this->_productCollection;
    }

getSearchCriterias()

getSearchCriterias

(

)

Returns prepared search criterias in text

Returns

array

Definition at line 390 of file Advanced.php.

    {
        return $this->_searchCriterias;
    }

prepareProductCollection()

prepareProductCollection

(

$collection

)

Prepare product collection

Parameters

Collection

$collection

Returns

$this

Definition at line 286 of file Advanced.php.

    {
        $collection
            ->addAttributeToSelect($this->_catalogConfig->getProductAttributes())
            ->setStore($this->_storeManager->getStore())
            ->addMinimalPrice()
            ->addTaxPercents()
            ->addStoreFilter()
            ->setVisibility($this->_catalogProductVisibility->getVisibleInSearchIds());

        return $this;
    }

Field Documentation

$_attributeCollectionFactory

$_attributeCollectionFactory

protected

Definition at line 83 of file Advanced.php.

$_catalogConfig

$_catalogConfig

protected

Definition at line 69 of file Advanced.php.

$_catalogProductVisibility

$_catalogProductVisibility

protected

Definition at line 76 of file Advanced.php.

$_currencyFactory

$_currencyFactory

protected

Definition at line 104 of file Advanced.php.

$_productCollection

$_productCollection

protected

Definition at line 62 of file Advanced.php.

$_productFactory

$_productFactory

protected

Definition at line 97 of file Advanced.php.

$_searchCriterias

$_searchCriterias = []

protected

Definition at line 55 of file Advanced.php.

$_storeManager

$_storeManager

protected

Definition at line 90 of file Advanced.php.

$productCollectionFactory

$productCollectionFactory

protected

Definition at line 111 of file Advanced.php.

---

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

• vendor/magento/module-catalog-search/Model/Advanced.php