Тип возвращаемых значений метода. Как правильно?

Question

[monday_suicide]

Всем привет.
Должен ли метод возвращать только один тип данных?
Например:

public function foo($obj)
    {
        if ($obj->isNotActive()) {
            return false;
        }
        //другие действия с объектом
        return $obj;
    }

возможен ли такой подход? или Метод должен вернуть либо булев, либо сам объект?

Answer 1

[Slava Rozhnev]

Мне видится предпочтительней вариант с возвратом исключения:

public function foo($obj) {
    if ($obj->isNotActive()) {
        throw new Exception('Not active.');
    }
    //другие действия с объектом
    return $obj;
}

try {
    foo($obj);
} catch (Exception $e) {
    echo 'Caught exception: ',  $e->getMessage(), "\n";
}

Answer 2

[FanatPHP]

Зависит от сценария.
Судя по коду, отсутствие активности - это не ошибка.
То есть в данном случае можно вернуть null.

А вот функции, которые возвращают false в случае ошибки устарели 20 лет назад. И если метод должен вернуть объект, но не может, то он должен кинуть исключение

Answer 3

[Сергей delphinpro]

Исключение здесь, вероятно, лишним будет.
Вместо false лучше вернуть null.
И расставить typehint.

public function foo(SomeClass $obj): ?SomeClass
    {
        if ($obj->isNotActive()) {
            return null;
        }
        //другие действия с объектом
        return $obj;
    }

Answer 4

[Андрей Ежгуров]

Да, такой подход возможен. И даже активно используется в стандартной библиотеке PHP.

Другой вариант - бросать исключение.

Третий вариант - возвращать массив из 2 значений:

public function foo($obj) {
    if ($obj->isNotActive()) {
        return [null, false];
    }
    //другие действия с объектом
    return [$obj, true];
}
...
[$result, $status] = $obj->foo(...);

Comments

[Daria Motorina]

Третий вариант технически правильный, но морально устаревший

[Андрей Ежгуров]

Daria Motorina, "Морально устаревшим" он может быть только для тех, кто не знаком с более чем современным Go.
Единственный недостаток третьего метода - невозможность создания цепочек вызовов методов.

[Daria Motorina]

Андрей Ежгуров, go это хорошо, но php с ним не взаимозаменяемые. Сейчас так в нормальных проектах писать не принято, это ухудшает читаемость и типизируемость методов

[Андрей Ежгуров]

Daria Motorina, Вместо массива возвращаем объект с двумя типизированными полями - и проблем с типизируемостью нет. Более того, это и проблему с цепочкой вызовов решает (например, через __invoke). :-)

P.S. Я прекрасно понимаю, что в PHP 7-8 так не пишут. Но у меня на работе основная часть системы - PHP 5.3 и существенная часть кода написанная ещё на PHP 4. И подобные ситуации встречаются не реже, чем идеально выверенный идеологически правильный код под актуальную версию PHP.