Как уточнить/конкретизировать типа параметра метода при имплементации интерфейса в PHP?

Question

[Пётр Грибанов]

На сколько я знаю этого сделать ни как нельзя, но на всякий случай спрашиваю так как наболело. Использую PHP 5.6

Суть проблемы:

Есть 4 класса с очень похожим интерфейсом. Приведу только 2

class Cover
{
    public function moveTmpFile(CoverInterface $entity)
    {
        // ..
    }

    public function removeOldFiles(CoverInterface $entity)
    {
        // ..
    }

    public function removeAllFiles(CoverInterface $entity)
    {
        // ..
    }
}

class OgImage
{
    public function moveTmpFile(OgImageInterface $entity)
    {
        // ..
    }

    public function removeOldFiles(OgImageInterface $entity)
    {
        // ..
    }

    public function removeAllFiles(OgImageInterface $entity)
    {
        // ..
    }
}

Интерфейсы CoverInterface и OgImageInterface кардинально отличаются. То есть эти сервисы имеют очень схожий интерфейс, но различную реализацию. Хочется для класса Cover и OgImage создать общий интерфейс. Если будет единый интерфейс то это позволит оптимизировать работу с сервисами. В идеале должно получится так:

Базовый интерфейс для $entity:

interface UploadableInterface
{
}

Наследуем его в CoverInterface и OgImageInterface

interface CoverInterface extends UploadableInterface
{
    public function getCover();

    public function setCover($filename);

    // ..
}

interface OgImageInterface extends UploadableInterface
{
    public function getOgImage();

    public function setOgImage($og_image);

    // ..
}

Базовый интерфейс для сервисов:

interface UploaderInterface
{
    public function moveTmpFile(UploadableInterface $entity);

    public function removeOldFiles(UploadableInterface $entity);

    public function removeAllFiles(UploadableInterface $entity);
}

наследуем интерфейс с уточнением/конкретизацией типа параметра

class Cover implements UploaderInterface
{
    public function moveTmpFile(CoverInterface $entity)
    {
        // ..
    }

    public function removeOldFiles(CoverInterface $entity)
    {
        // ..
    }

    public function removeAllFiles(CoverInterface $entity)
    {
        // ..
    }
}

class OgImage implements UploaderInterface
{
    public function moveTmpFile(OgImageInterface $entity)
    {
        // ..
    }

    public function removeOldFiles(OgImageInterface $entity)
    {
        // ..
    }

    public function removeAllFiles(OgImageInterface $entity)
    {
        // ..
    }
}

Выглядит здорово, но так сделать нельзя. PHP требует что бы методу принимали только UploadableInterface и ни что другое. Единственное решение этой задачи не указывать тип параметра вообще, но это решение не годится.

Answer 1

[Алексей Уколов]

Класс может реализовать несколько интерфейсов и никакое наследование для решения вашей задачи не нужно:

class Entity implements FirstInterface, SecondInterface

Более того, если хорошенько подумать о том что такое интерфейсы и зачем они нужны, становится ясно, что термин "наследование" к ним не применим в принципе.

Comments

[Пётр Грибанов]

Множественное наследование здесь ни как не поможет. Методы с одинаковым именем и разными аргументами. Читайте внимательней вопрос. И класс OgImage не должен реализовывать интерфейс OgImageInterface. Он его принимает в качестве аргумента методов

[Пётр Грибанов]

Пётр Грибанов: тьфу ты. Я имел в виду имплементацию нескольких интерфейсов

[Алексей Уколов]

Да, запутался в вашем коде.

В зависимости от конкретного кода, я вижу два решения:

1. Выделить-таки какие-то части, которые используются в общих методах, в отдельный интерфейс. Что там такого может быть в этих сущностях настолько разного в публичном апи, что для метода moveTmpFile нужно указывать прямо специальный интерфейс?

2. Не указывать интерфейс в сигнатуре метода, но оставить его в DocBlock, а в коде тип проверять руками.

[Пётр Грибанов]

Алексей Уколов: 2 вариант я упомянул в конце своего вопроса. На мой взгляд это выглядит как костыль:

не знаю вставится ли код

class Cover implements UploaderInterface
{
    public function moveTmpFile($entity)
    {
        assert($entity instanceof CoverInterface, sprintf('Entity "%s" must implement interface "%s"', get_class($entity), CoverInterface::class));
        // ..
    }
}

Поясню по поводу пункта 1.
Есть проект. В проекте есть модели/сущности/entities. Сущности могут иметь обложку (Cover), могут иметь промо обложку (PromoCover), могут иметь og:image (OgImage) и просто файл картинки (File). То есть имеется несколько моделей у которых есть обложка, но нет og:image. Есть несколько моделей у которых есть и обложка и промо обложка, но нет og:image и тд.

Это все разные поля, разные переменные и они существуют отдельно. Я просто не могу выделить общую часть и вынести ее в отдельный интерфейс.

Общий функционал я вынес в отдельные интерфейсы для стандартизации и не только.
Например я не тестирую методы сущности каждую в отдельности, а тестирую через интерфейс. Тоесть пишу тест для интерфейса и в dataProvider передаю список моделей которые реализуют этот интерфейс.
Еще эти интерфейсы испульзуются для чистки мусора. Например, при смене обложки для сущности на новую, старая картинка уже не нужна и её можно удалить. Она автоматически попадает в список устаревших при вызове метода setCover и доступна в из метода getOldCovers (ниже код). И при сохранении сущности она удаляется. Так вот, я создаю отдельного слушателя событий (Doctrine event subscriber если быть точнее) который слушает событие удаление сущности и при получении события он извлекает сущность и проверяет реализует ли она интерфейс CoverInterface и соответсвенно удаляет старую картинку. Этому обработчику событий не важен тип сущности, ему важно что бы сущность реализовывала интерфейс CoverInterface и только, а таких сущностей несколько.

Есть еще пара функций опирающихся на интерфейс, но я их сейчас описывать не буду.

Пример метода setCover()

public function setCover($cover)
{
    if ($this->cover) {
        $this->old_covers[] = $this->cover; // список старых обложек
    }
    $this->cover = $cover; // сохраняем новую обложку
    $this->cover_changed = true; // обложка была изменена
    return $this;
}

Ну и пример метода removeOldFiles()

public function removeOldFiles(CoverInterface $entity)
{
    $root = $this->root.$entity->getCoverDownloadPath(); // путь к дирректории с обложками
    foreach ($entity->getOldCovers() as $filename) {
        $this->fs->remove($root.$filename); // удаление файла обложки
    }
}

[Пётр Грибанов]

Алексей Уколов: То есть я ни как не могу отказаться от интерфейсов CoverInterface, PromoCoverInterface, OgImageInterface и FileInterface и менять в них по сути нечего.

код везде очень похожий, но все таки он разный

[Алексей Уколов]

Я бы не назвал второй вариант костылём. Да, он не так удобен, но это стандартный метод и он работает. При это вся остальная ваша логика не сломается, ведь ваши объекты по прежнему будут реализовывать все нужные интерфейсы, просто в конкретных методах принадлежность объекта к ним будет проверяться не автоматически на этапе вызова, а руками при исполнении кода.

Что касается остального вашего комментария: я не предлагаю отказаться от ваших интерфейсов, пусть они будут. Но выделите то, что используется в повторяющихся методах в отдельный новый интерфейс. Если вы сделаете не getCoverDownloadPath/getOgCoverDownloadPath, а getDownloadPath и т.п., уверен, общие методы можно будет выделить.

Если коротко, что я пытаюсь сказать: методу removeOldFiles не нужен весь интерфейс CoverInterface, ему нужна только часть этого интерфейса, которая отвечает за хранение обложки. И именно эту часть можно вынести в отдельный интерфейс и тайп-хинтить именно его.

[Алексей Уколов]

Разве что вместо assert стоит специальный Exception использовать.

[Пётр Грибанов]

Алексей Уколов: хм. тогда получается такой интерфейс:

interface UploadableInterface
{
    public function getOldImages();
}

и реализация внутри сущности:

class Cover implements CoverInterface, OgImageInterface, UploadableInterface
{
    // ..

    public function getOldImages()
    {
        $return = [];
        foreach ($entity->getOldCovers() as $filename) {
            $return[] = $this->getCoverDownloadPath().$filename;
        }
        foreach ($entity->getOldOgImages() as $filename) {
            $return[] = $this->getOgImageDownloadPath().$filename;
        }
        return $return
    }
}

ну и удаление тогда будет таким:

public function removeOldFiles(UploadableInterface $entity)
{
    foreach ($entity->getOldImages() as $filename) {
        $this->fs->remove($this->root.$filename); // удаление файла обложки
    }
}

спасибо за мысль. я еще над ней подумаю