annotate core/lib/Drupal/Component/Annotation/AnnotationInterface.php @ 19:fa3358dc1485 tip

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