www.aleph1.co.uk Git - yaffs-website/blob - web/core/lib/Drupal/Component/Annotation/AnnotationInterface.php

   1 <?php
   2
   3 namespace Drupal\Component\Annotation;
   4
   5 /**
   6  * Defines a common interface for classed annotations.
   7  */
   8 interface AnnotationInterface {
   9
  10   /**
  11    * Gets the value of an annotation.
  12    */
  13   public function get();
  14
  15   /**
  16    * Gets the name of the provider of the annotated class.
  17    *
  18    * @return string
  19    */
  20   public function getProvider();
  21
  22   /**
  23    * Sets the name of the provider of the annotated class.
  24    *
  25    * @param string $provider
  26    */
  27   public function setProvider($provider);
  28
  29   /**
  30    * Gets the unique ID for this annotated class.
  31    *
  32    * @return string
  33    */
  34   public function getId();
  35
  36   /**
  37    * Gets the class of the annotated class.
  38    *
  39    * @return string
  40    */
  41   public function getClass();
  42
  43   /**
  44    * Sets the class of the annotated class.
  45    *
  46    * @param string $class
  47    */
  48   public function setClass($class);
  49
  50 }