PHP Class Doctrine\ODM\MongoDB\Configuration

If you do not pass a configuration object, a blank one will be created for you.
Since: 1.0
Inheritance: extends Doctrine\MongoDB\Configuration
Show file Open project: pmjones/php-framework-benchmarks Class Usage Examples

Public Methods

Method Description
addDocumentNamespace ( string $alias, string $namespace ) Adds a namespace under a certain alias.
getAutoGenerateProxyClasses ( ) : boolean Gets a boolean flag that indicates whether proxy classes should always be regenerated during each script execution.
getDatabasePrefix ( ) : string Get prefix for db name
getDatabaseSuffix ( ) : string Get suffix for db name
getDefaultDB ( ) : string Gets the default DB to use for all Documents that do not specify a database.
getDocumentNamespace ( string $documentNamespaceAlias ) : string Resolves a registered namespace alias to the full namespace.
getEnvironment ( ) : string Gets the environment
getEnvironmentPrefix ( ) : string Gets prefix for environment
getMetadataCacheImpl ( ) : Doctrine\Common\Cache\Cache Gets the cache driver implementation that is used for metadata caching.
getMetadataDriverImpl ( ) : Doctrine\ODM\MongoDB\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.
setDBPrefix ( string $prefix = null ) Set prefix for db name
setDBSuffix ( string $suffix = null ) Set suffix for db name
setDefaultDB ( string $defaultDB ) Sets the default DB to use for all Documents that do not specify a database.
setDocumentNamespaces ( array $documentNamespaces ) : void Set the document alias map
setEnvironment ( string $environment ) Sets the environment
setMetadataCacheImpl ( Doctrine\Common\Cache\Cache $cacheImpl ) Sets the cache driver implementation that is used for metadata caching.
setMetadataDriverImpl ( Doctrine\ODM\MongoDB\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

addDocumentNamespace() public method

Adds a namespace under a certain alias.
public addDocumentNamespace ( string $alias, string $namespace )
$alias string
$namespace string

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

getDatabasePrefix() public method

Get prefix for db name
public getDatabasePrefix ( ) : string
return string

getDatabaseSuffix() public method

Get suffix for db name
public getDatabaseSuffix ( ) : string
return string

getDefaultDB() public method

Gets the default DB to use for all Documents that do not specify a database.
public getDefaultDB ( ) : string
return string $defaultDB

getDocumentNamespace() public method

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

getEnvironment() public method

Gets the environment
public getEnvironment ( ) : string
return string $environment

getEnvironmentPrefix() public method

Gets prefix for environment
public getEnvironmentPrefix ( ) : string
return string $envPrefix

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\ODM\MongoDB\Mapping\Driver\Driver
return Doctrine\ODM\MongoDB\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\ODM\MongoDB\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

setDBPrefix() public method

Set prefix for db name
public setDBPrefix ( string $prefix = null )
$prefix string The prefix for names of databases

setDBSuffix() public method

Set suffix for db name
public setDBSuffix ( string $suffix = null )
$suffix string The suffix for names of tables

setDefaultDB() public method

Sets the default DB to use for all Documents that do not specify a database.
public setDefaultDB ( string $defaultDB )
$defaultDB string

setDocumentNamespaces() public method

Set the document alias map
public setDocumentNamespaces ( array $documentNamespaces ) : void
$documentNamespaces array
return void

setEnvironment() public method

Sets the environment
public setEnvironment ( string $environment )
$environment string

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\ODM\MongoDB\Mapping\Driver\Driver $driverImpl )
$driverImpl Doctrine\ODM\MongoDB\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