PHP Class Doctrine\OXM\Configuration

Show file Open project: doctrine/oxm Class Usage Examples

Protected Properties

Property Type Description
$attributes array Values are default values.

Public Methods

Method Description
ensureProductionSettings ( ) Ensures that this Configuration instance contains settings that are suitable for a production environment.
getAutoGenerateProxyClasses ( ) : boolean Gets a boolean flag that indicates whether proxy classes should always be regenerated during each script execution.
getClassMetadataFactoryName ( ) : string
getEntityNamespace ( string $entityNamespaceAlias ) : string Resolves a registered namespace alias to the full namespace.
getMarshallerClassName ( ) : Doctrine\OXM\Marshaller\Marshaller
getMetadataCacheImpl ( ) : Doctrine\Common\Cache\Cache Gets the cache driver implementation that is used for metadata caching.
getMetadataDriverImpl ( ) : Doctrine\OXM\Mapping\Driver\Driver Gets the cache driver implementation that is used for the mapping metadata.
getProxyDir ( ) : string Gets the directory where Doctrine generates any necessary proxy class files.
getProxyNamespace ( ) : string Gets the namespace where proxy classes reside.
newDefaultAnnotationDriver ( array $paths = [] ) : AnnotationDriver Add a new default annotation driver with a correctly configured annotation reader.
setAutoGenerateProxyClasses ( boolean $bool ) Sets a boolean flag that indicates whether proxy classes should always be regenerated during each script execution.
setClassMetadataFactoryName ( $cmfName ) Set a class metadata factory.
setEntityNamespaces ( array $entityNamespaces ) : void Set the entity alias map
setMarshallerClassName ( string $marshallerClassName ) : void
setMetadataCacheImpl ( Doctrine\Common\Cache\Cache $cacheImpl ) Sets the cache driver implementation that is used for metadata caching.
setMetadataDriverImpl ( Doctrine\OXM\Mapping\Driver\Driver $driverImpl ) Sets the cache driver implementation that is used for metadata caching.
setProxyDir ( string $dir ) Sets the directory where Doctrine generates any necessary proxy class files.
setProxyNamespace ( string $ns ) Sets the namespace where proxy classes reside.

Method Details

ensureProductionSettings() public method

Ensures that this Configuration instance contains settings that are suitable for a production environment.
public ensureProductionSettings ( )

getAutoGenerateProxyClasses() public method

Gets a boolean flag that indicates whether proxy classes should always be regenerated during each script execution.
public getAutoGenerateProxyClasses ( ) : boolean
return boolean

getClassMetadataFactoryName() public method

public getClassMetadataFactoryName ( ) : string
return string

getEntityNamespace() public method

Resolves a registered namespace alias to the full namespace.
public getEntityNamespace ( string $entityNamespaceAlias ) : string
$entityNamespaceAlias string
return string

getMarshallerClassName() public method

public getMarshallerClassName ( ) : Doctrine\OXM\Marshaller\Marshaller
return Doctrine\OXM\Marshaller\Marshaller

getMetadataCacheImpl() public method

Gets the cache driver implementation that is used for metadata caching.
public getMetadataCacheImpl ( ) : Doctrine\Common\Cache\Cache
return Doctrine\Common\Cache\Cache

getMetadataDriverImpl() public method

Gets the cache driver implementation that is used for the mapping metadata.
public getMetadataDriverImpl ( ) : Doctrine\OXM\Mapping\Driver\Driver
return Doctrine\OXM\Mapping\Driver\Driver

getProxyDir() public method

Gets the directory where Doctrine generates any necessary proxy class files.
public getProxyDir ( ) : string
return string

getProxyNamespace() public method

Gets the namespace where proxy classes reside.
public getProxyNamespace ( ) : string
return string

newDefaultAnnotationDriver() public method

Add a new default annotation driver with a correctly configured annotation reader.
public newDefaultAnnotationDriver ( array $paths = [] ) : AnnotationDriver
$paths array
return Doctrine\OXM\Mapping\Driver\AnnotationDriver

setAutoGenerateProxyClasses() public method

Sets a boolean flag that indicates whether proxy classes should always be regenerated during each script execution.
public setAutoGenerateProxyClasses ( boolean $bool )
$bool boolean

setClassMetadataFactoryName() public method

Set a class metadata factory.
public setClassMetadataFactoryName ( $cmfName )

setEntityNamespaces() public method

Set the entity alias map
public setEntityNamespaces ( array $entityNamespaces ) : void
$entityNamespaces array
return void

setMarshallerClassName() public method

public setMarshallerClassName ( string $marshallerClassName ) : void
$marshallerClassName string
return void

setMetadataCacheImpl() public method

Sets the cache driver implementation that is used for metadata caching.
public setMetadataCacheImpl ( Doctrine\Common\Cache\Cache $cacheImpl )
$cacheImpl Doctrine\Common\Cache\Cache

setMetadataDriverImpl() public method

Sets the cache driver implementation that is used for metadata caching.
public setMetadataDriverImpl ( Doctrine\OXM\Mapping\Driver\Driver $driverImpl )
$driverImpl Doctrine\OXM\Mapping\Driver\Driver

setProxyDir() public method

Sets the directory where Doctrine generates any necessary proxy class files.
public setProxyDir ( string $dir )
$dir string

setProxyNamespace() public method

Sets the namespace where proxy classes reside.
public setProxyNamespace ( string $ns )
$ns string

Property Details

$attributes protected property

Values are default values.
protected array $attributes
return array