class PluginID in Drupal 8

Defines a Plugin annotation object that just contains an ID.

Hierarchy

• class \Drupal\Component\Annotation\AnnotationBase implements AnnotationInterface
  • class \Drupal\Component\Annotation\PluginID

Related topics

Annotations

Annotations for class discovery and metadata description.

4 files declare their use of PluginID

PluginIdTest.php in core/tests/Drupal/Tests/Component/Annotation/PluginIdTest.php

PluginManager.php in core/modules/system/tests/modules/lazy_route_provider_install_test/src/PluginManager.php

RenderElement.php in core/lib/Drupal/Core/Render/Annotation/RenderElement.php

ViewsHandlerAnnotationBase.php in core/modules/views/src/Annotation/ViewsHandlerAnnotationBase.php

2 classes are annotated with PluginID

NullIdMap in core/modules/migrate/src/Plugin/migrate/id_map/NullIdMap.php

Defines the null ID map implementation.

Sql in core/modules/migrate/src/Plugin/migrate/id_map/Sql.php

Defines the sql based ID map implementation.

File

core/lib/Drupal/Component/Annotation/PluginID.php, line 10

Namespace

Drupal\Component\Annotation

class PluginID extends AnnotationBase {

  /**
   * The plugin ID.
   *
   * When an annotation is given no key, 'value' is assumed by Doctrine.
   *
   * @var string
   */
  public $value;

  /**
   * {@inheritdoc}
   */
  public function get() {
    return [
      'id' => $this->value,
      'class' => $this->class,
      'provider' => $this->provider,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getId() {
    return $this->value;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AnnotationBase::$class	protected	property	The class used for this annotated class.
AnnotationBase::$id	public	property	The annotated class ID.	1
AnnotationBase::$provider	protected	property	The provider of the annotated class.
AnnotationBase::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
AnnotationBase::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
AnnotationBase::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
AnnotationBase::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
PluginID::$value	public	property	The plugin ID.
PluginID::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get
PluginID::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationBase::getId