Как заставить мою PHP IDE понимать контейнеры внедрения зависимостей?

Вы можете определить класс переменной вручную:

/** @var YourClassType $mailer */
$mailer = $container['mailer'];

В PhpStorm (и согласно стандартам) используйте две звездочки и напишите тип данных перед именем переменной.

Вы можете написать тип данных без имени переменной (но не имя без типа данных).

Хотя вы, безусловно, можете сообщить своей IDE тип объекта, извлекаемого из вашего контейнера, каждый раз, когда вы к нему обращаетесь, лучше сделать это один раз. Оба следующих решения включают создание подкласса контейнера. Я только начал использовать Pimple, который все равно рекомендует делать это.

Для контейнеров, в которых используются элементы экземпляра, доступ к которым осуществляется с помощью -> или доступ к которым осуществляется с помощью магического метода __get, вы можете сообщить своей среде IDE, какой тип они содержат. Это здорово, потому что не требует дополнительного синтаксического анализа при запуске кода — это беспокоит только IDE.

/**
 * My container. It contains things. Duh.
 *
 * @property MyService $service
 * @property MyDao $dao
 */
class MyContainer extends Container { }

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

class MyContainer extends Pimple
{
    /**
     * @return MyService
     */
    public function getMyService() {
        return $this['service'];
    }
}

Кстати, для подсказок типа встроенных переменных с @var в NetBeans вам нужно использовать /* с одной звездочкой. Это не комментарий в блоке документа и не работает с /** или //. Кроме того, имя предшествует типу.

public function foo() {
    /* @var $service MyService */
    $service = $container['service'];
    ...
}

Поскольку IDE не выполняет код, они не знают и нуждаются в вашей помощи. Я знаю, что это работает и для Eclipse, и для других IDE: укажите тип переменной.

Пример Netbeans / Phpstorm / PDT / ZendStudio

/* @var $mailer MailerInterface */
$mailer = $sc->mailer

Код завершен снова начинает работать на $mailer.

Для ФДТ важно, чтобы:

1. Комментарий начинается только с одного *.
2. Сначала имя переменной, затем подсказка.

Альтернативные варианты комментариев

Поскольку это было предметом большого обсуждения, оно может различаться в разных IDE. Однако большинство IDE поддерживают подсказку переменной для переменных встроенного кода, как описано выше. Таким образом, в зависимости от IDE это может быть написано по-разному, но похоже, как здесь с двумя звездочками впереди:

/** @var $mailer MailerInterface */

Совместимость с PHPDoc

У парсеров PHPDoc могут возникнуть проблемы, если вы имитируете класс var doc-comment для встроенного кода следующим образом:

/** @var MailerInterface $mailer  */

Эта документация обычно используется для переменных класса (@var — документируйте данные тип переменной класса). Затем в PHPDoc отсутствует определение переменной класса после комментария, что влечет за собой нагрузку на QA.

Однако некоторые IDE также предлагают автодополнение кода для простых переменных, если они написаны в стиле PHPDoc clas-variable. Я не знаю, имеет ли это побочные эффекты для завершения кода текущего класса, тогда как может появиться новый член, которого на самом деле не существует.

PHPStorm на самом деле предоставляет способ решения такого рода проблем вместо того, чтобы снова и снова писать PHPDocs — создавать и настраивать .phpstorm.meta.php файл способом описанные здесь обеспечивают бесперебойную работу автозаполнения и проверки типов.

Pimple просто представляет принцип построения контейнеров. Если вы это понимаете, вам больше не нужен Pimple:

class Container
{
    private $shared = array();

    public function getService() {
        return new Service(
            this->getFirstDependence(),
            this->getSecondDependence()
        );
    }

    protected function getFirstDependence() {
        return new FirstDependence(
            this->getSecondDependence()
        );
    }

    protected function getSecondDependence() {
        return isset($this->shared[__METHOD__]) ? $this->shared[__METHOD__] : $this->shared[__METHOD__] =
        new SecondDependence(
        );
    }
}

Таким образом, Pimple не скрывает тип объекта в смешанном $c['some key']. У вас будут предложения автозаполнения при редактировании вашего контейнера. Phpstorm может автоматически определять тип возвращаемого метода из вашего кода. И у вас будет чистый контейнер. Вы всегда можете переопределить контейнер:

class TestContainer extends Container
{
    protected function getFirstDependence() {
        return new FirstDependenceMock(
        );
    }
}

Честно говоря, контейнер, написанный на языке «программирования», - это неправильный путь. Ответственность за контейнер состоит в том, чтобы передать вызывающему объекту инициализированный граф объектов. Наличие доступа к «языку программирования» позволяет легко нарушить эту обязанность. Некоторые DSL для настройки зависимости лучше. Более того, большая часть исходной информации о зависимостях (подсказки типов аргументов конструкторов) просто игнорируется Pimple и sfDepenencyContainer, что делает вашу конфигурацию раздутой и хрупкой.

Я знаю, что вопрос касается только DIC, но есть поставщик услуг Silex Pimple Dumper. который сбрасывает контейнер в файл json. Тот же автор написал плагин для PHPStorm, который может читать этот файл и открывать автозаполнение с именами сервисов. и его тип (класс, строка и т. д.). Я использую эти два компонента и могу сказать, что это хорошие варианты автодополнения для Silex/Pimple.