1. interface
  2. Drupal
  3. \
  4. search
  5. \
  6. SearchPageRepositoryInterface

SearchPageRepositoryInterface

interface SearchPageRepositoryInterface (View source)

Provides the interface for a repository Search Page entities.

Methods

SearchPageInterface[]
getActiveSearchPages()

Returns all active search page entities.

bool
isSearchActive()

Returns whether search is active.

SearchPageInterface[]
getIndexableSearchPages()

Returns all active, indexable search page entities.

string|false
getDefaultSearchPage()

Returns the default search page.

SearchPageRepositoryInterface
setDefaultSearchPage(SearchPageInterface $search_page)

Sets a given search page as the default.

clearDefaultSearchPage()

Clears the default search page.

SearchPageInterface[]
sortSearchPages(SearchPageInterface[] $search_pages)

Sorts a list of search pages.

Details

at line 16
SearchPageInterface[] getActiveSearchPages()

Returns all active search page entities.

Return Value

SearchPageInterface[]

An array of active search page entities.

at line 24
bool isSearchActive()

Returns whether search is active.

Return Value

bool

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

at line 32
SearchPageInterface[] getIndexableSearchPages()

Returns all active, indexable search page entities.

Return Value

SearchPageInterface[]

An array of indexable search page entities.

at line 40
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.

at line 50
SearchPageRepositoryInterface setDefaultSearchPage(SearchPageInterface $search_page)

Sets a given search page as the default.

Parameters

SearchPageInterface $search_page

The search page entity.

Return Value

SearchPageRepositoryInterface

at line 55
clearDefaultSearchPage()

Clears the default search page.

at line 66
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.