Как сконфигурировать сервис с помощью конфигуратора¶

Конфигуратор сервиса - это функция сервис-контейнера, которая позволяет вам использовать вызываемое, чтобы сконфигурировать сервис после его инстанциирования.

Конфигуратор сервиса может быть использован, к примеру, когда у вас есть сервис, который требует сложной установки, основанной на настройках конфигурации, исходящих из разных источников или сервисов. Используя внешний конфигуратор, вы можете поддерживать реализацию сервиса в чистоте и держать её отдельно от других объектов, которые предоставляют необходимую конфигурацию.

Ещё один пример использования - когда у вас есть множество объектов, которые совместно используют общую конфигурацию, или которые должны быть похожим образом сконфигурированы во время прогона.

Например, представьте, что у вас есть приложение, где вы оправляtnt разные виды электронных писем пользователям. Письма пропускаются через различные программы форматирования, которые могут быть включены или нет, в зависимости от некоторых динамических установок приложения. Вы начинаете определять класс NewsletterManager таким образом:

// src/AppBundle/Mail/NewsletterManager.php
namespace AppBundle\Mail;

class NewsletterManager implements EmailFormatterAwareInterface
{
    private $enabledFormatters;

    public function setEnabledFormatters(array $enabledFormatters)
    {
        $this->enabledFormatters = $enabledFormatters;
    }

    // ...
}

а также класс GreetingCardManager:

// src/AppBundle/Mail/GreetingCardManager.php
namespace AppBundle\Mail;

class GreetingCardManager implements EmailFormatterAwareInterface
{
    private $enabledFormatters;

    public function setEnabledFormatters(array $enabledFormatters)
    {
        $this->enabledFormatters = $enabledFormatters;
    }

    // ...
}

Как упоминалось ранее, целью являетя установить программы форматирования во время прогона, в зависимости от настроек приложения. Чтобы сделать это, у вас также есть класс EmailFormatterManager, который отвечает за загрузку и валидацию программ форматирования, включённых в приложении:

// src/AppBundle/Mail/EmailFormatterManager.php
namespace AppBundle\Mail;

class EmailFormatterManager
{
    // ...

    public function getEnabledFormatters()
    {
        // код для конфигурации того, какие программы форматирования использовать
        $enabledFormatters = array(...);

        // ...

        return $enabledFormatters;
    }
}

Если вашей целью является избежать объединения NewsletterManager и GreetingCardManager с EmailFormatterManager, то вы можете захотеть создать класс конфигуратора для конфигурирования этих экземпляров:

// src/AppBundle/Mail/EmailConfigurator.php
namespace AppBundle\Mail;

class EmailConfigurator
{
    private $formatterManager;

    public function __construct(EmailFormatterManager $formatterManager)
    {
        $this->formatterManager = $formatterManager;
    }

    public function configure(EmailFormatterAwareInterface $emailManager)
    {
        $emailManager->setEnabledFormatters(
            $this->formatterManager->getEnabledFormatters()
        );
    }

    // ...
}

Работа EmailConfigurator - внедрять включённые программы форматирования в NewsletterManager и GreetingCardManager, потому что они не знают, откуда появились включённые программы форматирования. С другой стороны, EmailFormatterManager содержит данные о включенных программах форматирования и о том, как их загружать, поддерживая единый принцип ответственности.

1
2
3
4
5

app.newsletter_manager:
    # новый синтаксис
    configurator: 'AppBundle\Mail\EmailConfigurator:configure'
    # старый синтаксис
    configurator: ['@AppBundle\Mail\EmailConfigurator', configure]