AbstractDoctrineExtension
class AbstractDoctrineExtension extends Extension
This abstract classes groups common code that Doctrine Object Manager extensions (ORM, MongoDB, CouchDB) need.
Methods
| string | getXsdValidationBasePath() Returns the base path for the XSD files. | from Extension |
| string | getNamespace() Returns the namespace to be used for this extension (XML namespace). | from Extension |
| string | getAlias() Returns the recommended alias to use in XML. | from Extension |
| ConfigurationInterface|null | getConfiguration(array $config, ContainerBuilder $container) Returns extension configuration. | from Extension |
| array | getClassesToCompile() Gets the classes to cache. | from Extension |
| addClassesToCompile(array $classes) Adds classes to the class cache. | from Extension |
Details
string getXsdValidationBasePath()
Returns the base path for the XSD files.
Return Value
| string | The XSD base path |
string getNamespace()
Returns the namespace to be used for this extension (XML namespace).
Return Value
| string | The XML namespace |
string getAlias()
Returns the recommended alias to use in XML.
This alias is also the mandatory prefix to use when using YAML.
This convention is to remove the "Extension" postfix from the class name and then lowercase and underscore the result. So:
AcmeHelloExtension
becomes
acme_hello
This can be overridden in a sub-class to specify the alias manually.
Return Value
| string | The alias |
Exceptions
| BadMethodCallException | When the extension name does not follow conventions |
ConfigurationInterface|null getConfiguration(array $config, ContainerBuilder $container)
Returns extension configuration.
Parameters
| array | $config | |
| ContainerBuilder | $container |
Return Value
| ConfigurationInterface|null | The configuration or null |
array getClassesToCompile()
Gets the classes to cache.
Return Value
| array | An array of classes |
addClassesToCompile(array $classes)
Adds classes to the class cache.
Parameters
| array | $classes | An array of classes |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Bridge/Doctrine/DependencyInjection/AbstractDoctrineExtension.html