Search for help

  1. Search 7.x for help
  2. Search 8.9.x for help
  3. Search 10.3.x for help
  4. Search 11.x for help
  5. Search main for help
  6. Other projects
Title Object type File name Summary
HelpTestTwigNodeVisitor::getPriority function core/modules/help_topics/tests/modules/help_topics_twig_tester/src/HelpTestTwigNodeVisitor.php
HelpTestTwigNodeVisitor::getState function core/modules/help_topics/tests/modules/help_topics_twig_tester/src/HelpTestTwigNodeVisitor.php Returns the state information.
HelpTestTwigNodeVisitor::setStateValue function core/modules/help_topics/tests/modules/help_topics_twig_tester/src/HelpTestTwigNodeVisitor.php Sets state information.
HelpTestTwigNodeVisitor::STATE_NAME constant core/modules/help_topics/tests/modules/help_topics_twig_tester/src/HelpTestTwigNodeVisitor.php Name used in \Drupal::state() for saving state information.
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 Gets the definition of all plugins for this type.
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]]
HelpTopicDiscoveryTest::testDiscoveryExceptionProviderMismatch function core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testHelpTopicsBrokenYaml function core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testHelpTopicsDefinition function core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testHelpTopicsExtensionProviderSpecialCase function core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testHelpTopicsInCore function core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php @covers ::findAll[[api-linebreak]]
HelpTopicPluginBase class core/modules/help_topics/src/HelpTopicPluginBase.php Base class for help topic plugins.
HelpTopicPluginBase.php file core/modules/help_topics/src/HelpTopicPluginBase.php
HelpTopicPluginBase::getLabel function core/modules/help_topics/src/HelpTopicPluginBase.php Returns the label of the topic.
HelpTopicPluginBase::getProvider function core/modules/help_topics/src/HelpTopicPluginBase.php The name of the module or theme providing the help topic.
HelpTopicPluginBase::getRelated function core/modules/help_topics/src/HelpTopicPluginBase.php Returns the IDs of related topics.
HelpTopicPluginBase::isTopLevel function core/modules/help_topics/src/HelpTopicPluginBase.php Returns whether this is a top-level topic or not.
HelpTopicPluginBase::toLink function core/modules/help_topics/src/HelpTopicPluginBase.php Returns a link for viewing the help topic.
HelpTopicPluginBase::toUrl function core/modules/help_topics/src/HelpTopicPluginBase.php Returns the URL for viewing the help topic.
HelpTopicPluginController class core/modules/help_topics/src/Controller/HelpTopicPluginController.php Controller for help topic plugins.
HelpTopicPluginController.php file core/modules/help_topics/src/Controller/HelpTopicPluginController.php
HelpTopicPluginController::$helpTopicPluginManager property core/modules/help_topics/src/Controller/HelpTopicPluginController.php The Help Topic plugin manager.
HelpTopicPluginController::$renderer property core/modules/help_topics/src/Controller/HelpTopicPluginController.php The renderer service.
HelpTopicPluginController::create function core/modules/help_topics/src/Controller/HelpTopicPluginController.php Instantiates a new instance of this class.
HelpTopicPluginController::viewHelpTopic function core/modules/help_topics/src/Controller/HelpTopicPluginController.php Displays a help topic page.
HelpTopicPluginController::__construct function core/modules/help_topics/src/Controller/HelpTopicPluginController.php Constructs a HelpTopicPluginController object.
HelpTopicPluginInterface interface core/modules/help_topics/src/HelpTopicPluginInterface.php Defines an interface for help topic plugin classes.
HelpTopicPluginInterface.php file core/modules/help_topics/src/HelpTopicPluginInterface.php
HelpTopicPluginInterface::getBody function core/modules/help_topics/src/HelpTopicPluginInterface.php Returns the body of the topic.
HelpTopicPluginInterface::getLabel function core/modules/help_topics/src/HelpTopicPluginInterface.php Returns the label of the topic.
HelpTopicPluginInterface::getRelated function core/modules/help_topics/src/HelpTopicPluginInterface.php Returns the IDs of related topics.
HelpTopicPluginInterface::isTopLevel function core/modules/help_topics/src/HelpTopicPluginInterface.php Returns whether this is a top-level topic or not.
HelpTopicPluginInterface::toLink function core/modules/help_topics/src/HelpTopicPluginInterface.php Returns a link for viewing the help topic.
HelpTopicPluginInterface::toUrl function core/modules/help_topics/src/HelpTopicPluginInterface.php Returns the URL for viewing the help topic.
HelpTopicPluginManager class core/modules/help_topics/src/HelpTopicPluginManager.php Provides the default help_topic manager.
HelpTopicPluginManager.php file core/modules/help_topics/src/HelpTopicPluginManager.php
HelpTopicPluginManager::$defaults property core/modules/help_topics/src/HelpTopicPluginManager.php Provides default values for all help topic plugins.
HelpTopicPluginManager::$root property core/modules/help_topics/src/HelpTopicPluginManager.php The app root.

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