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.
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>.
20 namespace Doctrine\Common\Annotations;
23 * Interface for annotation readers.
25 * @author Johannes M. Schmitt <schmittjoh@gmail.com>
30 * Gets the annotations applied to a class.
32 * @param \ReflectionClass $class The ReflectionClass of the class from which
33 * the class annotations should be read.
35 * @return array An array of Annotations.
37 function getClassAnnotations(\ReflectionClass $class);
40 * Gets a class annotation.
42 * @param \ReflectionClass $class The ReflectionClass of the class from which
43 * the class annotations should be read.
44 * @param string $annotationName The name of the annotation.
46 * @return object|null The Annotation or NULL, if the requested annotation does not exist.
48 function getClassAnnotation(\ReflectionClass $class, $annotationName);
51 * Gets the annotations applied to a method.
53 * @param \ReflectionMethod $method The ReflectionMethod of the method from which
54 * the annotations should be read.
56 * @return array An array of Annotations.
58 function getMethodAnnotations(\ReflectionMethod $method);
61 * Gets a method annotation.
63 * @param \ReflectionMethod $method The ReflectionMethod to read the annotations from.
64 * @param string $annotationName The name of the annotation.
66 * @return object|null The Annotation or NULL, if the requested annotation does not exist.
68 function getMethodAnnotation(\ReflectionMethod $method, $annotationName);
71 * Gets the annotations applied to a property.
73 * @param \ReflectionProperty $property The ReflectionProperty of the property
74 * from which the annotations should be read.
76 * @return array An array of Annotations.
78 function getPropertyAnnotations(\ReflectionProperty $property);
81 * Gets a property annotation.
83 * @param \ReflectionProperty $property The ReflectionProperty to read the annotations from.
84 * @param string $annotationName The name of the annotation.
86 * @return object|null The Annotation or NULL, if the requested annotation does not exist.
88 function getPropertyAnnotation(\ReflectionProperty $property, $annotationName);