Как лучше организовать типизацию входных параметров метода?

Question

[NewSantaClaus]

Есть класс

class Test
{
    protected int $Columns ;

    protected string $Color;

    protected string $TextHAlign;

    public function setColumns(int $columns = 6): self
    {
        $this->Columns = $columns;
        return $this;
    }

    public function setColor(string $color): self
    {
        $this->Color = $color;
        return $this;
    }

    public function setTextHAlign(string $HAlign = "center"): self
    {
        $this->TextHAlign = $HAlign;
        return $this;
    }
}

Метод setColumns - должен принимать значение от 1 до 6
Метод setColor - должен принимать только HEX формат
Метод setTextHAlign - должен иметь одно из значений "left", "center" или "right"

Вопрос. Возможно ли сделать типизацию (если да то как), возможно как-то принимать только определенные константы, или нужно писать проверки внутри каждого метода?

Answer 1

[Дмитрий Гординский]

Для перечислений можно использовать Enum, это подойдёт для TextAlign.
Для других кейсов можно использовать ValueObject с валидацией в конструкторе.

Comments

[NewSantaClaus]

Обратил внимание что Enum поддерживается в php >= 8.1.0. Есть идеи как это можно реализовать на более старых версиях?

[Дмитрий Гординский]

NewSantaClaus, через всё те же ValueObject. Как-то так:

class MyCustomEnum
{
    private const VALUE1 = 'value1';
    private const VALUE2 = 'value2';
    private const VALUE3 = 'value3';

    private const ALLOWED_VALUES = [
        self::VALUE1, self::VALUE2, self::VALUE3
    ];

    private string $value;

    public function __construct(string $value)
    {
        if (!in_array($value, self::ALLOWED_VALUES, true)) {
            throw new Exception('Unsupported enum value');
        }

        $this->value = $value;
    }
}

Ну и снабдить это все необходимыми публичными методами.

[NewSantaClaus]

Дмитрий Гординский, пожалуй, я так понимаю, если мы говорим о более ранних версия php, то это будет единственное правильное решение. Правда меня все же смущает тот момент, что у нас конструктор все так же на вход принимает любую строку. То есть IDE нам не скажет, сразу, то мы передаем или нет. Нужно только запустить код, в отличие от того же Enum :(

[Дмитрий Гординский]

NewSantaClaus, можно не пользоваться конструктором, а для каждого из значений сделать фабричный метод:

public static createValue1(): self
{
    return new self::__construct(self::VALUE1);
}

[NewSantaClaus]

Дмитрий Гординский, То есть вы предлагаете использовать такой подход?

class Enum
{
    private static string $value;

    protected function __construct(string $value)
    {
        self::$value = $value;
    }

    public static function getValue(): string
    {
        return self::$value;
    }
}

final class TextHAlign extends Enum
{

    private const LEFT = 'left';

    private const CENTER = 'center';

    private const RIGHT = 'right';

    public static function LEFT(): self
    {
        return new self(self::LEFT);
    }

    public static function CENTER(): self
    {
        return new self(self::CENTER);
    }

    public static function RIGHT(): self
    {
        return new self(self::RIGHT);
    }
}


class Test
{
    // ....

    protected string $TextHAlign;

    // ...

    public function setTextHAlign(TextHAlign $HAlign): self
    {
        $this->TextHAlign = $HAlign::getValue();
        return $this;
    }
}

(new Test())
    ->setTextHAlign(TextHAlign::CENTER());

[Дмитрий Гординский]

NewSantaClaus, примерно такой да.
В вашем коде всё ещё не хватает валидации в конструкторе, а private string $value не должен быть статическим.

Как альтернатива всему этому - можно обойтись статическими анализаторами, и в докблоках указывать допустимые значения:Psalm type annotations

[NewSantaClaus]

Дмитрий Гординский, как бы да, с одной стороны можно обойтись и докблоками, но это не гарантиеут что в параметр не будет передана какай-то кака. Так что от валидации нужна в любом случае. Кстати, что касается валидации то в таком случае можно Enum превратить в

class Enum
{
    private string $value;

    protected function __construct(string $value)
    {
        $reflectionClass = new ReflectionClass(static::class);
        $constants = $reflectionClass->getConstants();
        $values = array_values($constants);

        if (!in_array($value, $values, true)) {
            throw new Exception('Unsupported enum value');
        }

        $this->value = $value;
    }

    public function getValue(): string
    {
        return $this->value;
    }
}

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

[russeljo]

вам не кажется что это какая-то дичь?
Что мешает добавить методы для проверки корректности входных значений?

[Дмитрий Гординский]

russeljo, а что не дичь? Отключить типизацию, и надеяться что в каждый из методов всегда безошибочно будет передано то что задумывалось?

Зачем проверять корректность пришедших значений, если можно запретить некорректные?

Answer 2

[Дмитрий Кузнецов]

Как вариант можно сделать константы со списком необходимых параметров для каждого метода. Но это добавит в каждый ваш метод класса небольшую проверку в ~1 строку.

Answer 3

[Александр Лыкасов]

К выше сказанному добавлю ещё - обратите внимание на filter_var/filter_var_array (может пригодится).