この記事では

Laravelでデータベーステーブルのカラム名を変更する方法

を解説します。

検証はLaravel11で実施しました。

Laravelではマイグレーションファイルを作成・編集し、コマンドでテーブルを作成します。

その際、テーブルのカラム名を間違えて入力してしまうということも起こりえます。

また、仕様変更によってカラム名の変更が必要となる可能性も考えられるでしょう。

ケケンタ

今回ご紹介する方法を用いることで簡単にカラム名を変更できるので、ぜひご活用ください！

あわせて読みたい

PHPやWordPressを学ぶのにおすすめのプログラミングスクール【７選】 僕はこれまで独学でPHPを学習してきました。結論から言えば、それでもPHPを習得することはできました。 しかし、それに費やした累計学習期間は1年ほど。モチベーション…

【解説】Laravelでデータベースのカラム名を変更する方法

STEP１　マイグレーションファイルを作成する

まずは以下のコマンドでマイグレーションファイルを作成しましょう。

 php artisan make:migration change_column_name_comments_table

「change_column_name_comments_table」の部分の名前は任意です。（分かりやすい名前を推奨）

STEP２　マイグレーションファイルを編集する

続いて、作成されたマイグレーションファイルを編集していきます。

今回はnicesテーブルの外部キーを「comment_id」とするべきところ、誤って「post_id」にしてしまった状況を想定しています。

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    /**
     * マイグレーション実行時に動く処理
     */
    public function up(): void
    {
        Schema::table('nices', function (Blueprint $table) {
            $table->renameColumn('post_id', 'comment_id')->change();
        });
    }

    /**
     * ロールバック実行時に動く処理
     */
    public function down(): void
    {
        Schema::table('nices', function (Blueprint $table) {
            $table->renameColumn('comment_id', 'post_id')->change();
        });
    }
};

主な編集個所はup()関数とdown()関数の２つです。

Laravelにはchange()関数が用意されており、以下のように記述することでカラム名を変更することが可能です。

$table->renameColumn('post_id', 'comment_id')->change();

また、down()関数にも以下の処理を記述しています。

down()関数

$table->renameColumn('comment_id', 'post_id')->change();

down()関数はロールバック実行時に動く関数です。

ここに記述するのは、簡単に言えばup()関数で実行させる処理と逆の処理です。
※今回は「post_id」を「comment_id」へ修正しているため、down()関数の方には、その反対の処理を記述しています。

down()はマイグレーション実行時には動きませんが、ロールバックするときに正しく処理が書かれていないとエラーが発生するためご注意ください。

STEP３　マイグレーションを実行する

マイグレーションファイルが編集できたら以下のコマンドでマイグレーションを実行しましょう。

php artisan migrate

STEP４　カラム名が変更されていることを確認する

最後に、本当にカラム名が変更されたかどうかを確認してみましょう。

この記事ではSQLite3での確認方法をご紹介します。

STEP

SQLite3をCLIで起動する

Laravelプロジェクトディレクトリの直下で以下のコマンドを実行することでSQLite3をCLIで起動することができます。

sqlite3 .\database\database.sqlite

STEP

テーブル構造を確認する

SQLite3で特定のテーブル構造を確認するときは以下のコマンドを実行します。

PRAGMA table_info('nices');

STEP

SQLite3を終了する

SQLite3のCLIモードを終了するときは以下のコマンドを実行します。

.quit

末尾に「;」を付けるとエラーになるのでご注意ください。

ケケンタ

以上がLaravel11でデータベーステーブルのカラム名を変更する方法です！

まとめ

以上がLaravelでデータベーステーブルのカラム名を変更する方法でした。

人の手でおこなう以上、カラム名の記述ミスが絶対に起こらないとは言い切れません。

また、仕様変更にともなうカラム名の変更も可能性としてはゼロではないでしょう。

ケケンタ

そのようなときに今回ご紹介させていただいた内容をご活用いただければ何よりです。

それでは、最後までご覧いただきありがとうございました！

当ブログではLaravelやPHPなどWebアプリに関する情報を発信しています。

ご興味のある方はほかの記事もご覧いただけるとうれしいです！

あわせて読みたい

【Laravel】データベーステーブルのカラムタイプを変更する方法【マイグレーション】 この記事では Laravelでデータベーステーブルのカラムタイプを変更する方法 をご紹介します。 検証はLaravel11で実施しました。 Laravelではマイグレーションを実行する…

この記事では

Laravelでデータベーステーブルのカラムタイプを変更する方法

をご紹介します。

検証はLaravel11で実施しました。

Laravelではマイグレーションを実行することでデータベーステーブルを作成します。

その際、マイグレーションファイルにテーブル構造を記述しますが、「うっかりカラムタイプを誤って指定しまった！」ということもあるかもしれません。

データベースへテストデータなどを追加する前であれば、

ロールバック→マイグレーションファイル修正→再度マイグレーション実行

という流れも取れます。

しかし、もしもカラムタイプの指定が誤っていることに気が付いたのがもっと後のタイミングだった場合、単にロールバックするだけでは何かと面倒だということもあるかもしれません。

ケケンタ

今回ご紹介するのはそんなときにご活用いただける方法です！

あわせて読みたい

PHPやWordPressを学ぶのにおすすめのプログラミングスクール【７選】 僕はこれまで独学でPHPを学習してきました。結論から言えば、それでもPHPを習得することはできました。 しかし、それに費やした累計学習期間は1年ほど。モチベーション…

【解説】Laravelでデータベースのカラムタイプを変更する方法

STEP１　マイグレーションファイルを作成する

まずは以下のコマンドでマイグレーションファイルを作成しましょう。

php artisan make:migration change_posts_table_title_column_type

「change_posts_table_title_column_type」の部分の名前は任意です。（分かりやすい名前を推奨）

STEP２　マイグレーションファイルを編集する

続いて、作成されたマイグレーションファイルを編集していきます。

今回はpostsテーブルのtitleカラムのカラムタイプをstringで指定すべきところ、「うっかり」integerで指定してしまった状況を想定しています。

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    /**
     * マイグレーション実行時に動く処理
     */
    public function up(): void
    {
        Schema::table('posts', function (Blueprint $table) {
            $table->string('title')->change();
        });
    }

    /**
     * ロールバック実行時に動く処理
     */
    public function down(): void
    {
        Schema::table('posts', function (Blueprint $table) {
            $table->integer('title')->change();
        });
    }
};

主な編集個所はup()関数とdown()関数の２つです。

Laravelにはchange()関数が用意されており、以下のように記述することでカラムタイプを変更することが可能です。

$table->string('title')->change();

カラムタイプ以外にオプション（修飾子）を指定している場合は明示的な記述が必要です。
詳しくは「【補足】カラムにオプション（修飾子）を指定している場合」をご覧ください。

また、down()関数にも以下の処理を記述しています。

down()関数

$table->integer('title')->change();

down()関数はロールバック実行時に動く関数です。

ここに記述するのは、簡単に言えばup()関数で実行させる処理と逆の処理です。
※今回はinteger指定をstring指定へ修正しているため、down()関数の方には、その反対の処理を記述しています。

down()はマイグレーション実行時には動きませんが、ロールバックするときに正しく処理が書かれていないとエラーが発生するためご注意ください。

STEP３　マイグレーションを実行する

マイグレーションファイルが編集できたら以下のコマンドでマイグレーションを実行しましょう。

php artisan migrate

STEP４　カラムタイプが変更されていることを確認する

最後に、本当にカラムタイプが変更されたかどうかを確認してみましょう。

この記事ではSQLite3での確認方法をご紹介します。

STEP

SQLite3をCLIで起動する

Laravelプロジェクトディレクトリの直下で以下のコマンドを実行することでSQLite3をCLIで起動することができます。

sqlite3 .\database\database.sqlite

STEP

テーブル構造を確認する

SQLite3で特定のテーブル構造を確認するときは以下のコマンドを実行します。

PRAGMA table_info('posts');

STEP

SQLite3を終了する

SQLite3のCLIモードを終了するときは以下のコマンドを実行します。

.quit

末尾に「;」を付けるとエラーになるのでご注意ください。

ケケンタ

以上がLaravel11でデータベーステーブルのカラムタイプを変更する方法です！

【補足】カラムにオプション（修飾子）を指定している場合

もし変更対象のカラムに何らかのオプション（修飾子）を指定していた場合は、change()を実行するときにそれらのオプション（修飾子）を明示的に指定する必要があります。

以下は「posts」テーブルの「nice_num（いいね数）」カラムにオプション（修飾子）が設定されていた場合の記述例です。

Schema::table('posts', function (Blueprint $table) {
    // 誤ってデフォルト値を「１」にしてしまっていたため、
    // $table->integer('nice_num')->unsigned()->default(1)->comment('post nice number') // ←元々のカラム設定
    
    // 「０」へ変更したい
    $table->integer('nice_num')->unsigned()->default(0)->comment('post nice number')->change();
});

ケケンタ

change()関数は簡単にカラムタイプを変更することが可能ですが、元々のオプション（修飾子）情報は保持してくれないようです！

まとめ

以上が、Laravelでデータベーステーブルのカラムタイプを変更する方法でした！

人為的ミスや仕様変更などにより、カラムタイプを変更しなくてはならないこともあるかと思います。

そんなときは「change()関数が使える」ということを覚えておくと、必要な情報をパッと調べられるかと思います。

ケケンタ

それでは最後までご覧いただきありがとうございました！

当ブログではLaravelやPHPなどに関する情報を発信しています。

ご興味のある方はほかの記事もご覧いただけるとうれしいです！

この記事では

Laravelの導入方法（インストール）　～　初めてのデータ出力

の手順を画像つきで丁寧に解説していきます。

ケケンタ

この記事をご覧いただくことで、初めてフレームワークに触れるという方でもLaravelの導入方法やデータ出力の仕組みについて理解することができます！

ぜひ実際に手を動かしながら記事を読み進めていただければと思います。

あわせて読みたい

PHPやWordPressを学ぶのにおすすめのプログラミングスクール【７選】 僕はこれまで独学でPHPを学習してきました。結論から言えば、それでもPHPを習得することはできました。 しかし、それに費やした累計学習期間は1年ほど。モチベーション…

Laravelとは？

Laravelの特徴

すでにご存じのとおり、LaravelはPHPのフレームワークのひとつです。

Symphony（シンフォニー）という別のフレームワークを踏襲して設計開発されました。そして、このSymphony（シンフォニー）というフレームワークは大規模開発に向いており、Laravelもその特徴を引き継いでいます。

また、Laravelは基本的にWebアプリ開発に用いられるフレームワークである一方、開発可能なアプリの幅は広いです。

現在も頻繁なバージョンアップが行われおり、今後の機能改善にも期待できるフレームワークとなっています。

Laravelを使用する「メリット」

Laravelを使用するメリットとして以下のような点が挙げられます。

はじめてフレームワークの学習をするという方にとってうれしいメリットとして、学習コストの低さが挙げられます。

これは、Laravelで使用する構文のわかりやすさによる恩恵です。

また、フレームワークであるにも関わらず自由度や拡張性が高く、柔軟な開発が可能な点もメリットと言えます。（設計をきちんと行わないとソースコードが煩雑化してしまうというデメリットがあるとも言えます……）

ちなみにプログラミングの公式ドキュメントというと英語で書かれていることも多いですが、LaravelにはReadoubleという川瀬裕久さんが個人運営されている日本語ドキュメントサイトがあります。

これも非常に大きなメリットのひとつと言えます。

ケケンタ

僕も英語が苦手なので、Laravelで分からないことがあったときはまっさきにReadoubleを訪ねています！

運営して下さっている川瀬さんと運営を支援して下さっている方々には本当に感謝しています。

Laravelを使用する「デメリット」

Laravelのデメリットは以下のとおりです。

メリットでもお伝えしたように、Laravelはフレームワークでありながら、開発の自由度や拡張性が高いです。

それゆえに、開発を進める中でソースコードが複雑化しやすいというデメリットもあります。

ただ、この点に関してはきちんと設計をして、読みやすいコードや適切なファイル管理を意識することで緩和することが可能です。

また、Laravelには様々な機能が備わっています。

そのため、どうしても処理に時間がかかってしまいます。

ケケンタ

表示速度が重要なWebアプリを開発する場合は、Laravel以外の選択肢も考える必要が出てくるかもしれません……

【解説①】Laravelの使用準備 ～ インストール（導入）

それでは、本章から実際にLaravelのインストールを行っていきましょう。

STEP１　Composerのインストール

Laravelを導入する方法はいくつかあります。
この記事ではComposerを利用してインストールする方法をご紹介します。

Composerのインストール方法については以下の記事で詳しく解説しています。

初めてお使いになる方は、まずはこちらの記事をご覧ください。

あわせて読みたい

【Windows】Composerのインストール方法｜エラー時の対処も解説 こんにちは！　ケケンタです。 この記事ではPHPでWebアプリ開発を行うなら必須の Composerのインストール方法（Windows版） を解説していきます。 PHPを始めたばかりの…

念のため補足として、LaravelはPHPのフレームワークのため、大前提としてお使いのPCにPHP自体がインストールされている必要があります。

STEP２　Laravelプロジェクトの作成

Composerのインストールが完了したら、早速Laravelのプロジェクトディレクトリを作成していきましょう。

プロジェクトディレクトリを作成するときはcomposerコマンドを使用します。

なお、プロジェクトディレクトリは、コマンドを実行したディレクトリ内に作成されます。

ケケンタ

今回はわかりやすく「デスクトップ」にプロジェクトディレクトリを作成することにします。

STEP

デスクトップでターミナルを開く

まずはデスクトップ上でターミナル（Windows PowerShell）を開きましょう。

 デスクトップ上でターミナルを開く方法

STEP

デスクトップ上で右クリック

STEP

「ターミナルで開く」をクリック

STEP

ターミナルが開く

STEP

プロジェクトを作成するコマンドを実行する

デスクトップ上でターミナルを開いたら、以下のコマンドを実行します。

composer create-project laravel/laravel example-project

末尾のexample-projectがプロジェクトディレクトリ名（任意の名前）です。

ちなみに、Laravelのバージョンを指定したいときは以下のように:^バージョンと入力します。
※ダブルクォーテーションで囲っていることにご注意ください。

composer create-project "laravel/laravel:^10.0" example-project

プロジェクトディレクトリ作成中のターミナルの様子

STEP３　トップページを表示する

続いて、作成したLaraveプロジェクトのトップページを表示してみましょう。

STEP

ターミナルでプロジェクトディレクトリ内へ移動する

以下のコマンドでプロジェクトディレクトリ内へ移動します。

cd example-project

STEP

簡易サーバーを立ち上げる

以下のコマンドを実行すると簡易的なサーバーが立ち上がり、Laravelアプリの動作を実際にブラウザ上で確認できるようになります。

php artisan serve

あくまでも「開発用の簡易サーバー」なので、本番環境で公開するときはきちんとしたサーバーを用意する必要があります。

なお、簡易サーバーの使用を終了したいときはキーボードのCtrl + Cを押します。

STEP

トップページへアクセスする

php artisan serveコマンドで簡易サーバーが起動できると、以下の画像のように、コマンドプロンプト上にアクセス用のURLが表示されます。

アクセス用のURL

このURLを使用することで、実際にブラウザ上でLaravelプロジェクトのトップページを表示することができます。

ケケンタ

「Ctrlキー」を押しながらURLをクリックすると簡単にリンク先を開くことができます！

Laravelプロジェクトのトップページ

ケケンタ

以上でLaravelの使用準備 ～ 導入が完了し、トップページにもアクセスできるようになりました！

次の章からは、実際にLaravelで実際にデータを表示するまでの手順を解説していきます！

【解説②】Laravelでデータを表示する

Laravelのプロジェクトディレクトリ内の初期構成は以下のようになっています。
※バージョン11の場合

ケケンタ

なんだかたくさんディレクトリやファイルがあってごちゃごちゃして見えますね……

この記事の目的は、「Laravelで初めてデータを表示する！」という部分をご体験いただくことにあるため、各ディレクトリやファイルの詳しい役割については割愛させていただきます。

今回、実際に編集するファイルは以下の２つだけです。

• /routes/web.php
• /resources/views/example.blade.php（こちらは後ほど新規作成します）

ケケンタ

それでは以下より具体的なステップを踏んでLaravelで初めてのデータ出力をしてみましょう！

STEP１　ルーティング設定

まずはroutesディレクトリ内にあるweb.phpを普段お使いのエディタで開きます。

すると、はじめから以下のような記述があるかと思います。

<?php

use Illuminate\Support\Facades\Route;

Route::get('/', function () {
    return view('welcome');
});

この内、重要なのがハイライト行です。

このソースコードは

「『/（サイトのドキュメントルート）』へアクセスがあったら『welcome.blade.php』を出力する」

という意味です。

前章のSTEP３　トップページを表示するでトップページへアクセスしたときのことを思い出してください。

あのときはhttp://127.0.0.1:8000/（つまりサイトのドキュメントルート）へアクセスしました。

そのときに呼び出されたのが、上記３行のソースコードです。

ケケンタ

Laravelの初期状態ではサイトのドキュメントルートへアクセスすると「welcomeページ」が表示される仕様になっているんですね。

あるURLへアクセスがあったときに特定の処理を返す仕組みのことを「ルーティング」と呼びます。

Laravelに限った仕組みということではないですが、今後アプリ開発をする上で非常に重要な概念なのでしっかり覚えておきましょう。

それでは、先ほどのソースコードに以下の３行を追記してみましょう。

<?php

use Illuminate\Support\Facades\Route;

Route::get('/', function () {
    return view('welcome');
});

// 以下の３行を追加
Route::get('/test', function () {
    return view('example');
});

そして、http://127.0.0.1:8000/testへアクセスしてみると……

ケケンタ

エラーが起きてしまいました……

それもそのはず、まだexample.blade.phpを作成していないので、404エラー（not found）が返ってきてしまいます。

次のステップでView（ビュー）を作成して、http://127.0.0.1:8000/testにアクセスするとexample.blade.phpが出力されるようにしましょう！

STEP２　View（ビュー）の作成

/resources/views/ディレクトリの中にexample.blade.phpを新規作成します。

このように/resources/views/ディレクトリ内に「○○.blade.php」というファイルを配置することで、ソースコードからそのページを呼び出せるようになります。

続いて、作成したexample.blade.phpの中に以下のソースコードを追加します。

<?php 

echo 'Hello World!!';

?>

ケケンタ

今回はプログラミング学習でお馴染みの「Hello World!!」を出力するようにしてみました。

STEP３　データの表示

再びhttp://127.0.0.1:8000/testへアクセスしてみましょう。

ケケンタ

今度は無事にexample.blade.phpが呼び出され、「Hello World!!」が出力されました！

まとめ

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

今回はLaravelの導入方法（インストール）からデータを表示するまでの手順を解説しました。

非常に簡単ではありますが、Laravelをインストールし、実際にデータを表示するまでの流れを体験していただけたかと思います。

実際に開発を行う際には、MVCモデル（モデル、ビュー、コントローラ）という概念を中心として、さらなる学習が必要になります。

これまでにフレームワークの学習をしたことが無いという方にとって、最初はまた新しい知識がたくさん登場して大変かもしれません。

しかし、Laravelを扱えるようになればWebアプリ開発が効率的になります。

さらに、ReactやVue.jsのようなフロントエンド向けのライブラリとの連携もしやすい仕組みが用意されており、Laravelの理解を深めることで、きっとその楽しさを体感できるはずです。

ケケンタ

ここまでプログラミングを挫折せずに学習してきた方であれば必ず習得できます！

当ブログでも、この記事のほかにLaravelの学習や開発で役立つ情報を発信していきます。

そちらもぜひご活用いただけるとうれしいです！

それでは、最後までご覧いただきありがとうございました。

Webアプリ開発をするときは、実際の画面表示やデータ処理の動きなどを確認するためにテストデータを作成する必要があります。

テストデータは手作業で入力していっても問題ありませんが、それではあまりに非効率です。

そこで今回は、Laravel11で

シーダとファクトリを用いて
テストデータを自動で一括作成する方法

をご紹介します。

ケケンタ

シーダとファクトリを活用するといつでも簡単にテストデータの登作成できるようになるため、効率的なアプリ開発が可能になります！

 おすすめ記事

あわせて読みたい

PHPやWordPressを学ぶのにおすすめのプログラミングスクール【７選】 僕はこれまで独学でPHPを学習してきました。結論から言えば、それでもPHPを習得することはできました。 しかし、それに費やした累計学習期間は1年ほど。モチベーション…

シーダとファクトリ

Laravelにはテストデータを自動作成する仕組みとして「シーダ」と「ファクトリ」の２つが用意されています。

まずは、これら２つについて簡単に解説をします。

シーダ（Seeder）とは？

シーダ（Seeder）とは、英語で「種をまく人」という意味です。

文字通りデータベースに種（テストデータ）をまくというイメージです。

シーダーを用意することで、コマンドを打つだけでテストデータを簡単に追加可能です。

シーダだけでもテストデータを自動追加することは可能です。
ただし、その場合は「テストデータひとつにつき、コマンドを１回実行する必要がある」ため、非常に手間がかかります。
※このあとご紹介するファクトリと組み合わせて使用することで、複数のデータを一括作成することが可能です。

公式ドキュメント（日本語）：シーディング
https://readouble.com/laravel/11.x/ja/seeding.html

ファクトリ（Factory）とは？

ファクトリ（Factory）は、データベースにテストデータを追加する際、各カラムのデフォルト値を自動設定するための仕組みです。

前節でご紹介したシーダと組み合わせることで、下記のような実装ができます。

• シーダ　　　→　モデルインスタンスを生成 ＋ データベースへ追加
• ファクトリ　→　シーダーで生成されたモデルインスタンスにデフォルト値を設定

シーダとファクトリを組み合わせることで複数のテストデータを一括作成できる

公式ドキュメント（日本語）：ファクトリ
https://readouble.com/laravel/11.x/ja/eloquent-factories.html

【手順】シーダとファクトリでテストデータを一括作成する

本章では、シーダとファクトリを利用して、実際に複数のテストデータを一括作成する手順を解説します。

ケケンタ

大まかな手順は以下のとおりです！

なお、解説をするにあたっては、以下のテーブル構造を持ったTODOアプリを例に用います。

（例）TODOアプリのテーブル構造

実際に手を動かしたい方は、上記構造のTaskモデルとtasksテーブルを事前にご準備下さい

STEP１　ファクトリを作成する

以下のコマンドでファクトリを作成します。

php make:factory TaskFactory

ファクトリファイル名は「モデル名+Factory」の形式にすることを推奨します。
※理由は「STEP２　シーダを作成する」で解説します。

続いて、生成されたTaskFactory.phpのdefinition()メソッドを以下のように編集します。

use Carbon\Carbon;
use Illuminate\Support\Str;

public function definition(): array
{
    return [
        'title' => Str::random(20),  // タスクタイトル
        'status' => 1,               // タスクの状態
        'due_date' => Carbon::now(), // 期限日
    ];
}

ポイントは、テーブルの各カラムに対して、以下のようにデフォルト値を設定している点です。

このあと作成するシーダを実行してモデルインスタンスがデータベースへ追加されるときに、上記で設定したデフォルト値が自動設定されます。

STEP２　シーダを作成する

以下のコマンドでシーダを作成します。

php make:seeder TaskSeeder

シーダファイルの名前は任意です。
※ここではわかりやすく「TaskSeeder」としています。

続いて、生成されたTaskSeeder.phpのrun()メソッドを編集します。

use App\Models\Task;

public function run(): void
{
    // テストデータを「10件」作成する
    Task::factory()->count(10)->create();
}

ここで重要になってくるのが、先ほど作成したファクトリファイル名が「モデル名＋Factory」の形式になっていることです。

これにより、TaskモデルとTaskFactoryファクトリがLaravelによって自動的に紐づけされます。

逆に、ファクトリ名が「モデル名＋Factory」の形式になっていない場合、モデルに対応するファクトリをLaravelが見つけだせず、Task::factory()が上手く実行できなくなります。

※もし任意のモデルとファクトリを紐づけたい場合は、「【補足】任意のモデルとファクトリを紐づける」をご覧ください。

STEP３　モデルを修正する

テストデータを自動作成する最後の準備として、モデルファイルに以下の２行を追加します。
※場合によってはすでに自動的に追加されているかもしれません。

use Illuminate\Database\Eloquent\Factories\HasFactory;

class Task extends Model
{
    use HasFactory; // 追加

    // ~ 省略 ~

}

ケケンタ

ここまでの手順で、テストデータを一括作成する準備が整いました！

STEP４　シーダを実行する

以下のコマンドを実行することで、指定したシーダが実行され、「STEP１　ファクトリを作成する」で設定したデフォルト値がテストデータとしてデータベースへ自動追加されます。

php artisan db:seed --class=TaskSeeder

実行結果

なお、作成済みの複数のシーダを一括実行したい場合は、「–class」オプションを除外します。

php artisan db:seed

【補足】任意のモデルとファクトリを紐づける

「STEP２　シーダを作成する」でお伝えしたように、ファクトリファイル名を「モデル名+Factory」の形式にしなかった場合、Laravelが「どのモデルとどのファクトリが対応しているか」を判断できず、自動的な紐づけが行われません。

もしも任意のモデルとファクトリを紐づけたい場合は、以下のように手動でモデルファイルとファクトリファイルを編集する必要があります。

※以下は、SampleモデルとSampleTableFactoryファクトリを手動で紐づける例です。

Sample.php（モデル）

use Database\Factories\Administration\SampleTableFactory;

/**
 * モデルの新ファクトリ・インスタンスの生成
 */
protected static function newFactory()
{
    return SampleTableFactory::new();
}

SampleTableFactory.php（ファクトリ）

use App\Administration\Sample;
use Illuminate\Database\Eloquent\Factories\Factory;

class SampleFactory extends Factory
{
    /**
     * このファクトリに対応するモデル名
     */
    protected $model = Sample::class;
}

まとめ

以上が、シーダとファクトリを使用して複数のテストデータを一括作成する方法でした。

Webアプリ開発をするときは、テストデータを作成することで動作確認などを行います。

そんなとき、テストデータをひとつひとつ手動で登録するのではなく、できるだけ効率的な方法を選択できると開発がはかどります。

Laravelにはそのための仕組みであるシーダとファクトリが用意されているため、これまで手動でテストデータを追加していたという方は、ぜひこれを機に活用してみて下さい。

ケケンタ

この記事が少しでも参考になったなら何よりです！

当ブログではPHPやLaravel、WordPressなどの情報を発信しています。

ご興味のある方はほかの記事もご覧いただけるとうれしいです！

それでは、最後までご覧いただきありがとうございました。

あわせて読みたい

【Laravel11】バリデーションの実装方法やエラーメッセージのカスタマイズ Laravelではバリデーションを簡単に実装する仕組みが用意されています。 この記事ではLaravelバージョン11でバリデーションを実装する方法をご紹介します。  この記事で…

あわせて読みたい

【Laravel11】Gate（ゲート）とPolicy（ポリシー）で「認可」機能を実装する Webアプリでは、特定の機能を実行する権限があるかどうかをチェックするために「認可」という仕組みを利用します。 PHPのフレームワークであるLaravelには、この「認可…

Laravelではバリデーションを簡単に実装する仕組みが用意されています。

この記事ではLaravelバージョン11でバリデーションを実装する方法をご紹介します。

ケケンタ

Webアプリを開発するならバリデーション実装は必須です！
この記事が少しでもお役に立てば何よりです。

あわせて読みたい

PHPやWordPressを学ぶのにおすすめのプログラミングスクール【７選】 僕はこれまで独学でPHPを学習してきました。結論から言えば、それでもPHPを習得することはできました。 しかし、それに費やした累計学習期間は1年ほど。モチベーション…

バリデーションとは？

まずは「そもそもバリデーションとは何か？」、　「その役割とは？」についてお伝えします。

そんなバリデーションの具体的な役割は以下の通りです。

バリデーションを実装することでWebアプリを安全に稼働できます。

逆にいえば、バリデーションを実装しないと、悪意あるユーザによるセキュリティ攻撃を素通りさせることになり、重要情報の漏洩などの被害が発生する危険性が高まります。

【基本】バリデーションの実装方法

本章よりLaravelバージョン11でバリデーションを実装する方法を解説します。

バリデーションの実装方法を解説する上で、入力フォームやそこからの値を受け取りデータベースへ保存する処理などがあると話が進めやすいため、この記事では以下の例をイメージしながら解説していきます。

この記事で扱うWebアプリと処理の例

ケケンタ

上記の例にそって、以下よりルーティングやコントローラーなどのソースコードをご紹介していきます！

ルーティング

// タスク登録ページを表示するルーティング
Route::get('/tasks/create', [TasksController::class, 'create'])->name('tasks.create');

// タスク登録処理を実行するルーティング
Route::post('/tasks/create', [TasksController::class, 'store']);

バリデーションルールの設定

/*
 * タスク登録ページ（create.blade.php）を表示
 */
public function create()
{
    return view('tasks.create');
}

/*
 * タスク登録処理
 */
public function store(Request $request, Task $task)
{
    // バリデーションルール（★）
    $validated = $request->validate([
        // 【形式】'$requestのキー名（name属性名）' => 'ルール１|ルール２……',
        'title' => 'required|max:50',
    ]);

    // タスク登録処理
    $task->title = $request->title;
    $task->save();

    return redirect()->route('tasks.index');  // タスク一覧ページへリダイレクト（※本記事ではページファイル省略）
}

上記の例では、titleに以下２つのバリデーションルールを適用しています。

このように、Laravel11ではデータベースへの保存処理の前にバリデーションルールを記述することで、そのデータに対して簡単にバリデーションを実装することが可能です。

バリデーションエラーが発生した際に出力するエラーメッセージについては次節で解説します。

【日本語ドキュメント】https://readouble.com/laravel/11.x/ja/validation.html
参照項目：「使用可能なバリデーションルール」

エラーメッセージの出力

続いて、バリデーションによって入力エラーが発生したときに出力するエラーメッセージについて解説します。

Laravel11では日本語版エラーメッセージ用ファイルがデフォルトで用意されていません。
そのため、エラーメッセージを日本語で出力させるためには、後述するエラー内容をカスタマイズするの解説内容もあわせて対応する必要があります。

エラーメッセージの出力方法は大きく２つあります。

方法①　エラーメッセージを項目ごとにひとつずつ出力する

<form action="{{ route('tasks.create') }}" method="post">
    @csrf
    <p>
        @error('title')
            <div class="alert alert-danger">{{ $message }}</div>
        @enderror
        <label for="title">タイトル</label>
        <input type="text" name="title" value="{{ old('title') }}">
    </p>
    <input type="submit" value="登録">
</form>

@error('DB上のカラム名')を使用することで、該当項目のバリデーションエラーが発生したときにエラーメッセージを出力することが可能です。

また、value属性にold('name属性の値')のように記述しておくことで、エラー発生時に入力されていた値がフォームに保持されるようになります。
※old('name属性の値')が無いとエラーが発生する度に入力内容が消えてしまい、再入力の手間が増えます。

方法②　複複数項目のエラーメッセージを一か所に出力する

@if ($errors->any())
    <div class="alert alert-danger">
        <ul>
            @foreach ($errors->all() as $error)
                <li>{{ $error }}</li>
            @endforeach
        </ul>
    </div>
@endif
<form action="{{ route('tasks.create') }}" method="post">
    @csrf
    <p>
        <label for="title">タイトル</label>
        <input type="text" name="title" value="{{ old('title') }}">
    </p>
    <input type="submit" value="登録">
</form>

@if ($errors->any())でエラーメッセージの有無をチェックしています。
もしバージョンエラーがあれば、@foreach ($errors->all() as $error)でループを回して、エラーメッセージをひとつずつ出力します。

また、value属性にold('name属性の値')のように記述しておくことで、エラー発生時に入力されていた値がフォームに保持されるようになります。
※old('name属性の値')が無いとエラーが発生する度に入力内容が消えてしまい、再入力の手間が増えます。

このように、バリデーションエラーによるエラーメッセージの出力方法は大きく２つあります。

ケケンタ

ただ、エラーが発生した項目ごとにエラーメッセージを出力した方が、ユーザにとっても分かりやすいと思うので、個人的には①の方法を使用する機会が多いのではないかと思っています。

エラー内容をカスタマイズする

バージョンによりますが、前述したようにLaravel11ではデフォルトだとバリデーションのエラーメッセージ用のファイルが用意されていません。

本章では、そのファイルの用意方法を含め、エラーメッセージ・項目名のカスタマイズ方法を解説します。

STEP１　日本語向けのバリデーション用ファイルを用意する

php artisan lang:publish

上記のコマンドを実行すると、プロジェクトディレクトリ直下にlang/enディレクトリが生成されます。

このをenをlang直下で複製し、そのディレクトリ名をjaとします。

このja内のvalidation.phpを編集することで、エラーメッセージを日本語対応させることが可能です。

なお前提として、プロジェクトディレクトリ直下の.envファイル内でAPP_LOCALE=jaとなっている必要があります。

※初期値は「en」になっており、この状態だとlang/enディレクトリが参照されてしまいます。

STEP２　エラーメッセージのカスタマイズ

エラーメッセージをカスタマイズするときは、ja内のvalidation.phpを編集するとお伝えしました。

例えば、requiredルールによるエラーメッセージを編集するときは以下のようにします。

// 変更前
'required' => 'The :attribute field is required.',

// 変更後
'required' => ':attribute は必須です。',

:attributeの部分には、エラーが発生した項目名が自動設定されます。

STEP３　項目名のカスタマイズ

エラーメッセージ上の項目名は、デフォルトだとデータベースで使用しているカラム名になります。

しかし、それでは「titleは必須です」のようなメッセージとなり、ユーザにとって分かりづらい内容になってしまいます。

ケケンタ

そこで、本節では項目名のカスタマイズ方法をご紹介します！

validation.phpの下の方にあるattributesへ、以下のように

「キー名（DB上のカラム名） => ‘任意の項目名’」と記述することで項目名を簡単にカスタマイズできます。

'attributes' => [
    'title' => 'タイトル',
],

以上のように「バリデーション用ファイル」を用意することで、エラーメッセージが正常に出力されるようになります。

ケケンタ

カスタマイズも簡単にできますね！

高度なバリデーションの実装方法

Laravelにはフォームリクエストという、より複雑なバリデーションを実装できるクラスが用意されています。

より複雑なバリデーションシナリオの場合は、「フォームリクエスト」を作成することをお勧めします。フォームリクエストは、独自のバリデーションおよび認可ロジックをカプセル化するカスタムリクエストクラスです。フォームリクエストクラスを作成するには、make:request Artisan CLIコマンドを使用します。

引用元：Laravel11日本語ドキュメント（https://readouble.com/laravel/11.x/ja/validation.html）

基本的なバリデーション実装では、コントローラーの登録処理メソッド内にバリデーションルールを記載していました。

フォームリクエストを利用することで、バリデーション関係の処理をコントローラーから切り離し、なおかつ複雑なバリデーションの実装が可能になります。

ケケンタ

以下よりフォームリクエストを利用してバリデーションを実装する手順を解説します！

STEP１　フォームリクエストの作成

以下のコマンドを実行することでフォームリクエストファイルが作成されます。

php artisan make:request 任意のフォームリクエストファイル名

実行例

php artisan make:request StoreTaskRequest

STEP２　フォームリクエストファイルの編集

class StoreTaskRequest extends FormRequest
{
    /*
     * リクエストの認証制御
     * ※このメソッドをカスタマイズすることでリクエストの認証範囲を変更できますが、
     * 　当記事では割愛します。
     */
    public function authorize(): bool
    {
        return true; // falseをtrueへ変更（★）
    }

    /*
     * バリデーションルール
     */
    public function rules(): array
    {
        return [
            'title' => 'required|max:50',
        ];
    }

    /*
     * バリデーションメッセージのカスタマイズ
     * （★）手動で追加
     */
    public function messages(): array
    {
        return [
            'title.required' => ':attribute の入力は必須です。',
        ];
    }
}

ポイントを解説します。

authorize()

authorize()はリクエストの認証を制御するためのメソッドです。

デフォルトではfalseが返るようになっていますが、このままの状態だと403エラーが発生するため、ここをtrueへ変更してすべてのリクエストが認証されるようにします。

この記事では省略しますが、authorize()をカスタマイズすることでより正確な認証範囲の制御が可能になります。

rules()

rules()にはバリデーションルールを記載します。

【日本語ドキュメント】https://readouble.com/laravel/11.x/ja/validation.html
参照項目：「使用可能なバリデーションルール」

messages()

messages()はバリデーションエラーが発生した際のエラーメッセージをカスタマイズするためのメソッドです。

このメソッドを利用することで、前項「エラー内容をカスタマイズする」でご紹介したvalidation.phpを使わなくてもエラーメッセージを個別にカスタマイズすることが可能です。

フォームリクエストを作成した時点では用意されていないため、手動で追加する必要があります。

メソッド名は「messages」とする必要がある点にご留意ください。

STEP３　コントローラーの編集

フォームリクエストファイルでバリデーションを実装したため、コントローラーにはバリデーション関係の処理を書く必要が無くなります。

/*
 * タスク登録処理
 */
// public function store(Request $request, Task $task)　　　　 // 変更前
public function store(StoreTaskRequest $request, Task $task)  // 変更後
{
    // バリデーションルール（★削除）
    // $validated = $request->validate([
    //     'title' => 'required|max:50',
    // ]);

    $task->title = $request->title;
    $task->save();

    return redirect()->route('tasks.index');
}

ひとつ注意点として、メソッドの引数にあるRequest型を、紐づけたいフォームリクエストの型に書き換える必要があります。

今回の例ではStoreTaskRequest型に書き換えています。

ケケンタ

このように、フォームリクエストを使用すればコントローラーからバリデーション処理を切り離すことができ、かつより細かな制御をすることができるようになります。

まとめ

以上が、Laravelバｰジョン11でバリデーションを実装する方法でした。

11以前のバージョンと書き方が同じ箇所もあるかと思いますが、大きな違いは、デフォルトでバリデーションメッセージ用のファイル（lang）がインストールされていないことです。

Laravelはドキュメントを日本語訳して下さっている方々がいるため、何か困ったことがあればそちらを参照すると大体の問題は解決できるかと思います。

【日本語ドキュメント】https://readouble.com/laravel/11.x/ja/

しかし、その方のプログラミング歴によっては、それでもドキュメントを読み解くのは大変なことも多々あるかと思います。（ドキュメントの言い回しはなかなか慣れません……）

今回はそうした方々の一助となればという思いもあり、簡単ではありますが、バリデーションに関する記事を書かせていただきました。

ケケンタ

この記事が少しでもお役に立ったなら何よりです！

それでは、最後までご覧いただきありがとうございました！

あわせて読みたい

【Laravel11】シーダとファクトリでテストデータを一括作成する方法 Webアプリ開発をするときは、実際の画面表示やデータ処理の動きなどを確認するためにテストデータを作成する必要があります。 テストデータは手作業で入力していっても…

あわせて読みたい

【Laravel11】Gate（ゲート）とPolicy（ポリシー）で「認可」機能を実装する Webアプリでは、特定の機能を実行する権限があるかどうかをチェックするために「認可」という仕組みを利用します。 PHPのフレームワークであるLaravelには、この「認可…