Search for all

  1. Search 7.x for all
  2. Search 9.5.x for all
  3. Search 10.3.x for all
  4. Search 11.x for all
  5. Other projects
Title Object type File name Summary
HelpSearch::__construct function core/modules/help_topics/src/Plugin/Search/HelpSearch.php Constructs a \Drupal\help_search\Plugin\Search\HelpSearch object.
HelpSection class core/modules/help/src/Annotation/HelpSection.php Defines a Plugin annotation object for help page section plugins.
HelpSection.php file core/modules/help/src/Annotation/HelpSection.php
HelpSection::$description property core/modules/help/src/Annotation/HelpSection.php The description of the help page section.
HelpSection::$id property core/modules/help/src/Annotation/HelpSection.php The plugin ID.
HelpSection::$permission property core/modules/help/src/Annotation/HelpSection.php The (optional) permission needed to view the help section.
HelpSection::$title property core/modules/help/src/Annotation/HelpSection.php The text to use as the title of the help page section.
HelpSection::$weight property core/modules/help/src/Annotation/HelpSection.php An optional weight for the help section.
HelpSectionManager class core/modules/help/src/HelpSectionManager.php Manages help page section plugins.
HelpSectionManager class core/modules/help_topics/src/HelpSectionManager.php Decorates the Help Section plugin manager to provide help topic search.
HelpSectionManager.php file core/modules/help_topics/src/HelpSectionManager.php
HelpSectionManager.php file core/modules/help/src/HelpSectionManager.php
HelpSectionManager::$searchManager property core/modules/help_topics/src/HelpSectionManager.php The search manager.
HelpSectionManager::clearCachedDefinitions function core/modules/help_topics/src/HelpSectionManager.php
HelpSectionManager::setSearchManager function core/modules/help_topics/src/HelpSectionManager.php Sets the search manager.
HelpSectionManager::__construct function core/modules/help/src/HelpSectionManager.php Constructs a new HelpSectionManager.
HelpSectionPluginBase class core/modules/help/src/Plugin/HelpSection/HelpSectionPluginBase.php Provides a base class for help section plugins.
HelpSectionPluginBase.php file core/modules/help/src/Plugin/HelpSection/HelpSectionPluginBase.php
HelpSectionPluginBase::getDescription function core/modules/help/src/Plugin/HelpSection/HelpSectionPluginBase.php
HelpSectionPluginBase::getTitle function core/modules/help/src/Plugin/HelpSection/HelpSectionPluginBase.php
HelpSectionPluginInterface interface core/modules/help/src/HelpSectionPluginInterface.php Provides an interface for a plugin for a section of the /admin/help page.
HelpSectionPluginInterface.php file core/modules/help/src/HelpSectionPluginInterface.php
HelpSectionPluginInterface::getDescription function core/modules/help/src/HelpSectionPluginInterface.php Returns the description text for the help section.
HelpSectionPluginInterface::getTitle function core/modules/help/src/HelpSectionPluginInterface.php Returns the title of the help section.
HelpSectionPluginInterface::listTopics function core/modules/help/src/HelpSectionPluginInterface.php Returns a list of topics to show in the help section.
HelpTest class core/modules/help/tests/src/Functional/HelpTest.php Verify help display and user access to help based on permissions.
HelpTest.php file core/modules/help/tests/src/Functional/HelpTest.php
HelpTest::$adminUser property core/modules/help/tests/src/Functional/HelpTest.php The admin user that will be created.
HelpTest::$anyUser property core/modules/help/tests/src/Functional/HelpTest.php The anonymous user that will be created.
HelpTest::$defaultTheme property core/modules/help/tests/src/Functional/HelpTest.php
HelpTest::$modules property core/modules/help/tests/src/Functional/HelpTest.php Modules to enable.
HelpTest::$profile property core/modules/help/tests/src/Functional/HelpTest.php Use the Standard profile to test help implementations of many core modules.
HelpTest::getModuleList function core/modules/help/tests/src/Functional/HelpTest.php Gets the list of enabled modules that implement hook_help().
HelpTest::setUp function core/modules/help/tests/src/Functional/HelpTest.php
HelpTest::testHelp function core/modules/help/tests/src/Functional/HelpTest.php Logs in users, tests help pages.
HelpTest::verifyHelp function core/modules/help/tests/src/Functional/HelpTest.php Verifies the logged in user has access to the various help pages.
HelpTopicDiscovery class core/modules/help_topics/src/HelpTopicDiscovery.php Discovers help topic plugins from Twig files in help_topics directories.
HelpTopicDiscovery.php file core/modules/help_topics/src/HelpTopicDiscovery.php
HelpTopicDiscovery::$directories property core/modules/help_topics/src/HelpTopicDiscovery.php An array of directories to scan, keyed by the provider.
HelpTopicDiscovery::FILE_KEY constant core/modules/help_topics/src/HelpTopicDiscovery.php Defines the key in the discovered data where the file path is stored.
HelpTopicDiscovery::findAll function core/modules/help_topics/src/HelpTopicDiscovery.php Returns an array of discoverable items.
HelpTopicDiscovery::findFiles function core/modules/help_topics/src/HelpTopicDiscovery.php Returns an array of providers keyed by file path.
HelpTopicDiscovery::getDefinitions function core/modules/help_topics/src/HelpTopicDiscovery.php
HelpTopicDiscovery::__construct function core/modules/help_topics/src/HelpTopicDiscovery.php Constructs a HelpTopicDiscovery object.
HelpTopicDiscoveryTest class core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php @coversDefaultClass \Drupal\help_topics\HelpTopicDiscovery[[api-linebreak]]
@group help_topics
HelpTopicDiscoveryTest.php file core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php
HelpTopicDiscoveryTest::testDiscoveryExceptionInvalidRelated function core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testDiscoveryExceptionInvalidTopLevel function core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testDiscoveryExceptionInvalidYamlKey function core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testDiscoveryExceptionMissingLabel function core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php @covers ::findAll[[api-linebreak]]

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