class LayoutBuilderRestriction in Layout Builder Restrictions 8.2

Defines a Layout builder restriction plugin item annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\layout_builder_restrictions\Annotation\LayoutBuilderRestriction

See also

\Drupal\layout_builder_restrictions\Plugin\LayoutBuilderRestrictionManager

Plugin API

2 classes are annotated with LayoutBuilderRestriction

EntityViewModeRestriction in src/Plugin/LayoutBuilderRestriction/EntityViewModeRestriction.php

Controls behavior of the per-view mode plugin.

EntityViewModeRestrictionByRegion in modules/layout_builder_restrictions_by_region/src/Plugin/LayoutBuilderRestriction/EntityViewModeRestrictionByRegion.php

Controls behavior of the by region plugin.

File

src/Annotation/LayoutBuilderRestriction.php, line 15

Namespace

Drupal\layout_builder_restrictions\Annotation

class LayoutBuilderRestriction extends Plugin {

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

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

  /**
   * A description of the plugin (optional).
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description = NULL;

}

Members

Name	Modifiers	Type	Description	Overrides
LayoutBuilderRestriction::$description	public	property	A description of the plugin (optional).
LayoutBuilderRestriction::$id	public	property	The plugin ID.
LayoutBuilderRestriction::$label	public	property	The label of the plugin.
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