AnnotationInterface.php

Same filename in other branches
  1. 9 core/lib/Drupal/Component/Annotation/AnnotationInterface.php
  2. 10 core/lib/Drupal/Component/Annotation/AnnotationInterface.php
  3. 11.x core/lib/Drupal/Component/Annotation/AnnotationInterface.php

Namespace

Drupal\Component\Annotation

File

core/lib/Drupal/Component/Annotation/AnnotationInterface.php

View source
<?php

namespace Drupal\Component\Annotation;


/**
 * Defines a common interface for classed annotations.
 */
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);

}

Interfaces

Title Deprecated Summary
AnnotationInterface Defines a common interface for classed annotations.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.