Как в Laravel prepareForValidation вернуть обработанное значение при ошибке валидации?

Question

[Sanes]

Если отправить пустое поле alias, оно сформируется на основе другого поля pagetitle.
Если не проходит валидация, то надо вернуть обработанное поле в форму.
Как это можно сделать?

CategoryStoreRequest

<?php

namespace App\Http\Requests\Admin;

use Illuminate\Foundation\Http\FormRequest;
use Str;

class CategoryStoreRequest extends FormRequest
{
    /**
     * Determine if the user is authorized to make this request.
     *
     * @return bool
     */
    public function authorize()
    {
        return true;
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array<string, mixed>
     */
    public function rules()
    {
        return [
            'pagetitle' => 'required|string|min:5|max:255|unique:categories,pagetitle',
            'alias' => 'required|string|min:2|max:255|unique:categories,alias',

        ];
    }

    protected function prepareForValidation()
    {
        if($this->alias == null)
        {
            $this->merge([
                'alias' => Str::slug($this->pagetitle),
            ]);
        }
        else
        {
            $this->merge([
                'alias' => Str::slug($this->alias),
            ]);            
        }
    }

}

Comments

[Алексей Уколов]

Что значит "вернуть в форму"? Вы хотите показать ошибки валидации в форме и при этом сразу заполнить ошибочное поле "дефолтным" значением? В чём смысл этих телодвижений, почему бы просто не перестать считать незаполненность поля ошибкой валидации?

[Сергей delphinpro]

Алексей Уколов, валидация может не пройти по другим полям, а в old() видимо возвращается то что пришло из формы. То есть пустой алиас не приводит к ошибке валидации, но сгенерированный не возвращается при других ошибках.
(Хотя я не уверен на 100%, не помню)

[Sanes]

Сергей delphinpro, Алексей Уколов, в old() приходят отправленные значения. Но раз мы решили их обработать, то логично вернуть обработанные значения.
Механизм подготовки вроде есть, но как с ним работать непонятно.

[Sanes]

Алексей Уколов,

В чём смысл этих телодвижений

Смысл в коде. Вроде там всё понятно.
Заполняется пустое поле или приводится к типу slug заполненное. Поле обязательное и уникальное.

[Дмитрий]

Sanes, не. Реально не понятно зачем валидировать то что вы генерируете исходя из уже отвалидированных данных. Вы себе не доверяете? Или методу slug?

[Sanes]

Дмитрий, допустим я хочу получить slug от заголовка

Как в Laravel prepareForValidation вернуть обработанное значение при ошибке валидации?

Мне руками это всё переводить в человеческий вид?

[Дмитрий]

Sanes, да получайте сколько хотите, зачем ещё раз это валидировать?
Старый ералаш вспоминается - а на этот случай у меня проездной

[Сергей delphinpro]

Sanes, Попробуйте

/**
 * @param  \Illuminate\Validation\Validator  $validator
 */
public function withValidator($validator)
{
    $validator->after(function ($validator) {
      $validator->  // Here
    });
}

покопайтесь в методах валидатора, может есть что-то

[Sanes]

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

[Sanes]

Дмитрий, вернет ошибку и то, что отправлял. Мы не можем понять, во что он преобразовал и что в итоге проверял.

[Дмитрий]

Sanes, ну дык напишете свой кастомное правило которое будет проверять уникальность имени и slug от неё. Напишите тест - если попрежнему не уверены что Str::slug сделает нужное

[Дмитрий]

Sanes, в смысле вы не можете понять во что он преобразовал?

Представьте гипотетическую ситуцию. Пользователь шлёт вам int, вы должны записать его, а в соседнюю колонку - это число умноженное на 2? Вы тоже будете это валидировать? Думаю нет.

У меня сильное подозрение что то создание slug , нужно делать в модели (скорее всего), в afterValidation (не скорее всего) - где угодно но не в prepareForValidation

[Sanes]

Сергей delphinpro, вряд ли осилю.

[Sanes]

если попрежнему не уверены что Str::slug сделает нужное

Всё он правильно делает. Вопрос перечитайте пожалуйста.

[Sanes]

Дмитрий,

У меня сильное подозрение что то создание slug , нужно делать в модели

Делаем в моделе, получаем не уникальное значение и вылет с ошибкой БД.

[Сергей delphinpro]

Sanes,

Делаем в моделе, получаем не уникальное значение и вылет с ошибкой БД.

Эти преобразования происходят до валидации.
Потом валидация. Пропишите для алиаса еще одно правило на уникальность, и никаких вылетов Бд не будет. Пример проверки на уникальность есть в документации (там про юзеров)

что-то не то написал...

[Sanes]

Сергей delphinpro, в методах store/update я могу получить эти данные. Осталось как-то передать в create/edit.

$validated = $request->safe();
dd($validated);

Есть метод withInput(), но как он работает не нашел.

[Сергей delphinpro]

Sanes,

->withInput([
  'alias' => $newAlias
])

[Сергей delphinpro]

Sanes, ну вот. А говорили, не осилите =)

Answer 1

[Sanes]

public function rules()
    {
        return [
            'pagetitle' => 'required|string|min:5|max:255|unique:categories,pagetitle',
            'alias' => 'required|string|min:2|max:255|unique:categories,alias',

        ];
    }

    protected function prepareForValidation()
    {
        if($this->alias == null)
        {
            $this->merge([
                'alias' => Str::slug($this->pagetitle),
            ]);
        }
        else
        {
            $this->merge([
                'alias' => Str::slug($this->alias),
            ]);            
        }
    }
    
    public function withValidator($validator)
    {
        $validator->after(function ($validator) {
            request()->merge([
                'alias' => $this->request->get('alias')
            ]);

            // $validator->errors()->add('alias', 'Something is wrong with this field!');
        });
    }

Answer 2

[Дмитрий]

Sanes, вопрос прочитал. Но ваш подход не правилен и не понятен. Окей забыли про single responsibility principle, у вас валидатор не только валидирует - но и создает данные, если вы банально модель решите создавать не только по пользовательскому щелчку а еще где нибудь в коде - вы тоже будете прогонять через CategoryRequest? Или появится еще одно место где будет генерироваться slug?

Comments

[Sanes]

Для каждой формы свой класс Request. Там мало что пересекается. Все инструменты есть в Laravel.
Проблема заключается в том, чтобы вернуть не отправленные данные, а уже обработанные.

[vism]

ох уж эти борцы за чистоту кода...

[Sanes]

vism, если этот метод предусмотрен разработчиками, почему бы им не воспользоваться.

[vism]

Sanes, дык для того он и сделан, этот метод)))

[Дмитрий]

vism, ну за чистоту кода обычно начинаешь бороться сразу после того как посидишь пару недель в техдолге какого нибудь проекта в котором на это клали хер

[vism]

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

[Дмитрий]

vism, ну мы здесь вроде общаемся, а не работаем. Над нами нет ни хозяина, под нами нет индуса. Что заставляет рекомендовать вещи которые потом придется переделывать?

[Sanes]

Дмитрий, валидация и подготовка данных в одном месте. Что вас тут смущает?

[vism]

Я тут вас удивлю, но, для педантов уточню, FormRequest это не валидация данных. Это работа с FORM REQUEST А работа там может быть разная. Я вобще не понимаю о чем речь :)

[Дмитрий]

Sanes, я уже написал и посоветовал вынести это из formrequest что бы при создании моделей не из данных пользователя генерировать нужные данные. Если уж вам так нужно валидировать в формреквест уникальность slug - используйте Rule::unique().

Но вы считаете правильным ваш вариант - ну ок.

[vism]

Sanes, А с последним коментом я соглашусь, сам метод генерации slug вынести куда-то, для того, чтоб это был единый метод. Даже если из данных пользователя, пусть будет отдельная функция где-то, в сервис классе например.

[Дмитрий]

vism, угу. а если внимательно посмотреть и на первый - то там же ровно тоже самое написано.

[Sanes]

Дмитрий, vism, может и надо вынести. Для меня сейчас важней, что бы я понимал, что происходит.
Я не синьор в третьем поколении.

[vism]

Sanes, Это верно, главное пиши то, что понимаешь. А то видел чудаков, которые прочитают про паттерны и начинают внедрять, ужасно усложняя код и делают это плохо.
Код должен быть как можно проще для выполнения своей задачи + с заделом на поддерживаемость и расширение, но без фанатизма. Лучше сделать просто и быстро, а потом отрефакторить

[Sanes]

vism, вот тоже так стараюсь делать.

[Сергей delphinpro]

vism,

сам метод генерации slug вынести куда-то, для того, чтоб это был единый метод.

Вот этого не понял.
Он и так уже вынесен. Разработчиками ларки, в хелпер класс Str.

Str::slug(),

Зачем это еще куда-то выносить?

[Дмитрий]

Сергей delphinpro, Вынести логику: создаём slug из pagetitle если slug пустой.

[Сергей delphinpro]

Дмитрий Тремасов, Да там логики на одну строку

protected function prepareForValidation()
{
    $this->merge([
        'alias' => Str::slug($this->alias ?? $this->pagetitle),
    ]);
}

ну или ?:

[Дмитрий]

Сергей delphinpro, здорово. Представьте что у вас модель создаётся не только через контроллер, но и прилетает из какой нибудь очереди которую вы мониторите, импортируется по крону из какого нибудь стороннего сайта. Вы везде расставляете эту одну строчку. А потом бац и надо поменять логику - генерация должна браться как pagetitle + id. И вы поползли менять в одном месте поменяли, во втором поменяли. А в третьем забыли. И начался рассколбас. В случае со slug это не так страшно, но привыкая к такими вещам можно как нибудь поймать немножко боли

[vism]

именно

[Сергей delphinpro]

Дмитрий Тремасов, как бы вы вынесли эту логику?
Такой вариант, очевидно, не подходит

function make_slug($title, $slug = null) { … }

То же самое, что и без него.

Значит нужно весь пак атрибутов передавать

function make_slug(array $attributes) { … }

..

$this->merge([
    'alias' => make_slug($this->toArray()),
]);

[Дмитрий]

Сергей delphinpro, без контекста сложно судить что будет лучше
Но первый вариант который приходит на ум использовать события модели - creating, в котором ловить ситуацию когда создаётся модель без slug и генерить