class Configuration (View source)

Configuration class

Methods

setUUIDGenerationBufferSize(integer $UUIDGenerationBufferSize)

Sets the default UUID Generator buffer size

integer
getUUIDGenerationBufferSize()

Gets the default UUID Generator buffer size

setValidateDoctrineMetadata(boolean $validateDoctrineMetadata)

Sets if all CouchDB document metadata should be validated on read

boolean
getValidateDoctrineMetadata()

Gets if all CouchDB document metadata should be validated on read

addDocumentNamespace(string $alias, string $namespace)

Adds a namespace under a certain alias.

string
getDocumentNamespace(string $documentNamespaceAlias)

Resolves a registered namespace alias to the full namespace.

void
setDocumentNamespaces(array $documentNamespaces)

Set the document alias map

setMetadataDriverImpl(MappingDriver $driverImpl)

Sets the cache driver implementation that is used for metadata caching.

newDefaultAnnotationDriver(array $paths = array())

Add a new default annotation driver with a correctly configured annotation reader.

setMetadataResolverImpl(MetadataResolver $resolver)

No description

getMetadataResolverImpl()

No description

MappingDriver
getMetadataDriverImpl()

Gets the cache driver implementation that is used for the mapping metadata.

Cache
getMetadataCacheImpl()

Gets the cache driver implementation that is used for metadata caching.

setMetadataCacheImpl(Cache $cacheImpl)

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.

string
getProxyDir()

Gets the directory where Doctrine generates any necessary proxy class files.

setProxyNamespace(string $namespace)

Sets the namespace for Doctrine proxy class files.

string
getProxyNamespace()

Gets the namespace for Doctrine proxy class files.

setAutoGenerateProxyClasses($bool)

No description

getAutoGenerateProxyClasses()

No description

addDesignDocument(string $name, string $className, array $options)

No description

array
getDesignDocumentNames()

No description

array
getDesignDocument(string $name)

No description

setAllOrNothingFlush(bool $allOrNothing)

No description

bool
getAllOrNothingFlush()

No description

setLuceneHandlerName($handlerName = '_fti')

No description

getLuceneHandlerName()

No description

NullMigration;
getMigrations()

No description

setMigrations(DocumentMigration $migration)

No description

Details

setUUIDGenerationBufferSize(integer $UUIDGenerationBufferSize)

Sets the default UUID Generator buffer size

Parameters

integer $UUIDGenerationBufferSize

integer getUUIDGenerationBufferSize()

Gets the default UUID Generator buffer size

Return Value

integer

setValidateDoctrineMetadata(boolean $validateDoctrineMetadata)

Sets if all CouchDB document metadata should be validated on read

Parameters

boolean $validateDoctrineMetadata

boolean getValidateDoctrineMetadata()

Gets if all CouchDB document metadata should be validated on read

Return Value

boolean

addDocumentNamespace(string $alias, string $namespace)

Adds a namespace under a certain alias.

Parameters

string $alias
string $namespace

string getDocumentNamespace(string $documentNamespaceAlias)

Resolves a registered namespace alias to the full namespace.

Parameters

string $documentNamespaceAlias

Return Value

string

Exceptions

CouchDBException

void setDocumentNamespaces(array $documentNamespaces)

Set the document alias map

Parameters

array $documentNamespaces

Return Value

void

setMetadataDriverImpl(MappingDriver $driverImpl)

Sets the cache driver implementation that is used for metadata caching.

Parameters

MappingDriver $driverImpl

AnnotationDriver newDefaultAnnotationDriver(array $paths = array())

Add a new default annotation driver with a correctly configured annotation reader.

Parameters

array $paths

Return Value

AnnotationDriver

setMetadataResolverImpl(MetadataResolver $resolver)

Parameters

MetadataResolver $resolver

getMetadataResolverImpl()

MappingDriver getMetadataDriverImpl()

Gets the cache driver implementation that is used for the mapping metadata.

Return Value

MappingDriver

Cache getMetadataCacheImpl()

Gets the cache driver implementation that is used for metadata caching.

Return Value

Cache

setMetadataCacheImpl(Cache $cacheImpl)

Sets the cache driver implementation that is used for metadata caching.

Parameters

Cache $cacheImpl

setProxyDir(string $dir)

Sets the directory where Doctrine generates any necessary proxy class files.

Parameters

string $dir

string getProxyDir()

Gets the directory where Doctrine generates any necessary proxy class files.

Return Value

string

setProxyNamespace(string $namespace)

Sets the namespace for Doctrine proxy class files.

Parameters

string $namespace

string getProxyNamespace()

Gets the namespace for Doctrine proxy class files.

Return Value

string

setAutoGenerateProxyClasses($bool)

Parameters

$bool

getAutoGenerateProxyClasses()

addDesignDocument(string $name, string $className, array $options)

Parameters

string $name
string $className
array $options

array getDesignDocumentNames()

Return Value

array

array getDesignDocument(string $name)

Parameters

string $name

Return Value

array

setAllOrNothingFlush(bool $allOrNothing)

Parameters

bool $allOrNothing

bool getAllOrNothingFlush()

Return Value

bool

setLuceneHandlerName($handlerName = '_fti')

Parameters

$handlerName

getLuceneHandlerName()

NullMigration; getMigrations()

Return Value

NullMigration;

setMigrations(DocumentMigration $migration)

Parameters

DocumentMigration $migration