HelpTopicTwig.php
Same filename in this branch
Same filename in other branches
Namespace
Drupal\helpFile
-
core/
modules/ help/ src/ HelpTopicTwig.php
View source
<?php
namespace Drupal\help;
use Drupal\Core\Cache\Cache;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Template\TwigEnvironment;
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* Represents a help topic plugin whose definition comes from a Twig file.
*
* @see \Drupal\help\HelpTopicDiscovery
* @see \Drupal\help\HelpTopicTwigLoader
* @see \Drupal\help\HelpTopicPluginManager
*
* @internal
* Plugin classes are internal.
*/
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;
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
HelpTopicTwig | Represents a help topic plugin whose definition comes from a Twig file. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.