abstract class RenderTagPlugin in Extensible BBCode 4.0.x

Base class for plugins that produce a Drupal render array.

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\RenderTagPlugin implements ContainerFactoryPluginInterface

3 files declare their use of RenderTagPlugin

ImageTagPlugin.php in standard/src/Plugin/XBBCode/ImageTagPlugin.php

ListTagPlugin.php in standard/src/Plugin/XBBCode/ListTagPlugin.php

TableTagPlugin.php in standard/src/Plugin/XBBCode/TableTagPlugin.php

File

src/Plugin/RenderTagPlugin.php, line 14

Namespace

Drupal\xbbcode\Plugin

abstract class RenderTagPlugin extends TagPluginBase implements ContainerFactoryPluginInterface {

  /**
   * The Drupal renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * RenderTagPlugin constructor.
   *
   * @param array $configuration
   *   Plugin configuration.
   * @param string $plugin_id
   *   Plugin ID.
   * @param mixed $plugin_definition
   *   Plugin definition.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   Drupal renderer service.
   */
  public function __construct(array $configuration, string $plugin_id, $plugin_definition, RendererInterface $renderer) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->renderer = $renderer;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('renderer'));
  }

  /**
   * {@inheritdoc}
   */
  public function doProcess(TagElementInterface $tag) : TagProcessResult {
    $element = $this
      ->buildElement($tag);

    // Use a new render context; metadata bubbles through the filter result.
    // Importantly, this adds language and theme cache contexts, just in
    // case the filter is used in an otherwise theme-independent context.
    $output = $this->renderer
      ->renderPlain($element);
    $result = TagProcessResult::createFromRenderArray($element);
    $result
      ->setProcessedText((string) $output);
    return $result;
  }

  /**
   * Build a render array from the tag.
   *
   * @param \Drupal\xbbcode\Parser\Tree\TagElementInterface $tag
   *   The tag element in the parse tree.
   *
   * @return array
   *   The render array.
   */
  public abstract function buildElement(TagElementInterface $tag) : array;

}

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.
RenderTagPlugin::$renderer	protected	property	The Drupal renderer.
RenderTagPlugin::buildElement	abstract public	function	Build a render array from the tag.	3
RenderTagPlugin::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
RenderTagPlugin::doProcess	public	function	Create the actual output. Overrides TagPluginBase::doProcess
RenderTagPlugin::__construct	public	function	RenderTagPlugin constructor. Overrides TagPluginBase::__construct
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