class DriverChain implements MappingDriver (View source)

The DriverChain allows you to add multiple other mapping drivers for certain namespaces.

Methods

getDefaultDriver()

Gets the default driver.

setDefaultDriver(MappingDriver $driver)

Set the default driver.

addDriver(MappingDriver $nestedDriver, $namespace)

Adds a nested driver.

getDrivers()

Gets the array of nested drivers.

void
loadMetadataForClass(string $className, ClassMetadata $metadata, ClassMetadataBuildingContext $metadataBuildingContext)

Loads the metadata for the specified class into the provided container.

string[]
getAllClassNames()

Gets the names of all mapped classes known to this driver.

bool
isTransient(string $className)

Returns whether the class with the specified name should have its metadata loaded.

Details

MappingDriver|null getDefaultDriver()

Gets the default driver.

Return Value

MappingDriver|null

setDefaultDriver(MappingDriver $driver)

Set the default driver.

Parameters

MappingDriver $driver

addDriver(MappingDriver $nestedDriver, $namespace)

Adds a nested driver.

Parameters

MappingDriver $nestedDriver
$namespace

MappingDriver[] getDrivers()

Gets the array of nested drivers.

Return Value

MappingDriver[] $drivers

void loadMetadataForClass(string $className, ClassMetadata $metadata, ClassMetadataBuildingContext $metadataBuildingContext)

Loads the metadata for the specified class into the provided container.

Parameters

string $className
ClassMetadata $metadata
ClassMetadataBuildingContext $metadataBuildingContext

Return Value

void

string[] getAllClassNames()

Gets the names of all mapped classes known to this driver.

Return Value

string[] The names of all mapped classes known to this driver.

bool isTransient(string $className)

Returns whether the class with the specified name should have its metadata loaded.

This is only the case if it is either mapped as an Entity or a MappedSuperclass.

Parameters

string $className

Return Value

bool