DriverChain
extends MappingDriverChain
in package
The DriverChain allows you to add multiple other mapping drivers for certain namespaces.
Tags
Table of Contents
- $defaultDriver : MappingDriver|null
- The default driver.
- $drivers : array<string|int, MappingDriver>
- addDriver() : void
- Adds a nested driver.
- getAllClassNames() : array<string|int, string>
- Gets the names of all mapped classes known to this driver.
- getDefaultDriver() : MappingDriver|null
- Gets the default driver.
- getDrivers() : array<string|int, MappingDriver>
- Gets the array of nested drivers.
- isTransient() : bool
- Returns whether the class with the specified name should have its metadata loaded.
- loadMetadataForClass() : void
- Loads the metadata for the specified class into the provided container.
- setDefaultDriver() : void
- Set the default driver.
Properties
$defaultDriver
The default driver.
private
MappingDriver|null
$defaultDriver
$drivers
private
array<string|int, MappingDriver>
$drivers
= []
Methods
addDriver()
Adds a nested driver.
public
addDriver(MappingDriver $nestedDriver, string $namespace) : void
Parameters
- $nestedDriver : MappingDriver
- $namespace : 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.
getDefaultDriver()
Gets the default driver.
public
getDefaultDriver() : MappingDriver|null
Return values
MappingDriver|null —getDrivers()
Gets the array of nested drivers.
public
getDrivers() : array<string|int, MappingDriver>
Return values
array<string|int, MappingDriver> —$drivers
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()
Loads the metadata for the specified class into the provided container.
public
loadMetadataForClass(mixed $className, ClassMetadata $metadata) : void
Parameters
- $className : mixed
- $metadata : ClassMetadata
Return values
void —setDefaultDriver()
Set the default driver.
public
setDefaultDriver(MappingDriver $driver) : void
Parameters
- $driver : MappingDriver