class HelpTopicTwig
Same name in other branches
- 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
- 11.x core/modules/help_topics/src/HelpTopicTwig.php \Drupal\help_topics\HelpTopicTwig
- 11.x core/modules/help/src/HelpTopicTwig.php \Drupal\help\HelpTopicTwig
Represents a help topic plugin whose definition comes from a Twig file.
@internal Help Topics is currently experimental and should only be leveraged by experimental modules and development releases of contributed modules. See https://www.drupal.org/core/experimental for more information.
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_topics\HelpTopicPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\help_topics\HelpTopicPluginInterface
- class \Drupal\help_topics\HelpTopicTwig extends \Drupal\help_topics\HelpTopicPluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\help_topics\HelpTopicPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\help_topics\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_topics\HelpTopicDiscovery
\Drupal\help_topics\HelpTopicTwigLoader
\Drupal\help_topics\HelpTopicPluginManager
2 files declare their use of HelpTopicTwig
- HelpTopicDiscoveryTest.php in core/
modules/ help_topics/ tests/ src/ Unit/ HelpTopicDiscoveryTest.php - HelpTopicTwigTest.php in core/
modules/ help_topics/ tests/ src/ Unit/ HelpTopicTwigTest.php
File
-
core/
modules/ help_topics/ src/ HelpTopicTwig.php, line 22
Namespace
Drupal\help_topicsView source
class HelpTopicTwig extends HelpTopicPluginBase implements ContainerFactoryPluginInterface {
/**
* The Twig environment.
*
* @var \Drupal\Core\Template\TwigEnvironment
*/
protected $twig;
/**
* 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);
$this->twig = $twig;
}
/**
* {@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
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DerivativeInspectionInterface::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | 1 | |
DerivativeInspectionInterface::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | 1 | |
HelpTopicPluginBase::getLabel | public | function | Returns the label of the topic. | Overrides HelpTopicPluginInterface::getLabel | |
HelpTopicPluginBase::getProvider | public | function | The name of the module or theme providing the help topic. | ||
HelpTopicPluginBase::getRelated | public | function | Returns the IDs of related topics. | Overrides HelpTopicPluginInterface::getRelated | |
HelpTopicPluginBase::isTopLevel | public | function | Returns whether this is a top-level topic or not. | Overrides HelpTopicPluginInterface::isTopLevel | |
HelpTopicPluginBase::toLink | public | function | Returns a link for viewing the help topic. | Overrides HelpTopicPluginInterface::toLink | |
HelpTopicPluginBase::toUrl | public | function | Returns the URL for viewing the help topic. | Overrides HelpTopicPluginInterface::toUrl | |
HelpTopicTwig::$twig | protected | property | The Twig environment. | ||
HelpTopicTwig::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | |
HelpTopicTwig::getBody | public | function | Returns the body of the topic. | Overrides HelpTopicPluginInterface::getBody | |
HelpTopicTwig::getCacheContexts | public | function | The cache contexts associated with this object. | Overrides CacheableDependencyInterface::getCacheContexts | |
HelpTopicTwig::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | Overrides CacheableDependencyInterface::getCacheMaxAge | |
HelpTopicTwig::getCacheTags | public | function | The cache tags associated with this object. | Overrides CacheableDependencyInterface::getCacheTags | |
HelpTopicTwig::__construct | public | function | HelpTopicPluginBase constructor. | ||
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin_id of the plugin instance. | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.