class UiPatternsSource in UI Patterns 8

Defines a UI Patterns Source item annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\ui_patterns\Annotation\UiPatternsSource

See also

\Drupal\ui_patterns\UiPatternsSourceManager

Plugin API

5 classes are annotated with UiPatternsSource

DsFieldSource in modules/ui_patterns_ds/src/Plugin/UiPatterns/Source/DsFieldSource.php

Defines Display Suite fields source plugin.

DsFieldTemplateSource in modules/ui_patterns_ds/src/Plugin/UiPatterns/Source/DsFieldTemplateSource.php

Defines Display Suite field template source plugin.

FieldSource in src/Plugin/UiPatterns/Source/FieldSource.php

Defines Fields API pattern source plugin.

TestSource in tests/modules/ui_patterns_field_source_test/src/Plugin/UiPatterns/Source/TestSource.php

Defines Fields API pattern source plugin.

ViewsRowSource in modules/ui_patterns_views/src/Plugin/UiPatterns/Source/ViewsRowSource.php

Defines Views row pattern source plugin.

File

src/Annotation/UiPatternsSource.php, line 15

Namespace

Drupal\ui_patterns\Annotation

class UiPatternsSource extends Plugin {

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

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

  /**
   * Module that must be enabled in order for the plugin to be discoverable.
   *
   * @var string
   */
  public $provider;

  /**
   * An array of tags specifying in which context the source plugin can be used.
   *
   * We should tackle this by using contexts but, until configuration entities
   * will not be exposed as typed data, we will use tags instead.
   *
   * @var array
   *
   * @link https://www.drupal.org/node/1818574
   */
  public $tags = [];

}

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
UiPatternsSource::$id	public	property	The plugin ID.
UiPatternsSource::$label	public	property	The label of the plugin.
UiPatternsSource::$provider	public	property	Module that must be enabled in order for the plugin to be discoverable.
UiPatternsSource::$tags	public	property	An array of tags specifying in which context the source plugin can be used.