AnnotationDriver
extends AnnotationDriver
in package
The AnnotationDriver reads the mapping metadata from docblock annotations.
Table of Contents
- $classNames : array<string|int, string>|null
- Cache for AnnotationDriver#getAllClassNames().
- $entityAnnotationClasses : array<string|int, 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.
- create() : AnnotationDriver
- Factory method for the Annotation 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.
- loadMetadataForClass() : mixed
- {@inheritDoc}
- setFileExtension() : void
- Sets the file extension used to look for mapping files under.
- columnToArray() : array<string|int, mixed>
- Parse the given Column as array
- getFetchMode() : int
- Attempts to resolve the fetch mode.
- getMethodCallbacks() : array<string|int, callable>
- Parses the given method.
- joinColumnToArray() : array<string|int, mixed>
- Parse the given JoinColumn as array
- loadRelationShipMapping() : void
Properties
$classNames
Cache for AnnotationDriver#getAllClassNames().
protected
array<string|int, string>|null
$classNames
Tags
$entityAnnotationClasses
Name of the entity annotations as keys.
protected
array<string|int, int>
$entityAnnotationClasses
= [\Doctrine\ORM\Mapping\Entity::class => 1, \Doctrine\ORM\Mapping\MappedSuperclass::class => 2]
Tags
$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 —create()
Factory method for the Annotation Driver.
public
static create([array<string|int, mixed>|string $paths = [] ][, AnnotationReader|null $reader = null ]) : AnnotationDriver
Parameters
- $paths : array<string|int, mixed>|string = []
- $reader : AnnotationReader|null = null
Return values
AnnotationDriver —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 —loadMetadataForClass()
{@inheritDoc}
public
loadMetadataForClass(mixed $className, ClassMetadata $metadata) : mixed
Parameters
- $className : mixed
- $metadata : ClassMetadata
Return values
mixed —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.
Return values
void —columnToArray()
Parse the given Column as array
private
columnToArray(string $fieldName, Column $column) : array<string|int, mixed>
Parameters
- $fieldName : string
- $column : Column
Tags
Return values
array<string|int, mixed> —getFetchMode()
Attempts to resolve the fetch mode.
private
getFetchMode(string $className, string $fetchMode) : int
Parameters
- $className : string
- $fetchMode : string
Tags
Return values
int —getMethodCallbacks()
Parses the given method.
private
getMethodCallbacks(ReflectionMethod $method) : array<string|int, callable>
Parameters
- $method : ReflectionMethod
Tags
Return values
array<string|int, callable> —joinColumnToArray()
Parse the given JoinColumn as array
private
joinColumnToArray(JoinColumn $joinColumn) : array<string|int, mixed>
Parameters
- $joinColumn : JoinColumn
Tags
Return values
array<string|int, mixed> —loadRelationShipMapping()
private
loadRelationShipMapping(ReflectionProperty $property, array<string|int, mixed> &$mapping, ClassMetadata $metadata, array<string|int, mixed> $joinColumns, string $className) : void
Parameters
- $property : ReflectionProperty
- $mapping : array<string|int, mixed>
- $metadata : ClassMetadata
- $joinColumns : array<string|int, mixed>
- $className : string