AnnotationInterface.php in Zircon Profile 8

Contains \Drupal\Component\Annotation\AnnotationInterface.

Namespace

Drupal\Component\Annotation

File

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

<?php

/**
 * @file
 * Contains \Drupal\Component\Annotation\AnnotationInterface.
 */
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

Name	Description
AnnotationInterface	Defines a common interface for classed annotations.