class BlockStyle in Block Style Plugins 8.2

Defines a Block style item annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\block_style_plugins\Annotation\BlockStyle

See also

\Drupal\block_style_plugins\Plugin\BlockStyleManager

Plugin API

2 classes are annotated with BlockStyle

DropdownWithInclude in tests/modules/block_style_plugins_test/src/Plugin/BlockStyle/DropdownWithInclude.php

Demonstrate using the 'include' parameter.

SimpleClass in tests/modules/block_style_plugins_test/src/Plugin/BlockStyle/SimpleClass.php

Provides a 'SimpleClass' block style for adding a class in a text field.

File

src/Annotation/BlockStyle.php, line 15

Namespace

Drupal\block_style_plugins\Annotation

class BlockStyle extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The label of the plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * The type of plugin this will support block, section, or all.
   *
   * @var string
   */
  public $type = 'block';

  /**
   * Block types to exclude.
   *
   * @var array
   */
  public $exclude = [];

  /**
   * Include only these block types.
   *
   * @var array
   */
  public $include = [];

  /**
   * Whether or not to embed the style form directly on the layout builder form.
   *
   * If set to true, the styles form will be embedded on the 'configure' form
   * of the layout builder block. Otherwise it will be added via a separate
   * 'Style settings' contextual link.
   *
   * @var array
   */
  public $layout_builder_embed_form = FALSE;

  /**
   * Do not automatically apply a css class based on the form value.
   *
   * @var array
   */
  public $disable_auto_classes = FALSE;

}

Members

Name	Modifiers	Type	Description	Overrides
BlockStyle::$disable_auto_classes	public	property	Do not automatically apply a css class based on the form value.
BlockStyle::$exclude	public	property	Block types to exclude.
BlockStyle::$id	public	property	The plugin ID.
BlockStyle::$include	public	property	Include only these block types.
BlockStyle::$label	public	property	The label of the plugin.
BlockStyle::$layout_builder_embed_form	public	property	Whether or not to embed the style form directly on the layout builder form.
BlockStyle::$type	public	property	The type of plugin this will support block, section, or all.
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