class HelpTopicTwig
Same name in this branch
- 11.x core/modules/help_topics/src/HelpTopicTwig.php \Drupal\help_topics\HelpTopicTwig
Same name in other branches
- 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
- 10 core/modules/help_topics/src/HelpTopicTwig.php \Drupal\help_topics\HelpTopicTwig
- 10 core/modules/help/src/HelpTopicTwig.php \Drupal\help\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 extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\help\HelpTopicPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\help\HelpTopicPluginInterface
- class \Drupal\help\HelpTopicTwig extends \Drupal\help\HelpTopicPluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\help\HelpTopicPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\help\HelpTopicPluginInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of HelpTopicTwig
See also
\Drupal\help\HelpTopicDiscovery
\Drupal\help\HelpTopicTwigLoader
\Drupal\help\HelpTopicPluginManager
3 files declare their use of HelpTopicTwig
- HelpTopicDiscoveryTest.php in core/
modules/ help/ tests/ src/ Unit/ HelpTopicDiscoveryTest.php - HelpTopicTwig.php in core/
modules/ help_topics/ src/ HelpTopicTwig.php - HelpTopicTwigTest.php in core/
modules/ help/ tests/ src/ Unit/ HelpTopicTwigTest.php
File
-
core/
modules/ help/ src/ HelpTopicTwig.php, line 20
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, TwigEnvironment $twig) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container->get('twig'));
}
/**
* {@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
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.