vendor/doctrine/common/lib/Doctrine/Common/Annotations/Reader.php

   1 <?php
   2 /*
   3  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   4  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   5  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   6  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   7  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   8  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   9  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14  *
  15  * This software consists of voluntary contributions made by many individuals
  16  * and is licensed under the MIT license. For more information, see
  17  * <http://www.doctrine-project.org>.
  18  */
  19
  20 namespace Doctrine\Common\Annotations;
  21
  22 /**
  23  * Interface for annotation readers.
  24  *
  25  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  26  */
  27 interface Reader
  28 {
  29     /**
  30      * @param \ReflectionClass $class
  31      * @return mixed
  32      */
  33     function getClassAnnotations(\ReflectionClass $class);
  34
  35     /**
  36      * @param \ReflectionClass $class
  37      * @param string $annotationName
  38      * @return mixed
  39      */
  40     function getClassAnnotation(\ReflectionClass $class, $annotationName);
  41
  42     /**
  43      * @param \ReflectionMethod $method
  44      * @return mixed
  45      */
  46     function getMethodAnnotations(\ReflectionMethod $method);
  47
  48     /**
  49      * @param \ReflectionMethod $method
  50      * @param string $annotationName
  51      * @return mixed
  52      */
  53     function getMethodAnnotation(\ReflectionMethod $method, $annotationName);
  54
  55     /**
  56      * @param \ReflectionProperty $property
  57      * @return mixed
  58      */
  59     function getPropertyAnnotations(\ReflectionProperty $property);
  60
  61     /**
  62      * @param \ReflectionProperty $property
  63      * @param string $annotationName
  64      * @return mixed
  65      */
  66     function getPropertyAnnotation(\ReflectionProperty $property, $annotationName);
  67 }