Как правильно конфигурировать сторонний бандл в своём?

Question

[grabbee]

Например LiipImagineBundle - у него много параметров нужно в его собственный конфиг прописать.

Я хочу сделать отдельный бандл в котором почти всё должно быть уже сконфигурировано.
Как это правильно сделать?

1. Импортировать файл конфига из своего бандла в приложение.
2. $container->prependExtensionConfig($name, $config);

Или как это вообще?

Comments

[grabbee]

Или если создать папку внутри бандла Resources/config/packages
Внутри нее прописать конфиги как в приложении для каждого бандла файл .yaml

Как это пачкой загрузить?

Answer 1

[Flying]

Переопределение конфигурации в Symfony вне основного процесса загрузки конфигурационных файлов - не самое простое дело. Этот процесс закрыт от прямой кастомизации т.к. основной процесс загрузки и обработки конфигурации bundles целиком отдан на откуп им самим. Причина подобных ограничений в том что загрузка конфигурации - один из самых ранних этапов работы и, как и для всех подобных частей кода - там довольно мало пространства для манёвров. В связи с этим путь (и сама возможность) переопределения конфигурации будет очень сильно зависеть от того что же именно вы хотите переопределить.

Для того чтобы лучше понять как это происходит - вам стоит подробнее изучить вопрос того как именно организована загрузка и обработка конфигурации в Symfony.

Если вкратце:

1. В процессе конфигурации контейнера происходит сбор данных конфигурации из конфигурационных файлов. Эти данные сохраняются в container'е через ContainerBuilder::loadFromExtension().
   
2. Далее, собранные данные передаются в качестве основы в bundle extension (через метод load()). То, как именно bundle extension будет работать с собранными данными - целиком зависит от кода bundle'а, так что в целом с ними может произойти всё что угодно.
   

Как вы, надеюсь, понимаете - из-за п.2 какого-то общего подхода к переопределению данных в Symfony не существует. Поэтому, как я уже писал выше, вам необходимо определиться с тем что именно вы хотите переопределить, а дальше смотреть на код загрузчика соответствующего bundle (вот он для LiipImagineBundle).

Как видно - в случае LiipImagineBundle в целом ничего страшного не происходит, полученная конфигурация сразу отправляется в processing и потом используется для регистрации сервисов и параметров.

Поскольку процесс сборки контейнера начинается с merge pass, то вы не можете вмешаться в этот процесс через compiler pass, как это делается обычно, однако вы можете воспользоваться вот этим куском логики для того чтобы добиться своей цели: вам достаточно определить в своём bundle собственный extension и отметить что он реализует PrependExtensionInterface. Это позволит вашему extension получить экземпляр ContainerBuilder до того как будут загружаться остальные extensions, именно это позволит вам воспользоваться ContainerBuilder::loadFromExtension() для добавления параметров конфигурации к нужному вам bundle.

Несколько нетривиально, но должно работать :)

Comments

[grabbee]

Я смотрю на эту конструкцию из мануалов

$loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
        $loader->load('services.yml');

Обычно он загружает описание сервисов. А если я туда загружу свой Resources/config/packages/liip_imagine.yaml из бандла?

[grabbee]

Не сработало((
There is no extension able to load the configuration for "liip_imagine" ... Looked for namespace "liip_imagine", found "none".

Понравилось такое
$container->import('../config/{packages}/*.yaml');

Можно ли такое в бандле провернуть для /../Resources/config ?
Как-то пропихнуть свои конфиги прямо из yaml файлов.
Если они в точности соответствуют тому, что хочет LiipImagineBundle

[Flying]

grabbee, Вы уж определитесь с тем чего вы хотите достичь... Если вы просто разместите конфигурационные файлы для бандла - то в приложении должен быть подключен bundle который будет их загружать, иначе вы как раз и получите ошибку о том что нет соответствующего extension.

Как именно и откуда вы будете загружать данные - на самом деле дело десятое, можно использовать и loader и любые другие механизмы, лишь бы только к моменту загрузки конфигурации через extension нужного вам bundle требуемые вам данные оказались в extension config в container'е.

[grabbee]

Flying, Сам ответ у вас содержит много информации по процессу конфигурации. Она где-то описана подробно? В документации по симфони так не расписано кажется ни где.

то в приложении должен быть подключен bundle который будет их загружать

Vich\UploaderBundle\VichUploaderBundle::class => ['all' => true],
    Liip\ImagineBundle\LiipImagineBundle::class => ['all' => true],

Flex подключает автоматически все бандлы из бандла в самом приложении(bundles.php).

можно использовать и loader и любые другие механизмы, лишь бы только к моменту загрузки конфигурации через extension

Ну а это как я понял нигде не описывается. Сам я пока не дотягиваю, как это сделать. Симфони дает папку
DependencyInjection и два файла BundleExtension.php + Configuration.php

Например я опишу конфиги LiipImagineBundle и VichUploaderBundle внутри своего бандла в соответствующих yaml файлах. Как их загрузить в контайнер из самого бандла(DependencyInjection)?

[Flying]

grabbee, Нет, этой информации в документации нет, иначе бы мне не пришлось указывать ссылки на исходники. Как именно сделать - я написал прямо в ответе: "вам достаточно определить в своём bundle собственный extension и отметить что он реализует PrependExtensionInterface. Это позволит вашему extension получить экземпляр ContainerBuilder до того как будут загружаться остальные extensions, именно это позволит вам воспользоваться ContainerBuilder::loadFromExtension() для добавления параметров конфигурации к нужному вам bundle."

[grabbee]

Да. Спасибо. Я нашел доку. Это кажется описано в одноименном компоненте DependencyInjection. Там и про процесс компиляции и про расширения. также там есть забавная сноска

When loading a config file that uses an extension alias as a key, the extension must already have been registered with the container builder or an exception will be thrown.

В общем читаю, разбираюсь пока.

https://symfony.com/doc/current/components/depende...
https://symfony.com/doc/current/components/depende...

[grabbee]

load() - получает пустой контейнер.
А ещё судя по всему можно CompilerPassInterface метод process(ContainerBuilder $container)
Туда приходит уже готовый контейнер. Сейчас буду понимать что лучше prepend или process

[Flying]

grabbee, Вы реально не читаете то что я написал? :) "Поскольку процесс сборки контейнера начинается с merge pass, то вы не можете вмешаться в этот процесс через compiler pass, как это делается обычно"

[grabbee]

Поскольку процесс сборки контейнера начинается с merge pass, то вы не можете вмешаться в этот процесс через compiler pass, как это делается обычно, однако вы можете воспользоваться вот этим куском логики для того чтобы добиться своей цели

Читаю. И доку читаю. И у меня диссонанс по этому поводу. Вы дали ссылки на исходный код DI - но почему он вдруг перестает работать? Если тем же Compiler Pass можно перелопатить всё в любой момент?
---
Я хз как, debug:config liip_imagine - показывает, что конфиг загрузился как мне хотелось. Сейчас буду смотреть, работает ли само приложение.

[Flying]

grabbee, либо я плохо написал либо вы невнимательны: compiler pass вам не поможет т.к. любые compiler pass запускаются после того как будет загружена конфигурация, а вам нужно влезть до этого момента.

[BoShurik]

Flying,

Нет, этой информации в документации нет

Разве это не оно: https://symfony.com/doc/current/bundles/prepend_ex... ? Вы расписали подробней, конечно, но того что в доке дано - достаточно

[Flying]

BoShurik, Хорошая статья, да, видимо пропустил её раньше, спасибо!

[grabbee]

BoShurik, Flying, всё настроил пока через prepend - заработало.

Пока никак не могу понять как пробросить конфигурацию из конфига одного бандла в другой. Задал отдельным вопросом Как пробросить конфигурацию из конфига одного бандла в другой?

Answer 2

[grabbee]

Да. Кажется получилось.

# implements CompilerPassInterface

    public function process(ContainerBuilder $container)
    {
        $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config/packages'));
        $loader->load('liip_imagine.yaml');
    }

Оно загрузило всё сразу в контейнер.

PrependExtensionInterface prepend - не сработало. Ему нужны были параметры из services.yml самого бандла, а его загрузка идет после prepend, как я понял. process - срабатывает на уже готовом контейнере, и все параметры там есть. Сейчас буду понимать, всё ли правильно я делаю.

Comments

[grabbee]

И да. Здесь затираются конфиги из приложения.
Работает, да не так :)