Как сделать общий сервис во всех контроллерах?

Question

[Александр]

В общем у меня есть сервис Settings, в котором методы для получения настроек сайта.

Мне он нужен в каждом контроллере, ибо он используется в 99% контроллерах. Я решил просто сделать метод в родительском контроллере:

public function settingService()
{
    return $this->get('app.setting');
}

Но выпадает ошибки, в которой говорится, что контроллер знает только о "базовых" сервисах, якобы используйте DI.
Окей, допустим я сделаю в родительском:

abstract class Controller extends AbstractController
{
    public $settingService;

    public function __construct(Setting $settingService)
    {
        $this->settingService = $settingService;
    }
}

И это вроде здравое решение, но в таком случаи если я в дочернем контроллере будут использовать __construct, то мне нужно будет дублировать все аргументы конструктора. А если я захочу что-то добавить общее для всех контроллеров, то мне все контроллеры придётся править.

Есть идея как сделать лучше? А может я вообще не в ту сторону копаю...

Answer 1

[BoShurik]

Абстрактный контроллер реализует Service Subscriber. Вам достаточно туда добавить ваш Setting:

abstract class Controller extends AbstractController
{
    public static function getSubscribedServices()
    {
        return array_merge(parent::getSubscribedServices(), [
            'setting' => Setting::class,
        ]);
    }

    protected function getSetting(): Setting
    {
        return $this->get('setting');
    }
}

Comments

[Александр]

Спасибо, самое красивое решение. Чёт я не допер что можно метод переопределить этот.

Answer 2

[Flying]

Простейший вариант - написать свой compiler pass, в нём выбрать сервисы (через findTaggedServiceIds) по тегу controller.service_arguments и дополнить определение сервисов либо вызовом вашего метода либо добавлением аргумента в конструктор, это можно делать по имени.

Можно сделать ещё более общее решение: определить интерфейс, например SettingsAwareInterface примерно такого вида:

namespace App\Contracts;

interface SettingsAwareInterface
{
    public function getSettings(): Setting;

    public function setSettings(Setting $settings): void;
}

затем в services.yaml добавить:

_instanceof:
  App\Contracts\SettingsAwareInterface:
    tags:
      - {name: 'app.settings-aware'}

и в compiler pass работать с тегом app.settings-aware, это позволит вам передавать данный сервис не только в контроллеры.

Comments

[BoShurik]

Простейший вариант

Ох, нет :)

[Flying]

BoShurik, Круто, не знал про ServiceSubscriber, спасибо, но в целом я не вижу проблемы и с compiler pass - нормально работает, задачу решает и реализуется за пару минут.

[BoShurik]

Flying, не спорю. Но реализуется за пару минут если ты уже с этим работал. С первого раза не думаю что все так быстро получится. Ну и раздувает кодовую базу, когда можно обойтись без этого

PS
Можно обойтись без Compiler Pass

_instanceof:
  App\Contracts\SettingsAwareInterface:
    calls:
        - [setSettings, ['@app.settings']]

[Flying]

BoShurik, Это было первое про что я подумал, но я помню что в _instanceof не всё можно поместить, как минимум args точно не принимается, поэтому отбросил этот вариант, а calls не проверял, может и работает.

Answer 3

[Максим Федоров]

будут использовать __construct, то мне нужно будет дублировать все аргументы конструктора

В каждом контроллере свои зависимости и это хорошо,
если что-то продублировалось — это случайность, ну точнее это не дубль в классическом понимании, тут логика не дублируется

Comments

[Александр]

Если в контроллере родительском, допустим будет 5 "Общих" сервисов. И у дочерних будет в контроллере будут свои конструкторы. В родительском убираем и всё ломается, тогда придётся везде проходить менять. Я допускаю что такое будет редко, но это реально всё усложняет.

[Максим Федоров]

можете так сделать

в родительском контроллере сделать сеттер
и поставить ему аннотацию @required

https://symfony.com/doc/current/service_container/...

[Максим Федоров]

alexrakirov,

Если в контроллере родительском, допустим будет 5 "Общих" сервисов

Инкапсулируейте работу с этими 5 сервисами в один фасад и поставляйте одной зависимостью

Answer 4

[AlpineMilk]

Можно воспользоваться аннотацией @required

/**
     * @required
     */
    public function setSetting(Setting $setting)
    {
        $this->setting = $setting;
    }