Class:Configuration - Superclass: Doctrine Doctrine
⌊ Configuration
public class Configuration
extends Doctrine
| Constructor Summary | |
|---|---|
Creates a new configuration that can be used for Doctrine. |
|
| Method Summary | |
|---|---|
| void | addCustomDatetimeFunction(string name, string className) Registers a custom DQL function that produces a date/time value. |
| void | addCustomNumericFunction(string name, string className) Registers a custom DQL function that produces a numeric value. |
| void | addCustomStringFunction(string name, string className) Registers a custom DQL function that produces a string value. |
| void | addEntityNamespace(string alias, string namespace) Adds a namespace under a certain alias. |
| void | addNamedNativeQuery(string name, string sql, ResultSetMapping rsm) Adds a named native query to the configuration. |
| void | addNamedQuery(string name, string dql) Adds a named DQL query to the configuration. |
| void | Ensures that this Configuration instance contains settings that are suitable for a production environment. |
| boolean | Gets a boolean flag that indicates whether proxy classes should always be regenerated during each script execution. |
| string | getCustomDatetimeFunction(string name) Gets the implementation class name of a registered custom date/time DQL function. |
| string | getCustomNumericFunction(string name) Gets the implementation class name of a registered custom numeric DQL function. |
| string | getCustomStringFunction(string name) Gets the implementation class name of a registered custom string DQL function. |
| string | getEntityNamespace(string entityNamespaceAlias) Resolves a registered namespace alias to the full namespace. |
| \Doctrine\Common\Cache\Cache | Gets the cache driver implementation that is used for metadata caching. |
| Mapping\Driver\Driver | Gets the cache driver implementation that is used for the mapping metadata. |
| array | getNamedNativeQuery(string name) Gets the components of a previously registered named native query. |
| string | getNamedQuery(string name) Gets a previously registered named DQL query. |
| string | Gets the directory where Doctrine generates any necessary proxy class files. |
| string | Gets the namespace where proxy classes reside. |
| \Doctrine\Common\Cache\Cache | Gets the cache driver implementation that is used for the query cache (SQL cache). |
| \Doctrine\Common\Cache\Cache | Gets the cache driver implementation that is used for query result caching. |
| boolean | Gets a boolean flag that indicates whether Doctrine should make use of the C extension. |
| Mapping\Driver\AnnotationDriver | newDefaultAnnotationDriver(array paths) Add a new default annotation driver with a correctly configured annotation reader. |
| void | setAutoGenerateProxyClasses(boolean bool) Sets a boolean flag that indicates whether proxy classes should always be regenerated during each script execution. |
| void | setEntityNamespaces(mixed entityNamespaces, array entityAliasMap) Set the entity alias map |
| void | setMetadataCacheImpl(\Doctrine\Common\Cache\Cache cacheImpl) Sets the cache driver implementation that is used for metadata caching. |
| void | setMetadataDriverImpl(Driver driverImpl) Sets the cache driver implementation that is used for metadata caching. |
| void | setProxyDir(string dir) Sets the directory where Doctrine generates any necessary proxy class files. |
| void | setProxyNamespace(string ns) Sets the namespace where proxy classes reside. |
| void | setQueryCacheImpl(\Doctrine\Common\Cache\Cache cacheImpl) Sets the cache driver implementation that is used for the query cache (SQL cache). |
| void | setResultCacheImpl(\Doctrine\Common\Cache\Cache cacheImpl) Sets the cache driver implementation that is used for query result caching. |
| void | setUseCExtension(boolean boolean) Sets a boolean flag that indicates whether Doctrine should make use of the C extension. |
public Configuration()
Creates a new configuration that can be used for Doctrine.
public void addCustomDatetimeFunction(string name, string className)
Registers a custom DQL function that produces a date/time value. Such a function can then be used in any DQL statement in any place where date/time functions are allowed.
public void addCustomNumericFunction(string name, string className)
Registers a custom DQL function that produces a numeric value. Such a function can then be used in any DQL statement in any place where numeric functions are allowed.
public void addCustomStringFunction(string name, string className)
Registers a custom DQL function that produces a string value. Such a function can then be used in any DQL statement in any place where string functions are allowed.
public void addEntityNamespace(string alias, string namespace)
Adds a namespace under a certain alias.
public void addNamedNativeQuery(string name, string sql, ResultSetMapping rsm)
Adds a named native query to the configuration.
public void addNamedQuery(string name, string dql)
Adds a named DQL query to the configuration.
public void ensureProductionSettings()
Ensures that this Configuration instance contains settings that are suitable for a production environment.
public boolean getAutoGenerateProxyClasses()
Gets a boolean flag that indicates whether proxy classes should always be regenerated during each script execution.
public string getCustomDatetimeFunction(string name)
Gets the implementation class name of a registered custom date/time DQL function.
public string getCustomNumericFunction(string name)
Gets the implementation class name of a registered custom numeric DQL function.
public string getCustomStringFunction(string name)
Gets the implementation class name of a registered custom string DQL function.
public string getEntityNamespace(string entityNamespaceAlias)
Resolves a registered namespace alias to the full namespace.
public \Doctrine\Common\Cache\Cache getMetadataCacheImpl()
Gets the cache driver implementation that is used for metadata caching.
public Mapping\Driver\Driver getMetadataDriverImpl()
Gets the cache driver implementation that is used for the mapping metadata.
public array getNamedNativeQuery(string name)
Gets the components of a previously registered named native query.
public string getNamedQuery(string name)
Gets a previously registered named DQL query.
public string getProxyDir()
Gets the directory where Doctrine generates any necessary proxy class files.
public string getProxyNamespace()
Gets the namespace where proxy classes reside.
public \Doctrine\Common\Cache\Cache getQueryCacheImpl()
Gets the cache driver implementation that is used for the query cache (SQL cache).
public \Doctrine\Common\Cache\Cache getResultCacheImpl()
Gets the cache driver implementation that is used for query result caching.
public boolean getUseCExtension()
Gets a boolean flag that indicates whether Doctrine should make use of the C extension.
public Mapping\Driver\AnnotationDriver newDefaultAnnotationDriver(array paths)
Add a new default annotation driver with a correctly configured annotation reader.
public void setAutoGenerateProxyClasses(boolean bool)
Sets a boolean flag that indicates whether proxy classes should always be regenerated during each script execution.
public void setEntityNamespaces(mixed entityNamespaces, array entityAliasMap)
Set the entity alias map
public void setMetadataCacheImpl(\Doctrine\Common\Cache\Cache cacheImpl)
Sets the cache driver implementation that is used for metadata caching.
public void setMetadataDriverImpl(Driver driverImpl)
Sets the cache driver implementation that is used for metadata caching.
public void setProxyDir(string dir)
Sets the directory where Doctrine generates any necessary proxy class files.
public void setProxyNamespace(string ns)
Sets the namespace where proxy classes reside.
public void setQueryCacheImpl(\Doctrine\Common\Cache\Cache cacheImpl)
Sets the cache driver implementation that is used for the query cache (SQL cache).
public void setResultCacheImpl(\Doctrine\Common\Cache\Cache cacheImpl)
Sets the cache driver implementation that is used for query result caching.
public void setUseCExtension(boolean boolean)
Sets a boolean flag that indicates whether Doctrine should make use of the C extension.
Configuration container for all configuration options of Doctrine. It combines all configuration options from DBAL & ORM.