Создание класса расширения

Для того, чтобы загружать конфигурацию сервисов, вам нужно создать Расширение внедрения зависимости (ВЗ) для вашего пакета. По умолчанию, класс Расширения должен следовать таким соглашениям (но позже вы узнаете, как их пропускать, если это необходимо):

• Он должен жить в пространстве имён DependencyInjection пакета;
• Он должен реализовывать ExtensionInterface, что обычно достигается путём расширения класса Extension ;
• Имя равняется имени пакета с суффиксом Bundle, заменённым на Extension (например класс расширения AcmeBundle будет называться AcmeExtension, а AcmeHelloBundle - AcmeHelloExtension).

Вот как должно выглядеть расширение AcmeHelloBundle:

1
2
3
4
5
6
7
8
9
10
11
12
13

// src/DependencyInjection/AcmeHelloExtension.php
namespace Acme\HelloBundle\DependencyInjection;

use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Extension\Extension;

class AcmeHelloExtension extends Extension
{
    public function load(array $configs, ContainerBuilder $container): void
    {
        // ... позднее вы будете загружать здесь файлы
    }
}

1
2
3
4
5
6
7
8
9
10
11

// ...
use Acme\HelloBundle\DependencyInjection\UnconventionalExtensionClass;
use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;

class AcmeHelloBundle extends Bundle
{
    public function getContainerExtension(): ?ExtensionInterface
    {
        return new UnconventionalExtensionClass();
    }
}

Использование метода load()

В методе load(), все сервисы и параметры относятся к загружаемому расширению. Этот метод получает не настоящий экземпляр контейнера, а копию. Контейнер имеет только параметры из настоящего контейнера. После загрузки сервисов и параметром, копия будет соединена с настоящим контейнером, чтобы убедитьс, что все сервисы и параметры также добавлены в него.

В методе load(), вы можете использовать PHP-код для регистрации определений сервиса, но чаще вы будете помещать эти определения в файл конфигурации (используя форматы YAML, XML или PHP).

Например, предположим, что у вас есть файл по имени services.xml в каталоге Resources/config/ вашего пакета, ваш метод load() выглядит так:

1
2
3
4
5
6
7
8
9
10
11
12

use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;

// ...
public function load(array $configs, ContainerBuilder $container): void
{
    $loader = new XmlFileLoader(
        $container,
        new FileLocator(__DIR__.'/../../config')
    );
    $loader->load('services.xml');
}

Другие доступные загрузчики - YamlFileLoader и PhpFileLoader.

Загрузка сервисов прямо в вашем классе пакета

Как вариант, вы можете определять и загружать конфигурацию сервисов прямо в классе пакета, вместо создания специального класса Extension. Вы можете сделать это путём расширения из AbstractBundle и определения метода loadExtension():

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

// ...
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
use Symfony\Component\HttpKernel\Bundle\AbstractBundle;

class AcmeHelloBundle extends AbstractBundle
{
    public function loadExtension(array $config, ContainerConfigurator $containerConfigurator, ContainerBuilder $containerBuilder): void
    {
        // загрузить файл XML, PHP или Yaml
        $container->import('../config/services.xml');

        // вы также можете добавить или заменить параметры и сервисы
        $container->parameters()
            ->set('acme_hello.phrase', $config['phrase'])
        ;

        if ($config['scream']) {
            $container->services()
                ->get('acme_hello.printer')
                    ->class(ScreamingPrinter::class)
            ;
        }
    }
}

Этот метод работает схоже с методом Extension::load(), но использует новый API для определения и импорта конфиуграции сервиса.

Добавление классов для компиляции

Пакеты могут намекать Symfony о том, какие из их классов содержат аннотации, чтобы они были скомпилированы при генерировании кеша приложения для улучшения общей производительности. Определите список классов с аннотациями для компиляции в методе addAnnotatedClassesToCompile():

1
2
3
4
5
6
7
8
9
10
11
12
13

public function load(array $configs, ContainerBuilder $container): void
{
    // ...

    $this->addAnnotatedClassesToCompile([
        // вы можете определить полностью квалифицированные имена класса...
        'Acme\\BlogBundle\\Controller\\AuthorController',
        // ... но глобальные паттерны также поддерживаются:
        'Acme\\BlogBundle\\Form\\**',

        // ...
    ]);
}

Схемы трансформируются в настоящие пространства имён классов, используя карту классов, сегенерированную Composer. Следовательно, до использования этих схем, вы должны сгенерировать полную карту классов, выполняющую команду Composer dump-autoload.