class XBBCodeTag in Extensible BBCode 8.3

Defines a BBCode annotation object.

Plugin Namespace: Plugin\XBBCode.

For a working example, see \Drupal\xbbcode\Plugin\XBBCode\EntityTagPlugin.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\xbbcode\Annotation\XBBCodeTag

See also

Plugin API

1 file declares its use of XBBCodeTag

TagPluginManager.php in src/TagPluginManager.php

7 classes are annotated with XBBCodeTag

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

Prints raw code.

EntityTagPlugin in src/Plugin/XBBCode/EntityTagPlugin.php

A tag plugin based on a custom tag entity.

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

Inserts an image.

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

Renders a list.

NullTagPlugin in src/Plugin/XBBCode/NullTagPlugin.php

Provides a fallback placeholder plugin.

... See full list

File

src/Annotation/XBBCodeTag.php, line 18

Namespace

Drupal\xbbcode\Annotation

class XBBCodeTag extends Plugin {

  /**
   * The human-readable name of the tag.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  protected $label;

  /**
   * Whether or not the plugin is enabled by default.
   *
   * @var bool
   */
  protected $status = FALSE;

  /**
   * The suggested code-name of the tag.
   *
   * This will be the default name for using the tag in BBCode. It must not
   * contain any whitespace characters.
   *
   * @var string
   */
  protected $name;

  /**
   * Additional administrative information about the filter's behavior.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  protected $description;

  /**
   * A sample tag for the filter tips.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  protected $sample;

  /**
   * The default settings for the tag.
   *
   * @var array
   */
  protected $settings = [];

}

Members

Name	Modifiers	Type	Description	Overrides
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2
XBBCodeTag::$description	protected	property	Additional administrative information about the filter's behavior.
XBBCodeTag::$label	protected	property	The human-readable name of the tag.
XBBCodeTag::$name	protected	property	The suggested code-name of the tag.
XBBCodeTag::$sample	protected	property	A sample tag for the filter tips.
XBBCodeTag::$settings	protected	property	The default settings for the tag.
XBBCodeTag::$status	protected	property	Whether or not the plugin is enabled by default.