プログラミング

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

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

 

注目の記事

迷惑メールはなぜ届く?amazonや楽天を騙る悪質メールへの対処法とは
ネットワーク
amazon,スパム,メール,楽天
迷惑メールはなぜ届く?amazonや楽天を騙る悪質メールへの対処法とは

「いきなり迷惑メールが届くようになった」 「Amazonや楽天を装ったメールはどうやって見分ければいいの?」   知らない人からいきなり連絡が届いたり、登録もしていないようなサービスからメールが届けば、それは詐欺メールかも知れません。 スマホやパソコンが一般的に普及して、ネットでの買い物やサービスを利用...

わざマシン編 習得 PHPポケモン105
プログラミング
PHP,PHPポケモン,ポケモン
わざマシン編 習得 PHPポケモン105

わざマシンによる技習得 前回、わざマシンのアイテムクラスを作成したので、今回は実際に使用するまでの処理を作成していきます。 まずは、アイテムクラスに使用時の処理(effectsメソッド)を増設しましょう。   わざマシン01(/Classes/Item/ItemTM01.php) <?php require_once(root_path('Classes').'...

LANとWANについて【第2回 ド素人のためのネットワーク講座】
ネットワーク
IoT,LAN,WAN,Wi-Fi
LANとWANについて【第2回 ド素人のためのネットワーク講座】

  YQUALがお送りする、ド素人のためのネットワーク講座。 栄えある第2回は「LANとWANについて」です。   フロントエンジニアや現在プログラミングを学習中の方を中心に、ネットワークについての基礎的理解を深めていくための内容になっています。 ざっくりとした説明で物足りない、または細かく見ていった...

ポケモン預かりシステム編 PHPポケモン 85
プログラミング
PHP,PHPポケモン,ポケモン
ポケモン預かりシステム編 PHPポケモン 85

ポケモン預かりシステムとは ポケモンは手持ち(パーティー)に6匹しか入れることができません。そのため、ポケモンを捕まえた際にその上限に達していれば、ボックスへ転送するという仕組みをPHPポケモンでも実装していきます。これが、ポケモン預かりシステムです。 今回は前段階であるボックスの仕様決めをメイン...

進化直後の技習得編 PHPポケモン 65
プログラミング
PHP,PHPポケモン,ポケモン
進化直後の技習得編 PHPポケモン 65

進化直後の技習得 パーティー機能を導入に合わせて、至る場所を修正することになり、合わせて未実装だった機能を導入していきます。 見た目にはわからない部分や、とある条件が重ならなければ起こらない部分の作り込みが多いため、プレイユーザー目線からすると少し面白みが無いかも知れません。 ですが、そういっ...

フリーランスの最大の敵は休日!?正しい休息の取り方教えます
フリーランス
フリーランス,独立
フリーランスの最大の敵は休日!?正しい休息の取り方教えます

  フリーランスになりたての人は、仕事のペースがわからなかったり、無理に自分へ追い込みをかけて頑張ろうとしてしまうことがあります。 毎日を仕事でいることが、フリーランスにとっての心がけや意識のあり方としては大切ですが、それをそのままの意味で実行してしまうと明らかなオーバーペースになるのは事...

未経験からWeb系エンジニアとしてフリーランスになる現実的な方法教えます【軌道に乗れば起業も可能】
フリーランス
エンジニア,フリーランス,プログラミング学習,独立,起業
未経験からWeb系エンジニアとしてフリーランスになる現実的な方法教えます【軌道に乗れば起業も可能】

  セカンドキャリアとしてプログラミングやデザインを学習したい   そう考えてスクールを受講したり、独学で始める人が増えていますが、そのほとんどが実らずに挫折してしまいます。 ですが、学習方法と経験の積み方や職の選び方さえ間違えなければ、技術を身につけてフリーランスとして活動することも難しく...

PHPポケモン(α)第1回目の大型アプデ
プログラミング
PHP,PHPポケモン,ポケモン
PHPポケモン(α)第1回目の大型アプデ

第1回目 大型アップデートについて 本日、PHPポケモンの大型アップデートをしました。 今回のアップデートには全体的なデザインチェンジが含まれているため、今まで遊んでくれていた人も、新鮮な気持ちで初められることができるはずです。   デザインについては、PHPを使った開発をしている人からすれば馴...

カテゴリ

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