Search for help
- Search 7.x for help
- Search 9.5.x for help
- Search 10.3.x for help
- Search 11.x for help
- Search main for help
- Other projects
| Title | Object type | File name | Summary |
|---|---|---|---|
| HelpPageReverseOrderTest::$defaultTheme | property | core/ |
The theme to install as the default for testing. |
| HelpPageReverseOrderTest::$modules | property | core/ |
Modules to enable. |
| HelpPageReverseOrderTest::$stringOrder | property | core/ |
Strings to search for on admin/help, in order. |
| HelpPageTestController | class | core/ |
Provides controllers for testing the help block. |
| HelpPageTestController.php | file | core/ |
|
| HelpPageTestController::hasHelp | function | core/ |
Provides a route with help. |
| HelpPageTestController::noHelp | function | core/ |
Provides a route with no help. |
| HelpPageTestController::testArray | function | core/ |
Provides a route which has multiple array returns from hook_help(). |
| HelpSearch | class | core/ |
Handles searching for help using the Search module index. |
| HelpSearch.php | file | core/ |
|
| HelpSearch::$account | property | core/ |
The Drupal account to use for checking for access to search. |
| HelpSearch::$database | property | core/ |
The current database connection. |
| HelpSearch::$helpSectionManager | property | core/ |
The help section plugin manager. |
| HelpSearch::$languageManager | property | core/ |
The language manager. |
| HelpSearch::$messenger | property | core/ |
The messenger. |
| HelpSearch::$searchIndex | property | core/ |
The search index. |
| HelpSearch::$searchSettings | property | core/ |
A config object for 'search.settings'. |
| HelpSearch::$state | property | core/ |
The state object. |
| HelpSearch::access | function | core/ |
Checks data value access. |
| HelpSearch::create | function | core/ |
Creates an instance of the plugin. |
| HelpSearch::execute | function | core/ |
Executes the search. |
| HelpSearch::findResults | function | core/ |
Finds the search results. |
| HelpSearch::getSectionPlugin | function | core/ |
Instantiates a help section plugin and verifies it is searchable. |
| HelpSearch::getType | function | core/ |
Returns the search index type this plugin uses. |
| HelpSearch::indexClear | function | core/ |
Clears the search index for this plugin. |
| HelpSearch::indexStatus | function | core/ |
Reports the status of indexing. |
| HelpSearch::markForReindex | function | core/ |
Marks the search index for reindexing for this plugin. |
| HelpSearch::prepareResults | function | core/ |
Prepares search results for display. |
| HelpSearch::removeItemsFromIndex | function | core/ |
Removes an item or items from the search index. |
| HelpSearch::updateIndex | function | core/ |
Updates the search index for this plugin. |
| HelpSearch::updateTopicList | function | core/ |
Rebuilds the database table containing topics to be indexed. |
| HelpSearch::__construct | function | core/ |
Constructs a \Drupal\help_search\Plugin\Search\HelpSearch object. |
| HelpSection | class | core/ |
Defines a Plugin annotation object for help page section plugins. |
| HelpSection.php | file | core/ |
|
| HelpSection::$description | property | core/ |
The description of the help page section. |
| HelpSection::$id | property | core/ |
The plugin ID. |
| HelpSection::$permission | property | core/ |
The (optional) permission needed to view the help section. |
| HelpSection::$title | property | core/ |
The text to use as the title of the help page section. |
| HelpSection::$weight | property | core/ |
An optional weight for the help section. |
| HelpSectionManager | class | core/ |
Manages help page section plugins. |
| HelpSectionManager | class | core/ |
Decorates the Help Section plugin manager to provide help topic search. |
| HelpSectionManager.php | file | core/ |
|
| HelpSectionManager.php | file | core/ |
|
| HelpSectionManager::$searchManager | property | core/ |
The search manager. |
| HelpSectionManager::clearCachedDefinitions | function | core/ |
Clears static and persistent plugin definition caches. |
| HelpSectionManager::setSearchManager | function | core/ |
Sets the search manager. |
| HelpSectionManager::__construct | function | core/ |
Constructs a new HelpSectionManager. |
| HelpSectionPluginBase | class | core/ |
Provides a base class for help section plugins. |
| HelpSectionPluginBase.php | file | core/ |
|
| HelpSectionPluginBase::getDescription | function | core/ |
Returns the description text for the help section. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.