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

Question

[crack_user]

Делаю апишку, и задался вопросом, как лучше реализовать проверку обязательных параметров в методе? Чтобы в случае если обязательный параметр не был передан - то выдавать ошибку мол "Не указан обязательный параметр 'name'"

public function addCourse(string $name, array $dates, float $price, string $code): array
    {
        if (empty($name)) {
            throw new Exception('Название курса не указано.');
        }
        if (empty($price)) {
            throw new Exception('Цена курса не указана.');
        }
        if (empty($code)) {
            throw new Exception('Код курса не указан.');
        }
}

Не буду же я для каждой переменной вызывать exception.
Была идея сделать отдельный метод "validateRequiredFields" и передавать туда $_POST и массив с обязательными параметрами, но не знаю насколько правильно юзать такой варик
что-то по типу такого -

protected function validateRequiredFields(array $data, array $requiredFields): void
{
    $missingFields = [];

    foreach ($requiredFields as $field) {
        if (empty($data[$field])) {
            $missingFields[] = $field;
        }
    }

    if (!empty($missingFields)) {
        throw new Exception('Не указаны обязательные параметры: ' . implode(', ', $missingFields));
    }
}

Буду рад вашим советам

Comments

[Adamos]

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

[Ипатьев]

Чтобы называете словом "не передан"?
Если функцию addCourse() вызвать без одного из параметров, то РНР и так выдаст ошибку.
А если вызывать её, передавая элементы массива $_POST, то РНР будет сыпать Warning-ами при отсутствии нужного параметра
Проверять надо ДО её вызова.

Функция нормальная, только во-первых, она не должна кидать никаких исключений. Ну или хотя бы кидать своё собственное исключение.
А во-вторых, её можно сделать короче, с использованием array_diff()

[Adamos]

Впрочем, если очень хочется... :)

$fieldValidation = [
  ['name' => 'name', 'type' => 'non-empty'],
  ['name' => 'date_from', 'type' = 'date'],
  ['name' => 'email', 'type' => 'regex', 'regex' => '.+@.+\..+'] // это пример, а не образец ;)
];

Дальше цикл, проверки....
вынесение типов в константы...
класс валидации для использования в будущем...
ну, и наконец - замена его на то, что сто лет как сделано, отлажено и стало стандартом - например, из Symfony.

Answer 1

[Ипатьев]

Отдельно проверять наличие нет смысла. Если уж валидировать, то нормально, каждое поле, на соответствие ожидаемому формату. Ну и заодно и наличие.
А скопом если проверять, то скорее на наличие лишних полей.

Плюс никаких исключений. Странно, что я не обратил на это внимание в прошлый раз, там этот говнокод с try catch просто везде. Самому не надоедает всё время писать эти тру, кетч, ретурн для каждого запроса? И с какой стати пользователь API должен читать, что в БД нету например нужной таблицы? Это ВНУТРЕННЯЯ информация, которая не должна утекать наружу

Как вариант, метод validate должен возвращать массив с ошибками.
Если массив пустой, то используем данные
Если не пустой - возвращаем их пользователю.

Comments

[crack_user]

по поводу try catch - уже давно понял, что в таких моментах ему там не место) а сейчас просто для тестового кода оставил
спасибо

Answer 2

[Артём Дайнов]

Лично я сделал бы для каждого поля throw new Exception
таким образом я сам лично буду контролировать каждую кинутую ошибку.
Если вы хотите сократить количество throw new Exception, то объедините в в один if все поля, но тогда у вас отпадает возможность указать, кто не заполнен.
Далее, когда вы будете вызывать метод, используйте один try catch для всех методов, выполняющие что-то в одном контроллере.