class CodeTagPlugin in Extensible BBCode 8.3

Prints raw code.

Plugin annotation

@XBBCodeTag(
  id = "code",
  label = @Translation("Code"),
  description = @Translation("Formats code."),
  sample = @Translation("[{{ name }}]This is a [{{ name }}]<code>[/{{ name }}] tag.[/{{ name }}]"),
  name = "code",
)

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_standard\Plugin\XBBCode\CodeTagPlugin

File

standard/src/Plugin/XBBCode/CodeTagPlugin.php, line 22

Namespace

Drupal\xbbcode_standard\Plugin\XBBCode

class CodeTagPlugin extends TagPluginBase {

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

    // Escape HTML characters, to prevent other filters from creating entities.
    // Use $tag->getSource() instead of $content, to discard the ::prepare()
    // output of nested tags (because they will not be rendered).
    return Utf8::encode($tag
      ->getSource(), '<>&"\'');
  }

  /**
   * {@inheritdoc}
   */
  public function doProcess(TagElementInterface $tag) : TagProcessResult {
    $source = Html::escape(Utf8::decode($tag
      ->getSource()));
    return new TagProcessResult("<code>{$source}</code>");
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CodeTagPlugin::doProcess	public	function	Create the actual output. Overrides TagPluginBase::doProcess
CodeTagPlugin::prepare	public	function	Transform an elements' content, to armor against other filters. Overrides TagPluginBase::prepare
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	3
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.	1
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::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