Проверять ли входящие данные функции?

[nigirma]

Cтоит ли в функции производить проверку входящих параметров, которые задаются программистом, а не пользователем?

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

Можно и перестраховываться и вседа производить проверку. Но все это дополнительный код, его поддержка, время на разработку кода и дополнительное время выполнения функции.

Какое ваше мнение??


Простой пример, вот функция перевода текста в транслит:

/**
 * Транслит текста
 * 
 * @param  string $data     Текст для обработки
 * @param  string $language Язык транслитерации
 * @return string
 * 
 * Обрабатываемые языки ($language):
 *  ru string Русский язык
*/
function textTranslit($data, $language = 'ru') {
    // Русский язык
    $text['ru']    = array('а', 'б', 'в', 'г', 'д', 'е', 'ё', 'ж', 'з', 'и', 'й', 'к', 'л', 'м', 'н', 'о', 'п', 'р', 'с', 'т', 'у', 'ф', 'х', 'ц', 'ч',  'ш',  'щ',   'э', 'ю',  'я',  'ъ', 'ы', 'ь', 'А', 'Б', 'В', 'Г', 'Д', 'Е', 'Ё', 'Ж', 'З', 'И', 'Й', 'К', 'Л', 'М', 'Н', 'О', 'П', 'Р', 'С', 'Т', 'У', 'Ф', 'Х', 'Ц', 'Ч',  'Ш',  'Щ',   'Э', 'Ю',  'Я',  'Ъ', 'Ы', 'Ь');
    $replace['ru'] = array('a', 'b', 'v', 'g', 'd', 'e', 'e', 'j', 'z', 'i', 'i', 'k', 'l', 'm', 'n', 'o', 'p', 'r', 's', 't', 'u', 'f', 'h', 'c', 'ch', 'sh', 'sch', 'e', 'yu', 'ya', "'", 'i', "'", 'A', 'B', 'V', 'G', 'D', 'E', 'E', 'J', 'Z', 'I', 'I', 'K', 'L', 'M', 'N', 'O', 'P', 'R', 'S', 'T', 'U', 'F', 'H', 'C', 'CH', 'SH', 'SCH', 'E', 'YU', 'YA', "'", 'I', "'");
    // Замена
    return str_replace($text[$language], $replace[$language], $data);
}

Понимает она пока только русский текст.
Если же ввести $language = 'de', то будет ошибка!
Тут желательно бы производить проверку $language

return (isset($text[$language], $replace[$language])) ? str_replace($text[$language], $replace[$language], $data) : $data;

 

[Mr_Max]

Мое мнение, к примеру, что если фунция может принимать _только_ опереденный тип данных, то должна быть проверка на этот тип
1. Ибо ты сам забудешь через пол-года.
2. Оградишь других (а главное себя любимого) от лазанья в код для выяснения и устранения амнезии.
Поставил ты "левый" тип, тут тебе о-п-па и ексепшин вылетел.

 

[Dovg]

В текущем виде второй параметр вообще не нужен.

 

[SiZE]

В данном примере проверка никчему, достаточно документирования этой функции.

 

[Royal Flash]

nigirma

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

Полностью согласен с SiZE - в подавляющем больщинстве случаев лишние проверки ни к чему, а чтобы "ексепшин" не вылетал - читайте документацию. Ведь имея доступ к коду PHP напортачить может кто угодно.

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

 

[флоппик]

Эксепшн — не ошибка. Ошибкой он станет только если его никто не обработает.

 

[radioheaded]

В данном случае нужна проверка $language, это называется валидация. Проверка будет не нужна в том случае, если передача параметра в эту функцию контролируется внутренними алгоритмами. То есть, сам код гарантирует, что будут переданы валидные данные (например, есть массив языков, и значение всегда выбирается из этого массива, ручной ввод запрещен).

Проверки не нужны на типы входных параметров (если тип строго задан разработчиком). Для классов и массивов есть type hinting, а к скалярам пишите/читайте доку.

 

[TutanXamoN]

Данные нужно проверять всегда.
Но давай в качестве примера возьмем твою функцию:
1.

С одной стороны раз это моя функция, то я знаю что можно, а что нельзя вводить.

Да ты один в проекте. Это никого не касается. Ты полностью контролируешь себя и осознаешь что она и все 100500 ф-ций делают. (кстати если через 1,5-2 года (иногда через две-три недели ) ты вернешься к коду который юзает эту ф-цию ты очень долго будешь вспоминать а что это за ф-ция и какими данными она может оперировать и что она выдаст если какая-то ошибка. Тут спасет твое же документирование.
2.

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

Тут вариант однозначен ДОКУМЕНТИРОВАНИЕ. Если еще один разработчик не способен прочитать документацию - это не твоя проблема, это проблема тим-лида. Если ты тим-лид - тебе не нужен этот разработчик/тебе нужно дрессировать HR/ткни носом и скажи что нужно читать(ну 1-2 раза, не дошло до разработчика -читай раньше)
3.

Можно и перестраховываться и вседа производить проверку. Но все это дополнительный код, его поддержка, время на разработку кода и дополнительное время выполнения функции.

Согласен. Вернемся к твоей ф-ции. Сколько дополнительного кода необходимо написать для валидации пармаметра

$language

?
А сколько кода необходимо написать для валидации символов в выбранном

$language

?
А сколько кода необходимо написать для возврата в return'e не одного параметра а двух, второй будет сообщать о том как отработала ф-ция - "всё ок", "обработали но символы которых не было в массиве преобразований вернули как были" и т.д.
Нет, не было и не будет однозначного ответа на твой вопрос. В каждой ситуации нужно отдавать себе отчёт в том что мы делаем и для кого мы пишем эту ф-цию.