Symfony 2: конфигурирование пакетов

• YAML

  # app/config/config.yml
  parameters:
      hello.email.from: fabien@example.com

• XML

  <!-- app/config/config.xml -->
  <parameters>
      <parameter key="hello.email.from">fabien@example.com</parameter>
  </parameters>

• PHP

  // app/config/config.php
  $container->setParameter('hello.email.from', 'fabien@example.com');

• INI

  [parameters]
  hello.email.from = fabien@example.com

Создание расширения (Extension)

Для того чтобы использовать семантическую конфигурацию, создайте расширение Dependency Injection, которое наследуется от Extension:

// HelloBundle/DependencyInjection/HelloExtension.php
use SymfonyComponentDependencyInjectionExtensionExtension;

class HelloExtension extends Extension
{
    public function configLoad($config, ContainerBuilder $container)
    {
        // ...
    }

    public function getXsdValidationBasePath()
    {
        return __DIR__.'/../Resources/config/';
    }

    public function getNamespace()
    {
        return 'http://www.example.com/symfony/schema/';
    }

    public function getAlias()
    {
        return 'hello';
    }
}

Класс, описанный выше определяет пространство имен hello:config, доступное в любом конфигурационном файле:

Разбор конфигурации

Всякий раз, когда пользователь включает пространство имен hello.config в конфигурационный файл, вызывается метод configLoad() вашего расширения и конфигурация передается в виде массива (Symfony2 автоматически конвертирует XML и YAML в массивы).

Итак, мы имеем следующую конфигурацию:

Массив, который будет передаваться в ваш метод будет таким:

array(
    'foo' => 'foo',
    'bar' => 'bar',
)

Внутри метода configLoad() переменная $container ссылается на контейнер, который знает лишь об этом пространстве имен. Вы можете манипулировать добавлением сервисов и параметров в нужном вам направлении. Когда метод вызывается первый раз, контейнер знает лишь о глобальных параметрах. При последующих вызовах он содержит конфигурацию, определенную предыдущими вызовами. Таким образом метод должен объединить новые настройки со старыми:

// only load default services and parameters once
if (!$container->hasDefinition('xxxxx')) {
    $loader = new XmlFileLoader($container, __DIR__.'/../Resources/config');
    $loader->load('hello.xml');
}

Глобальные параметры:

• kernel.name
• kernel.environment
• kernel.debug
• kernel.root_dir
• kernel.cache_dir
• kernel.logs_dir
• kernel.bundle_dirs
• kernel.bundles
• kernel.charset

Соглашения по созданию расширений

При создании расширения следуйте этим простым соглашениям:

• Расширение должно находиться во вложенном пространстве имен DependencyInjection;
• Расширение должно именоваться при помощи наименования пакета и завершаться суффиксом Extension (HelloExtension для HelloBundle) – если же вы создаете несколько расширений для одного пакета, просто завершайте их суффиксом Extension;
• Алиас должен быть уникальным и должен именоваться также при помощи наименования пакета (hello для HelloBundle или sensio.social.blog для SensioSocialBlogBundle);
• Расширение должно содержать XSD схему.

Если вы последуете этим рекомендациям, то ваше расширение автоматически будет зарегистрировано Symfony2. Если этого не произошло, переопределите метод пакета registerExtensions():

class HelloBundle extends Bundle
{
    public function registerExtensions(ContainerBuilder $container)
    {
        // register the extension(s) found in DependencyInjection/ directory
        parent::registerExtensions($container);

        // register extensions that do not follow the conventions manually
        $container->registerExtension(new ExtensionHello());
    }
}

Конфигурация по-умолчанию

Как определено ранее, пользователь пакета должен включить пространство имен hello.config в конфигурационный файл, для того чтобы вызывался код вашего расширения. Но вы также можете автоматически регистрировать конфигурацию по-умолчанию, переопределяя метод пакета registerExtensions():

class HelloBundle extends Bundle
{
    public function registerExtensions(ContainerBuilder $container)
    {
        // will register the HelloBundle extension(s) found in DependencyInjection/ directory
        parent::registerExtensions($container);

        // load some defaults
        $container->loadFromExtension('hello', 'config', array(/* your default config for the hello.config namespace */));
    }
}