プログラミング

【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系を使った開発を検討している人は、ぜひ参考にしてくださいね。

 

注目の記事

食に関する考察 自炊と節約は成立するのか?
雑記
食に関する考察 自炊と節約は成立するのか?

スキル関係の記事が多めの当ブログですが、今回は「食」をテーマに触れていきます。突き詰めていけば食も立派なスキルであり、奥が深いものです。更に、生活の基盤となるため多くの人がこの問題に直面することであり、健康とも直結するため仕事などにおけるパフォーマンスにも大きく関係します。   これから一人暮ら...

ネットワークとは【 第1回 ド素人のためのネットワーク講座】
ネットワーク
Wi-Fi,インターネット
ネットワークとは【 第1回 ド素人のためのネットワーク講座】

  身近なもの、普段から触れているものであっても、詳しく知らないものや、正しい理解が出来ていないものは多いですね。 その中の一つに「ネットワーク」というものがあります。   この講座は、一般的に言われる「コンピューター・ネットワーク」についてを説明していきます。 これからシステム関係の...

なぜ(・・? あなたはMacを使うのか?
雑記
AWS,Linux,MacBook,OS,Windows
なぜ(・・? あなたはMacを使うのか?

  あなたが使っているPCはなんですか?   たまに聞かれることがあります。 そこで「Macを使っています」と答えると「何故?」という次の問いが返ってくることがあります。   あなたがもしMacを使っているのであれば、このときになんと答えますか?   今回のテーマは、「何故Macを使っているの?」と...

【変数とは】初心者が最短でPHPを使えるようになるための実践的な学び方
プログラミング
HTML,PHP,プログラミング学習
【変数とは】初心者が最短でPHPを使えるようになるための実践的な学び方

  ※PHP初心者へ向けた内容となりますので、ある程度HTMLの知識がある方を対象とした内容になります。予めご了承ください。    Webプログラミングを学ぶ方はHTML、そしてCSSを学び、そしてJavascriptやPHPという順に学んでいくひとが多いでしょう。 私も実際に、似たような手順で学んでいきました。   ...

本当に価値のある宣伝方法 〜多くの人が実践している【間違った努力】とは〜
マーケティング
Facebook,note,Twitter,YouTube,集客
本当に価値のある宣伝方法 〜多くの人が実践している【間違った努力】とは〜

  YouTubeやTwitter、Facebookやnoteなど、いろんなサービスを使った集客方法があります。集客という視点ではなく、それ自体に人を集めたいという人も多いでしょう。   フォロワーやチャンネル登録者数を増やすために、多くの人が様々な取り組みをしていますが、その中でもひときわ意味のないことをただ繰り返して...

レベルアップ時のステータス表示編 PHPポケモン 48
プログラミング
PHP,PHPポケモン,ポケモン
レベルアップ時のステータス表示編 PHPポケモン 48

ステータスの表示 前回経験値バーのアニメーションとレベルアップ時の動的な変更を実装しましたが、レベルアップ時に表示されるステータスの実装は先送りにしていました。なので今回はそのステータス表示を作成しましょう。   ステータスはメッセージとして返却せずに、小モーダルを起動させるという方法で対応しま...

動画編集に役立つ基本的な考え方【Adobe AfterEffects】
動画編集
Adobe,AfterEffects,PremierePro,YouTube
動画編集に役立つ基本的な考え方【Adobe AfterEffects】

  YouTubeの人気に合わせて、動画編集の需要も高まってきましたが、その大変さから挫折してしまう人も続出しています。 動画編集は奥が深く、技術的な部分に関してはプロのクリエイターであっても自分がよく使うような一部しか把握していないのが普通であり、調べても該当する情報が出てきにくいということもあ...

捕獲処理実装編 PHPポケモン 80
プログラミング
PHP,PHPポケモン,ポケモン
捕獲処理実装編 PHPポケモン 80

捕獲処理の作成 前回モンスターボールのクラスを作成したので、今回は捕獲判定までの一連の処理を仕上げていきます。サービス自体は他のアイテムと一緒にするためItemServiceを呼び出し、その中で使用されたアイテムを判断して分岐を作ります。   バトル中のアイテムサービス(/App/Services/Battle/ItemService.ph...

カテゴリ

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