interface ConfigurableSearchPluginInterface in Drupal 9

Provides an interface for a configurable Search plugin.

Hierarchy

• interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Core\Plugin\PluginFormInterface; interface \Drupal\search\Plugin\SearchInterface
  • interface \Drupal\search\Plugin\ConfigurableSearchPluginInterface

File

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

Namespace

Drupal\search\Plugin

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

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	14
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.	37
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
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