プログラミング

【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ポケモン「バトルシステム実装編〜補正値計算・乱数・急所〜」21
プログラミング
PHP,PHPポケモン,ポケモン
PHPポケモン「バトルシステム実装編〜補正値計算・乱数・急所〜」21

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

事業所検索サービス「児発ねっと」児童発達支援・放課後等デイサービス
ビジネスモデル
SEO対策,プログラミング,児童デイサービス,児童発達支援,放課後等デイサービス
事業所検索サービス「児発ねっと」児童発達支援・放課後等デイサービス

どうも、児発ねっとの中の人です。 この度は児童発達支援・放課後等デイサービスといった療育施設の事業所検索サービス「児発ねっと」を開始することになりました。 本ブログでは、プログラミングやデザインといった内容のコンテンツを紹介しているため、児発ねっとのサービスは少し異色になります。なので、今回...

ピカチュウから学ぶオブジェクト指向 〜トレイト編〜 4
プログラミング
PHP,PHPポケモン,オブジェクト指向,ポケモン
ピカチュウから学ぶオブジェクト指向 〜トレイト編〜 4

  ピカチュウから学ぶオブジェクト指向の第4弾は「トレイト(trait)の活用」についてです。更に、レベルシステムを導入すれば欠かせない経験値システムも合わせて実装します。 第3回からの続きとなりますので、もし前回をまだ見ていない人は是非ご参考ください。   それでは今回もピカチュウと一緒に、...

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

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

WordPressをローカルと本番環境で同じ状態にするために理解しておきたい3つのポイントを徹底解説
プログラミング
PHP,phpMyAdmin,WordPress
WordPressをローカルと本番環境で同じ状態にするために理解しておきたい3つのポイントを徹底解説

  WordPressで作ったサイトは通常のサイトと違い、DBが絡んでくるためローカル環境と本番環境を同一の状態で稼働させるには設定や更新されるディレクトリの知識が必要になります。 今回は、WordPressを使ったサイトを作成している人や、開発に挑戦しようとしている人に向けて、ローカルで作ったWordPressのサイ...

システムエンジニア向けまとめ情報サイト IT News Checker
ネットワーク
システムエンジニア向けまとめ情報サイト IT News Checker

新年のスタートダッシュが遅れ気味に見えるかも知れませんが、年末からじっくりと作業を進めており、やっとある程度形になりました。 師走の如く作業に走り、気分転換に雪遊びもしつつ、成人式を終えた辺りでリリースしたのが「IT News Checker」です。   IT News Checkerとは 簡潔に説明すると、まと...

簡単に良質なブログ記事を量産する3箇条【ネタがないとは言わせない】
ライティング
ブロガー,ブログ
簡単に良質なブログ記事を量産する3箇条【ネタがないとは言わせない】

  ブログの毎日のテーマ決めが大変・・・ そもそも良質な記事をどうやって書けるようになるのかわからない   こんな悩みを抱えていませんか? 始めたばかりで伸び悩んでいる人には多いのではないでしょうか。 今回はブログで収益化や、アクセス数を伸ばそうと考えている人へ向けて「簡単に良質なブログ...

PHPポケモン「野生ポケモン遭遇編」18
プログラミング
PHP,PHPポケモン,ポケモン
PHPポケモン「野生ポケモン遭遇編」18

  PHPポケモンが第18回にしていよいよバトルの第一歩、野生ポケモンとの遭遇編に突入です。 新しいコントローラーの作成と、バトル画面の作成、そしてポケモンデータの受け渡しなどを中心にご紹介します。   バトル画面の実装  ポケモンのゲームでも、野生ポケモンが現れるとバトル画面へ移管し...

カテゴリ

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