class HelpSearch
Same name in this branch
- 11.x core/modules/help/src/Plugin/Search/HelpSearch.php \Drupal\help\Plugin\Search\HelpSearch
Same name and namespace in other branches
- 9 core/modules/help_topics/src/Plugin/Search/HelpSearch.php \Drupal\help_topics\Plugin\Search\HelpSearch
- 8.9.x core/modules/help_topics/src/Plugin/Search/HelpSearch.php \Drupal\help_topics\Plugin\Search\HelpSearch
- 10 core/modules/help_topics/src/Plugin/Search/HelpSearch.php \Drupal\help_topics\Plugin\Search\HelpSearch
- 10 core/modules/help/src/Plugin/Search/HelpSearch.php \Drupal\help\Plugin\Search\HelpSearch
Handles searching for help using the Search module index.
Help items are indexed if their HelpSection plugin implements \Drupal\help\HelpSearchInterface.
@internal Help Topics is currently experimental and should only be leveraged by experimental modules and development releases of contributed modules. See https://www.drupal.org/core/experimental for more information.
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\help\Plugin\Search\HelpSearch extends \Drupal\Core\Access\AccessibleInterface, \Drupal\search\Plugin\SearchIndexingInterface implements \Drupal\search\Plugin\SearchPluginBase
- class \Drupal\help_topics\Plugin\Search\HelpSearch implements \Drupal\help\Plugin\Search\HelpSearch
- class \Drupal\help\Plugin\Search\HelpSearch extends \Drupal\Core\Access\AccessibleInterface, \Drupal\search\Plugin\SearchIndexingInterface 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 HelpSearch
See also
\Drupal\help\HelpSearchInterface
\Drupal\help\HelpSectionPluginInterface
File
-
core/
modules/ help_topics/ src/ Plugin/ Search/ HelpSearch.php, line 21
Namespace
Drupal\help_topics\Plugin\SearchView source
class HelpSearch extends CoreHelpSearch {
}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. | |||
| 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 | |||
| HelpSearch::$account | protected | property | The Drupal account to use for checking for access to search. | |||
| HelpSearch::$database | protected | property | The current database connection. | |||
| HelpSearch::$helpSectionManager | protected | property | The help section plugin manager. | |||
| HelpSearch::$languageManager | protected | property | The language manager. | |||
| HelpSearch::$messenger | protected | property | The messenger. | Overrides MessengerTrait::$messenger | ||
| HelpSearch::$searchIndex | protected | property | The search index. | |||
| HelpSearch::$searchSettings | protected | property | A config object for 'search.settings'. | |||
| HelpSearch::$state | protected | property | The state object. | |||
| HelpSearch::access | public | function | Checks data value access. | Overrides AccessibleInterface::access | ||
| HelpSearch::create | public static | function | Creates an instance of the plugin. | Overrides SearchPluginBase::create | ||
| HelpSearch::execute | public | function | Executes the search. | Overrides SearchInterface::execute | ||
| HelpSearch::findResults | protected | function | Finds the search results. | |||
| HelpSearch::getSectionPlugin | protected | function | Instantiates a help section plugin and verifies it is searchable. | |||
| HelpSearch::getType | public | function | Returns the search index type this plugin uses. | Overrides SearchPluginBase::getType | ||
| HelpSearch::indexClear | public | function | Clears the search index for this plugin. | Overrides SearchIndexingInterface::indexClear | ||
| HelpSearch::indexStatus | public | function | Reports the status of indexing. | Overrides SearchIndexingInterface::indexStatus | ||
| HelpSearch::markForReindex | public | function | Marks the search index for reindexing for this plugin. | Overrides SearchIndexingInterface::markForReindex | ||
| HelpSearch::prepareResults | protected | function | Prepares search results for display. | |||
| HelpSearch::removeItemsFromIndex | protected | function | Removes an item or items from the search index. | |||
| HelpSearch::updateIndex | public | function | Updates the search index for this plugin. | Overrides SearchIndexingInterface::updateIndex | ||
| HelpSearch::updateIndexState | public | function | Updates the 'help_search_unindexed_count' state variable. | |||
| HelpSearch::updateTopicList | public | function | Rebuilds the database table containing topics to be indexed. | |||
| HelpSearch::__construct | public | function | Constructs a \Drupal\help_search\Plugin\Search\HelpSearch object. | Overrides PluginBase::__construct | ||
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
| MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | ||
| 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. | ||
| RefinableCacheableDependencyTrait::addCacheableDependency | public | function | 1 | |||
| RefinableCacheableDependencyTrait::addCacheContexts | public | function | ||||
| RefinableCacheableDependencyTrait::addCacheTags | public | function | ||||
| RefinableCacheableDependencyTrait::mergeCacheMaxAge | public | function | ||||
| 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::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::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.