class Configuration (View source)

Configuration class.

Methods

setValidateDoctrineMetadata(bool $validateDoctrineMetadata)

Sets if all PHPCR document metadata should be validated on read.

bool
getValidateDoctrineMetadata()

Gets if all PHPCR document metadata should be validated on read.

setWriteDoctrineMetadata(bool $writeDoctrineMetadata)

Sets if all PHPCR documents should automatically get doctrine metadata added on write.

bool
getWriteDoctrineMetadata()

Gets if all PHPCR documents should automatically get doctrine metadata added on write.

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.

setDocumentNamespaces(array $documentNamespaces)

Set the document alias map.

setMetadataDriverImpl(MappingDriver $driverImpl, $useBuildInDocumentsDriver = true)

Sets the driver implementation that is used to retrieve mapping metadata.

MappingDriver
getMetadataDriverImpl()

Gets the driver implementation that is used to retrieve mapping metadata.

setMetadataCacheImpl(Cache $metadataCacheImpl)

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

Cache|null
getMetadataCacheImpl()

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

getDocumentClassMapper()

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

setDocumentClassMapper(DocumentClassMapperInterface $documentClassMapper)

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 $bool)

Sets a boolean flag that indicates whether proxy classes should always be regenerated during each script execution.

bool
getAutoGenerateProxyClasses()

Gets a boolean flag that indicates whether proxy classes should always be regenerated during each script execution.

void
setClassMetadataFactoryName(string $cmfName)

Sets a class metadata factory.

string
getClassMetadataFactoryName()

No description

void
setDefaultRepositoryClassName(string $className)

Sets default repository class.

string
getDefaultRepositoryClassName()

Get default repository class.

setRepositoryFactory(RepositoryFactory $repositoryFactory)

Set the document repository factory.

getRepositoryFactory()

Get the document repository factory.

setUuidGenerator(Closure $generator)

Set the closure for the UUID generation.

callable
getUuidGenerator()

Get the closure for the UUID generation.

Details

setValidateDoctrineMetadata(bool $validateDoctrineMetadata)

Sets if all PHPCR document metadata should be validated on read.

Parameters

bool $validateDoctrineMetadata

bool getValidateDoctrineMetadata()

Gets if all PHPCR document metadata should be validated on read.

Return Value

bool

setWriteDoctrineMetadata(bool $writeDoctrineMetadata)

Sets if all PHPCR documents should automatically get doctrine metadata added on write.

Parameters

bool $writeDoctrineMetadata

bool getWriteDoctrineMetadata()

Gets if all PHPCR documents should automatically get doctrine metadata added on write.

Return Value

bool

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 the namespace URI

Exceptions

PHPCRException

setDocumentNamespaces(array $documentNamespaces)

Set the document alias map.

Parameters

array $documentNamespaces

setMetadataDriverImpl(MappingDriver $driverImpl, $useBuildInDocumentsDriver = true)

Sets the driver implementation that is used to retrieve mapping metadata.

Parameters

MappingDriver $driverImpl
$useBuildInDocumentsDriver

MappingDriver getMetadataDriverImpl()

Gets the driver implementation that is used to retrieve mapping metadata.

Return Value

MappingDriver

setMetadataCacheImpl(Cache $metadataCacheImpl)

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

Parameters

Cache $metadataCacheImpl

Cache|null getMetadataCacheImpl()

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

Return Value

Cache|null

DocumentClassMapperInterface getDocumentClassMapper()

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

setDocumentClassMapper(DocumentClassMapperInterface $documentClassMapper)

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

Parameters

DocumentClassMapperInterface $documentClassMapper

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 $bool)

Sets a boolean flag that indicates whether proxy classes should always be regenerated during each script execution.

Parameters

bool $bool

bool getAutoGenerateProxyClasses()

Gets a boolean flag that indicates whether proxy classes should always be regenerated during each script execution.

Return Value

bool

void setClassMetadataFactoryName(string $cmfName)

Sets a class metadata factory.

Parameters

string $cmfName

Return Value

void

string getClassMetadataFactoryName()

Return Value

string

void setDefaultRepositoryClassName(string $className)

Sets default repository class.

Parameters

string $className

Return Value

void

Exceptions

PHPCRException If not is a ObjectRepository

string getDefaultRepositoryClassName()

Get default repository class.

Return Value

string

setRepositoryFactory(RepositoryFactory $repositoryFactory)

Set the document repository factory.

Parameters

RepositoryFactory $repositoryFactory

RepositoryFactory getRepositoryFactory()

Get the document repository factory.

Return Value

RepositoryFactory

setUuidGenerator(Closure $generator)

Set the closure for the UUID generation.

Parameters

Closure $generator

callable getUuidGenerator()

Get the closure for the UUID generation.

Return Value

callable a UUID generator