interface SearchPageRepositoryInterface

Same name in other branches
  1. 9 core/modules/search/src/SearchPageRepositoryInterface.php \Drupal\search\SearchPageRepositoryInterface
  2. 8.9.x core/modules/search/src/SearchPageRepositoryInterface.php \Drupal\search\SearchPageRepositoryInterface
  3. 11.x core/modules/search/src/SearchPageRepositoryInterface.php \Drupal\search\SearchPageRepositoryInterface

Provides the interface for a repository Search Page entities.

Hierarchy

Expanded class hierarchy of SearchPageRepositoryInterface

All classes that implement SearchPageRepositoryInterface

6 files declare their use of SearchPageRepositoryInterface
SearchBlock.php in core/modules/search/src/Plugin/Block/SearchBlock.php
SearchBlockForm.php in core/modules/search/src/Form/SearchBlockForm.php
SearchController.php in core/modules/search/src/Controller/SearchController.php
SearchLocalTask.php in core/modules/search/src/Plugin/Derivative/SearchLocalTask.php
SearchPageFormBase.php in core/modules/search/src/Form/SearchPageFormBase.php

... See full list

File

core/modules/search/src/SearchPageRepositoryInterface.php, line 8

Namespace

Drupal\search
View source 
interface SearchPageRepositoryInterface {
    
    /**
     * Returns all active search page entities.
     *
     * @return \Drupal\search\SearchPageInterface[]
     *   An array of active search page entities.
     */
    public function getActiveSearchPages();
    
    /**
     * Returns whether search is active.
     *
     * @return bool
     *   TRUE if at least one search is active, FALSE otherwise.
     */
    public function isSearchActive();
    
    /**
     * Returns all active, indexable search page entities.
     *
     * @return \Drupal\search\SearchPageInterface[]
     *   An array of indexable search page entities.
     */
    public function getIndexableSearchPages();
    
    /**
     * Returns the default search page.
     *
     * @return string|false
     *   The default search page entity ID, or FALSE if no pages are active.
     */
    public function getDefaultSearchPage();
    
    /**
     * Sets a given search page as the default.
     *
     * @param \Drupal\search\SearchPageInterface $search_page
     *   The search page entity.
     *
     * @return static
     */
    public function setDefaultSearchPage(SearchPageInterface $search_page);
    
    /**
     * Clears the default search page.
     */
    public function clearDefaultSearchPage();
    
    /**
     * Sorts a list of search pages.
     *
     * @param \Drupal\search\SearchPageInterface[] $search_pages
     *   The unsorted list of search pages.
     *
     * @return \Drupal\search\SearchPageInterface[]
     *   The sorted list of search pages.
     */
    public function sortSearchPages($search_pages);

}

Members

Title Modifiers Object type Summary
SearchPageRepositoryInterface::clearDefaultSearchPage public function Clears the default search page.
SearchPageRepositoryInterface::getActiveSearchPages public function Returns all active search page entities.
SearchPageRepositoryInterface::getDefaultSearchPage public function Returns the default search page.
SearchPageRepositoryInterface::getIndexableSearchPages public function Returns all active, indexable search page entities.
SearchPageRepositoryInterface::isSearchActive public function Returns whether search is active.
SearchPageRepositoryInterface::setDefaultSearchPage public function Sets a given search page as the default.
SearchPageRepositoryInterface::sortSearchPages public function Sorts a list of search pages.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.