interface SearchPageInterface

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

Provides an interface defining a search page entity.

Hierarchy

Expanded class hierarchy of SearchPageInterface

All classes that implement SearchPageInterface

4 files declare their use of SearchPageInterface
SearchController.php in core/modules/search/src/Controller/SearchController.php
SearchPage.php in core/modules/search/src/Entity/SearchPage.php
SearchPageForm.php in core/modules/search/src/Form/SearchPageForm.php
umami.theme in core/profiles/demo_umami/themes/umami/umami.theme
Functions to support theming in the Umami theme.

File

core/modules/search/src/SearchPageInterface.php, line 10

Namespace

Drupal\search
View source
interface SearchPageInterface extends ConfigEntityInterface {
  
  /**
   * Returns the search plugin.
   *
   * @return \Drupal\search\Plugin\SearchInterface
   *   The search plugin used by this search page entity.
   */
  public function getPlugin();
  
  /**
   * Sets the search plugin.
   *
   * @param string $plugin_id
   *   The search plugin ID.
   */
  public function setPlugin($plugin_id);
  
  /**
   * Determines if this search page entity is currently the default search.
   *
   * @return bool
   *   TRUE if this search page entity is the default search, FALSE otherwise.
   */
  public function isDefaultSearch();
  
  /**
   * Determines if this search page entity is indexable.
   *
   * @return bool
   *   TRUE if this search page entity is indexable, FALSE otherwise.
   */
  public function isIndexable();
  
  /**
   * Returns the path for the search.
   *
   * @return string
   *   The part of the path for this search page that comes after 'search'.
   */
  public function getPath();
  
  /**
   * Returns the weight for the page.
   *
   * @return int
   *   The page weight.
   */
  public function getWeight();

}

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