EngineInterface Interface Reference

Inheritance diagram for EngineInterface:

Public Member Functions
	getAllowedVisibility ()
	allowAdvancedIndex ()
	processAttributeValue ($attribute, $value)
	prepareEntityIndex ($index, $separator=' ')

Data Fields
const	FIELD_PREFIX = 'attr_'
const	SCOPE_IDENTIFIER = 'scope'
const	CONFIG_ENGINE_PATH = 'catalog/search/engine'

Detailed Description

CatalogSearch Index Engine Interface

@api

Since

100.0.2

Definition at line 14 of file EngineInterface.php.

Member Function Documentation

allowAdvancedIndex()

allowAdvancedIndex

(

)

Define if current search engine supports advanced index

Returns

bool

Implemented in Engine, and Engine.

getAllowedVisibility()

getAllowedVisibility

(

)

Retrieve allowed visibility values for current engine

Returns

array

Implemented in Engine, and Engine.

prepareEntityIndex()

prepareEntityIndex	(		$index,
			$separator = ' '
	)

Prepare index array as a string glued by separator

Parameters

array	$index
string	$separator

Returns

array

Implemented in Engine, and Engine.

processAttributeValue()

processAttributeValue	(		$attribute,
			$value
	)

Prepare attribute value to store in index

Parameters

\Magento\Eav\Model\Entity\Attribute	$attribute
mixed	$value

Returns

mixed

Implemented in Engine, and Engine.

Field Documentation

CONFIG_ENGINE_PATH

const CONFIG_ENGINE_PATH = 'catalog/search/engine'

Configuration path by which current indexer handler stored

Deprecated:

since using engine resolver

See also

\Magento\Framework\Search\EngineResolverInterface

Definition at line 32 of file EngineInterface.php.

FIELD_PREFIX

const FIELD_PREFIX = 'attr_'

Definition at line 16 of file EngineInterface.php.

SCOPE_IDENTIFIER

const SCOPE_IDENTIFIER = 'scope'

Scope identifier

Deprecated:

since using engine resolver

See also

\Magento\Framework\Search\EngineResolverInterface

Definition at line 24 of file EngineInterface.php.

---

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

• vendor/magento/module-catalog-search/Model/ResourceModel/EngineInterface.php