More than 1 year has passed since last update.

Laravelで投稿機能を作る

Last updated at 2022-07-31Posted at 2022-07-24

はじめに

Laravelで初めてのアプリケーションを作成中です。
学習しながら作成しているので、私自身の頭の整理をしつつ、超基礎的な流れや頻出コマンドをまとめてみました。
かなり長いですが、この通りにおこなえば簡単にできるはずです。

ちなみに前提として、モデル・コントローラーとは何かを理解しており、環境構築は終わっていることとします。
私はRuby on Railsは簡単なアプリケーションであればサクサク作成できる程度の知識がありますが、PHP、Laravelは学習開始して1週間程度の初学者です。間違えていることなどあれば、ご指摘ください。

開発環境

AWS Cloud9
PHP 8.0.2
Laravel 9.21.6
Composer 2.3.10
MariaDB 5.5.68

手順

ここでは、超シンプルな投稿機能を実装します。
ベースを作成するだけですので、バリデーションやレイアウトは無視していますので、実際にアプリケーションを作成する場合は、これをもとに作りこむ必要があります。

また、名称は、それぞれ下記のようにしました。
テーブル： items
モデル： Item
コントローラー： ItemsController
もしこの記事を見てご自身で作成される場合は、それぞれ名称を変えてくださいね。

その１　マイグレーションファイル・テーブル作成

最初に、下記コマンドでマイグレーションファイルを作成します。

$ php artisan make:migration create_items_table

database/migrationsディレクトリの中にマイグレーションファイルが作られるので、テーブルに追加するカラムを記入します。

database/migrations/2022_07_24_062806create_items_table.php

    public function up()
    {
        Schema::create('items', function (Blueprint $table) {
            $table->id();
            // ここから
            $table->string('name');
            $table->text('description');
            $table->integer('price');
            // ここまで追記
            $table->timestamps();
        });
    }

追加できたら、下記コマンドを打ってテーブルを作成します。

$ php artisan migrate

【その１：応用編】Seederで初期データ追加

Seederで初期データを追加してみましょう。
下記コマンドで、database/seeders内にitemsテーブル用のseederファイルを作成します。

$ php artisan make:seeder ItemsTableSeeder

ファイルを下記のように編集します。内容は何でもOKです。

database/Seeder/ItemsTableSeeder.php

class ItemsTableSeeder extends Seeder
{
    public function run()
    {
    // ここから
        DB::table('items')->insert(
            [
                'name'=>'サンプル',
                'description'=>'サンプルアイテム',
                'price'=>100,
            ]
        );
     // ここまで追記
    }
}

データは複数作っても良いです。お好きなだけ、お好きな内容を追加してください。
気が済んだら、ターミナルでコマンドを実行し、内容を反映させます。

$ php artisan migrate --seed

以上でテーブルが完成しました。

その２　モデル作成

次に、モデルを作っていきます。
ターミナルで、下記コマンドを実行し、モデルを作成します。

$ php artisan make:model Item

app/Modelディレクトリ内に「Item.php」というファイルが作られるはずです。
これを開いて、下記のように編集します。

app/Models/Item.php


class Item extends Model
{
    use HasFactory;
    public $guarded = ['id', 'created_at']; //追記部分
}

追記部分について説明します。

  $guarded

これは、データベースに保存する際の、書き込み禁止のフィールドを設定しています。
この記述をしないと、データベースに保存するときにエラーが発生します。
Eloquentという、データベースとモデルを紐づけるLavarelの機能があり、書き込み可能もしくは書き込み禁止フィールドを指定しなくてはいけないようになっているようです。

例の記述ですと、

    public $guarded = ['id', 'created_at'];

としているため、自動で追加される「id」と「created_at」が書き込み禁止になってます。

書き込み可能を指定することもできます。その場合は、

    public $fillable = ['name', 'description', 'price'];

のように記述します。
どちらでも良いみたいですが、記述禁止フィールドの方が少ないことが多いと思うので、私は$guardedを多用していきたいと思います。

その３　コントローラー・ルート作成

次に、コントローラーを作っていきます。
コントローラーは、下記のコマンドで作成します。

$ php artisan make:controller ItemsController --model=Item --resource

--model=Itemでモデルを関連付けさせています。
また--resourceを付けることで、投稿機能に必要なアクションを処理するコントローラーが作成できます。

コントローラーはapp/Http/Controllers内に作成されます。

余談ですが、私がPHPを学習し始めて最初に躓いたのが、コントローラーの書き方でした。（resourceコマンドを知らずに一ページずつ作ろうとしていました。）
最初に引っかかったのが、Rubyでいう「new」アクションと「create」アクションです。
Rubyの「new」 => PHPでは「create」
Rubyの「create」 => PHPでは「store」
なのですが、最初に新規投稿ページ作ろ！と思ってnewとcreateアクションを実装しようとするもののよくわからず、ちょっとして分かったときには感動しました。

本題に戻ります。
アクションごとに説明しながら、コントローラーアクションを記述していきます。

まずは、indexから。