EngineResolver Class Reference

Inheritance diagram for EngineResolver:

Public Member Functions
	__construct (ScopeConfigInterface $scopeConfig, array $engines, LoggerInterface $logger, $path, $scopeType, $scopeCode=null)
	getCurrentSearchEngine ()

Data Fields
const	CATALOG_SEARCH_MYSQL_ENGINE = 'mysql'

Protected Attributes
	$scopeConfig
	$path
	$scopeType
	$scopeCode

Detailed Description

@api

Since

100.1.0

Definition at line 16 of file EngineResolver.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ScopeConfigInterface	$scopeConfig,
		array	$engines,
		LoggerInterface	$logger,
			$path,
			$scopeType,
			$scopeCode = null
	)

Parameters

ScopeConfigInterface	$scopeConfig
array	$engines
string	$path
string	$scopeType
string	$scopeCode

Definition at line 68 of file EngineResolver.php.

      {
        $this->scopeConfig = $scopeConfig;
        $this->path = $path;
        $this->scopeType = $scopeType;
        $this->scopeCode = $scopeCode;
        $this->engines = $engines;
        $this->logger = $logger;
    }

Member Function Documentation

getCurrentSearchEngine()

getCurrentSearchEngine

(

)

Returns Current Search Engine

It returns string identifier of Search Engine that is currently chosen in configuration

Returns

string

Since

100.1.0

Implements EngineResolverInterface.

Definition at line 92 of file EngineResolver.php.

    {
        $engine = $this->scopeConfig->getValue(
            $this->path,
            $this->scopeType,
            $this->scopeCode
        );

        if (in_array($engine, $this->engines)) {
            return $engine;
        } else {
            $this->logger->error(
                $engine . ' search engine doesn\'t exists. Falling back to ' . self::CATALOG_SEARCH_MYSQL_ENGINE
            );
            return self::CATALOG_SEARCH_MYSQL_ENGINE;
        }
    }

Field Documentation

$path

$path

protected

Definition at line 34 of file EngineResolver.php.

$scopeCode

$scopeCode

protected

Definition at line 48 of file EngineResolver.php.

$scopeConfig

$scopeConfig

protected

Definition at line 27 of file EngineResolver.php.

$scopeType

$scopeType

protected

Definition at line 41 of file EngineResolver.php.

CATALOG_SEARCH_MYSQL_ENGINE

const CATALOG_SEARCH_MYSQL_ENGINE = 'mysql'

MySQL search engine

Definition at line 21 of file EngineResolver.php.

---

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

• vendor/magento/module-search/Model/EngineResolver.php