CirrusSearch
Elasticsearch-powered search for MediaWiki
Loading...
Searching...
No Matches
CirrusSearch\Profile\ConfigProfileRepository Class Reference

Profile repository backed by a Config object. More...

+ Inheritance diagram for CirrusSearch\Profile\ConfigProfileRepository:
+ Collaboration diagram for CirrusSearch\Profile\ConfigProfileRepository:

Public Member Functions

 __construct ( $type, $name, $configEntry, Config $config)
 
 repositoryType ()
 
 repositoryName ()
 The repository name.
 
 getProfile ( $name)
 Load a profile named $name.
 
 hasProfile ( $name)
 Check if a profile named $name exists in this repository.
 
 listExposedProfiles ()
 Get the list of profiles that we want to expose to the user.
 

Static Public Member Functions

static extractConfig (string $configEntry, Config $config)
 
static extractAttribute (string $configEntry)
 

Detailed Description

Profile repository backed by a Config object.

Constructor & Destructor Documentation

◆ __construct()

CirrusSearch\Profile\ConfigProfileRepository::__construct ( $type,
$name,
$configEntry,
Config $config )
Parameters
string$type
string$name
string$configEntrythe name of config key holding the list of profiles
Config$config

Member Function Documentation

◆ extractAttribute()

static CirrusSearch\Profile\ConfigProfileRepository::extractAttribute ( string $configEntry)
static
Parameters
string$configEntry
Returns
array

◆ extractConfig()

static CirrusSearch\Profile\ConfigProfileRepository::extractConfig ( string $configEntry,
Config $config )
static
Parameters
string$configEntry
Config$config
Returns
array

◆ getProfile()

CirrusSearch\Profile\ConfigProfileRepository::getProfile ( $name)

Load a profile named $name.

Parameters
string$name
Returns
array[]|null the profile data or null if not found
Exceptions
SearchProfileException

Implements CirrusSearch\Profile\SearchProfileRepository.

◆ hasProfile()

CirrusSearch\Profile\ConfigProfileRepository::hasProfile ( $name)

Check if a profile named $name exists in this repository.

Parameters
string$name
Returns
bool

Implements CirrusSearch\Profile\SearchProfileRepository.

◆ listExposedProfiles()

CirrusSearch\Profile\ConfigProfileRepository::listExposedProfiles ( )

Get the list of profiles that we want to expose to the user.

Returns
array[] list of profiles index by name

Implements CirrusSearch\Profile\SearchProfileRepository.

◆ repositoryName()

CirrusSearch\Profile\ConfigProfileRepository::repositoryName ( )

The repository name.

Returns
string

Implements CirrusSearch\Profile\SearchProfileRepository.

◆ repositoryType()

CirrusSearch\Profile\ConfigProfileRepository::repositoryType ( )

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