1. 8.2.x core/lib/Drupal/Component/Annotation/PluginID.php PluginID
  2. 8.0.x core/lib/Drupal/Component/Annotation/PluginID.php PluginID
  3. 8.1.x core/lib/Drupal/Component/Annotation/PluginID.php PluginID
  4. 8.3.x core/lib/Drupal/Component/Annotation/PluginID.php PluginID

Defines a Plugin annotation object that just contains an ID.

Hierarchy

Expanded class hierarchy of PluginID

Related topics

2 files declare their use of PluginID
RenderElement.php in core/lib/Drupal/Core/Render/Annotation/RenderElement.php
ViewsHandlerAnnotationBase.php in core/modules/views/src/Annotation/ViewsHandlerAnnotationBase.php
1 class is annotated with PluginID
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
View source
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 array(
      'id' => $this->value,
      'class' => $this->class,
      'provider' => $this->provider,
    );
  }

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

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
AnnotationBase::$class protected property The class used for this annotated class.
AnnotationBase::$id public property The annotated class ID.
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