PHP Class Doctrine\ODM\OrientDB\Mapper\Annotations\Reader

Inheritance: implements Doctrine\ODM\OrientDB\Mapper\Annotations\ReaderInterface
Show file Open project: doctrine/orientdb-odm

Protected Properties

Property Type Description
$reader

Public Methods

Method Description
__construct ( Doctrine\Common\Cache\Cache $cacheReader = null ) Instantiates a new annotation reader, optionally injecting a cache mechanism for it.
getClassAnnotation ( ReflectionClass $class, string $annotation ) : The Gets a class annotation.
getClassAnnotations ( ReflectionClass $class ) : array Gets the annotations applied to a class.
getMethodAnnotation ( ReflectionMethod $method, string $annotation ) : The Gets a method annotation.
getMethodAnnotations ( ReflectionMethod $method ) : array Gets the annotations applied to a method.
getPropertyAnnotation ( ReflectionProperty $property, string $annotation ) : The Gets a property annotation.
getPropertyAnnotations ( ReflectionProperty $property ) : array Gets the annotations applied to a property.

Protected Methods

Method Description
createCacheProvider ( ) : Doctrine\Common\Cache\CacheProvider Creates a new instance of a cache provider.
getReader ( ) : CachedReader Returns the cached reader associated with this reader.

Method Details

__construct() public method

This reader is basically a proxy wrapping Doctrine's one.
public __construct ( Doctrine\Common\Cache\Cache $cacheReader = null )
$cacheReader Doctrine\Common\Cache\Cache

createCacheProvider() protected method

Creates a new instance of a cache provider.
protected createCacheProvider ( ) : Doctrine\Common\Cache\CacheProvider
return Doctrine\Common\Cache\CacheProvider

getClassAnnotation() public method

Gets a class annotation.
public getClassAnnotation ( ReflectionClass $class, string $annotation ) : The
$class ReflectionClass The ReflectionClass of the class from which the class annotations should be read.
$annotation string The name of the annotation.
return The Annotation or null, if the requested annotation does not exist.

getClassAnnotations() public method

Gets the annotations applied to a class.
public getClassAnnotations ( ReflectionClass $class ) : array
$class ReflectionClass The ReflectionClass of the class from which the class annotations should be read.
return array An array of Annotations.

getMethodAnnotation() public method

Gets a method annotation.
public getMethodAnnotation ( ReflectionMethod $method, string $annotation ) : The
$method ReflectionMethod
$annotation string The name of the annotation.
return The Annotation or null, if the requested annotation does not exist.

getMethodAnnotations() public method

Gets the annotations applied to a method.
public getMethodAnnotations ( ReflectionMethod $method ) : array
$method ReflectionMethod
return array An array of Annotations.

getPropertyAnnotation() public method

Gets a property annotation.
public getPropertyAnnotation ( ReflectionProperty $property, string $annotation ) : The
$property ReflectionProperty
$annotation string The name of the annotation.
return The Annotation or null, if the requested annotation does not exist.

getPropertyAnnotations() public method

Gets the annotations applied to a property.
public getPropertyAnnotations ( ReflectionProperty $property ) : array
$property ReflectionProperty The name or ReflectionProperty of the property from which the annotations should be read.
return array An array of Annotations.

getReader() protected method

Returns the cached reader associated with this reader.
protected getReader ( ) : CachedReader
return Doctrine\Common\Annotations\CachedReader

Property Details

$reader protected property

protected $reader