プログラミング

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

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

 

注目の記事

PHPポケモン「バトルシステム実装編〜ダメージ計算〜」20
プログラミング
PHP,PHPポケモン,ポケモン
PHPポケモン「バトルシステム実装編〜ダメージ計算〜」20

バトルシステムの実装  今回はバトルシステムの中でもメインとなるダメージ計算と、命中判定の部分を実装していきます。   ダメージ計算  ポケモンのダメージ計算は初代から現在までそこまで大きな変化はありません。最新世代ではダメージに関係する要素(アイテム等)が多く、それにより補正値の修正はあります...

PHPポケモン「バトルシステム実装編〜タイプ相性の判定〜」デモ&配布有り 19
プログラミング
jQuery,PHP,PHPポケモン,ポケモン
PHPポケモン「バトルシステム実装編〜タイプ相性の判定〜」デモ&配布有り 19

  システムを組むなら、仕様書や設計書はしっかり作りましょう。   ということで、またまたフォルダ移動やページ分けなどを見えないところでやりました。正直説明すると全く進まなくなりそうなので、改修部分は必要最低限にします。 結論、説明しません。(コード配布するので許してください)   そして今...

PHPポケモン「バトルシステム実装編〜補正値計算・乱数・急所〜」21
プログラミング
PHP,PHPポケモン,ポケモン
PHPポケモン「バトルシステム実装編〜補正値計算・乱数・急所〜」21

バトルシステムの実装  今回は「急所」と「乱数」と「タイプ一致」の判定と補正を実装していきます。 ちなみにですが、ポケモンwikiを熟読したところ、補正値の計算にも順番があり、計算後に小数点の切り捨てや五捨五超入をするなど、そこそこ複雑な計算順序がありましたが、今回はそこまで精密に再現せず、補正値(...

これをしてはいけません!「よくわかるSEO対策」エンジニアのための基礎知識編
SEO対策
htaccess,HTML,JavaScript,SEO,エンジニア,プログラミング
これをしてはいけません!「よくわかるSEO対策」エンジニアのための基礎知識編

  近年ではWebサイト制作会社や個人事業主はかなり増えてきました。 会社によっては力を入れている部分は異なり、主に「デザイン」「機能(システム)」「SEO」という3つに分けられます。 飽和しているのでは無いかと囁かれている中、この3つすべてを揃えた事業者は意外と少なく、個人となれば更に少なくなります。...

アクセス層とは – 物理的な信号の伝送【第4回 ド素人のためのネットワーク講座】
ネットワーク
TCP/IP,Wi-Fi,アクセス層,無線LAN
アクセス層とは – 物理的な信号の伝送【第4回 ド素人のためのネットワーク講座】

  第4回のド素人のためのネットワーク講座は アクセス層の物理的な役割について です。   実際にデータを送る際にはどのような信号が送られて、どういったことに影響を受けているのかを解説していきます。     信号を伝達する   TCP/IPモデルの第一層(レイヤー1)のアクセス層が担っている役割の...

PHPポケモン「バトルシステム実装編〜ランク補正〜」22
プログラミング
PHP,PHPポケモン,ポケモン
PHPポケモン「バトルシステム実装編〜ランク補正〜」22

ランク補正とは  ポケモンでは通常ステータスとは違い、バトル中にのみ変化するステータスが存在します。初代仕様であれば、「なきごえ」や「かたくなる」といった変化技により「こうげき」や「ぼうぎょ」の強化や弱体化をさせるものです。これはバトル中であれば引き継がれるものですが、交代やバトルが終了すればリ...

人に相談しても期待はするな【行動もどきって?成功する人と失敗する人の違いとは】
雑記
自己啓発
人に相談しても期待はするな【行動もどきって?成功する人と失敗する人の違いとは】

  「とにかく行動しろ」 「いろんな人に会え」 「どんどん外注しろ」   どれも覚えておきたい教訓ではありますが、その本質が見抜けなければ逆効果になります。 行動であっても、それが行動もどきになっている人は多く、人に会って人生が変わるということも受け身であれば全く意味がありません。外注に...

Laravelで生成したCookie情報をjQueryで取得する方法【JavaScript】
プログラミング
ajax,api,JavaScript,jQuery,Laravel,PHP
Laravelで生成したCookie情報をjQueryで取得する方法【JavaScript】

  今回はLaravel開発備忘録です。 ajaxでapi認証してviewに記述したhtmlデータを取得するために、cookieを使ったapi_tokenの受け渡し手順をまとめてみました。   Laravelを使った開発をしている人は、ぜひ参考にしてくださいね。     Laravel側の処理   まずはcookieにデータをセットする必要があり...

カテゴリ

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 独立 神戸 福祉 秘密鍵 翻訳 自己啓発 英語 見積書 計算機 読書 起業 迷惑メール 配列 銀の弾丸 集客 雑学力