interface ConfigurableSearchPluginInterface

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

Provides an interface for a configurable Search plugin.

Hierarchy

Expanded class hierarchy of ConfigurableSearchPluginInterface

All classes that implement ConfigurableSearchPluginInterface

File

core/modules/search/src/Plugin/ConfigurableSearchPluginInterface.php, line 12

Namespace

Drupal\search\Plugin
View on git.drupalcode.org
View source 
interface ConfigurableSearchPluginInterface extends ConfigurableInterface, DependentPluginInterface, PluginFormInterface, SearchInterface {
  
  /**
   * Sets the ID for the search page using this plugin.
   *
   * @param string $search_page_id
   *   The search page ID.
   *
   * @return static
   */
  public function setSearchPageId($search_page_id);

}

Members

Title Modifiers Object type Summary Overrides
ConfigurableInterface::defaultConfiguration public function Gets default configuration for this plugin. 24
ConfigurableInterface::getConfiguration public function Gets this plugin's configuration. 15
ConfigurableInterface::setConfiguration public function Sets the configuration for this plugin instance. 15
ConfigurableSearchPluginInterface::setSearchPageId public function Sets the ID for the search page using this plugin. 1
DependentPluginInterface::calculateDependencies public function Calculates dependencies for the configured plugin. 20
PluginFormInterface::buildConfigurationForm public function Form constructor. 47
PluginFormInterface::submitConfigurationForm public function Form submission handler. 42
PluginFormInterface::validateConfigurationForm public function Form validation handler. 28
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 4
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
SearchInterface::buildResults public function Executes the search and builds render arrays for the result items. 1
SearchInterface::buildSearchUrlQuery public function Builds the URL GET query parameters array for search. 1
SearchInterface::execute public function Executes the search. 4
SearchInterface::getAttributes public function Returns the currently set attributes (from the request). 1
SearchInterface::getHelp public function Returns the searching help. 1
SearchInterface::getKeywords public function Returns the currently set keywords of the plugin instance. 1
SearchInterface::getParameters public function Returns the current parameters set using setSearch(). 1
SearchInterface::getType public function Returns the search index type this plugin uses. 1
SearchInterface::isSearchExecutable public function Verifies if the values set via setSearch() are valid and sufficient. 1
SearchInterface::searchFormAlter public function Alters the search form when being built for a given plugin. 1
SearchInterface::setSearch public function Sets the keywords, parameters, and attributes to be used by execute(). 1
SearchInterface::suggestedTitle public function Provides a suggested title for a page of search results. 1
SearchInterface::usesAdminTheme public function Returns whether or not search results should be displayed in admin theme. 1

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