FileCacheReader
in package
implements
Reader
File cache reader for annotations.
Tags
Interfaces, Classes, Traits and Enums
- Reader
- Interface for annotation readers.
Table of Contents
- $classNameHashes : array<string, string>
- $debug : bool
- $dir : string
- $loadedAnnotations : mixed
- $reader : Reader
- $umask : int
- __construct() : mixed
- clearLoadedAnnotations() : void
- Clears loaded annotations.
- getClassAnnotation() : T|null
- Gets a class annotation.
- getClassAnnotations() : array<string|int, object>
- Gets the annotations applied to a class.
- getMethodAnnotation() : T|null
- Gets a method annotation.
- getMethodAnnotations() : array<string|int, object>
- Gets the annotations applied to a method.
- getPropertyAnnotation() : T|null
- Gets a property annotation.
- getPropertyAnnotations() : array<string|int, object>
- Gets the annotations applied to a property.
- saveCacheFile() : void
- Saves the cache file.
Properties
$classNameHashes
private
array<string, string>
$classNameHashes
= []
$debug
private
bool
$debug
$dir
private
string
$dir
$loadedAnnotations
private
mixed
$loadedAnnotations
= []
Tags
$reader
private
Reader
$reader
$umask
private
int
$umask
Methods
__construct()
public
__construct(Reader $reader, string $cacheDir[, bool $debug = false ][, int $umask = 02 ]) : mixed
Parameters
- $reader : Reader
- $cacheDir : string
- $debug : bool = false
- $umask : int = 02
Tags
Return values
mixed —clearLoadedAnnotations()
Clears loaded annotations.
public
clearLoadedAnnotations() : void
Return values
void —getClassAnnotation()
Gets a class annotation.
public
getClassAnnotation(ReflectionClass $class, mixed $annotationName) : T|null
Parameters
- $class : ReflectionClass
-
The ReflectionClass of the class from which the class annotations should be read.
- $annotationName : mixed
-
The name of the annotation.
Return values
T|null —The Annotation or NULL, if the requested annotation does not exist.
getClassAnnotations()
Gets the annotations applied to a class.
public
getClassAnnotations(ReflectionClass $class) : array<string|int, object>
Parameters
- $class : ReflectionClass
-
The ReflectionClass of the class from which the class annotations should be read.
Return values
array<string|int, object> —An array of Annotations.
getMethodAnnotation()
Gets a method annotation.
public
getMethodAnnotation(ReflectionMethod $method, mixed $annotationName) : T|null
Parameters
- $method : ReflectionMethod
-
The ReflectionMethod to read the annotations from.
- $annotationName : mixed
-
The name of the annotation.
Return values
T|null —The Annotation or NULL, if the requested annotation does not exist.
getMethodAnnotations()
Gets the annotations applied to a method.
public
getMethodAnnotations(ReflectionMethod $method) : array<string|int, object>
Parameters
- $method : ReflectionMethod
-
The ReflectionMethod of the method from which the annotations should be read.
Return values
array<string|int, object> —An array of Annotations.
getPropertyAnnotation()
Gets a property annotation.
public
getPropertyAnnotation(ReflectionProperty $property, mixed $annotationName) : T|null
Parameters
- $property : ReflectionProperty
-
The ReflectionProperty to read the annotations from.
- $annotationName : mixed
-
The name of the annotation.
Return values
T|null —The Annotation or NULL, if the requested annotation does not exist.
getPropertyAnnotations()
Gets the annotations applied to a property.
public
getPropertyAnnotations(ReflectionProperty $property) : array<string|int, object>
Parameters
- $property : ReflectionProperty
-
The ReflectionProperty of the property from which the annotations should be read.
Return values
array<string|int, object> —An array of Annotations.
saveCacheFile()
Saves the cache file.
private
saveCacheFile(string $path, mixed $data) : void
Parameters
- $path : string
- $data : mixed