Что должен возвращать метод?

Question

[Павел Клочков]

Здравствуйте! помогите разобраться с вопросом.
Пытаюсь написать класс для очистки данных. Предполагается что все данные любых форм будут проходить через соответствующие статические методы этого класса.
Однако IDE материт меня почём зря и сам PHP тоже недоволен моими кривыми руками не слишком умными мозгами.

Пытаясь написать метод для очистки int я нагородил следующее:

public static function cleanInt($int)
    {
        $int = trim($int);
        try {
            if ($int = (int) $int) {
                return $int;
            }
            throw new Exception('Not int ');

        } catch (Exception $e) {
            echo $e->getMessage();
        }

        return false;
    }

Вот тут у меня и возникли вопросы.
Если я ожидаю что метод вернёт int то по идее return false неверное решение, но если вместо int в метод пришла абракадабра? что должен вернуть метод если не false? Возвращать в таком случае 0 и считать его ошибкой? Тоже так себе решение, придётся каждый раз проверять не равен ли результат 0? А что делать если случится случай при котором 0 вполне себе допустим?
Или после выброса исключения вообще ничего не возвращать? В таком варианте IDE говорит что руки у меня кривые и мозги я уже пропил и вообще мне не стоит этим заниматься в таком возрасте.

Есть ещё одна мысль, но я пока не знаю с какой стороны к ней подойти.
А может забить на мнение IDE и всё таки ничего не возвращать? И написать свой собственный Exception результатом которого будет alert пользователю что он ошибся при вводе данных. Такой путь конечно сложен и тернист но мне пока он кажется наиболее верным.
Подскажите может я вообще не в ту сторону думаю?

Comments

[Павел Клочков]

VicTHOR, мне показалось что это удобно. При проверке данных вызывать соответствующие методы.
например:

$age = DataCleaner::cleanInt($_POST['age'];

if (21 > $age) {
    echo 'Курение вредит вашему здоровью, а порнофильмы причина мозолей на правой руке, если вы не левша!'
} else {
// код который разрешит пользователю посмотреть мультфильм "Ну, погоди!"
}

[Сергей delphinpro]

Зачем вы выбрасываете исключение и тут же его ловите?

function cleanInt($int) {
    $int = trim($int);
    if ($int != (int) $int) {
        throw new Exception('Not int ');
    }
    return $int;
}

[Павел Клочков]

Сергей delphinpro, Видимо потому что я ещё не разобрался с исключениями. Ваш вариант отвечает на все мои вопросы. Правда IDE всё равно ругается, но тон снизился :) теперь пишет Unhandled Exception.

[Сергей delphinpro]

Павел Клочков, правильно пишет. в phpdoc укажите, что метод бросает исключение.

/**
 * Clean int.
 *
 * @param  string  $int
 * @return int
 * @throws \Exception
 */
function cleanInt($int) {
    $int = trim($int);
    if ($int != (int) $int) {
        throw new Exception('Not int ');
    }
    return $int;
}

[Сергей delphinpro]

Можно в строке на функцией вбить /**, нажать Enter, и ide должна сама сгенерировать этот блок.

[Павел Клочков]

Сергей delphinpro, огромное спасибо! Как многому мне ещё нужно учиться!
К сожалению не могу поставить ваш комментарий как ответ на вопрос, потому что вы писали просто комментарием, а не ответом, но всё равно ещё раз спасибо!

[Vitsliputsli]

Павел Клочков, не сравнивайте разнотипные данные, это плохая привычка, т.к. чтобы это сделать без ошибок, нужно очень хорошо знать нюансы подобных сравнений в конкретном языке, ведь логика может быть разной. В частности для ($int != (int) $int) еще хуже, эта конструкция будет работать по-разному на разных версиях php.

Answer 1

[Developer]

Нельзя смешивать int и boolean.
Здесь несколько вариантов.
Самый простой - использовать exceptions, но это дорого.
Если функция возвращает 0, то в большинстве случаев это означает учпех. Можно в виде ошибки вернуть -1.
Другой вариант - возвращать класс типа ErrorType { errorCode, errDescription }.
Вариант сложнее - написать класс, внутри которого этот метод, но не статичный. И писать результаты выполнения в поля этого класса - errCode, errDescription
...
Вариантов масса, но только не такой как у тебя

Comments

[Василий Банников]

А как же вариант с null-ом?

[Developer]

Василий Банников, вариант с классом это подразумевает

[Василий Банников]

Developer, я имел в виду без класса. Просто возращать либо число, либо null

[Сергей Водаков]

Василий Банников, возвращать null плохо, всегда, без исключений. Я бы возвращал ответ в виде класса с полями:
errorCode
errorDescription
value
При errorCode = 0 - нет ошибки, и результат работы можно забрать из поля value

[Василий Банников]

Сергей Водаков, считаю, что нет. Если в языке нет нативной поддержи Optional - главное чтобы это было явно отражено в документации и типах.

Answer 2

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

Как вариант, можно подсмотреть в С#. Там реализованы пары методов для классов Int, Float (и прочими): Int.Parse(string) и Int.TryParse(string). Первый в случае ошибки бросает исключение, второй молча возвращает 0. В зависимости от логики используется либо то, либо то.