AnnotationDriver
in package
implements
MappingDriver
The AnnotationDriver reads the mapping metadata from docblock annotations.
Interfaces, Classes, Traits and Enums
- MappingDriver
- Contract for metadata drivers.
Table of Contents
- $classNames : array<string|int, string>|null
- Cache for AnnotationDriver#getAllClassNames().
- $entityAnnotationClasses : array<class-string, bool|int>
- Name of the entity annotations as keys.
- $excludePaths : array<string|int, string>
- The paths excluded from path where to look for mapping files.
- $fileExtension : string
- The file extension of mapping documents.
- $paths : array<string|int, string>
- The paths where to look for mapping files.
- $reader : Reader
- The annotation reader.
- __construct() : mixed
- Initializes a new AnnotationDriver that uses the given AnnotationReader for reading docblock annotations.
- addExcludePaths() : void
- Append exclude lookup paths to metadata driver.
- addPaths() : void
- Appends lookup paths to metadata driver.
- getAllClassNames() : array<string|int, string>
- Gets the names of all mapped classes known to this driver.
- getExcludePaths() : array<string|int, string>
- Retrieve the defined metadata lookup exclude paths.
- getFileExtension() : string
- Gets the file extension used to look for mapping files under.
- getPaths() : array<string|int, string>
- Retrieves the defined metadata lookup paths.
- getReader() : Reader
- Retrieve the current annotation reader
- isTransient() : bool
- Returns whether the class with the specified name is transient. Only non-transient classes, that is entities and mapped superclasses, should have their metadata loaded.
- setFileExtension() : void
- Sets the file extension used to look for mapping files under.
Properties
$classNames
Cache for AnnotationDriver#getAllClassNames().
protected
array<string|int, string>|null
$classNames
Tags
$entityAnnotationClasses
Name of the entity annotations as keys.
protected
array<class-string, bool|int>
$entityAnnotationClasses
= []
$excludePaths
The paths excluded from path where to look for mapping files.
protected
array<string|int, string>
$excludePaths
= []
$fileExtension
The file extension of mapping documents.
protected
string
$fileExtension
= '.php'
$paths
The paths where to look for mapping files.
protected
array<string|int, string>
$paths
= []
$reader
The annotation reader.
protected
Reader
$reader
Methods
__construct()
Initializes a new AnnotationDriver that uses the given AnnotationReader for reading docblock annotations.
public
__construct(Reader $reader[, string|array<string|int, string>|null $paths = null ]) : mixed
Parameters
- $reader : Reader
-
The AnnotationReader to use, duck-typed.
- $paths : string|array<string|int, string>|null = null
-
One or multiple paths where mapping classes can be found.
Return values
mixed —addExcludePaths()
Append exclude lookup paths to metadata driver.
public
addExcludePaths(array<string|int, string> $paths) : void
Parameters
- $paths : array<string|int, string>
Return values
void —addPaths()
Appends lookup paths to metadata driver.
public
addPaths(array<string|int, string> $paths) : void
Parameters
- $paths : array<string|int, string>
Return values
void —getAllClassNames()
Gets the names of all mapped classes known to this driver.
public
getAllClassNames() : array<string|int, string>
Return values
array<string|int, string> —The names of all mapped classes known to this driver.
getExcludePaths()
Retrieve the defined metadata lookup exclude paths.
public
getExcludePaths() : array<string|int, string>
Return values
array<string|int, string> —getFileExtension()
Gets the file extension used to look for mapping files under.
public
getFileExtension() : string
Return values
string —getPaths()
Retrieves the defined metadata lookup paths.
public
getPaths() : array<string|int, string>
Return values
array<string|int, string> —getReader()
Retrieve the current annotation reader
public
getReader() : Reader
Return values
Reader —isTransient()
Returns whether the class with the specified name is transient. Only non-transient classes, that is entities and mapped superclasses, should have their metadata loaded.
public
isTransient(mixed $className) : bool
A class is non-transient if it is annotated with an annotation from the AnnotationDriver::entityAnnotationClasses.
Parameters
- $className : mixed
Return values
bool —setFileExtension()
Sets the file extension used to look for mapping files under.
public
setFileExtension(string $fileExtension) : void
Parameters
- $fileExtension : string
-
The file extension to set.