class TemplateTagPlugin in Extensible BBCode 4.0.x

This is a tag that delegates processing to a Twig template.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\xbbcode\Plugin\TagPluginBase implements TagPluginInterface
      • class \Drupal\xbbcode\Plugin\TemplateTagPlugin

1 file declares its use of TemplateTagPlugin

EntityTagPlugin.php in src/Plugin/XBBCode/EntityTagPlugin.php

File

src/Plugin/TemplateTagPlugin.php, line 13

Namespace

Drupal\xbbcode\Plugin

class TemplateTagPlugin extends TagPluginBase {

  /**
   * The twig environment.
   *
   * @var \Twig\Environment
   */
  protected $twig;

  /**
   * The serializable identifier of the template.
   *
   * (Either a template name or inline code.)
   *
   * @var string
   */
  protected $template;

  /**
   * Ephemeral reference to the template.
   *
   * This is private because it cannot be serialized, and must be reloaded
   * through the twig environment after hydration.
   *
   * @var \Twig\TemplateWrapper
   */
  private $templateWrapper;

  /**
   * TemplateTagPlugin constructor.
   *
   * @param array $configuration
   *   Plugin configuration.
   * @param string $plugin_id
   *   Plugin ID.
   * @param mixed $plugin_definition
   *   Plugin definition.
   * @param \Twig\Environment $twig
   *   Twig environment service.
   * @param string|null $template
   *   The template.
   */
  public function __construct(array $configuration, string $plugin_id, $plugin_definition, TwigEnvironment $twig, $template = NULL) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->twig = $twig;
    $this->template = $template;
  }

  /**
   * Get the tag template.
   *
   * @return \Twig_TemplateWrapper
   *   The compiled template that should render this tag.
   *
   * @throws \Twig\Error\LoaderError
   * @throws \Twig\Error\RuntimeError
   * @throws \Twig\Error\SyntaxError
   */
  protected function getTemplate() : TwigTemplateWrapper {
    if (!$this->templateWrapper) {
      $this->templateWrapper = $this->twig
        ->load($this->template);
    }
    return $this->templateWrapper;
  }

  /**
   * {@inheritdoc}
   *
   * @throws \Twig\Error\LoaderError
   * @throws \Twig\Error\RuntimeError
   * @throws \Twig\Error\SyntaxError
   */
  public function doProcess(TagElementInterface $tag) : TagProcessResult {
    return new TagProcessResult($this
      ->getTemplate()
      ->render([
      'settings' => $this->settings,
      'tag' => $tag,
    ]));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.
TagPluginBase::$name	protected	property	The configurable tag name.
TagPluginBase::$sample	protected	property	The sample code of this tag.
TagPluginBase::$settings	protected	property	The settings for this tag plugin.
TagPluginBase::$status	protected	property	A Boolean indicating whether this tag is enabled.
TagPluginBase::defaultConfiguration	public	function	Get default plugin configuration from definition.
TagPluginBase::getConfiguration	public	function	Get the plugin configuration.
TagPluginBase::getDefaultName	public	function	Returns the default tag name. Overrides TagPluginInterface::getDefaultName
TagPluginBase::getDefaultSample	public	function	Return the unprocessed sample code. Overrides TagPluginInterface::getDefaultSample	3
TagPluginBase::getDescription	public	function	Returns the administrative description for this tag plugin. Overrides TagPluginInterface::getDescription
TagPluginBase::getName	public	function	Returns the configured name. Overrides TagPluginInterface::getName
TagPluginBase::getSample	public	function	Return a sample tag for the filter tips. Overrides TagPluginInterface::getSample
TagPluginBase::label	public	function	Returns the administrative label for this tag plugin. Overrides TagPluginInterface::label
TagPluginBase::prepare	public	function	Transform an elements' content, to armor against other filters. Overrides TagPluginInterface::prepare	2
TagPluginBase::process	public	function	Generate output from a tag element. Overrides TagPluginInterface::process
TagPluginBase::setConfiguration	public	function	Set the plugin configuration after instancing.
TagPluginBase::status	public	function	Returns the status of this tag plugin. Overrides TagPluginInterface::status
TemplateTagPlugin::$template	protected	property	The serializable identifier of the template.
TemplateTagPlugin::$templateWrapper	private	property	Ephemeral reference to the template.
TemplateTagPlugin::$twig	protected	property	The twig environment.
TemplateTagPlugin::doProcess	public	function	Overrides TagPluginBase::doProcess	1
TemplateTagPlugin::getTemplate	protected	function	Get the tag template.	1
TemplateTagPlugin::__construct	public	function	TemplateTagPlugin constructor. Overrides TagPluginBase::__construct	1