プログラミング

【Laravel7】既存makeテンプレートのカスタマイズ Requestサンプル有り

Laravel Linux PHP
【Laravel7】既存makeテンプレートのカスタマイズ Requestサンプル有り

 

Laravel7では新しい機能が様々導入されており、Webアプリケーションの開発がよりスムーズなものとなってきています。その中でも、もどかしい場所へ手を届いたと感じさせてくれたのが、既存makeコマンドのstubを簡単にカスタマイズできるようになったことです。

 

今回は既存make用stubの取得コマンドと、リクエスト用雛形のカスタマイズについてご紹介します。

 

 

make用テンプレートの取得

 

Laravel7系より前では、requestmodelなどのmakeコマンドで作られる雛形をカスタムするためには、新しい雛形用のmakeコマンドを作成する必要がありました。ですが、Laravel7からは雛形そのものを修正できるようになったため、カスタマイズが今まで以上に簡単になりました。

 

まず、テンプレートであるstubファイルを自分の開発環境下に取得するためのコマンドを実行します。

$ php artisan stub:publish

 

上記コマンドを実行して、成功メッセージが出ればLaravelルートにstubsディレクトリが生成され、以下のファイル群が生成されます。

Stubs published successfully.
stubs/console.stub
stubs/controller.api.stub
stubs/controller.invokable.stub
stubs/controller.model.api.stub
stubs/controller.model.stub
stubs/controller.nested.api.stub
stubs/controller.nested.stub
stubs/controller.plain.stub
stubs/controller.stub
stubs/factory.stub
stubs/job.queued.stub
stubs/job.stub
stubs/middleware.stub
stubs/migration.create.stub
stubs/migration.stub
stubs/migration.update.stub
stubs/model.pivot.stub
stubs/model.stub
stubs/policy.plain.stub
stubs/policy.stub
stubs/request.stub
stubs/rule.stub
stubs/seeder.stub
stubs/test.stub
stubs/test.unit.stub

 

あとは、カスタマイズしたいmakeコマンド用のstubファイルをカスタマイズするだけです。

 

 

make:requestのカスタマイズ

 

では1例としてmake:requeststubファイルをカスタマイズしてみます。ご自身の開発で不要になる部分については無視してください。

 

request.stubの初期状態は以下の通りです。

<?php

namespace {{ namespace }};

use Illuminate\Foundation\Http\FormRequest;

class {{ class }} extends FormRequest
{
    /**
     * Determine if the user is authorized to make this request.
     *
     * @return bool
     */
    public function authorize()
    {
        return false;
    }
 
    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            //
        ];
    }
}

  

この雛形を、以下4つの条件を想定してカスタマイズをします。

  • 認証有り
  • 日本語パラメーターの設定
  • エラーメッセージのカスタマイズ
  • リクエストデータの加工

 

 

認証有り

 

認証有り用のカスタマイズは、authorize()でtrueを返却するだけです。

/**
* Determine if the user is authorized to make this request.
*
* @return bool
*/
public function authorize()
{
    return true;
}

 

もし認証を必要としない場合や、特別な処理が必要な場合は、頻度の多いものを記述しておくと開発が楽になります。

 

 

日本語パラメーターの設定

 

次にパラメーターを日本語化するためのattributesメソッドを、rulesの後ろに追加します。

/**
 * パラメーターの日本語化
*
* @return array
*/
 public function attributes()
{
    return [
        //
    ];
}

 

例えば名前の入力フォーム(name)を必須項目にした場合、標準では「nameは、必ず指定してください」と返ってきてしまいます。そうならないためにも、requestの雛形にはカスタマイズ用のattributesを準備しておくと便利です。システム内で多様するものであれば、validation.phpattributesへ設定するようにしておきましょう。

 

バリデーションメッセージを一括で日本語化したい場合は、以下の「バリデーションメッセージの日本語化」をご参考ください。

【Laravel7】バリデーションメッセージの日本語化【6系対応】 【Laravel7】バリデーションメッセージの日本語化【6系対応】

  Laravelのバリデーションメッセージは標準だと英語で返ってきてしまいますね。 1つずつ変更する方法もありますが、言語ファイルを作成して一括変更するほうが開発時間の短縮に繋がります。   今回は「Laravel7のバリデーションメッセージを日本語化する方法」をご紹介します。Laravel6系でも同じ方法ででき...

 

 

メッセージのカスタム

 

次にメッセージのカスタマイズ用メソッドattributesの後ろに追記します。

/**
* 定義済みバリデーションルールのエラーメッセージ取得
*
* @return array
*/
public function messages()
{
    return [
        //
    ];
}

 

場合によっては標準のエラーメッセージだと意味が通らないものも出てきます。そういった時のためにrequestの雛形へ準備しておくと便利です。

 

 

リクエストデータの加工

 

最後はリクエストデータの加工用メソッドmessagesの後ろに追記します。

/**
* リクエストデータの加工
*
* @return void
*/
protected function prepareForValidation()
{
    //
}

 

こちらの使用頻度は他と比べれば少ないですが、場合によっては必要になりますので、テンプレートとして準備しておきます。不要の場合は削除するだけですので、数回でも利用することがあれば最初から準備しておくに越したことはありません。

 

 

以下が最終のリクエスト用stubの内容になります。

<?php

namespace {{ namespace }};
use Illuminate\Foundation\Http\FormRequest;

class {{ class }} 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 [
            //
        ];
    }
    /**
    * パラメーターの日本語化
    *
    * @return array
    */
    public function attributes()
    {
        return [
            //
        ];
    }

    /**
    * 定義済みバリデーションルールのエラーメッセージ取得
    *
    * @return array
    */
    public function messages()
    {
        return [
            //
        ];
    }

    /**
    * リクエストデータの加工
    *
    * @return void
    */
    protected function prepareForValidation()
    {
        //
    }
}

 

他にも利用頻度の高いメソッドや、クラスなどがある場合は事前に準備しておくと開発スピードはもちろんエラー回避につながります。

 

  

まとめ

 

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

今回は「【Laravel7】既存makeテンプレートのカスタマイズ」について、既存makeコマンドのstub取得方法とそのリクエストの一例をご紹介しました。

Laravel7系はまだリリースされて間もないですが、開発の助けになる要素が数多く含まれています。

これから7系を使った開発を検討している人は、ぜひ参考にしてくださいね。

 

注目の記事

PHPポケモン「バトルシステム編〜経験値の獲得〜」29
プログラミング
PHP,PHPポケモン,ポケモン
PHPポケモン「バトルシステム編〜経験値の獲得〜」29

経験値の獲得 今まではポケモンに直接経験値を与えるというチートびっくりの仕様でしたが、バトルシステムも終盤に差し掛かってきたので「倒したポケモンから経験値を取得する」というごく当たりまえの仕様を導入していきます。   基礎経験値の設定 では、経験値の計算式に入る前に、必要なパラメーターを1つ用...

PHPポケモン「オートロード編(修正版)」17 おまけ:日本語化
プログラミング
PHP,PHPポケモン,ポケモン
PHPポケモン「オートロード編(修正版)」17 おまけ:日本語化

  前回実装したオートローダーの使い方が盛大に間違っていたので、今回その間違いの説明をしながら、正しい実装方法をご紹介します。 申し訳ありません。(誠意)    オートロードについて(再)  必要なタイミングで必要なファイルをrequireまたはincludeするあれです。   前回spl_autoload_reg...

戦闘不能による交代編 PHPポケモン84
プログラミング
PHP,PHPポケモン,ポケモン
戦闘不能による交代編 PHPポケモン84

戦闘不能による交代 ポケモンが戦闘不能になった際、もし手持ちに戦える状態のポケモンが残っていれば「交代」か「逃げる」の2択になります。今までは手持ちポケモンが1匹のみで判定を行っていたので、今回は交代の選択肢も含めて勝負の判定の見直しをしていきます。   パーティーを含めた勝負判定 味方または...

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

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

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

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

なぜプロは有線のマウスやキーボードを選ぶのか?【有線VS無線】
雑記
Bluetooth
なぜプロは有線のマウスやキーボードを選ぶのか?【有線VS無線】

  無線が普及する現代、何故有線のマウスやキーボードは売れているのか   いろんなものが製品の進化と共に無線化している一方、有線の需要も高く、とくにプロなど上層で活躍する人は有線を選択するケースが少なくありません。 今回は、そんな有線と無線の違いや、それぞれのメリットについて解説していき...

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

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

飲食店がホームページを作る5つのメリット 〜デメリットについても解説します〜
マーケティング
Google AdSense,SEO
飲食店がホームページを作る5つのメリット 〜デメリットについても解説します〜

  お店のホームページを作りたい   そういった飲食店の方は意外にも多く、イタリアンや居酒屋、日本料理店など種類も様々です。   今回のテーマは「飲食店がホームページを作る上で知っておきたいメリットとデメリットについて」です。   食べログやホットペッパーなどといったグルメサイトが主流とな...

カテゴリ

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