Laravel – マスアサインメント

2021-08-24 / tau / コメントする

概要

マスアサインメントによって、フォームからPOSTされたパラメーターを一括してモデルの属性にセットして、データベースに書き込める
ただしセットできる属性をモデルの$fillable配列に限定列挙する必要がある
モデルのインスタンス生成時に、セットできるパラメーターをonlyメソッドで限定列挙できる
$fillableのほかに$guarded配列も指定できて、こちらは指定した属性をモデルのセットの際に排除する

準備

以下のようなフォームがあって、nameとcommentをPOSTする。

  <form method="post">
    @csrf
    <div><label>名前: <input type="text" name="name"></label></div>
    <div><label>コメント: <input type="text" name = "comment"></label></div>
    <input type="submit" value="投稿">
  </form>

@csrf

</form>

POSTはコントローラーのstore()メソッドにルーティングされる。

Route::post('/messages', 'MessageController@store');

1	Route::post('/messages', 'MessageController@store');

ルーティング先のコントローラーでは、モデルのインスタンスを生成し、その属性にPOSTされたパラメーターをセットしてデータベースに書き込む。

class MessageController extends Controller
{
  .....
  public function store(Request $request) {
    $message = new Message();
    $messsage->name = $request->name;
    $messsage->comment = $request->comment;
    $message->save();
    .....
  }
}

class MessageController extends Controller

{

.....

public function store(Request $request) {

$message = new Message();

$messsage->name = $request->name;

$messsage->comment = $request->comment;

$message->save();

.....

}

マスアサインメント

Requestのall()メソッド

Request引数のall()メソッドで得られる内容を確認。

class MessageController extends Controller
{
  .....
  public function store(Request $request) {
    dd($request->all());
    .....
  }
}

class MessageController extends Controller

{

.....

public function store(Request $request) {

dd($request->all());

.....

}

CSRF対策のトークンを含んだパラメーターの配列が得られる。

array:3 [▼
  "_token" => "DPci3aVibUshjdv5xGhllPZHvGgfdIUNh5iMniO9"
  "name" => "test"
  "comment" => "test comment"
]

array:3 [▼

"_token" => "DPci3aVibUshjdv5xGhllPZHvGgfdIUNh5iMniO9"

"name" => "test"

"comment" => "test comment"

]

$request->all()の結果を、モデルインスタンスのfill()メソッドによって属性にセット。dd()で内容を確認してみる。

class MessageController extends Controller
{
  .....
  public function store(Request $request) {
    $message = new Message();
    $message->fill($request->all());
    dd($message);
    .....
  }
}

class MessageController extends Controller

{

.....

public function store(Request $request) {

$message = new Message();

$message->fill($request->all());

dd($message);

.....

}

エラー。

マスアサインメントのためにはfillable属性に加えなければならないと言われる。

Illuminate\Database\Eloquent\MassAssignmentException
Add [_token] to fillable property to allow mass assignment on [App\Message].

1 2	Illuminate\Database\Eloquent\MassAssignmentException Add [_token] to fillable property to allow mass assignment on [App\Message].

モデルの$fillableプロパティー

モデルの定義で、$fillable配列に取得したいプロパティーを列挙する。

class Message extends Model
{
  protected $fillable = ['name', 'comment'];
}

class Message extends Model

{

protected $fillable = ['name', 'comment'];

}

先ほどのコードの実行結果。エラーがなくなる。dd()でプロパティーがセットされたインスタンスの内容を確認。

fillableプロパティーに2つのパラメーター名がセットされている
attributesに属性とその内容が配列としてセットされている
guardedは指定しておらず、サイズ1、内容'*'の配列となっている

App\Message {#323 ▼
  +fillable: array:2 [▼
    0 => "name"
    1 => "comment"
  ]
  .....
  #attributes: array:2 [▼
    "name" => "test"
    "comment" => "test comment"
  ]
  .....
  #guarded: array:1 [▼
    0 => "*"
  ]
}

App\Message {#323 ▼

+fillable: array:2 [▼

0 => "name"

1 => "comment"

]

.....

#attributes: array:2 [▼

"name" => "test"

"comment" => "test comment"

]

.....

#guarded: array:1 [▼

0 => "*"

]

}

以上を踏まえて、fillableがセットされたモデルのマスアサインメントとデータベース登録を以下に例示。

class MessageController extends Controller
{
  .....
  public function store(Request $request) {
    $message = new Message();
    $message->fill($request->all());
    $message->save();
    .....
  }
}

class MessageController extends Controller

{

.....

public function store(Request $request) {

$message = new Message();

$message->fill($request->all());

$message->save();

.....

}

マスアサインメントの記述方法

マスアサインメントの書き方には複数あって、同じ結果が得られる。create()スタティックメソッドは、インスタンスの生成とデータベースの書き込みを一つのメソッドで行う。

    $message = new Message();
    $message->fill($request->all());
    $message->save();
      または
    $message = new Message($request->all());
    $message->save();
      または
    $message = Message::create($request->all());

$message = new Message();

$message->fill($request->all());

$message->save();

または

$message = new Message($request->all());

$message->save();

または

$message = Message::create($request->all());

Requestのonly()メソッドによる限定

意図しないパラメーターの追加を避けるため、all()メソッドではなくonly()メソッドでパラメーターを限定列挙できる。

    $message = Message::create($request->only(['name', 'comment']));

1	$message = Message::create($request->only(['name', 'comment']));

Laravel – tinker – モデルの操作

2021-08-23 / tau / コメントする

tinkerの起動

php artisan tinkerでtinkerを起動。

[vagrant@localhost laravel_tutorial]$ php artisan tinker
Psy Shell v0.10.8 (PHP 7.3.29 — cli) by Justin Hileman
>>>

[vagrant@localhost laravel_tutorial]$ php artisan tinker

Psy Shell v0.10.8 (PHP 7.3.29 — cli) by Justin Hileman

>>>

helpでコマンドが確認できる。

>>> help
  help             Show a list of commands. Type `help [foo]` for information about [foo].      Aliases: ?
  ls               List local, instance or class variables, methods and constants.              Aliases: dir
  dump             Dump an object or primitive.
  doc              Read the documentation for an object, class, constant, method or property.   Aliases: rtfm, man
  show             Show the code for an object, class, constant, method or property.
  wtf              Show the backtrace of the most recent exception.                             Aliases: last-exception,
  whereami         Show where you are in the code.
  throw-up         Throw an exception or error out of the Psy Shell.
  timeit           Profiles with a timer.
  trace            Show the current call stack.
  buffer           Show (or clear) the contents of the code input buffer.                       Aliases: buf
  clear            Clear the Psy Shell screen.
  edit             Open an external editor. Afterwards, get produced code in input buffer.
  sudo             Evaluate PHP code, bypassing visibility restrictions.
  history          Show the Psy Shell history.                                                  Aliases: hist
  exit             End the current session and return to caller.                                Aliases: quit, q
  clear-compiled   Remove the compiled class file
  down             Put the application into maintenance mode
  env              Display the current framework environment
  optimize         Cache the framework bootstrap files
  up               Bring the application out of maintenance mode
  migrate          Run the database migrations
  inspire          Display an inspiring quote

>>> help

help Show a list of commands. Type `help [foo]` for information about [foo]. Aliases: ?

ls List local, instance or class variables, methods and constants. Aliases: dir

dump Dump an object or primitive.

doc Read the documentation for an object, class, constant, method or property. Aliases: rtfm, man

show Show the code for an object, class, constant, method or property.

wtf Show the backtrace of the most recent exception. Aliases: last-exception,

whereami Show where you are in the code.

throw-up Throw an exception or error out of the Psy Shell.

timeit Profiles with a timer.

trace Show the current call stack.

buffer Show (or clear) the contents of the code input buffer. Aliases: buf

clear Clear the Psy Shell screen.

edit Open an external editor. Afterwards, get produced code in input buffer.

sudo Evaluate PHP code, bypassing visibility restrictions.

history Show the Psy Shell history. Aliases: hist

exit End the current session and return to caller. Aliases: quit, q

clear-compiled Remove the compiled class file

down Put the application into maintenance mode

env Display the current framework environment

optimize Cache the framework bootstrap files

up Bring the application out of maintenance mode

migrate Run the database migrations

inspire Display an inspiring quote

モデル・データベースの操作

データの登録

モデルとマイグレーションで作成したモデルを使う。

まずshowコマンドでモデルクラスを見てみる。

>>> show TestModel
[!] Aliasing 'TestModel' to 'App\TestModel' for this Tinker session.
 7: class TestModel extends Model
 8: {
 9:     //
10: }

>>> show TestModel

[!] Aliasing 'TestModel' to 'App\TestModel' for this Tinker session.

7: class TestModel extends Model

8: {

9: //

10: }

変数$modelにTestModelクラスのインスタンスを生成。

>>> $model = new App\TestModel();
=> App\TestModel {#3370}

1 2	>>> $model = new App\TestModel(); => App\TestModel {#3370}

マイグレーションファイルで定義したフィールド(product_name、amount)に値を代入。

>>> $model->product_name = 'wire';
=> "wire"
>>> $model->amount = 100;
=> 10

>>> $model->product_name = 'wire';

=> "wire"

>>> $model->amount = 100;

=> 10

変数を入力すると、その内容が確認できる。

>>> $model;
=> App\TestModel {#3370
     product_name: "wire",
     amount: 100,
   }

>>> $model;

=> App\TestModel {#3370

product_name: "wire",

amount: 100,

}

lsで定義された変数を、ls -lでそれらを少し詳しく見ることができる。

>>> ls
Variables: $model
>>> ls -l

Variables:
  $model   App\TestModel {#3370 …5}

>>> ls

Variables: $model

>>> ls -l

Variables:

$model App\TestModel {#3370 …5}

変数の内容をデータベースに保存するステートメントを実行。

>>> $model->save();
=> true

1 2	>>> $model->save(); => true

データベース側で確認すると、日付もちゃんと登録されている。

mysql> SELECT * FROM test_models;
+----+--------------+--------+---------------------+---------------------+
| id | product_name | amount | created_at          | updated_at          |
+----+--------------+--------+---------------------+---------------------+
|  1 | wire         |    100 | 2021-08-23 14:33:27 | 2021-08-23 14:33:27 |
+----+--------------+--------+---------------------+---------------------+
1 row in set (0.00 sec)

mysql> SELECT * FROM test_models;

+----+--------------+--------+---------------------+---------------------+

+----+--------------+--------+---------------------+---------------------+

| 1 | wire | 100 | 2021-08-23 14:33:27 | 2021-08-23 14:33:27 |

+----+--------------+--------+---------------------+---------------------+

1 row in set (0.00 sec)

さらに2つのデータを登録。

>>> $model->product_name = 'steel plate';
=> "steel plate"
>>> $model->amount = 50;
=> 50
>>> $model->save();
=> true
>>> $model = new App\TestModel();
=> App\TestModel {#4110}
>>> $model->product_name = 'screws';
=> "screws"
>>> $model->amount = 150;
=> 150
>>> $model->save();
=> true

>>> $model->product_name = 'steel plate';

=> "steel plate"

>>> $model->amount = 50;

=> 50

>>> $model->save();

=> true

>>> $model = new App\TestModel();

=> App\TestModel {#4110}

>>> $model->product_name = 'screws';

=> "screws"

>>> $model->amount = 150;

=> 150

>>> $model->save();

=> true

データベース側でも登録されているのが確認できる。

mysql> SELECT * FROM test_models;
+----+--------------+--------+---------------------+---------------------+
| id | product_name | amount | created_at          | updated_at          |
+----+--------------+--------+---------------------+---------------------+
|  1 | wire         |    100 | 2021-08-23 14:33:27 | 2021-08-23 14:33:27 |
|  2 | steel plate  |     50 | 2021-08-23 14:51:02 | 2021-08-23 14:51:02 |
|  3 | screws       |    150 | 2021-08-23 14:53:44 | 2021-08-23 14:53:44 |
+----+--------------+--------+---------------------+---------------------+
3 rows in set (0.00 sec)

mysql> SELECT * FROM test_models;

+----+--------------+--------+---------------------+---------------------+

+----+--------------+--------+---------------------+---------------------+

| 1 | wire | 100 | 2021-08-23 14:33:27 | 2021-08-23 14:33:27 |

| 2 | steel plate | 50 | 2021-08-23 14:51:02 | 2021-08-23 14:51:02 |

| 3 | screws | 150 | 2021-08-23 14:53:44 | 2021-08-23 14:53:44 |

+----+--------------+--------+---------------------+---------------------+

3 rows in set (0.00 sec)

全データ取得

tinkerで変数$modelsにデータベースの全データを取得。

>>> $models = App\TestModel::all();
=> Illuminate\Database\Eloquent\Collection {#4327
     all: [
       App\TestModel {#4328
         id: 1,
         product_name: "wire",
         amount: 100,
         created_at: "2021-08-23 14:33:27",
         updated_at: "2021-08-23 14:33:27",
       },
       App\TestModel {#4329
         id: 2,
         product_name: "steel plate",
         amount: 50,
         created_at: "2021-08-23 14:51:02",
         updated_at: "2021-08-23 14:52:53",
       },
       App\TestModel {#4330
         id: 3,
         product_name: "screws",
         amount: 150,
         created_at: "2021-08-23 14:53:44",
         updated_at: "2021-08-23 14:53:44",
       },
     ],
   }

>>> $models = App\TestModel::all();

=> Illuminate\Database\Eloquent\Collection {#4327

all: [

App\TestModel {#4328

id: 1,

product_name: "wire",

amount: 100,

created_at: "2021-08-23 14:33:27",

updated_at: "2021-08-23 14:33:27",

App\TestModel {#4329

id: 2,

product_name: "steel plate",

amount: 50,

created_at: "2021-08-23 14:51:02",

updated_at: "2021-08-23 14:52:53",

App\TestModel {#4330

id: 3,

product_name: "screws",

amount: 150,

created_at: "2021-08-23 14:53:44",

updated_at: "2021-08-23 14:53:44",

}

$modelsは配列で要素はゼロから始まるので、$models[1]は2番目のデータ。

>>> $models[1];
=> App\TestModel {#4329
     id: 2,
     product_name: "steel plate",
     amount: 50,
     created_at: "2021-08-23 14:51:02",
     updated_at: "2021-08-23 14:51:02",
   }

>>> $models[1];

=> App\TestModel {#4329

id: 2,

product_name: "steel plate",

amount: 50,

created_at: "2021-08-23 14:51:02",

updated_at: "2021-08-23 14:51:02",

}

データの更新

スタティック関数find()でid=2のデータを$modelに取得。

>>> $model = App\TestModel::find(2);
=> App\TestModel {#4073
     id: 2,
     product_name: "steel plate",
     amount: 50,
     created_at: "2021-08-23 14:51:02",
     updated_at: "2021-08-23 14:52:53",
   }

>>> $model = App\TestModel::find(2);

=> App\TestModel {#4073

id: 2,

product_name: "steel plate",

amount: 50,

created_at: "2021-08-23 14:51:02",

updated_at: "2021-08-23 14:52:53",

}

取得したid=2のデータのamountを0に変更して保存。

>>> $model->amount = 0;
=> 0
>>> $model->save();
=> true

>>> $model->amount = 0;

=> 0

>>> $model->save();

=> true

データが更新されているのを確認。

>>> App\TestModel::find(2);
=> App\TestModel {#4332
     id: 2,
     product_name: "steel plate",
     amount: 0,
     created_at: "2021-08-23 14:51:02",
     updated_at: "2021-08-23 15:01:36",
   }

>>> App\TestModel::find(2);

=> App\TestModel {#4332

id: 2,

product_name: "steel plate",

amount: 0,

created_at: "2021-08-23 14:51:02",

updated_at: "2021-08-23 15:01:36",

}

データベースでも確認できる。

mysql> SELECT * FROM test_models;
+----+--------------+--------+---------------------+---------------------+
| id | product_name | amount | created_at          | updated_at          |
+----+--------------+--------+---------------------+---------------------+
|  1 | wire         |    100 | 2021-08-23 14:33:27 | 2021-08-23 14:33:27 |
|  2 | steel plate  |      0 | 2021-08-23 14:51:02 | 2021-08-23 15:01:36 |
|  3 | screws       |    150 | 2021-08-23 14:53:44 | 2021-08-23 14:53:44 |
+----+--------------+--------+---------------------+---------------------+
3 rows in set (0.00 sec)

mysql> SELECT * FROM test_models;

+----+--------------+--------+---------------------+---------------------+

+----+--------------+--------+---------------------+---------------------+

| 1 | wire | 100 | 2021-08-23 14:33:27 | 2021-08-23 14:33:27 |

| 2 | steel plate | 0 | 2021-08-23 14:51:02 | 2021-08-23 15:01:36 |

| 3 | screws | 150 | 2021-08-23 14:53:44 | 2021-08-23 14:53:44 |

+----+--------------+--------+---------------------+---------------------+

3 rows in set (0.00 sec)

データの削除

id=2のデータを取得。

>>> $model = App\TestModel::find(2);
=> App\TestModel {#4267
     id: 2,
     product_name: "steel plate",
     amount: 0,
     created_at: "2021-08-23 14:51:02",
     updated_at: "2021-08-23 15:01:36",
   }

>>> $model = App\TestModel::find(2);

=> App\TestModel {#4267

id: 2,

product_name: "steel plate",

amount: 0,

created_at: "2021-08-23 14:51:02",

updated_at: "2021-08-23 15:01:36",

}

delete()メソッドでデータベースから削除。

>>> $model->delete();
=> true

1 2	>>> $model->delete(); => true

全データを取得すると、id=2のデータが削除されている。

>>> App\TestModel::all();
=> Illuminate\Database\Eloquent\Collection {#4336
     all: [
       App\TestModel {#4338
         id: 1,
         product_name: "wire",
         amount: 100,
         created_at: "2021-08-23 14:33:27",
         updated_at: "2021-08-23 14:33:27",
       },
       App\TestModel {#4339
         id: 3,
         product_name: "screws",
         amount: 100,
         created_at: "2021-08-23 14:53:44",
         updated_at: "2021-08-23 14:58:51",
       },
     ],
   }

>>> App\TestModel::all();

=> Illuminate\Database\Eloquent\Collection {#4336

all: [

App\TestModel {#4338

id: 1,

product_name: "wire",

amount: 100,

created_at: "2021-08-23 14:33:27",

updated_at: "2021-08-23 14:33:27",

App\TestModel {#4339

id: 3,

product_name: "screws",

amount: 100,

created_at: "2021-08-23 14:53:44",

updated_at: "2021-08-23 14:58:51",

}

データベース側でも確認できる。

mysql> SELECT * FROM test_models;
+----+--------------+--------+---------------------+---------------------+
| id | product_name | amount | created_at          | updated_at          |
+----+--------------+--------+---------------------+---------------------+
|  1 | wire         |    100 | 2021-08-23 14:33:27 | 2021-08-23 14:33:27 |
|  3 | screws       |    150 | 2021-08-23 14:53:44 | 2021-08-23 14:53:44 |
+----+--------------+--------+---------------------+---------------------+
2 rows in set (0.00 sec)

mysql> SELECT * FROM test_models;

+----+--------------+--------+---------------------+---------------------+

+----+--------------+--------+---------------------+---------------------+

| 1 | wire | 100 | 2021-08-23 14:33:27 | 2021-08-23 14:33:27 |

| 3 | screws | 150 | 2021-08-23 14:53:44 | 2021-08-23 14:53:44 |

+----+--------------+--------+---------------------+---------------------+

2 rows in set (0.00 sec)

Laravel – モデル作成とマイグレーション

2021-08-23 / tau / コメントする

データベース設定の確認

アプリケーションディレクトリー直下の.envファイルでデータベースの設定を確認する。DB_DATABASEに設定されたデータベースが作成済みでRDBMSでアクセス可能であることを確認する。

[vagrant@localhost laravel_tutorial]$ cat .env
.....

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=laravel_test←データベース名
DB_USERNAME=root
DB_PASSWORD=パスワード

.....

[vagrant@localhost laravel_tutorial]$ cat .env

.....

DB_CONNECTION=mysql

DB_HOST=127.0.0.1

DB_PORT=3306

DB_DATABASE=laravel_test←データベース名

DB_USERNAME=root

DB_PASSWORD=パスワード

.....

モデルの作成

モデル作成コマンド

モデルの作成には、artisanのmake:modelコマンドを使う。同時にデータベースを定義するマイグレーションファイルも作成するときは--migrationオプションを付ける。

php artisan make:model モデル名 --migration

モデル名の考え方は以下の通り。

データベースのレコードに保存する対象として、単数の名詞とする
モデル名はアッパー・キャメルケース(パスカルケース)で定義する

以下はTestModelというモデルを作成したケース。

[vagrant@localhost laravel_tutorial]$ php artisan make:model TestModel --migration
Model created successfully.
Created Migration: 2021_08_23_093211_create_test_models_table

[vagrant@localhost laravel_tutorial]$ php artisan make:model TestModel --migration

Model created successfully.

Created Migration: 2021_08_23_093211_create_test_models_table

モデルの作成に成功したことと、2021_08_23…という名前でマイグレーションファイルが作成されたことが表示されている。

マイグレーションファイルの作成は--migrationオプションを付けたためで、これをつけないとモデルのだけが作成される。

モデルクラスファイル

モデルのクラスファイルはappディレクトリー下に作成される。コマンドで指定したモデル名に拡張子.phpが付けられている。

[vagrant@localhost laravel_tutorial]$ ls -Al app
合計 8
drwxrwxr-x. 2 vagrant vagrant  24  8月 15 23:38 Console
drwxrwxr-x. 2 vagrant vagrant  25  8月 15 23:38 Exceptions
drwxrwxr-x. 4 vagrant vagrant  61  8月 15 23:38 Http
drwxrwxr-x. 2 vagrant vagrant 167  8月 15 23:38 Providers
-rw-rw-r--. 1 vagrant vagrant 105  8月 23 09:32 TestModel.php
-rw-rw-r--. 1 vagrant vagrant 734  8月 15 23:38 User.php

[vagrant@localhost laravel_tutorial]$ ls -Al app

合計 8

drwxrwxr-x. 2 vagrant vagrant 24 8月 15 23:38 Console

drwxrwxr-x. 2 vagrant vagrant 25 8月 15 23:38 Exceptions

drwxrwxr-x. 4 vagrant vagrant 61 8月 15 23:38 Http

drwxrwxr-x. 2 vagrant vagrant 167 8月 15 23:38 Providers

-rw-rw-r--. 1 vagrant vagrant 105 8月 23 09:32 TestModel.php

-rw-rw-r--. 1 vagrant vagrant 734 8月 15 23:38 User.php

以下がモデルクラスファイルの内容。

名前空間をAppとしている
名前空間Illuminate\Database\EloquentのModelファイルを利用する
ModelファイルはModelクラスのファイル
今回作成したTestModelクラスはModelクラスを継承している
モデル作成で定義した名前がそのままクラス名になっている
作成したクラスの中身は空

[vagrant@localhost laravel_tutorial]$ cat app/TestModel.php
<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class TestModel extends Model
{
    //
}

[vagrant@localhost laravel_tutorial]$ cat app/TestModel.php

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class TestModel extends Model

{

}

オプション指定

モデル作成コマンドのオプションは-h/--helpオプションで指定できる。

php artisan make:model --help

1	php artisan make:model --help

主なオプションは以下の通り。

-c/--controller: コントローラーを作成する。
-m/--migration: マイグレーションファイルを作成する。
-r/--resource: リソースベースのアクションが含まれたコントローラーが生成される。ルーティングでのonly、exceptと関係なく、すべてのアクションが含まれる。
-s/--seed: シーダーファイルを作成する。

マイグレーションファイル

ファイル名

モデルクラスファイルと同時に作成されたマイグレーションファイルは、database/migrations下にある。新たに作成された2021_08_23...のマイグレーションファイルが確認できる。

マイグレーションファイルのファイル名構成は以下の通り。

日付_時刻_create_テーブル名_table.php

テーブル名はモデル名をスネークケースに変更し、複数形となっている。

[vagrant@localhost laravel_tutorial]$ ls -Al database/migrations/
合計 16
-rw-rw-r--. 1 vagrant vagrant 813  8月 15 23:38 2014_10_12_000000_create_users_table.php
-rw-rw-r--. 1 vagrant vagrant 683  8月 15 23:38 2014_10_12_100000_create_password_resets_table.php
-rw-rw-r--. 1 vagrant vagrant 789  8月 15 23:38 2019_08_19_000000_create_failed_jobs_table.php
-rw-rw-r--. 1 vagrant vagrant 606  8月 23 09:32 2021_08_23_093211_create_test_models_table.php

[vagrant@localhost laravel_tutorial]$ ls -Al database/migrations/

合計 16

-rw-rw-r--. 1 vagrant vagrant 813 8月 15 23:38 2014_10_12_000000_create_users_table.php

-rw-rw-r--. 1 vagrant vagrant 683 8月 15 23:38 2014_10_12_100000_create_password_resets_table.php

-rw-rw-r--. 1 vagrant vagrant 789 8月 15 23:38 2019_08_19_000000_create_failed_jobs_table.php

-rw-rw-r--. 1 vagrant vagrant 606 8月 23 09:32 2021_08_23_093211_create_test_models_table.php

マイグレーションファイルの内容は以下の通り。

up()メソッド

up()メソッドではテーブルを作成するときのカラム定義が記述されている。

bigincrements()はbigint unsigned型、AUTO_INCREMENT設定のカラムidを定義
timestamps()はtimestamp型でcreated_atとupdated_atの2つのカラムを定義

bigIncrements()によるIDを外部キーで参照する場合

bigIncrements()で生成されるカラムはbigint(unsigned)となる。他テーブルでこれを外部キーとして参照する場合のカラム型はbigint unsignedとする。マイグレーションファイルで指定する場合はunsignedBigInteger()とする。

down()メソッド

down()メソッドは、test_modelsテーブルが存在する場合にこれを削除(DROP)。

[vagrant@localhost laravel_tutorial]$ cat database/migrations/2021_08_23_093211_create_test_models_table.php
<?php

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

class CreateTestModelsTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('test_models', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('test_models');
    }
}

[vagrant@localhost laravel_tutorial]$ cat database/migrations/2021_08_23_093211_create_test_models_table.php

<?php

use Illuminate\Database\Migrations\Migration;

use Illuminate\Database\Schema\Blueprint;

use Illuminate\Support\Facades\Schema;

class CreateTestModelsTable extends Migration

{

/**

* Run the migrations.

* @return void

public function up()

{

Schema::create('test_models', function (Blueprint $table) {

$table->bigIncrements('id');

$table->timestamps();

});

}

/**

* Reverse the migrations.

* @return void

public function down()

{

Schema::dropIfExists('test_models');

}

マイグレーション実行

マイグレーションコマンドについてはこちらを参照。

状態確認

マイグレーション実行前のテーブルの状態。準備の時に作成したままになっている。

mysql> SHOW TABLES;
+------------------------+
| Tables_in_laravel_test |
+------------------------+
| failed_jobs            |
| migrations             |
| password_resets        |
| users                  |
+------------------------+
5 rows in set (0.00 sec)

mysql> SHOW TABLES;

+------------------------+

| Tables_in_laravel_test |

+------------------------+

| failed_jobs |

| migrations |

| password_resets |

| users |

+------------------------+

5 rows in set (0.00 sec)

マイグレーションの実行状態は以下のコマンドで確認。

php artisan migrate:status

今回作成されたマイグレーションファイルだけが未実行となっている。

[vagrant@localhost laravel_tutorial]$ php artisan migrate:status
+------+------------------------------------------------+-------+
| Ran? | Migration                                      | Batch |
+------+------------------------------------------------+-------+
| Yes  | 2014_10_12_000000_create_users_table           | 1     |
| Yes  | 2014_10_12_100000_create_password_resets_table | 1     |
| Yes  | 2019_08_19_000000_create_failed_jobs_table     | 1     |
| No   | 2021_08_23_093211_create_test_models_table     |       |
+------+------------------------------------------------+-------+

[vagrant@localhost laravel_tutorial]$ php artisan migrate:status

+------+------------------------------------------------+-------+

| Ran? | Migration | Batch |

+------+------------------------------------------------+-------+

| Yes | 2014_10_12_000000_create_users_table | 1 |

| Yes | 2014_10_12_100000_create_password_resets_table | 1 |

| Yes | 2019_08_19_000000_create_failed_jobs_table | 1 |

| No | 2021_08_23_093211_create_test_models_table | |

+------+------------------------------------------------+-------+

マイグレート

以下のコマンドで、マイグレーションファイルの設定に従ってテーブルを作成する。

php artisan migrate

[vagrant@localhost laravel_tutorial]$ php artisan migrate
Migrating: 2021_08_23_093211_create_test_models_table
Migrated:  2021_08_23_093211_create_test_models_table (0.02 seconds)

[vagrant@localhost laravel_tutorial]$ php artisan migrate

Migrating: 2021_08_23_093211_create_test_models_table

Migrated: 2021_08_23_093211_create_test_models_table (0.02 seconds)

マイグレーションの結果、データベースにテーブルが作成される。テーブル名はマイグレーションファイル名にもあるとおりで、以下のように付けられる。

モデル名のキャメルケースをスネークケースに変更
複数形にする

[vagrant@localhost laravel_tutorial]$ php artisan migrate:status
+------+------------------------------------------------+-------+
| Ran? | Migration                                      | Batch |
+------+------------------------------------------------+-------+
| Yes  | 2014_10_12_000000_create_users_table           | 1     |
| Yes  | 2014_10_12_100000_create_password_resets_table | 1     |
| Yes  | 2019_08_19_000000_create_failed_jobs_table     | 1     |
| Yes  | 2021_08_23_093211_create_test_models_table     | 2     |
+------+------------------------------------------------+-------+

[vagrant@localhost laravel_tutorial]$ php artisan migrate:status

+------+------------------------------------------------+-------+

| Ran? | Migration | Batch |

+------+------------------------------------------------+-------+

| Yes | 2014_10_12_000000_create_users_table | 1 |

| Yes | 2014_10_12_100000_create_password_resets_table | 1 |

| Yes | 2019_08_19_000000_create_failed_jobs_table | 1 |

| Yes | 2021_08_23_093211_create_test_models_table | 2 |

+------+------------------------------------------------+-------+

データベースでテーブルが作成されていることを確認。

mysql> SHOW TABLES;
+------------------------+
| Tables_in_laravel_test |
+------------------------+
| failed_jobs            |
| migrations             |
| password_resets        |
| test_models            |
| users                  |
+------------------------+
5 rows in set (0.00 sec)

mysql> SHOW TABLES;

+------------------------+

| Tables_in_laravel_test |

+------------------------+

| failed_jobs |

| migrations |

| password_resets |

| test_models |

| users |

+------------------------+

5 rows in set (0.00 sec)

テーブル構造を確認。timestamp()によって、created_atとupdated_atの2つのカラムが作られている。

ただしtimestamp型は2038年問題が発生するため、datetime型に変更する方がよい。

mysql> DESCRIBE test_models;
+------------+-----------------+------+-----+---------+----------------+
| Field      | Type            | Null | Key | Default | Extra          |
+------------+-----------------+------+-----+---------+----------------+
| id         | bigint unsigned | NO   | PRI | NULL    | auto_increment |
| created_at | timestamp       | YES  |     | NULL    |                |
| updated_at | timestamp       | YES  |     | NULL    |                |
+------------+-----------------+------+-----+---------+----------------+
3 rows in set (0.00 sec)

mysql> DESCRIBE test_models;

+------------+-----------------+------+-----+---------+----------------+

+------------+-----------------+------+-----+---------+----------------+

| id | bigint unsigned | NO | PRI | NULL | auto_increment |

+------------+-----------------+------+-----+---------+----------------+

3 rows in set (0.00 sec)

ロールバック

ロールバックにより、作成したテーブルを削除してマイグレーション前の状態に戻すことができる。

php artisan migrate:rollback

[vagrant@localhost laravel_tutorial]$ php artisan migrate:rollback
Rolling back: 2021_08_23_093211_create_test_models_table
Rolled back:  2021_08_23_093211_create_test_models_table (0.01 seconds)

[vagrant@localhost laravel_tutorial]$ php artisan migrate:rollback

Rolling back: 2021_08_23_093211_create_test_models_table

Rolled back: 2021_08_23_093211_create_test_models_table (0.01 seconds)

ロールバックを実行することで、ここまでで作成したtest_modelsテーブルが削除される。

mysql> SHOW TABLES;
+------------------------+
| Tables_in_laravel_test |
+------------------------+
| failed_jobs            |
| migrations             |
| password_resets        |
| users                  |
+------------------------+
4 rows in set (0.00 sec)

mysql> SHOW TABLES;

+------------------------+

| Tables_in_laravel_test |

+------------------------+

| failed_jobs |

| migrations |

| password_resets |

| users |

+------------------------+

4 rows in set (0.00 sec)

ただしマイグレーションファイルは残っていて、編集などを行った後に再度マイグレーションできる。

[vagrant@localhost laravel_tutorial]$ ls -Al database/migrations/
合計 16
-rw-rw-r--. 1 vagrant vagrant 813  8月 15 23:38 2014_10_12_000000_create_users_table.php
-rw-rw-r--. 1 vagrant vagrant 683  8月 15 23:38 2014_10_12_100000_create_password_resets_table.php
-rw-rw-r--. 1 vagrant vagrant 789  8月 15 23:38 2019_08_19_000000_create_failed_jobs_table.php
-rw-rw-r--. 1 vagrant vagrant 606  8月 23 09:32 2021_08_23_093211_create_test_models_table.php

[vagrant@localhost laravel_tutorial]$ ls -Al database/migrations/

合計 16

-rw-rw-r--. 1 vagrant vagrant 813 8月 15 23:38 2014_10_12_000000_create_users_table.php

-rw-rw-r--. 1 vagrant vagrant 683 8月 15 23:38 2014_10_12_100000_create_password_resets_table.php

-rw-rw-r--. 1 vagrant vagrant 789 8月 15 23:38 2019_08_19_000000_create_failed_jobs_table.php

-rw-rw-r--. 1 vagrant vagrant 606 8月 23 09:32 2021_08_23_093211_create_test_models_table.php

マイグレーションファイルの実行状態も未実行に戻る。

[vagrant@localhost laravel_tutorial]$ php artisan migrate:status
+------+------------------------------------------------+-------+
| Ran? | Migration                                      | Batch |
+------+------------------------------------------------+-------+
| Yes  | 2014_10_12_000000_create_users_table           | 1     |
| Yes  | 2014_10_12_100000_create_password_resets_table | 1     |
| Yes  | 2019_08_19_000000_create_failed_jobs_table     | 1     |
| No   | 2021_08_23_093211_create_test_models_table     |       |
+------+------------------------------------------------+-------+

[vagrant@localhost laravel_tutorial]$ php artisan migrate:status

+------+------------------------------------------------+-------+

| Ran? | Migration | Batch |

+------+------------------------------------------------+-------+

| Yes | 2014_10_12_000000_create_users_table | 1 |

| Yes | 2014_10_12_100000_create_password_resets_table | 1 |

| Yes | 2019_08_19_000000_create_failed_jobs_table | 1 |

| No | 2021_08_23_093211_create_test_models_table | |

+------+------------------------------------------------+-------+

マイグレーションファイルの編集とマイグレーション

test_modelsテーブルのカラムを以下のように編集する。

idカラムはそのまま
VARCHAR(20)でproduct_nameカラムを追加
int型でamountカラムを追加
created_atとupdated_atをtimestamp型からdatetime型に変更

参考：利用可能なカラムタイプ

マイグレーション前のファイルを以下のように編集してマイグレート。

[vagrant@localhost laravel_tutorial]$ cat database/migrations/2021_08_23_093211_create_test_models_table.php
<?php

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

class CreateTestModelsTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('test_models', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->string('product_name', 20);
            $table->integer('amount');
            $table->datetime('created_at');
            $table->datetime('updated_at');
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('test_models');
    }
}

[vagrant@localhost laravel_tutorial]$ cat database/migrations/2021_08_23_093211_create_test_models_table.php

<?php

use Illuminate\Database\Migrations\Migration;

use Illuminate\Database\Schema\Blueprint;

use Illuminate\Support\Facades\Schema;

class CreateTestModelsTable extends Migration

{

/**

* Run the migrations.

* @return void

public function up()

{

Schema::create('test_models', function (Blueprint $table) {

$table->bigIncrements('id');

$table->string('product_name', 20);

$table->integer('amount');

$table->datetime('created_at');

$table->datetime('updated_at');

});

}

/**

* Reverse the migrations.

* @return void

public function down()

{

Schema::dropIfExists('test_models');

}

以下の構造のテーブルが作成される。

mysql> DESCRIBE test_models;
+--------------+-----------------+------+-----+---------+----------------+
| Field        | Type            | Null | Key | Default | Extra          |
+--------------+-----------------+------+-----+---------+----------------+
| id           | bigint unsigned | NO   | PRI | NULL    | auto_increment |
| product_name | varchar(20)     | NO   |     | NULL    |                |
| amount       | int             | NO   |     | NULL    |                |
| created_at   | datetime        | NO   |     | NULL    |                |
| updated_at   | datetime        | NO   |     | NULL    |                |
+--------------+-----------------+------+-----+---------+----------------+
5 rows in set (0.00 sec)

mysql> DESCRIBE test_models;

+--------------+-----------------+------+-----+---------+----------------+

+--------------+-----------------+------+-----+---------+----------------+

| id | bigint unsigned | NO | PRI | NULL | auto_increment |

| amount | int | NO | | NULL | |

+--------------+-----------------+------+-----+---------+----------------+

5 rows in set (0.00 sec)

モデルの削除

モデルとテーブルを削除する手順は以下の通り。

該当テーブルのマイグレーションの前までロールバック
マイグレーションファイル削除
モデルファイル削除

timestampの2038年問題について

モデルとマイグレーションファイルを生成させると、自動的にtimestampsが設定されるが、MySQLとの組み合わせの場合に2038年問題が発生する。datetime型で書きなおすなどの対応をしておくべき。

モデル名とテーブル名について

モデルとテーブルを生成するときの命名の流れは以下のようになっている。

モデル名は単数形でアッパーキャメルケース
モデルクラスファイル名はモデル名に.phpの拡張子
モデルクラス名はモデル名と同じ
テーブル名はキャメルケースからスネークケースに変換され、複数形になる

複数形への変更はLaravelがエレガントにやってくれて、不規則な複数形にも対応している。ただし不可算名詞にはそのままsが付くようだ。

TestModel→test_models
TestDiary→test_diaries
CompanyPerson→CompanyPeople
WildGoos→WildGees
StockWater→StockWaters

なお、敢えてモデル名をスネークケースにすると、クラスファイル名、モデルクラス名もキャメルケースのままで、テーブル名は複数形になる。

test_model→test_models

Laravel – 現在のURLの取得

2021-08-16 / tau / コメントする

url()ヘルパー

ヘルパーやLaravel - url()を参照。現在のドメインやURLに関する情報が得られる。

Route::current()

以下のメソッドでドメイン名を除いた現在のフルパスが得られる。

\Route::current()->uri()
→localhost:3000/current/path

1 2	\Route::current()->uri() →localhost:3000/current/path

これとurl()ヘルパーを組み合わせて、以下でもカレントパスを得られる。

url(\Route::current()->uri())
→http://localhost:3000/current/path

1 2	url(\Route::current()->uri()) →http://localhost:3000/current/path

Laravel – バリデーションメッセージの日本語化

2021-07-14 / tau / コメントする

概要

バリデーションエラーはデフォルトで英語だが、これを日本語にしてみる。

方法の1つとして、ロケールjaに対するメッセージファイルを編集する方法を整理する。

ロケールファイルを一括して日本語化する方法はこちら。

元になるアプリケーション

ルーティング

GETリクエストに対してフォームを含むビューを表示し、POSTリクエストに対してバリデーション処理を実行する。

Route::get('/validation_message', 'SampleController@validationMessage');
Route::post('/validation_message', 'SampleController@validationMessageResult');

1 2	Route::get('/validation_message', 'SampleController@validationMessage'); Route::post('/validation_message', 'SampleController@validationMessageResult');

ビュー

フォームでユーザー名とメールアドレスを入力し、POST処理の結果バリデーションエラーがあれば表示する。

  <h1>{{ $title }}</h1>

  <form method="post">
    @csrf
    <p><input type="text" name="name" placeholder="ユーザー名:10文字以内"></p>
    <p><input type="text" name="email" placeholder="メールアドレス:**@**"></p>
    <input type="submit" value="送信">
  </form>

  <p>{!! implode('<br>', $errors->all()) !!}</p>

<h1>{{ $title }}</h1>

@csrf

</form>

<p>{!! implode('<br>', $errors->all()) !!}</p>

コントローラー

フォーム表示

GETリクエストに対してフォーム画面を表示する。

  public function validationMessage() {
    return view('samples.validation_message', [
      'title' => 'カスタムバリデーションメッセージ',
    ]);
  }

public function validationMessage() {

return view('samples.validation_message', [

'title' => 'カスタムバリデーションメッセージ',

]);

}

POST処理

POSTリクエストに対して、ユーザー名とメールアドレスのバリデーションを実行。

  public function validationMessageResult(Request $request) {
    $request->validate([
      'name' => ['required', 'max:10'],
      'email' => ['required', 'email'],
    ]);

    return redirect('/validation_message');
  }

public function validationMessageResult(Request $request) {

$request->validate([

'name' => ['required', 'max:10'],

'email' => ['required', 'email'],

]);

return redirect('/validation_message');

}

この場合のバリデーションエラーは以下の様に表示される。

The name field is required.
The email field is required.

1 2	The name field is required. The email field is required.

あるいは

The name may not be greater than 10 characters.
The email must be a valid email address.

1 2	The name may not be greater than 10 characters. The email must be a valid email address.

ロケール設定による日本語化

ReaDouble.comのバリデーションのドキュメントでエラーメッセージのカスタマイズについて説明されていて、ローカライゼーションについては多言語化ドキュメントを参照するよう示唆されている。

これに基づいて、バリデーションエラーメッセージの日本語化をローカライゼーション周りで実装する方法を整理する。

言語の選択

config/app.phpでロケール設定を変更する。

localeをデフォルトのenからjaに変更
localeがjaで見つからないときのfallback_localeがデフォルトでenになっていることを確認
これにより、日本語ロケールの設定がある場合は日本語が適用され、見つからない場合は英語の設定が適用される

    .....
    'locale' => 'ja',
    .....
    'fallback_locale' => 'en',
    .....

.....

'locale' => 'ja',

.....

'fallback_locale' => 'en',

.....

バリデーションエラーメッセージのコピー・編集

resources/en/validation.phpで英語のバリデーションメッセージが定義されている。

<?php

return [
    .....
    'email' => 'The :attribute must be a valid email address.',
    .....
    'max' => [
        'numeric' => 'The :attribute may not be greater than :max.',
        'file' => 'The :attribute may not be greater than :max kilobytes.',
        'string' => 'The :attribute may not be greater than :max characters.',
        'array' => 'The :attribute may not have more than :max items.',
    ],
    .....
    'required' => 'The :attribute field is required.',
    .....
];

<?php

return [

.....

'email' => 'The :attribute must be a valid email address.',

.....

'max' => [

'numeric' => 'The :attribute may not be greater than :max.',

'file' => 'The :attribute may not be greater than :max kilobytes.',

'string' => 'The :attribute may not be greater than :max characters.',

'array' => 'The :attribute may not have more than :max items.',

.....

'required' => 'The :attribute field is required.',

.....

];

日本語ロケール設定のため、jaディレクトリーを作成し、そこにコピーしたvalidation.phpを編集する。

resources/jaディレクトリーを作成
jaディレクトリー下にvalidation.phpをコピー
必要なバリデーションメッセージを日本語化

<?php

return [
    .....
    'email' => ':attributeが正しい形式ではありません。',
    .....
    'max' => [
        'numeric' => 'The :attribute may not be greater than :max.',
        'file' => 'The :attribute may not be greater than :max kilobytes.',
        'string' => ':attributeは:max文字を超えられません。',
        'array' => 'The :attribute may not have more than :max items.',
    ],
    .....
    'required' => ':attributeの入力が必要です。',
    .....
];

<?php

return [

.....

'email' => ':attributeが正しい形式ではありません。',

.....

'max' => [

'numeric' => 'The :attribute may not be greater than :max.',

'file' => 'The :attribute may not be greater than :max kilobytes.',

'string' => ':attributeは:max文字を超えられません。',

'array' => 'The :attribute may not have more than :max items.',

.....

'required' => ':attributeの入力が必要です。',

.....

];

:attributeはエラーが発生したフィールドのname属性の値で置き換えられる。また:maxはバリデーションで設定した値に置き換えられる。

これにより、バリデーションエラーが生じたときの表示は以下の様に日本語化される。

nameの入力が必要です。
emailの入力が必要です。

1 2	nameの入力が必要です。 emailの入力が必要です。

あるいは

nameは10文字を超えられません。
emailが正しい形式ではありません。

1 2	nameは10文字を超えられません。 emailが正しい形式ではありません。

属性の日本語化

上記のメッセージでは、:attributeが置き換えられるname属性のnameやemailがそのまま現れている。

これらは、validation.phpの最後にある'attributes'に連想配列を記述することで、日本語表現に置き換えることができる。

    'attributes' => [],

1	'attributes' => [],

今回の例の場合、name属性はname(ユーザー名)とemail(メールアドレス)なので、これらを日本語に置き換えるよう定義する。

    'attributes' => [
        'email' => 'メールアドレス',
        'name' => 'ユーザー名'
    ],

'attributes' => [

'email' => 'メールアドレス',

'name' => 'ユーザー名'

この結果、バリデーションエラーメッセージは以下の様になる。

ユーザー名の入力が必要です。
メールアドレスの入力が必要です。

1 2	ユーザー名の入力が必要です。メールアドレスの入力が必要です。

あるいは

ユーザー名は10文字を超えられません。
メールアドレスが正しい形式ではありません。

1 2	ユーザー名は10文字を超えられません。メールアドレスが正しい形式ではありません。

エラーメッセージを日本語化したもの以外のバリデーションに対しては、元のまま残っている英語の内容が使われる。

たとえばバリデーションを追加する。

'email' => ['required', 'email', 'regex:/^\w+@\w+$/'],

1	'email' => ['required', 'email', 'regex:/^\w+@\w+$/'],

そうするとバリデーションエラーは以下のようになる。

The メールアドレス format is invalid.

1	The メールアドレス format is invalid.

全体のセンテンスは英語だが、name属性emailがattributesで変更した内容に置き換えられている。

Laravel – 動的メッセージ表示

2021-07-13 / tau / コメントする

概要

バリデーションエラーや登録成功などのメッセージを一時的に表示する方法を整理する。

ダイアログによりブラウザー表示領域とは別に表示する方法と、表示領域にメッセージを出して動的に消去する方法の2つ。

エラー・成功メッセージの登録

以下のような例で考えていく。

GETリクエストから表示用コントローラー・アクションにルーティング
アクションからフォームを含むページを呼び出す
フォームにユーザー名とメールアドレスの入力テキストボックスを配置

    <form method="post">
      @csrf
      <p><input type="text" name="name" placeholder="ユーザー名10文字以内"></p>
      <p><input type="text" name="email" placeholder="***@***"></p>
      <input type="submit" value="送信">
    </form>

@csrf

</form>

送信ボタンが押された場合のPOSTに対して、バリデーション用コントローラー・アクションにルーティング
バリデーション用アクションでは、ユーザー名とメールアドレスのバリデーションを記述
- バリデーション結果が妥当な場合はflash()で成功メッセージを登録
- バリデーション結果が妥当でない場合は、それ以降は実行されず$errorsに結果が保存される
いずれの場合も元のGETルートにリダイレクトされる

  public function flashResult(Request $request) {
    $request->validate([
      'name' => ['required', 'max:10'],
      'email' => ['required', 'email'],
    ]);

    session()->flash('success', '正しく入力されました');

    return redirect('/flash_sample');
  }

public function flashResult(Request $request) {

$request->validate([

'name' => ['required', 'max:10'],

'email' => ['required', 'email'],

]);

session()->flash('success', '正しく入力されました');

return redirect('/flash_sample');

}

状況に応じて登録された／空のままの$errorsやflashに対して、ビュー側で表示する。

ダイアログ表示

$errorsやflashをダイアログで表示する方法。

ビューのhead要素内で、これらの状態に応じたメッセージを生成し、Javascriptのalertの引数に渡している。

複数のエラーメッセージを改行文字を挟んでつなげるのに、PHPのinplode()関数を使っている。

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>{{ $title }}</title>
    <script>
    @if ($errors->any())
      alert("{{ implode('\n', $errors->all()) }}");
    @elseif (session()->has('success'))
      alert("{{ session()->get('success') }}");
    @endif
    </script>
  </head>
  <body>
  .....
  </body>
</html>

<!DOCTYPE html>

<head>

<title>{{ $title }}</title>

@if ($errors->any())

alert("{{ implode('\n', $errors->all()) }}");

@elseif (session()->has('success'))

alert("{{ session()->get('success') }}");

@endif

</script>

</head>

<body>

.....

</body>

</html>

スライドアップによる一時表示

エラーや成功メッセージをブラウザーの上部などに表示し、一定時間後にそれをスライドアップなどで消去する。

メッセージ表示領域の設定と、Javascriptによる動的な消去の2段階で整理する。

メッセージ表示エリアの設定

ビューのbody要素最上部で、ディレクティブによってメッセージ表示領域を動的に生成している。その際に、エラー／成功に応じたクラスを要素に設定している。

$errors->any()でエラーが登録されていれば、エラー表示領域を生成
session()->has()で成功メッセージが登録されていれば成功メッセージ表示領域を生成

ビューのhead要素内で、エラーメッセージ領域／成功メッセージ領域それぞれのクラスに応じたスタイルを設定している。

なお、エラーメッセージは複数のメッセージを改行で表示させたいので、PHPのImplode()関数で区切りを<br>としたうえで{!! ... !!}で囲んでエスケープを抑制している。

!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <style>
      .error {
        padding: 0.5em 1em 0.5em 1em;
        background-color: #fcc;
      }
      .success {
        padding: 0.5em 1em 0.5em 1em;
        background-color: #9df;
      }
    </style>
    <title>{{ $title }}</title>
  </head>
  <body>
    @if ($errors->any())
      {{-- エラーメッセージ --}}
      <div class="error">
        {!! implode('<br>', $errors->all()) !!}
      </div>
    @elseif (session()->has('success'))
      {{-- 成功メッセージ --}}
      <div class="success">
        {{ session()->get('success') }}
      </div>
    @endif
    .....
  </body>
</html>

!DOCTYPE html>

<head>

<style>

.error {

padding: 0.5em 1em 0.5em 1em;

background-color: #fcc;

}

.success {

padding: 0.5em 1em 0.5em 1em;

background-color: #9df;

}

</style>

<title>{{ $title }}</title>

</head>

<body>

@if ($errors->any())

{!! implode('<br>', $errors->all()) !!}

</div>

@elseif (session()->has('success'))

</div>

@endif

.....

</body>

</html>

メッセージ表示エリアの消去

エラー／成功のクラスに対して、JQueryでこれらをスライドアップして消去するスクリプトを追加する。

5行目でJQueryをCDNで読み込み
script要素内でスライドアップの動作を定義

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <script src="https://code.jquery.com/jquery-3.5.0.min.js"></script>
    <script>
      window.setTimeout(() => {
        $(".error").slideUp();
        $(".success").slideUp();
      }, 1500);
    </script>
    .....
  </head>
  <body>
  .....
  </body>
</html>

<!DOCTYPE html>

<head>

window.setTimeout(() => {

$(".error").slideUp();

$(".success").slideUp();

}, 1500);

</script>

.....

</head>

<body>

.....

</body>

</html>

Laravel – flash

2021-07-13 / tau / コメントする

概要

セッションのflash()メソッドは、put()メソッドと同じくセッションにキーと値のデータを登録できる
ただしそのデータは、次のリクエストの間だけ保存され、その後は削除される
このためflashはコントローラー処理結果の通知などに使われる
flashの操作はsession()グローバルヘルパーを使うが、Requestインスタンス経由でもよい

基本形

flashへの登録

session()->flash('キー', 値);
$request->session()->flash('キー', 値);

flashのデータ存在確認

session()->has('キー')

flashのデータ参照

session()->get('キー')

実装例

ビュー

ビューから見た動作は以下の通り

GETリクエストでルーティングされ、フォームを表示する
ユーザー名を入力後に送信ボタンを押すと、ユーザー名のバリデーション用コントローラーに制御を移す
バリデーションの結果、このページにリダイレクトされ、結果に応じて$errorsかflashの内容が表示される
$errorsはバリデーション結果が妥当でない時に自動でメッセージが登録される
flashはバリデーション結果が妥当な時にコントローラーでメッセージを登録する

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>{{ $title }}</title>
    <style>
      .error {
        color: red;
      }
      .success {
        color: blue;
      }
    </style>
  </head>
  <body>
    {{-- エラーメッセージ --}}
    @foreach ($errors->all() as $error)
      <p class="error">{{ $error }}</p>
    @endforeach

    {{-- 成功メッセージ --}}
    @if (session()->has('success'))
      <p class="success">{{ session()->get('success') }}</p>
    @endif

    <h1>{{ $title }}</h1>

    {{-- 入力フォーム --}}
    <form method="post">
      @csrf
      <input type="text" name="user_name" placeholder="ユーザー名10文字以内">
      <input type="submit" value="送信">
    </form>
  </body>
</html>

<!DOCTYPE html>

<head>

<title>{{ $title }}</title>

<style>

.error {

color: red;

}

.success {

color: blue;

}

</style>

</head>

<body>

@foreach ($errors->all() as $error)

<p class="error">{{ $error }}</p>

@endforeach

@if (session()->has('success'))

<p class="success">{{ session()->get('success') }}</p>

@endif

<h1>{{ $title }}</h1>

@csrf

</form>

</body>

</html>

表示アクション

最初のルーティングで呼ばれ、ビューを初期状態で表示する。

  public function flashSample() {
    return view('samples.flash_sample', ['title' => 'flashのサンプル']);
  }

public function flashSample() {

return view('samples.flash_sample', ['title' => 'flashのサンプル']);

}

バリデーションアクション

フォームから呼び出され、バリデーションのみを行い、元のページへリダイレクトする。

バリデーション結果が妥当でなければ、$errorsにメッセージが登録され、初期ページにリダイレクト
バリデーション結果が妥当な時はflashにメッセージを登録して初期ページにリダイレクト

  public function flashResult(Request $request) {
    $request->validate([
      'user_name' => ['required', 'max:10'],
    ]);

    session()->flash('success', '正しく入力されました');

    return redirect('/flash_sample');
  }

public function flashResult(Request $request) {

$request->validate([

'user_name' => ['required', 'max:10'],

]);

session()->flash('success', '正しく入力されました');

return redirect('/flash_sample');

}

Laravel – 各ヘルパーのパス指定

2021-07-13 / tau / コメントする

概要

引数にパス文字列を与えて、サーバー上のパスやURLを返すヘルパー。

パス系はpublic_pathのみ挙動が異なるが、全般に以下のように決めておくと紛れがない。

引数を省略、もしくは引数に''を与えると、それぞれのターゲットパスが得られる
引数に'/'を指定してはいけない
引数のパス指定の頭に'/'を付けない
戻り値のパスの後に動的にパスを付加したいといった場合は、以下のいずれか
- 引数のパス指定の最後に'/'を付ける
- 引数のパス指定の最後に'/'を付けず、戻り値に明示的に'/'を連結する

URL系はパス系と挙動が異なる。

引数は省略できない
引数に''を与えると、ドメイン名のみのURLが得られる
引数に'/'を与えると、ドメイン名の後ろに’/’が付いたURLが得られる
引数のパスの最後に'/'を付けても付けなくても、結果のURLの最後には'/'は付かない
戻り値のパスの後に動的にパスを付加したいといった場合は、以下の一択
- 引数のパス指定の最後に'/'を付けても付けなくても、戻り値に明示的に'/'を連結する

storage_path()、storage_path('')
→/.../アプリケーションディレクトリー/storage
storage_path('abc/def')
→/.../アプリケーションディレクトリー/storage/abc/def
storage_path('abc/def/')→/.../アプリケーションディレクトリー/storage/abc/def/
storage_path('/')→/.../アプリケーションディレクトリー/storage//
storage_path('/abc/def')→/.../アプリケーションディレクトリー/storage//abc/def
storage_path('/abc/def/')→/.../アプリケーションディレクトリー/storage//abc/def/

URL系

asset()～publicディレクトリー下のアセット

Laravelアプリケーションのpublicディレクトリー下の相対パスまたは絶対パスを与えて、アセットへのURLを返す。

末尾の'/'の有無は結果に影響しないが、'/'を単独で指定するとドメイン名の後に'/'が付加されたURLになる。

以下の例では、public/abcディレクトリー下のdefファイルを指定していて、ブラウザーに戻り値のURLを指定するとdefファイルの内容が表示される。

asset('abc/def')
asset('abc/def/')
asset('/abc/def')
asset('/abc/def/')
→http://ドメイン/abc/def
asset('/')
→http://ドメイン/
asset()
→エラー

セキュア―な通信環境下の場合はsecure_asset()を使う。戻り値はhttp→httpsとなったURL。

url()～アプリケーションのURL

Laravelアプリケーションのドメインより後のディレクトリーを与えて、URLを返す。ルーティングで定義したパスを指定するとドメイン名を含んだURLが得られる。パスの指定は相対／絶対のどちらでもよい。

末尾の'/'の有無は結果に影響せず、戻り値の末尾には常に'/'が付かない。

'/'を単独で指定するとドメイン名の後に'/'が付加されたURLになる。

url('abc/def')
url('abc/def/')
url('/abc/def')
url('/abc/def/')
→http://ドメイン/abc/def
url('/')
→http://ドメイン/
asset()
→エラー

url()ヘルパーを使ってURLに関する様々な情報を得ることができる。

Laravel – セッション

2021-07-13 / tau / コメントする

セッションの操作

セッションの操作には、session()グローバルヘルパーを利用する方法と、、アクション引数のRequestインスタンスを経由する方法がある。

session()グローバルヘルパーを利用する方法：

session()->各メソッド;

Requestインスタンスを経由する方法：

$request->session()->各メソッド;

セッションデータの取得・初期化

変数 = session()->get('キー', 初期値);
変数 = $request->session()->('キー', 初期値);
変数 = $request->session()->('キー', function() { return 初期値 });

キーに対応するセッションデータの値を変数に代入する
キーが存在しない時は、キーと初期値をセットしてセッションデータを追加し、その値を変数に代入する

セッションデータの保存

session()->put('キー', 値);
session(['キー' => 値]);
$request->session()->put('キー', 値);

キーと値をセッションデータとして保存する

セッションデータの削除

session()->forget('キー');
$request->session()->forget('キー');

キーに対応するセッションデータを削除する

session()->flush();
$request->session()->flush();

セッションのすべてのデータを削除する

実装例

ビュー

以下の内容を含むビューを所定の位置に準備。

$countが1なら初訪問の旨を、そうでなければ訪問回数を表示
カウンターをクリアするためのボタンを表示

  @if ($count === 1)
    <p>初めまして</p>
  @else
    <p>{{ $count }}回目のアクセスです</p>
  @endif

  <form method="post">
    @csrf
    <input type="submit" value="カウンタークリア">
  </form>

@if ($count === 1)

<p>初めまして</p>

@else

<p>{{ $count }}回目のアクセスです</p>

@endif

@csrf

</form>

設定・変更アクション

コントローラーに以下のアクションを準備し、ルーティング設定する。

'count'キーのセッションデータの値を取得して$countに代入
- countというキーのセッションデータがなければ値0で作成して、その値を$countに代入
$countの値をインクリメント
$countの値を渡してビューをレンダリング

  public function sessionTest() {
    $count = session()->get('count', 0);
    $count++;

    session()->put('count', $count);

    return view('samples.counter_sample', [
      'title' => 'セッションのサンプル',
      'count' => $count,
    ]);
  }

public function sessionTest() {

$count = session()->get('count', 0);

$count++;

session()->put('count', $count);

return view('samples.counter_sample', [

'title' => 'セッションのサンプル',

'count' => $count,

]);

}

削除アクション

forget('キー'): キーに対応するセッションデータを削除する。
flush(): 全てのセッションデータを削除する。

フォームのカウンタークリアボタンが押されたときのアクションを準備し、ルーティングを設定する。

'count'キーのセッションデータを削除する
削除した旨を画面に直接表示する

  public function deleteSession() {
    session()->forget('count');

    return 'セッションデータを削除しました';
  }

public function deleteSession() {

session()->forget('count');

return 'セッションデータを削除しました';

}

実行結果

最初にアクセスすると、「初めまして」と表示
リロードすると「2回目のアクセスです」と表示
その後リロードするたびに回数が1つずつ増加
カウンタークリアボタンを押すと、「セッションデータを削除しました」と表示
ブラウザーの戻るボタンを押すと元の画面に戻り、「初めまして」と表示

Laravel – Cookie

2021-07-12 / tau / コメントする

Cookieの操作

Cookieの取得・初期化

変数 = \Cookie::get('Cookie名', 初期値);

Cookie名のCookieの値を変数に代入する
Cookie名のCookieが存在しない時は、初期値をセットしてその値を変数に代入する

Cookieの保存

\Cookie::queue('Cookie名', 変数, 保存期限);

Cookie名のCookieに変数の値を保存する
保存期限は分単位で設定する

Cookieの削除

\Cookie::queue(\Cookie::forget('Cookie名'));

Cookie名のCookieを削除する

実装例

ビュー

以下の内容を含むビューを所定の位置に準備。

$countが1なら初訪問の旨を、そうでなければ訪問回数を表示
カウンターをクリアするためのボタンを表示

  @if ($count === 1)
    <p>初めまして</p>
  @else
    <p>{{ $count }}回目のアクセスです</p>
  @endif

  <form method="post">
    @csrf
    <input type="submit" value="カウンタークリア">
  </form>

@if ($count === 1)

<p>初めまして</p>

@else

<p>{{ $count }}回目のアクセスです</p>

@endif

@csrf

</form>

設定・変更アクション

コントローラーに以下のアクションを準備し、ルーティング設定する。

countという名前のCookieの値を取得して$countに代入
- countという名前のCookieがなければ値0で作成して、その値を$countに代入
$countの値をインクリメント
$countの値を90日期限でCookieに保存
$countの値を渡してビューをレンダリング

  public function cookieTest() {
    $count = \Cookie::get('count', 0);
    $count++;

    \Cookie::queue('count', $count, 60 * 24 * 90);

    return view('samples.cookie', [
      'count' => $count,
    ]);
  }

public function cookieTest() {

$count = \Cookie::get('count', 0);

$count++;

\Cookie::queue('count', $count, 60 * 24 * 90);

return view('samples.cookie', [

'count' => $count,

]);

}

削除アクション

フォームのカウンタークリアボタンが押されたときのアクションを準備し、ルーティングを設定する。

Cookieを削除する
削除した旨を画面に直接表示する

  public function deleteCookie() {
    \Cookie::queue(\Cookie::forget('count'));

    return 'cookieを削除しました';
  }

public function deleteCookie() {

\Cookie::queue(\Cookie::forget('count'));

return 'cookieを削除しました';

}

実行結果

最初にアクセスすると、「初めまして」と表示
リロードすると「2回目のアクセスです」と表示
その後リロードするたびに回数が1つずつ増加
カウンタークリアボタンを押すと、「cookieを削除しました」と表示
ブラウザーの戻るボタンを押すと元の画面に戻り、「初めまして」と表示