PHP Class Doctrine\Common\Annotations\AnnotationReader

Author: Benjamin Eberlei ([email protected])
Author: Guilherme Blanco ([email protected])
Author: Jonathan Wage ([email protected])
Author: Roman Borschel ([email protected])
Author: Johannes M. Schmitt ([email protected])
Inheritance: implements Doctrine\Common\Annotations\Reader
Show file Open project: doctrine/annotations Class Usage Examples

Public Methods

Method Description
__construct ( DocParser $parser = null ) Constructor.
addGlobalIgnoredName ( string $name ) Add a new annotation to the globally ignored annotation names with regard to exception handling.
addGlobalIgnoredNamespace ( string $namespace ) Add a new annotation to the globally ignored annotation namespaces with regard to exception handling.
getClassAnnotation ( ReflectionClass $class, $annotationName ) {@inheritDoc}
getClassAnnotations ( ReflectionClass $class ) {@inheritDoc}
getMethodAnnotation ( ReflectionMethod $method, $annotationName ) {@inheritDoc}
getMethodAnnotations ( ReflectionMethod $method ) {@inheritDoc}
getPropertyAnnotation ( ReflectionProperty $property, $annotationName ) {@inheritDoc}
getPropertyAnnotations ( ReflectionProperty $property ) {@inheritDoc}

Private Methods

Method Description
collectParsingMetadata ( ReflectionClass $class ) Collects parsing metadata for a given class.
getClassImports ( ReflectionClass $class ) : array Retrieves imports.
getIgnoredAnnotationNames ( ReflectionClass $class ) : array Returns the ignored annotations for the given class.
getMethodImports ( ReflectionMethod $method ) : array Retrieves imports for methods.
getPropertyImports ( ReflectionProperty $property ) : array Retrieves imports for properties.

Method Details

__construct() public method

Initializes a new AnnotationReader.
public __construct ( DocParser $parser = null )
$parser DocParser

addGlobalIgnoredName() public static method

Add a new annotation to the globally ignored annotation names with regard to exception handling.
public static addGlobalIgnoredName ( string $name )
$name string

addGlobalIgnoredNamespace() public static method

Add a new annotation to the globally ignored annotation namespaces with regard to exception handling.
public static addGlobalIgnoredNamespace ( string $namespace )
$namespace string

getClassAnnotation() public method

{@inheritDoc}
public getClassAnnotation ( ReflectionClass $class, $annotationName )
$class ReflectionClass

getClassAnnotations() public method

{@inheritDoc}
public getClassAnnotations ( ReflectionClass $class )
$class ReflectionClass

getMethodAnnotation() public method

{@inheritDoc}
public getMethodAnnotation ( ReflectionMethod $method, $annotationName )
$method ReflectionMethod

getMethodAnnotations() public method

{@inheritDoc}
public getMethodAnnotations ( ReflectionMethod $method )
$method ReflectionMethod

getPropertyAnnotation() public method

{@inheritDoc}
public getPropertyAnnotation ( ReflectionProperty $property, $annotationName )
$property ReflectionProperty

getPropertyAnnotations() public method

{@inheritDoc}
public getPropertyAnnotations ( ReflectionProperty $property )
$property ReflectionProperty