Обробка масиву $configs

Перршочергово вам потрібно створити клас розширення так, як пояснюється у Як завантажувати конфігурацію сервісу всередині пакета.

Кожний раз, коли користувач додає ключ acme_social (який є додатковим іменем ВЗ) у файлі конфігурації, конфігурація під ним додається в масив конфігурації та передається методу load() вашого розширення (Symfony автоматично конвертує XML та YAML у масив).

Для прикладу конфігурації в попердньому розділі, масив, переданий вашому методу load() виглядатиме так:

1
2
3
4
5
6
7
8

[
    [
        'twitter' => [
            'client_id' => 123,
            'client_secret' => 'your_secret',
        ],
    ],
]

Відмітьте, що це масив масивів, а не просто плаский масив значень конфігурації. Це зроблено спеціально, так як дозволяє Symfony аналізувати декілька джерел конфігурації. Наприклад, якщо acme_social зʼявляється в іншому файлі конфігурації - скажімо, config/packages/dev/acme_social.yaml - з іншими значеннями під ним, вхідний масив може виглядати так:

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

[
    // значення з config/packages/acme_social.yaml
    [
        'twitter' => [
            'client_id' => 123,
            'client_secret' => 'your_secret',
        ],
    ],
    // значення з config/packages/dev/acme_social.yaml
    [
        'twitter' => [
            'client_id' => 456,
        ],
    ],
]

Порядок двох масивів залежить від того, який встановлено першим.

Але не хвилюйтеся! Компонент Symfony Конфігурація допоможе вам обʼєднати ці значення, надасть значення за замовчуванням та видасть користувачу помилки валідації у поганій конфігурації. Ось, як це працює. Створіть клас Configuration у каталозі DependencyInjection та побудуйте дерево, що визначає структуру конфігурації вашого пакета.

Клас Configuration для обробки прробної конфігурації виглядає так:

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

// src/Acme/SocialBundle/DependencyInjection/Configuration.php
namespace Acme\SocialBundle\DependencyInjection;

use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

class Configuration implements ConfigurationInterface
{
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder('acme_social');

        $treeBuilder->getRootNode()
            ->children()
                ->arrayNode('twitter')
                    ->children()
                        ->integerNode('client_id')->end()
                        ->scalarNode('client_secret')->end()
                    ->end()
                ->end() // twitter
            ->end()
        ;

        return $treeBuilder;
    }
}

Цей клас тепер може бути використаний у вашому методі load() для злиття конфігурацій та форсування валідації (наприклад, якщо була передана додаткова опція, буде видано виключення):

1
2
3
4
5
6
7
8
9
10

// src/Acme/SocialBundle/DependencyInjection/AcmeSocialExtension.php
public function load(array $configs, ContainerBuilder $container)
{
    $configuration = new Configuration();

    $config = $this->processConfiguration($configuration, $configs);

    // тепер у вас є ці 2 ключі конфігурації
    // $config['twitter']['client_id'] and $config['twitter']['client_secret']
}

Метод processConfiguration() використовує дерево конфігурації, яке ви визначили у класі Configuration для валідації, нормалізації та злиття всіх масивів конфігурації.

Тепер ви можете використати змінну $config для зміни сервісу, наданого вашим пакетом. Наприклад, уявіть, що ваш пакет має наступний приклад конфігурації:

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

<!-- src/Acme/SocialBundle/Resources/config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd"
>
    <services>
        <service id="acme.social.twitter_client" class="Acme\SocialBundle\TwitterClient">
            <argument></argument> <!-- will be filled in with client_id dynamically -->
            <argument></argument> <!-- will be filled in with client_secret dynamically -->
        </service>
    </services>
</container>

У вашому розширенні ви можете завантажити це і динамічно встановити аргументи:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

// src/Acme/SocialBundle/DependencyInjection/AcmeSocialExtension.php
// ...

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

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

    $configuration = new Configuration();
    $config = $this->processConfiguration($configuration, $configs);

    $definition = $container->getDefinition('acme.social.twitter_client');
    $definition->replaceArgument(0, $config['twitter']['client_id']);
    $definition->replaceArgument(1, $config['twitter']['client_secret']);
}

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

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

use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\HttpKernel\DependencyInjection\ConfigurableExtension;

class AcmeHelloExtension extends ConfigurableExtension
{
    // відмітьте, що цей метод називається loadInternal, а не завантажує захищену
    функцію loadInternal(array $mergedConfig, ContainerBuilder $container)
    {
        // ...
    }
}

Підготуйте ваше дерево конфігурації до XML

Компонент Конфігурація надає деякі методи за замовчуванням, щоб дозволяти йому коректно обробляти XML-конфігурацію. Дивіться "" у документації компонента. Однак, ви можете зробити деякі додаткові речі, які покращать досвід використання XML-конфігурації:

Вибір простору імен XML

В XML, простір імен XML використовується для визначення того, які елементи належать конфігурації конкретного пакета. Простір імен повертається з методу Extension::getNamespace(). За домовленістю, простір імен - це URL (він не має бути валідним або в принципі існувати). За замовчуванням, простір імен для пакета - http://example.org/schema/dic/DI_ALIAS, де DI_ALIAS - додаткове імʼя впровадження розширення. Ви можете захотіти змінити це на більш професійний URL:

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

// src/Acme/HelloBundle/DependencyInjection/AcmeHelloExtension.php

// ...
class AcmeHelloExtension extends Extension
{
    // ...

    public function getNamespace()
    {
        return 'http://acme_company.com/schema/dic/hello';
    }
}

Надання XML-схеми

XML має дуже корисну функцію, під назвою XML-схема. Вона дозволяє вам описати всі можливі елементи та атрибути, а також їх значення, у визначенні XML-схеми (xsd-файл). Цей XSD-файл використовується інтегрованим середовищем обробки для автозаповнення та використовується компонентом Конфігурація для валідації елементів.

Для того, шоб використати схему, файл XML-конфігурації повинен надавати атрибут xsi:schemaLocation, який вказує на XSD-файл для певного простору імен XML. Це місцезнаходження завжди починається з простору імен XML. Цей простір імен XML потім замінюється базовим шляхом XSD-валідації, що повертаються з методу Extension::getXsdValidationBasePath(). Потім за цим простором імен іде решта шляху з базового шляху до самого файлу.

За домовленістю, XSD-файл живе у Resources/config/schema/, але ви можете розмістити його де завгодно. Вам варто повернути цей шлях в якості базового:

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

// src/Acme/HelloBundle/DependencyInjection/AcmeHelloExtension.php

// ...
class AcmeHelloExtension extends Extension
{
    // ...

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

Якщо припустити, що XSD-файл називається hello-1.0.xsd, то місцезнаходження схеми буде http://acme_company.com/schema/dic/hello/hello-1.0.xsd:

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

<!-- config/packages/acme_hello.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:acme-hello="http://acme_company.com/schema/dic/hello"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://acme_company.com/schema/dic/hello
        https://acme_company.com/schema/dic/hello/hello-1.0.xsd"
>
    <acme-hello:config>
        <!-- ... -->
    </acme-hello:config>

    <!-- ... -->
</container>