interface AnnotationInterface in Drupal 8

Defines a common interface for classed annotations.

Hierarchy

• interface \Drupal\Component\Annotation\AnnotationInterface

5 files declare their use of AnnotationInterface

AnnotatedClassDiscovery.php in core/lib/Drupal/Core/Plugin/Discovery/AnnotatedClassDiscovery.php

AnnotatedClassDiscovery.php in core/lib/Drupal/Component/Annotation/Plugin/Discovery/AnnotatedClassDiscovery.php

AnnotatedClassDiscoveryAutomatedProviders.php in core/modules/migrate/src/Plugin/Discovery/AnnotatedClassDiscoveryAutomatedProviders.php

MultipleProviderAnnotationInterface.php in core/modules/migrate/src/Annotation/MultipleProviderAnnotationInterface.php

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

File

core/lib/Drupal/Component/Annotation/AnnotationInterface.php, line 8

Namespace

Drupal\Component\Annotation

interface AnnotationInterface {

  /**
   * Gets the value of an annotation.
   */
  public function get();

  /**
   * Gets the name of the provider of the annotated class.
   *
   * @return string
   */
  public function getProvider();

  /**
   * Sets the name of the provider of the annotated class.
   *
   * @param string $provider
   */
  public function setProvider($provider);

  /**
   * Gets the unique ID for this annotated class.
   *
   * @return string
   */
  public function getId();

  /**
   * Gets the class of the annotated class.
   *
   * @return string
   */
  public function getClass();

  /**
   * Sets the class of the annotated class.
   *
   * @param string $class
   */
  public function setClass($class);

}

Members

Name	Modifiers	Type	Description	Overrides
AnnotationInterface::get	public	function	Gets the value of an annotation.	6
AnnotationInterface::getClass	public	function	Gets the class of the annotated class.	2
AnnotationInterface::getId	public	function	Gets the unique ID for this annotated class.	2
AnnotationInterface::getProvider	public	function	Gets the name of the provider of the annotated class.	2
AnnotationInterface::setClass	public	function	Sets the class of the annotated class.	2
AnnotationInterface::setProvider	public	function	Sets the name of the provider of the annotated class.	2