class HelpTopicTwig
Same name and namespace in other branches
- 11.x core/modules/help/src/HelpTopicTwig.php \Drupal\help\HelpTopicTwig
- 10 core/modules/help_topics/src/HelpTopicTwig.php \Drupal\help_topics\HelpTopicTwig
- 10 core/modules/help/src/HelpTopicTwig.php \Drupal\help\HelpTopicTwig
- 9 core/modules/help_topics/src/HelpTopicTwig.php \Drupal\help_topics\HelpTopicTwig
- 8.9.x core/modules/help_topics/src/HelpTopicTwig.php \Drupal\help_topics\HelpTopicTwig
Represents a help topic plugin whose definition comes from a Twig file.
@internal Plugin classes are internal.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\help\HelpTopicPluginBase implements \Drupal\help\HelpTopicPluginInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\help\HelpTopicTwig implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\help\HelpTopicPluginBase
- class \Drupal\help\HelpTopicPluginBase implements \Drupal\help\HelpTopicPluginInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of HelpTopicTwig
See also
\Drupal\help\HelpTopicDiscovery
\Drupal\help\HelpTopicTwigLoader
\Drupal\help\HelpTopicPluginManager
2 files declare their use of HelpTopicTwig
- HelpTopicDiscoveryTest.php in core/
modules/ help/ tests/ src/ Unit/ HelpTopicDiscoveryTest.php - HelpTopicTwigTest.php in core/
modules/ help/ tests/ src/ Unit/ HelpTopicTwigTest.php
File
-
core/
modules/ help/ src/ HelpTopicTwig.php, line 19
Namespace
Drupal\helpView source
class HelpTopicTwig extends HelpTopicPluginBase implements ContainerFactoryPluginInterface {
/**
* HelpTopicPluginBase constructor.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin ID for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Template\TwigEnvironment $twig
* The Twig environment.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, protected TwigEnvironment $twig) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
}
/**
* {@inheritdoc}
*/
public function getBody() {
return [
'#markup' => $this->twig
->load('@help_topics/' . $this->getPluginId() . '.html.twig')
->render(),
];
}
/**
* {@inheritdoc}
*/
public function getCacheContexts() {
return [];
}
/**
* {@inheritdoc}
*/
public function getCacheTags() {
return [
'core.extension',
];
}
/**
* {@inheritdoc}
*/
public function getCacheMaxAge() {
return Cache::PERMANENT;
}
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
|---|---|---|---|---|---|
| AutowiredInstanceTrait::createInstanceAutowired | public static | function | Instantiates a new instance of the implementing class using autowiring. | ||
| AutowiredInstanceTrait::getAutowireArguments | private static | function | Resolves arguments for a method using autowiring. | ||
| 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 | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | 2 | ||
| HelpTopicPluginBase::getLabel | public | function | Overrides HelpTopicPluginInterface::getLabel | ||
| HelpTopicPluginBase::getProvider | public | function | The name of the module or theme providing the help topic. | ||
| HelpTopicPluginBase::getRelated | public | function | Overrides HelpTopicPluginInterface::getRelated | ||
| HelpTopicPluginBase::isTopLevel | public | function | Overrides HelpTopicPluginInterface::isTopLevel | ||
| HelpTopicPluginBase::toLink | public | function | Overrides HelpTopicPluginInterface::toLink | ||
| HelpTopicPluginBase::toUrl | public | function | Overrides HelpTopicPluginInterface::toUrl | ||
| HelpTopicTwig::getBody | public | function | Overrides HelpTopicPluginInterface::getBody | ||
| HelpTopicTwig::getCacheContexts | public | function | Overrides CacheableDependencyInterface::getCacheContexts | ||
| HelpTopicTwig::getCacheMaxAge | public | function | Overrides CacheableDependencyInterface::getCacheMaxAge | ||
| HelpTopicTwig::getCacheTags | public | function | Overrides CacheableDependencyInterface::getCacheTags | ||
| HelpTopicTwig::__construct | public | function | HelpTopicPluginBase constructor. | Overrides PluginBase::__construct | |
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | |
| 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::create | public static | function | Instantiates a new instance of the implementing class using autowiring. | 64 | |
| PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | |||
| PluginBase::getBaseId | public | function | Overrides DerivativeInspectionInterface::getBaseId | ||
| PluginBase::getDerivativeId | public | function | Overrides DerivativeInspectionInterface::getDerivativeId | ||
| PluginBase::getPluginDefinition | public | function | Overrides PluginInspectionInterface::getPluginDefinition | 2 | |
| PluginBase::getPluginId | public | function | Overrides PluginInspectionInterface::getPluginId | ||
| 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.