Config Class Reference

Inheritance diagram for Config:

Public Member Functions
	__construct (ScopeConfigInterface $scopeConfig, ClientResolver $clientResolver=null, EngineResolverInterface $engineResolver=null, $prefix=null)
	prepareClientOptions ($options=[])
	getElasticsearchConfigData ($field, $storeId=null)
	getSearchConfigData ($field, $storeId=null)
	isElasticsearchEnabled ()
	getIndexPrefix ()
	getEntityType ()

Data Fields
const	ENGINE_NAME = 'elasticsearch'
const	ELASTICSEARCH_TYPE_DOCUMENT = 'document'
const	ELASTICSEARCH_TYPE_DEFAULT = 'product'
const	ELASTICSEARCH_DEFAULT_TIMEOUT = 15

Protected Attributes
	$scopeConfig

Detailed Description

Elasticsearch config model @api

Since

100.1.0

Definition at line 21 of file Config.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ScopeConfigInterface	$scopeConfig,
		ClientResolver	$clientResolver = null,
		EngineResolverInterface	$engineResolver = null,
			$prefix = null
	)

Constructor

Parameters

ScopeConfigInterface	$scopeConfig
ClientResolver | null	$clientResolver
EngineResolverInterface | null	$engineResolver
string | null	$prefix

Definition at line 74 of file Config.php.

      {
        $this->scopeConfig = $scopeConfig;
        $this->clientResolver = $clientResolver ?: ObjectManager::getInstance()->get(ClientResolver::class);
        $this->engineResolver = $engineResolver ?: ObjectManager::getInstance()->get(EngineResolverInterface::class);
        $this->prefix = $prefix ?: $this->clientResolver->getCurrentEngine();
    }

Member Function Documentation

getElasticsearchConfigData()

getElasticsearchConfigData	(		$field,
			$storeId = null
	)

Retrieve information from Elasticsearch search engine configuration

Parameters

string	$field
int	$storeId

Returns

string|int

Since

100.1.0

Definition at line 114 of file Config.php.

    {
        return $this->getSearchConfigData($this->prefix . '_' . $field, $storeId);
    }

getEntityType()

getEntityType

(

)

Get Elasticsearch entity type

Returns

string

Since

100.1.0

Definition at line 161 of file Config.php.

    {
        return self::ELASTICSEARCH_TYPE_DOCUMENT;
    }

getIndexPrefix()

getIndexPrefix

(

)

Get Elasticsearch index prefix

Returns

string

Since

100.1.0

Definition at line 150 of file Config.php.

    {
        return $this->getElasticsearchConfigData('index_prefix');
    }

getSearchConfigData()

getSearchConfigData	(		$field,
			$storeId = null
	)

Retrieve information from search engine configuration

Parameters

string	$field
int | null	$storeId

Returns

string|int

Since

100.1.0

Definition at line 127 of file Config.php.

    {
        $path = 'catalog/search/' . $field;
        return $this->scopeConfig->getValue($path, ScopeInterface::SCOPE_STORE, $storeId);
    }

isElasticsearchEnabled()

isElasticsearchEnabled

(

)

Return true if third party search engine is used

Returns

bool

Since

100.1.0

Definition at line 139 of file Config.php.

    {
        return in_array($this->engineResolver->getCurrentSearchEngine(), [self::ENGINE_NAME, self::ENGINE_NAME_5]);
    }

prepareClientOptions()

prepareClientOptions

(

$options = []

)

Return search client options

Parameters

array

$options

Returns

array

Since

100.1.0

Since

100.1.0

Implements ClientOptionsInterface.

Definition at line 91 of file Config.php.

    {
        $defaultOptions = [
            'hostname' => $this->getElasticsearchConfigData('server_hostname'),
            'port' => $this->getElasticsearchConfigData('server_port'),
            'index' => $this->getElasticsearchConfigData('index_prefix'),
            'enableAuth' => $this->getElasticsearchConfigData('enable_auth'),
            'username' => $this->getElasticsearchConfigData('username'),
            'password' => $this->getElasticsearchConfigData('password'),
            'timeout' => $this->getElasticsearchConfigData('server_timeout') ? : self::ELASTICSEARCH_DEFAULT_TIMEOUT,
        ];
        $options = array_merge($defaultOptions, $options);
        return $options;
    }

Field Documentation

$scopeConfig

$scopeConfig

protected

Definition at line 49 of file Config.php.

ELASTICSEARCH_DEFAULT_TIMEOUT

const ELASTICSEARCH_DEFAULT_TIMEOUT = 15

Default Elasticsearch server timeout

Definition at line 43 of file Config.php.

ELASTICSEARCH_TYPE_DEFAULT

const ELASTICSEARCH_TYPE_DEFAULT = 'product'

Elasticsearch default Entity type

Definition at line 38 of file Config.php.

ELASTICSEARCH_TYPE_DOCUMENT

const ELASTICSEARCH_TYPE_DOCUMENT = 'document'

Elasticsearch Entity type

Definition at line 33 of file Config.php.

ENGINE_NAME

const ENGINE_NAME = 'elasticsearch'

Search engine name

Definition at line 26 of file Config.php.

---

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

• vendor/magento/module-elasticsearch/Model/Config.php