You are here

Home » API reference » Extensible BBCode 4.0.x » TagPluginBase.php

abstract class TagPluginBase in Extensible BBCode 4.0.x

Same name and namespace in other branches
  1. 8.3 src/Plugin/TagPluginBase.php \Drupal\xbbcode\Plugin\TagPluginBase

Provides a base class for XBBCode tag plugins.

Hierarchy

Expanded class hierarchy of TagPluginBase

See also

XBBCodeTag

TagPluginInterface

Plugin API

4 files declare their use of TagPluginBase
CodeTagPlugin.php in standard/src/Plugin/XBBCode/CodeTagPlugin.php
NullTagPlugin.php in src/Plugin/XBBCode/NullTagPlugin.php
TagPluginDeriver.php in src/Plugin/Derivative/TagPluginDeriver.php
XBBCodeTestPlugin.php in tests/xbbcode_test_plugin/src/Plugin/XBBCode/XBBCodeTestPlugin.php

File

src/Plugin/TagPluginBase.php, line 18

Namespace

Drupal\xbbcode\Plugin
View source 
abstract class TagPluginBase extends PluginBase implements TagPluginInterface {

  /**
   * A Boolean indicating whether this tag is enabled.
   *
   * @var bool
   */
  protected $status = FALSE;

  /**
   * The configurable tag name.
   *
   * @var string
   */
  protected $name;

  /**
   * The settings for this tag plugin.
   *
   * @var array
   */
  protected $settings;

  /**
   * The sample code of this tag.
   *
   * @var string
   */
  protected $sample;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->name = $this->pluginDefinition['name'];
    $this->settings = $this->pluginDefinition['settings'];
    $this
      ->setConfiguration($configuration);
  }

  /**
   * Set the plugin configuration after instancing.
   *
   * @param array $configuration
   *   Plugin configuration.
   *
   * @return $this
   */
  public function setConfiguration(array $configuration) : self {
    if (isset($configuration['name'])) {
      $this->name = $configuration['name'];
    }
    if (isset($configuration['settings'])) {
      $this->settings = (array) $configuration['settings'];
    }
    return $this;
  }

  /**
   * Get the plugin configuration.
   *
   * @return array
   *   Plugin configuration.
   */
  public function getConfiguration() : array {
    return [
      'id' => $this
        ->getPluginId(),
      'name' => $this->name,
      'settings' => $this->settings,
    ];
  }

  /**
   * Get default plugin configuration from definition.
   *
   * @return array
   *   Default plugin configuration.
   */
  public function defaultConfiguration() : array {
    return [
      'name' => $this->pluginDefinition['name'],
      'settings' => $this->pluginDefinition['settings'],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function label() : string {
    return $this->pluginDefinition['label'];
  }

  /**
   * {@inheritdoc}
   */
  public function status() : bool {
    return $this->status;
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() : string {
    return $this->pluginDefinition['description'];
  }

  /**
   * {@inheritdoc}
   */
  public function getName() : string {
    return $this->name;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultName() : string {
    return $this->pluginDefinition['name'];
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultSample() : string {
    return $this->pluginDefinition['sample'];
  }

  /**
   * {@inheritdoc}
   */
  public function getSample() : string {
    if (!$this->sample) {
      $this->sample = str_replace('{{ name }}', $this->name, trim($this
        ->getDefaultSample()));
    }
    return $this->sample;
  }

  /**
   * {@inheritdoc}
   */
  public function prepare(string $content, TagElementInterface $tag) : string {
    return $content;
  }

  /**
   * {@inheritdoc}
   */
  public function process(TagElementInterface $tag) : OutputElementInterface {

    // Use an adapter that marks rendered output as safe.
    $result = $this
      ->doProcess(new PreparedTagElement($tag));

    // Merge metadata from rendered sub-tags.
    foreach ($tag
      ->getRenderedChildren(FALSE) as $child) {
      if ($child instanceof TagProcessResult) {
        $result = $result
          ->merge($child);
      }
    }
    return $result;
  }

  /**
   * Create the actual output.
   *
   * Tag plugins should override this function rather than ::process(),
   * in order to let the metadata from sub-tags bubble up.
   *
   * @param \Drupal\xbbcode\Parser\Tree\TagElementInterface $tag
   *   Tag element in the parse tree.
   *
   * @return \Drupal\xbbcode\TagProcessResult
   *   Tag process result.
   */
  public abstract function doProcess(TagElementInterface $tag) : TagProcessResult;

}

Members

Namesort descending 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::doProcess abstract public function Create the actual output. 5
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
TagPluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 3