class SearchPageRepository implements SearchPageRepositoryInterface (View source)

Provides a repository for Search Page config entities.

Properties

protected ConfigFactoryInterface $configFactory

The config factory.

protected EntityStorageInterface $storage

The search page storage.

Methods

__construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager)

Constructs a new SearchPageRepository.

getActiveSearchPages()

Returns all active search page entities.

bool
isSearchActive()

Returns whether search is active.

getIndexableSearchPages()

Returns all active, indexable search page entities.

string|false
getDefaultSearchPage()

Returns the default search page.

clearDefaultSearchPage()

Clears the default search page.

setDefaultSearchPage(SearchPageInterface $search_page)

Sets a given search page as the default.

sortSearchPages(SearchPageInterface[] $search_pages)

Sorts a list of search pages.

getQuery()

Returns an entity query instance.

Details

__construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager)

Constructs a new SearchPageRepository.

Parameters

ConfigFactoryInterface $config_factory

The config factory.

EntityTypeManagerInterface $entity_type_manager

The entity type manager.

SearchPageInterface[] getActiveSearchPages()

Returns all active search page entities.

Return Value

SearchPageInterface[]

An array of active search page entities.

bool isSearchActive()

Returns whether search is active.

Return Value

bool

TRUE if at least one search is active, FALSE otherwise.

SearchPageInterface[] getIndexableSearchPages()

Returns all active, indexable search page entities.

Return Value

SearchPageInterface[]

An array of indexable search page entities.

string|false getDefaultSearchPage()

Returns the default search page.

Return Value

string|false

The default search page entity ID, or FALSE if no pages are active.

clearDefaultSearchPage()

Clears the default search page.

SearchPageRepositoryInterface setDefaultSearchPage(SearchPageInterface $search_page)

Sets a given search page as the default.

Parameters

SearchPageInterface $search_page

The search page entity.

Return Value

SearchPageRepositoryInterface

SearchPageInterface[] sortSearchPages(SearchPageInterface[] $search_pages)

Sorts a list of search pages.

Parameters

SearchPageInterface[] $search_pages

The unsorted list of search pages.

Return Value

SearchPageInterface[]

The sorted list of search pages.

protected QueryInterface getQuery()

Returns an entity query instance.

Return Value

QueryInterface

The query instance.