class ImageTagPlugin in Extensible BBCode 4.0.x

Inserts an image.

Plugin annotation

@XBBCodeTag(
  id = "image",
  label = @Translation("Image"),
  description = @Translation("Inserts an image."),
  name = "img",
)

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
        • class \Drupal\xbbcode_standard\Plugin\XBBCode\ImageTagPlugin

File

standard/src/Plugin/XBBCode/ImageTagPlugin.php, line 21

Namespace

Drupal\xbbcode_standard\Plugin\XBBCode

class ImageTagPlugin extends RenderTagPlugin {

  /**
   * {@inheritdoc}
   *
   * @throws \InvalidArgumentException
   */
  public function getDefaultSample() : string {
    return $this
      ->t('[{{ name }} width=57 height=66]@url[/{{ name }}]', [
      '@url' => Url::fromUri('base:core/themes/bartik/logo.svg')
        ->toString(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function buildElement(TagElementInterface $tag) : array {
    $style = [];
    $dimensions = explode('x', $tag
      ->getOption());
    if (count($dimensions) === 2) {
      [
        $width,
        $height,
      ] = $dimensions;
    }
    else {
      $width = (string) $tag
        ->getAttribute('width');
      $height = (string) $tag
        ->getAttribute('height');
    }
    if (is_numeric($width)) {
      $style[] = "width:{$width}px";
    }
    if (is_numeric($height)) {
      $style[] = "height:{$height}px";
    }
    $src = Html::decodeEntities($tag
      ->getContent());
    return [
      '#type' => 'inline_template',
      '#template' => '<img src="{{ src }}" alt="{{ src }}" style="{{ style }};" />',
      '#context' => [
        'tag' => $tag,
        'style' => implode(';', $style),
        'src' => $src,
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
ImageTagPlugin::buildElement	public	function	Build a render array from the tag. Overrides RenderTagPlugin::buildElement
ImageTagPlugin::getDefaultSample	public	function	Overrides TagPluginBase::getDefaultSample
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::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::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