プログラミング

【Laravel】論理削除対応型existsバリデーションの実装方法

Laravel PHP
【Laravel】論理削除対応型existsバリデーションの実装方法

 

Laravelでは多くのバリデーションが提供されていますが、論理削除を使用している場合はそのままでは使えないものが複数あります。

今回は紐付けをする際に存在チェックで使用するexistsのソフトデリート対応のバリデーションを実装する方法をご紹介します。

 

 

カスタムバリデーションの追加

 

存在チェックをするためのexistsは論理削除に対応されていないため、導入されているテーブルを使用する際には使えません。比較的使用頻度が高いため、今回は他のバリデーション同様にパイプで登録できるようにプロバイダーへ登録します。

 

 

exists_soft_delete

 

まずはプロバイダーファイルを作成するために以下のコマンドをLaravel直下で実行しましょう。

php artisan make:provider ExistsSoftDeleteProvider

 

以下のディレクトリにファイルが作成されます

app/Providers/ExistsSoftDeleteProvider.php

 

ファイルの中身を以下のように書き換えます。

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use Illuminate\Support\Facades\Validator;

class ExistsSoftDeleteProvider extends ServiceProvider
{
    /**
     * Register services.
     *
     * @return void
     */
    public function register()
    {
        //
    }

    /**
     * 論理削除の条件下で存在チェック
     *
     * @return void
     */
    public function boot()
    {
        Validator::extend('exists_soft_delete', function ($attribute, $value, $parameters, $validator) {
            return \DB::table($parameters[0])->where($parameters[1] ?? 'id', $value)
            ->whereNull('deleted_at')
            ->exists();
        });
    }
}

 

簡単に解説です。

まず、バリデーションを登録するためにValidatorを宣言します。

use Illuminate\Support\Facades\Validator;

 

boot内の処理についてです。

Validator::extend('exists_soft_delete', function ($attribute, $value, $parameters, $validator) {
   return \DB::table($parameters[0])->where($parameters[1] ?? 'id', $value)
   ->whereNull('deleted_at')
   ->exists();
});

 

バリデーション名はextendの第一パラメーターで指定します。今回はexists_soft_deleteとしていますが、もし別称が良ければ覚えやすいものを使ってください。

次にコールバック関数の中身ですが、バリデーションのパラメーターで存在チェック用のテーブルを指定するためDBを使用します。

existsと同様に、第一パラメーターににテーブル名、第二パラメーターにカラム名(省略可)を指定できるようにするため、tableには$parameters[0]where句を$parameters[1]として 飛んできた値の$valueをチェックにかけます。

カラム名に関しては、省略すれば自動でidをチェックしてもらうよう$parameters[1] ?? ‘id’というようにNull合体演算子を使用します。

このままだと通常のexistsと同じになるため、論理削除に対応させるためwhereNull(‘deleted_at’)を繋げてからexists()で判定チェックをします。

 

 

プロバイダー登録

 

バリデーターを作成したらプロバイダー登録をします。以下のコンフィグファイルに記述を追加します。

config/app.php

 

130行付近にprovidersの配列が用意されているので、最終行に以下の記述を追加しましょう。

 App\Providers\ExistsSoftDeleteProvider::class,

 

追加したら以下のコマンドを実行します。

php artisan config:cache

 

最後にエラーメッセージを追加します。以下のファイルにexists_soft_deleteを追加しましょう。

resources/lang/ja/validation.php

※jaファイルを作成していない場合はenに登録してください

 

配列内のexistsの下に以下の記述を追加します。

'exists_soft_delete' => '選択された:attributeは、有効ではありません。',

 

これでバリデーションが利用できるようになりました。リクエストファイルのrulesexistsと同じ要領で記述して使用しましょう。

'user_id' => 'required|exists_soft_delete:users',

 

これでメッセージが正常に表示されたら完了です。

 

 

まとめ

 

いかがだったでしょうか。

Laravelはカスタム機能が豊富なので、使用頻度の高いバリデーションを実装したい場合は早めにプロバイダー登録をして開発をスムーズに進めましょう。

論理削除を導入している人は、ぜひ参考にしてくださいね。

 

注目の記事

get_template_partで引数を渡す方法(WordPress5.5以降)
プログラミング
PHP,WordPress
get_template_partで引数を渡す方法(WordPress5.5以降)

WordPress5.5へのバージョンアップで、大きく機能が追加されました。中には変更に戸惑っている人もいるかも知れませんが、個人的にはエンジニアの要望を大きく取り入れて自由度がアップした印象があります。 今回はその中でも、多くの方が待ち望んでいた「get_template_part」の変更点についてご紹介します。 ge...

3日坊主にならないために
雑記
ブログ,プログラミング
3日坊主にならないために

  プログラミングに挑戦してみたが、途中で挫折した人 ブログを書き始めたが、まったく続かない人   継続することの大切さは分かっても、なかなか難しいものです。 しかしそれは、取り組み方を見直すだけで、実は簡単に解決できてしまうものなのです。 今回は、そんな「3日坊主」と呼ばれる人が、そ...

【Laravel】論理削除対応型existsバリデーションの実装方法
プログラミング
Laravel,PHP
【Laravel】論理削除対応型existsバリデーションの実装方法

  Laravelでは多くのバリデーションが提供されていますが、論理削除を使用している場合はそのままでは使えないものが複数あります。 今回は紐付けをする際に存在チェックで使用するexistsのソフトデリート対応のバリデーションを実装する方法をご紹介します。     カスタムバリデーションの追加   存...

バトルステータス可視化編 PHPポケモン 70
プログラミング
PHP,PHPポケモン,ポケモン
バトルステータス可視化編 PHPポケモン 70

バトルステータスの可視化 現在のポケモンでは、バトルステータスの現状を可視化できるようになっており、どれぐらいのランク補正がかかっているか、フィールドがどういう状態になっているかがわかるようになっています。 初代、第2世代等では確認できなかった内容ではありますが、システムとしては便利な要素でも...

状態異常演出編 PHPポケモン 62
プログラミング
PHP,PHPポケモン,ポケモン
状態異常演出編 PHPポケモン 62

状態異常の演出 今回は「状態異常」にかかった際の動的な変更、演出を実装していきます。 どく状態になれば、メッセージに合わせて「どく」を表記、まひ状態になれば、メッセージに合わせて「まひ」をセットするという単純なものです。   返り値の変更 それではまず、状態異常をセットしてメッセージを生成して...

進化アニメーション 前編 PHPポケモン 59
プログラミング
PHP,PHPポケモン,ポケモン
進化アニメーション 前編 PHPポケモン 59

進化アニメーションの実装 今回は後回しにしていた進化アニメーションの作り込みをしていきます。今までもレベルに達すれば進化はしていましたが、その演出はありませんでした。また、ポケモンではBボタンを押すことで進化のキャンセルをすることができます。なので、この辺りも実際のゲームを再現していきましょう。...

ダメージ固定技編(ちきゅうなげ・カウンター) PHPポケモン 41
プログラミング
PHP,PHPポケモン,ポケモン
ダメージ固定技編(ちきゅうなげ・カウンター) PHPポケモン 41

ダメージ固定技とは PHPポケモンでも作成したダメージ計算機能ですが、ポケモンの技の中にはそれを必要としない技がいくつかあります。それが「固定ダメージ技」です。 ポケモンwiki(ダメージ固定技) https://wiki.ポケモン.com/wiki/ダメージ固定技 ステータスに依存せず、わざ自体にダメージ量が決...

フォームはもう古い?サイトのCVRを高くするチャットシステムとは
マーケティング
CVR,ECショップ
フォームはもう古い?サイトのCVRを高くするチャットシステムとは

  サイトのコンバージョン率を上げたい お問い合わせフォームから連絡が来ない   ちょっとWebサイトやネットショップを立ち上げても中々思うような結果につながらない時代になりました。数多くのサイトが出回っていることはもちろん、ユーザーの閲覧頻度が増えて目が肥えているというのも大きな理由の1...

カテゴリ

SEO対策 イベント デザイン ネットワーク ビジネスモデル フリーランス プログラミング マーケティング ライティング 動画編集 雑記

タグ

5G Adobe AfterEffects AI ajax amazon Animate api artisan atom Automator AWS Bluetooth CSS CVR description EC-CUBE4 ECショップ ESLint Facebook feedly foreach function Google Google AdSense Honeycode htaccess HTML IEEE 802.11ax Illustrator Instagram IoT JavaScript jQuery jQuery UI keyword LAN Laravel Linux MacBook MAMP meta MLM MySQL NoCode note OS OSI参照モデル Paypal Photoshop PHP phpMyAdmin PHPポケモン PremierePro rss SEO SEO対策 Sequel Pro Skype SNS SSH Symfony TCP/IP title Toastr Trait Twig Twitter UCC V系 WAN WebSub Wi-Fi wiki Windows WordPress XAMPP xml Xserver YouTube YouTuber Zoom アーティスト アウトプット アクセス層 アニメーション アフィリエイト イーブイ インターネット インプット エンジニア オブジェクト指向 お金配り クリック単価 クリック数 コミュニケーション能力 コロナ コンサルティング サムネイル システムエンジニア スタートアップ スタイルシート スパム データベース ディープフェイク デザイナー デザイン テレワーク ナンパ ニュース ネットワークモデル ノマドワーク バナー ピカチュウ ビジネス フィード フリーランス ブロガー ブログ プログラマー プログラミング プログラミング学習 プログラミング教育 プロトコル ホームページ制作 ポケモン マークアップ マーケティング メール リモートワーク レンダリング 三井住友 三宮 仕事依頼 児童デイ 児童デイサービス 児童発達支援 公開鍵 初心者 助成金 勉強法 営業 広告 広告収入 必勝マニュアル 放課後等デイサービス 朝活 楽天 深層学習 無線LAN 独立 神戸 福祉 秘密鍵 翻訳 自己啓発 英語 見積書 計算機 読書 起業 迷惑メール 配列 銀の弾丸 集客 雑学力