リクエストに対するバリデーションはLaravelのリクエストを拡張したクラスを利用することでできます。

例えば以下のようなリクエストクラスを作成することで、コントローラーが処理をする際に検証済のリクエスト情報になっています

class StorePostRequest 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
     */
    public function rules()
    {
        return [
            'title' => 'required|string|max:60',
            'body' => ['required'],
            'category' => 'required|string|max:50',
        ];
    }
}

これは、viewファイル(blade)でerrorsにて拾うことができます

@if ($errors->any())
	    <div class="alert alert-danger">
	        <ul>
	            @foreach ($errors->all() as $error)
	                <li>{{ $error }}</li>
	            @endforeach
	        </ul>
	    </div>
	@endif

今回はドメインルール（仕様）などの検証結果をオブジェクトで返したい時を考慮してみます。

フォームから送られてきた内容ではなくてエンティティクラスに対して検証を行う感じです。

githubにコードはアップロードしています。(タグa1)

構成としては、

ルールクラスがあります。ルールクラスは実際に検証を行い結果を返します。結果は検証に失敗した場合にメッセージも付与できるようにします。実装クラスはcheckRuleメソッドにてその検証を定義します。

バリデーションクラスは、これらのルールクラスを管理する配列を持ちます。そしてvaildメソッドを全てのルールを実行します。配列に入れるルールは実装クラスが選択できるようにします。またコンストラクタにて必要なエンティティクラスなどを渡すようにします。

検証結果クラスは検証結果のboolとメッセージの配列を持っています。検証結果がfalseの場合はメッセージの配列をview側に渡すなどすればviewでメッセージの一覧を表示できます

こんな適当エンティティクラスがあります。今回の検証対象です。

<?php

namespace App\MaruValidationSet\SampleModel;

class SampleModel{

    private string $name;

    private int $point;

    public function __construct(string $name, int $point)
    {
        $this->name = $name;
        $this->point = $point;
    }

    public function overPoint() : bool
    {
        return $this->point > 99;
    }

    public function isMisaka() : bool
    {
        return $this->name === "misaka";
    }

}

これらの検証を行います

コントローラーでやっちゃってますが、エンティティを作成したら、バリデーション実装クラスに渡して、そのまま検証処理を呼出します。

すると結果オブジェクトが返ってきますで、検証結果を元にメッセージをviewに返します。

public function storeSample(Request $request)
    {

        $model = new SampleModel($request->name, $request->point);
        // バリデーションの実行
        $validation = new SampleValidation($model);
        $result = $validation->vaild();
        
        if(!$result->getResult())
        {
            return back()->withInput()->withErrors($result->getMessages());
        }

        return view('exampleview');
    }

これなら、様々なロジックに合わせて検証クラスを作成できます。

バリデーションクラスは抽象クラスを実装します。

抽象クラス

<?php

namespace App\MaruValidationSet\Validation;


use App\MaruValidationSet\MaruResult;
use App\MaruValidationSet\Rule\MaruRule;

/**
 * バリデーションは登録されたルールを実行して
 * 結果オブジェクトを返却します。
 */
abstract class MaruValidation {

    private array $rules = array();

    /**
     * 初期化処理でルールを設定するようにする
     */
    protected abstract function init();

    /**
     * 設定されたルールを全て実施して
     * Resultオブジェクトを返却します。
     */
    public function vaild() : MaruResult
    {

        if($this->rules === null)
        {
            return new MaruResult();
        }

        $maruResult = new MaruResult();

        array_walk($this->rules, function(MaruRule $rule) use($maruResult){

            $rule->checkRule();
            if(!$rule->getResult()){
                $maruResult->setResult($rule->getResult());
                $maruResult->setMessage($rule->getMessages());
            }
        });

        return $maruResult;
    }

    public function addRule(MaruRule $rule)
    {
        if($this->rules === null){
            $this->rules = array();
        }
        array_push($this->rules,$rule);
    }

    public function addRules(MaruRule ...$rules)
    {
        foreach($rules as $rule){
            array_push($this->rules, $rule);
        }
    }

    public function setRules(array $rules)
    {
        // convert rule class
        $this->rules = array_map(function(MaruRule $rule){
            return $rule;
        },$rules);

    }
    
}

実装クラス

<?php


namespace App\MaruValidationSet\Validation;

use App\MaruValidationSet\Logic\SampleLogic;
use App\MaruValidationSet\Rule\Example\CheckNameRule;
use App\MaruValidationSet\Rule\Example\CheckOverPointRule;
use App\MaruValidationSet\Rule\Example\CheckSampleLogicRule;
use App\MaruValidationSet\SampleModel\SampleModel;

class SampleValidation extends MaruValidation{

    private SampleModel $model;

    // コンストラクタで必要なオブジェクトを受取っておく
    public function __construct(SampleModel $model)
    {
        $this->model = $model;
        $this->init();
    }

    // ルールを設定する
    public function init()
    {
        $this->addRules(
            new CheckOverPointRule($this->model),
            new CheckNameRule($this->model),
            new CheckSampleLogicRule(),
        );
    }

}

実装クラスでルールクラスを設定するので、様々な検証クラスを作成することができます

ルールクラスも抽象クラスを実装します。

抽象クラス

<?php


namespace App\MaruValidationSet\Rule;

use App\MaruValidationSet\MaruResult;

/**
 * ルールの基底クラスです。
 * ルールのチェックおよび、結果の返却を行います
 * ルールの詳細は実装クラスにて定義します
 */
abstract class MaruRule{


    protected bool $result = true;

    protected array $messages = array();


    public abstract function checkRule() : void;

    public function getResult() : bool
    {
        return $this->result;
    }

    public function getMessages() : array
    {
        return $this->messages;
    }
    
    protected function setMessage(...$messages)
    {
        array_walk($messages, function(string $message){
            array_push($this->messages, $message);
        });
    }
}

実装クラス

<?php

namespace App\MaruValidationSet\Rule\Example;

use App\MaruValidationSet\MaruResult;
use App\MaruValidationSet\Rule\MaruRule;
use App\MaruValidationSet\SampleModel\SampleModel;

class CheckNameRule extends MaruRule{

    private SampleModel $model;

    public function __construct(SampleModel $model)
    {
        $this->model = $model;
    }

    public function checkRule() : void
    {
        if($this->model->isMisaka())
        {
            $this->result = false;
            $this->setMessage("その名前は利用できません。");
        }
    }
}

実装クラスはエンティティのメソッドを呼び出して、その結果メッセージを設定しています。

もちろんエンティティ以外にも何らかのロジッククラスを利用することもできます。以下はDIを利用したパターンです

<?php

namespace App\MaruValidationSet\Rule\Example;

use App\MaruValidationSet\Logic\MaruLogic;
use App\MaruValidationSet\MaruResult;
use App\MaruValidationSet\Rule\MaruRule;
use App\MaruValidationSet\SampleModel\SampleModel;

class CheckSampleLogicRule extends MaruRule{

    public function __construct()
    {
    }

    public function checkRule() : void
    {

        $logic = app()->make('SampleLogic');

        if($logic->checkLogic())
        {
            $this->result = false;
            $this->setMessage("ブラックリストに登録されているため操作できません。");
        }
    }
}

これでリクエスト以外の検証も、ある程度規則性を持って行えるようになりました。

Laravelでエンティティの独自検証を行う