A repository of search profiles. More...
Inheritance diagram for CirrusSearch\Profile\SearchProfileRepository:
Public Member Functions | |
| repositoryType () | |
| The repository type. | |
| 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. | |
Detailed Description
A repository of search profiles.
Member Function Documentation
◆ getProfile()
| CirrusSearch\Profile\SearchProfileRepository::getProfile | ( | $name | ) |
Load a profile named $name.
- Parameters
-
string $name
- Returns
- array|null the profile data or null if not found
Implemented in CirrusSearch\Profile\ArrayProfileRepository, CirrusSearch\Profile\CompletionSearchProfileRepository, CirrusSearch\Profile\ConfigProfileRepository, CirrusSearch\Profile\PhraseSuggesterProfileRepoWrapper, and CirrusSearch\Profile\SearchProfileRepositoryTransformer.
◆ hasProfile()
| CirrusSearch\Profile\SearchProfileRepository::hasProfile | ( | $name | ) |
Check if a profile named $name exists in this repository.
- Parameters
-
string $name
- Returns
- bool
Implemented in CirrusSearch\Profile\ArrayProfileRepository, CirrusSearch\Profile\CompletionSearchProfileRepository, CirrusSearch\Profile\ConfigProfileRepository, CirrusSearch\Profile\PhraseSuggesterProfileRepoWrapper, and CirrusSearch\Profile\SearchProfileRepositoryTransformer.
◆ listExposedProfiles()
| CirrusSearch\Profile\SearchProfileRepository::listExposedProfiles | ( | ) |
Get the list of profiles that we want to expose to the user.
- Returns
- array[] list of profiles indexed by name
Implemented in CirrusSearch\Profile\ArrayProfileRepository, CirrusSearch\Profile\CompletionSearchProfileRepository, CirrusSearch\Profile\ConfigProfileRepository, CirrusSearch\Profile\PhraseSuggesterProfileRepoWrapper, and CirrusSearch\Profile\SearchProfileRepositoryTransformer.
◆ repositoryName()
| CirrusSearch\Profile\SearchProfileRepository::repositoryName | ( | ) |
The repository name.
- Returns
- string
Implemented in CirrusSearch\Profile\ArrayProfileRepository, CirrusSearch\Profile\CompletionSearchProfileRepository, CirrusSearch\Profile\ConfigProfileRepository, CirrusSearch\Profile\PhraseSuggesterProfileRepoWrapper, and CirrusSearch\Profile\SearchProfileRepositoryTransformer.
◆ repositoryType()
| CirrusSearch\Profile\SearchProfileRepository::repositoryType | ( | ) |
The repository type.
- Returns
- string
Implemented in CirrusSearch\Profile\ArrayProfileRepository, CirrusSearch\Profile\CompletionSearchProfileRepository, CirrusSearch\Profile\ConfigProfileRepository, CirrusSearch\Profile\PhraseSuggesterProfileRepoWrapper, and CirrusSearch\Profile\SearchProfileRepositoryTransformer.
The documentation for this interface was generated from the following file:
- includes/Profile/SearchProfileRepository.php
