PHPDriver
extends FileDriver
in package
The PHPDriver includes php files which just populate ClassMetadataInfo instances with plain PHP code.
Table of Contents
- $classCache : array<string|int, ClassMetadata>|null
- $globalBasename : string|null
- $locator : FileLocator
- $metadata : ClassMetadata
- __construct() : mixed
- Initializes a new FileDriver that looks in the given path(s) for mapping documents and operates in the specified operating mode.
- getAllClassNames() : array<string|int, string>
- Gets the names of all mapped classes known to this driver.
- getElement() : ClassMetadata
- Gets the element of schema meta data for the class from the mapping file.
- getGlobalBasename() : string|null
- Retrieves the global basename.
- getLocator() : FileLocator
- Retrieves the locator used to discover mapping files by className.
- isTransient() : bool
- Returns whether the class with the specified name should have its metadata loaded.
- loadMetadataForClass() : mixed
- {@inheritDoc}
- setGlobalBasename() : void
- Sets the global basename.
- setLocator() : void
- Sets the locator used to discover mapping files by className.
- initialize() : void
- Initializes the class cache from all the global files.
- loadMappingFile() : array<string|int, ClassMetadata>
- Loads a mapping file with the given name and returns a map from class/entity names to their corresponding file driver elements.
Properties
$classCache
protected
array<string|int, ClassMetadata>|null
$classCache
Tags
$globalBasename
protected
string|null
$globalBasename
$locator
protected
FileLocator
$locator
$metadata
protected
ClassMetadata
$metadata
Tags
Methods
__construct()
Initializes a new FileDriver that looks in the given path(s) for mapping documents and operates in the specified operating mode.
public
__construct(mixed $locator) : mixed
Parameters
- $locator : mixed
-
A FileLocator or one/multiple paths where mapping documents can be found.
Return values
mixed —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.
getElement()
Gets the element of schema meta data for the class from the mapping file.
public
getElement(string $className) : ClassMetadata
This will lazily load the mapping file if it is not loaded yet.
Parameters
- $className : string
Tags
Return values
ClassMetadata —The element of schema meta data.
getGlobalBasename()
Retrieves the global basename.
public
getGlobalBasename() : string|null
Return values
string|null —getLocator()
Retrieves the locator used to discover mapping files by className.
public
getLocator() : FileLocator
Return values
FileLocator —isTransient()
Returns whether the class with the specified name should have its metadata loaded.
public
isTransient(mixed $className) : bool
Parameters
- $className : mixed
Return values
bool —loadMetadataForClass()
{@inheritDoc}
public
loadMetadataForClass(mixed $className, ClassMetadata $metadata) : mixed
Parameters
- $className : mixed
- $metadata : ClassMetadata
Return values
mixed —setGlobalBasename()
Sets the global basename.
public
setGlobalBasename(string $file) : void
Parameters
- $file : string
Return values
void —setLocator()
Sets the locator used to discover mapping files by className.
public
setLocator(FileLocator $locator) : void
Parameters
- $locator : FileLocator
Return values
void —initialize()
Initializes the class cache from all the global files.
protected
initialize() : void
Using this feature adds a substantial performance hit to file drivers as more metadata has to be loaded into memory than might actually be necessary. This may not be relevant to scenarios where caching of metadata is in place, however hits very hard in scenarios where no caching is used.
Return values
void —loadMappingFile()
Loads a mapping file with the given name and returns a map from class/entity names to their corresponding file driver elements.
protected
loadMappingFile(mixed $file) : array<string|int, ClassMetadata>
Parameters
- $file : mixed
-
The mapping file to load.