[DI] Add a base class for extension
This commit is contained in:
parent
8968bd0e03
commit
57e9d28795
@ -1,6 +1,12 @@
|
|||||||
CHANGELOG
|
CHANGELOG
|
||||||
=========
|
=========
|
||||||
|
|
||||||
|
2.2.0
|
||||||
|
-----
|
||||||
|
|
||||||
|
* added an Extension base class with sensible defaults to be used in conjunction
|
||||||
|
with the Config component.
|
||||||
|
|
||||||
2.1.0
|
2.1.0
|
||||||
-----
|
-----
|
||||||
|
|
||||||
|
@ -0,0 +1,107 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/*
|
||||||
|
* This file is part of the Symfony package.
|
||||||
|
*
|
||||||
|
* (c) Fabien Potencier <fabien@symfony.com>
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view the LICENSE
|
||||||
|
* file that was distributed with this source code.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Symfony\Component\DependencyInjection\Extension;
|
||||||
|
|
||||||
|
use Symfony\Component\DependencyInjection\Container;
|
||||||
|
use Symfony\Component\Config\Resource\FileResource;
|
||||||
|
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
||||||
|
use Symfony\Component\Config\Definition\Processor;
|
||||||
|
use Symfony\Component\Config\Definition\ConfigurationInterface;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides useful features shared by many extensions.
|
||||||
|
*
|
||||||
|
* @author Fabien Potencier <fabien@symfony.com>
|
||||||
|
*/
|
||||||
|
abstract class Extension implements ExtensionInterface, ConfigurationExtensionInterface
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Returns the base path for the XSD files.
|
||||||
|
*
|
||||||
|
* @return string The XSD base path
|
||||||
|
*/
|
||||||
|
public function getXsdValidationBasePath()
|
||||||
|
{
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the namespace to be used for this extension (XML namespace).
|
||||||
|
*
|
||||||
|
* @return string The XML namespace
|
||||||
|
*/
|
||||||
|
public function getNamespace()
|
||||||
|
{
|
||||||
|
return 'http://example.org/schema/dic/'.$this->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 string The alias
|
||||||
|
*
|
||||||
|
* @throws \BadMethodCallException When the extension name does not follow conventions
|
||||||
|
*/
|
||||||
|
public function getAlias()
|
||||||
|
{
|
||||||
|
$className = get_class($this);
|
||||||
|
if (substr($className, -9) != 'Extension') {
|
||||||
|
throw new \BadMethodCallException('This extension does not follow the naming convention; you must overwrite the getAlias() method.');
|
||||||
|
}
|
||||||
|
$classBaseName = substr(strrchr($className, '\\'), 1, -9);
|
||||||
|
|
||||||
|
return Container::underscore($classBaseName);
|
||||||
|
}
|
||||||
|
|
||||||
|
final protected function processConfiguration(ConfigurationInterface $configuration, array $configs)
|
||||||
|
{
|
||||||
|
$processor = new Processor();
|
||||||
|
|
||||||
|
return $processor->processConfiguration($configuration, $configs);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritDoc}
|
||||||
|
*/
|
||||||
|
public function getConfiguration(array $config, ContainerBuilder $container)
|
||||||
|
{
|
||||||
|
$reflected = new \ReflectionClass($this);
|
||||||
|
$namespace = $reflected->getNamespaceName();
|
||||||
|
|
||||||
|
$class = $namespace . '\\Configuration';
|
||||||
|
if (class_exists($class)) {
|
||||||
|
$r = new \ReflectionClass($class);
|
||||||
|
$container->addResource(new FileResource($r->getFileName()));
|
||||||
|
|
||||||
|
if (!method_exists($class, '__construct')) {
|
||||||
|
$configuration = new $class();
|
||||||
|
|
||||||
|
return $configuration;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
@ -11,20 +11,14 @@
|
|||||||
|
|
||||||
namespace Symfony\Component\HttpKernel\DependencyInjection;
|
namespace Symfony\Component\HttpKernel\DependencyInjection;
|
||||||
|
|
||||||
use Symfony\Component\Config\Definition\Processor;
|
use Symfony\Component\DependencyInjection\Extension\Extension as BaseExtension;
|
||||||
use Symfony\Component\Config\Resource\FileResource;
|
|
||||||
use Symfony\Component\Config\Definition\ConfigurationInterface;
|
|
||||||
use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
|
|
||||||
use Symfony\Component\DependencyInjection\Extension\ConfigurationExtensionInterface;
|
|
||||||
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
|
||||||
use Symfony\Component\DependencyInjection\Container;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Provides useful features shared by many extensions.
|
* Allow adding classes to the class cache.
|
||||||
*
|
*
|
||||||
* @author Fabien Potencier <fabien@symfony.com>
|
* @author Fabien Potencier <fabien@symfony.com>
|
||||||
*/
|
*/
|
||||||
abstract class Extension implements ExtensionInterface, ConfigurationExtensionInterface
|
abstract class Extension extends BaseExtension
|
||||||
{
|
{
|
||||||
private $classes = array();
|
private $classes = array();
|
||||||
|
|
||||||
@ -47,85 +41,4 @@ abstract class Extension implements ExtensionInterface, ConfigurationExtensionIn
|
|||||||
{
|
{
|
||||||
$this->classes = array_merge($this->classes, $classes);
|
$this->classes = array_merge($this->classes, $classes);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the base path for the XSD files.
|
|
||||||
*
|
|
||||||
* @return string The XSD base path
|
|
||||||
*/
|
|
||||||
public function getXsdValidationBasePath()
|
|
||||||
{
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the namespace to be used for this extension (XML namespace).
|
|
||||||
*
|
|
||||||
* @return string The XML namespace
|
|
||||||
*/
|
|
||||||
public function getNamespace()
|
|
||||||
{
|
|
||||||
return 'http://example.org/schema/dic/'.$this->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 string The alias
|
|
||||||
*
|
|
||||||
* @throws \BadMethodCallException When the extension name does not follow conventions
|
|
||||||
*/
|
|
||||||
public function getAlias()
|
|
||||||
{
|
|
||||||
$className = get_class($this);
|
|
||||||
if (substr($className, -9) != 'Extension') {
|
|
||||||
throw new \BadMethodCallException('This extension does not follow the naming convention; you must overwrite the getAlias() method.');
|
|
||||||
}
|
|
||||||
$classBaseName = substr(strrchr($className, '\\'), 1, -9);
|
|
||||||
|
|
||||||
return Container::underscore($classBaseName);
|
|
||||||
}
|
|
||||||
|
|
||||||
final protected function processConfiguration(ConfigurationInterface $configuration, array $configs, $normalizeKeys = true)
|
|
||||||
{
|
|
||||||
$processor = new Processor();
|
|
||||||
|
|
||||||
return $processor->processConfiguration($configuration, $configs, $normalizeKeys);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* {@inheritDoc}
|
|
||||||
*/
|
|
||||||
public function getConfiguration(array $config, ContainerBuilder $container)
|
|
||||||
{
|
|
||||||
$reflected = new \ReflectionClass($this);
|
|
||||||
$namespace = $reflected->getNamespaceName();
|
|
||||||
|
|
||||||
$class = $namespace . '\\Configuration';
|
|
||||||
if (class_exists($class)) {
|
|
||||||
$r = new \ReflectionClass($class);
|
|
||||||
$container->addResource(new FileResource($r->getFileName()));
|
|
||||||
|
|
||||||
if (!method_exists($class, '__construct')) {
|
|
||||||
$configuration = new $class();
|
|
||||||
|
|
||||||
return $configuration;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user