class ConfigurableSearchPluginBase
Same name and namespace in other branches
- 9 core/modules/search/src/Plugin/ConfigurableSearchPluginBase.php \Drupal\search\Plugin\ConfigurableSearchPluginBase
- 8.9.x core/modules/search/src/Plugin/ConfigurableSearchPluginBase.php \Drupal\search\Plugin\ConfigurableSearchPluginBase
- 10 core/modules/search/src/Plugin/ConfigurableSearchPluginBase.php \Drupal\search\Plugin\ConfigurableSearchPluginBase
Provides a base implementation for a configurable Search plugin.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\search\Plugin\SearchPluginBase extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\search\Plugin\SearchInterface, \Drupal\Core\Cache\RefinableCacheableDependencyInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\search\Plugin\ConfigurableSearchPluginBase extends \Drupal\search\Plugin\ConfigurableSearchPluginInterface uses \Drupal\Core\Plugin\ConfigurableTrait implements \Drupal\search\Plugin\SearchPluginBase
- class \Drupal\search\Plugin\SearchPluginBase extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\search\Plugin\SearchInterface, \Drupal\Core\Cache\RefinableCacheableDependencyInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of ConfigurableSearchPluginBase
3 files declare their use of ConfigurableSearchPluginBase
- EntitySearchPage.php in core/
modules/ search/ src/ Plugin/ migrate/ destination/ EntitySearchPage.php - NodeSearch.php in core/
modules/ node/ src/ Plugin/ Search/ NodeSearch.php - SearchExtraTypeSearch.php in core/
modules/ search/ tests/ modules/ search_extra_type/ src/ Plugin/ Search/ SearchExtraTypeSearch.php
File
-
core/
modules/ search/ src/ Plugin/ ConfigurableSearchPluginBase.php, line 11
Namespace
Drupal\search\PluginView source
abstract class ConfigurableSearchPluginBase extends SearchPluginBase implements ConfigurableSearchPluginInterface {
use ConfigurableTrait;
/**
* The unique ID for the search page using this plugin.
*
* @var string
*/
protected $searchPageId;
/**
* {@inheritdoc}
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->setConfiguration($configuration);
}
/**
* {@inheritdoc}
*/
public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
}
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
return [];
}
/**
* {@inheritdoc}
*/
public function setSearchPageId($search_page_id) {
$this->searchPageId = $search_page_id;
return $this;
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
CacheableDependencyTrait::$cacheContexts | protected | property | Cache contexts. | |||
CacheableDependencyTrait::$cacheMaxAge | protected | property | Cache max-age. | |||
CacheableDependencyTrait::$cacheTags | protected | property | Cache tags. | |||
CacheableDependencyTrait::getCacheContexts | public | function | 4 | |||
CacheableDependencyTrait::getCacheMaxAge | public | function | 4 | |||
CacheableDependencyTrait::getCacheTags | public | function | 4 | |||
CacheableDependencyTrait::setCacheability | protected | function | Sets cacheability; useful for value object constructors. | |||
ConfigurableSearchPluginBase::$searchPageId | protected | property | The unique ID for the search page using this plugin. | |||
ConfigurableSearchPluginBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | ||
ConfigurableSearchPluginBase::setSearchPageId | public | function | Sets the ID for the search page using this plugin. | Overrides ConfigurableSearchPluginInterface::setSearchPageId | ||
ConfigurableSearchPluginBase::validateConfigurationForm | public | function | Form validation handler. | Overrides PluginFormInterface::validateConfigurationForm | ||
ConfigurableSearchPluginBase::__construct | public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | Overrides PluginBase::__construct | 1 | |
ConfigurableTrait::$configuration | protected | property | Configuration information passed into the plugin. | |||
ConfigurableTrait::defaultConfiguration | public | function | Gets default configuration for this plugin. | 19 | ||
ConfigurableTrait::getConfiguration | public | function | Gets this plugin's configuration. | 3 | ||
ConfigurableTrait::setConfiguration | public | function | Sets the configuration for this plugin instance. | 2 | ||
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
DependencySerializationTrait::__sleep | public | function | 3 | |||
DependencySerializationTrait::__wakeup | public | function | 3 | |||
MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | ||
PluginBase::$pluginId | protected | property | The plugin ID. | |||
PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | ||||
PluginBase::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | ||
PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | ||
PluginBase::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | 2 | |
PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | ||
PluginBase::isConfigurable | Deprecated | public | function | Determines if the plugin is configurable. | ||
PluginFormInterface::buildConfigurationForm | public | function | Form constructor. | 48 | ||
PluginFormInterface::submitConfigurationForm | public | function | Form submission handler. | 44 | ||
RefinableCacheableDependencyTrait::addCacheableDependency | public | function | 1 | |||
RefinableCacheableDependencyTrait::addCacheContexts | public | function | ||||
RefinableCacheableDependencyTrait::addCacheTags | public | function | ||||
RefinableCacheableDependencyTrait::mergeCacheMaxAge | public | function | ||||
SearchInterface::execute | public | function | Executes the search. | 4 | ||
SearchPluginBase::$keywords | protected | property | The keywords to use in a search. | |||
SearchPluginBase::$searchAttributes | protected | property | Array of attributes - usually from the request object. | |||
SearchPluginBase::$searchParameters | protected | property | Array of parameters from the query string from the request. | |||
SearchPluginBase::buildResults | public | function | Executes the search and builds render arrays for the result items. | Overrides SearchInterface::buildResults | 1 | |
SearchPluginBase::buildSearchUrlQuery | public | function | Builds the URL GET query parameters array for search. | Overrides SearchInterface::buildSearchUrlQuery | 1 | |
SearchPluginBase::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | 3 | |
SearchPluginBase::getAttributes | public | function | Returns the currently set attributes (from the request). | Overrides SearchInterface::getAttributes | ||
SearchPluginBase::getHelp | public | function | Returns the searching help. | Overrides SearchInterface::getHelp | 1 | |
SearchPluginBase::getKeywords | public | function | Returns the currently set keywords of the plugin instance. | Overrides SearchInterface::getKeywords | ||
SearchPluginBase::getParameters | public | function | Returns the current parameters set using setSearch(). | Overrides SearchInterface::getParameters | ||
SearchPluginBase::getType | public | function | Returns the search index type this plugin uses. | Overrides SearchInterface::getType | 2 | |
SearchPluginBase::isSearchExecutable | public | function | Verifies if the values set via setSearch() are valid and sufficient. | Overrides SearchInterface::isSearchExecutable | 2 | |
SearchPluginBase::searchFormAlter | public | function | Alters the search form when being built for a given plugin. | Overrides SearchInterface::searchFormAlter | 1 | |
SearchPluginBase::setSearch | public | function | Sets the keywords, parameters, and attributes to be used by execute(). | Overrides SearchInterface::setSearch | 1 | |
SearchPluginBase::suggestedTitle | public | function | Provides a suggested title for a page of search results. | Overrides SearchInterface::suggestedTitle | ||
SearchPluginBase::usesAdminTheme | public | function | Returns whether or not search results should be displayed in admin theme. | Overrides SearchInterface::usesAdminTheme | ||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | ||
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | |||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | |||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | |||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | ||
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.