interface AnnotationInterface

Defines a common interface for classed annotations.

Hierarchy

interface \Drupal\Component\Annotation\AnnotationInterface

Expanded class hierarchy of AnnotationInterface

All classes that implement 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
AttributeDiscoveryWithAnnotations.php in core/lib/Drupal/Core/Plugin/Discovery/AttributeDiscoveryWithAnnotations.php
MultipleProviderAnnotationInterface.php in core/modules/migrate/src/Annotation/MultipleProviderAnnotationInterface.php

1 string reference to 'AnnotationInterface'

ValidVariableNameSniff::processMemberVar in vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/NamingConventions/ValidVariableNameSniff.php: Processes class member variables.

File

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

Namespace

Drupal\Component\Annotation

View source

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
     *   The provider of the annotated class.
     */
    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
     *   The class of the annotated class.
     */
    public function setClass($class);

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overrides
AnnotationInterface::get	public	function	Gets the value of an annotation.	4
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.	3
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