Laravel – 外部スタイルファイル

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

ビューに対するスタイルファイルを外部に置く場合、ビューHTMLのヘッダー部分にlinkタグを記述する。

<link rel="stylesheet" href="スタイルファイルのURL">

アプリケーションのpublicディレクトリー下に置く場合は、asset()ヘルパーを使うことができる。

例えばスタイルファイルをpublic/css/style.cssとして準備する場合は以下のようなタグになる。

<link rel="stylesheet" href="{{ asset('css/style.css') }}">

1	<link rel="stylesheet" href="{{ asset('css/style.css') }}">

httpsによるセキュアーな通信環境の場合はsecure_asset()を使う。

<link rel="stylesheet" href="{{ secure_asset('css/style.css') }}">

1	<link rel="stylesheet" href="{{ secure_asset('css/style.css') }}">

Laravel – エラーメッセージの日本語化

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

日本語化ファイルのダウンロードとインストール

ユーザー認証やバリデーションなどに関するエラーメッセージの日本語化はロケールファイルを編集する方法で可能だが、言語ファイルをダウンロード・インストールする方法がReadDoubleで紹介されている。

以下、プロジェクトのルートディレクトリーで操作。

インストールファイルのダウンロード

$ php -r "copy('https://readouble.com/laravel/6.x/ja/install-ja-lang-files.php', 'install-ja-lang.php');"

1	$ php -r "copy('https://readouble.com/laravel/6.x/ja/install-ja-lang-files.php', 'install-ja-lang.php');"

インストールファイルの実行

$ php -f install-ja-lang.php

1	$ php -f install-ja-lang.php

インストールファイルの削除

$ php -r "unlink('install-ja-lang.php');"

1	$ php -r "unlink('install-ja-lang.php');"

これによりresources/lang/jaディレクトリーにauth.php、passwords.php、pagination.php、validation.phpの4つのファイルが生成される。

[vagrant@localhost laravel_tutorial]$ ls -Al resources/lang/ja/
合計 24
-rw-rw-r--. 1 vagrant vagrant   658  8月 24 23:09 auth.php
-rw-rw-r--. 1 vagrant vagrant   564  8月 24 23:09 pagination.php
-rw-rw-r--. 1 vagrant vagrant   844  8月 24 23:09 passwords.php
-rw-rw-r--. 1 vagrant vagrant 10490  8月 24 23:09 validation.php

[vagrant@localhost laravel_tutorial]$ ls -Al resources/lang/ja/

合計 24

-rw-rw-r--. 1 vagrant vagrant 658 8月 24 23:09 auth.php

-rw-rw-r--. 1 vagrant vagrant 564 8月 24 23:09 pagination.php

-rw-rw-r--. 1 vagrant vagrant 844 8月 24 23:09 passwords.php

-rw-rw-r--. 1 vagrant vagrant 10490 8月 24 23:09 validation.php

これでメッセージは日本語化されるが、まだ属性名は以下のようにソースコードで記述したまま。

nameは必ず指定してください。

handlenameは、10文字以下で指定してください。

emailに正しい形式を指定してください。

nameは必ず指定してください。

handlenameは、10文字以下で指定してください。

emailに正しい形式を指定してください。

属性名の日本語化

バリデーションエラーの属性名を日本語化するには、resources/lang/ja/validation.phpを編集する。

<?php

return [
    .....

    /*
    |--------------------------------------------------------------------------
    | カスタムバリデーション属性名
    |--------------------------------------------------------------------------
    |
    | 以下の言語行は、例えば"email"の代わりに「メールアドレス」のように、
    | 読み手にフレンドリーな表現でプレースホルダーを置き換えるために指定する
    | 言語行です。これはメッセージをよりきれいに表示するために役に立ちます。
    |
    */

    'attributes' => [],

];

<?php

return [

.....

|--------------------------------------------------------------------------

| カスタムバリデーション属性名

|--------------------------------------------------------------------------

| 以下の言語行は、例えば"email"の代わりに「メールアドレス」のように、

| 読み手にフレンドリーな表現でプレースホルダーを置き換えるために指定する

| 言語行です。これはメッセージをよりきれいに表示するために役に立ちます。

'attributes' => [],

];

たとえばname、handlename、emailを日本語化するには以下のように編集。

<?php

return [
    .....

    /*
    |--------------------------------------------------------------------------
    | カスタムバリデーション属性名
    |--------------------------------------------------------------------------
    |
    | 以下の言語行は、例えば"email"の代わりに「メールアドレス」のように、
    | 読み手にフレンドリーな表現でプレースホルダーを置き換えるために指定する
    | 言語行です。これはメッセージをよりきれいに表示するために役に立ちます。
    |
    */

    'attributes' => [
        'name' => '名前',
        'handlename' => 'ハンドルネーム',
        'email' => 'メールアドレス',
     ],

];

<?php

return [

.....

|--------------------------------------------------------------------------

| カスタムバリデーション属性名

|--------------------------------------------------------------------------

| 以下の言語行は、例えば"email"の代わりに「メールアドレス」のように、

| 読み手にフレンドリーな表現でプレースホルダーを置き換えるために指定する

| 言語行です。これはメッセージをよりきれいに表示するために役に立ちます。

'attributes' => [

'name' => '名前',

'handlename' => 'ハンドルネーム',

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

];

これにより、メッセージ表示は以下のように日本語化される。

名前は必ず指定してください。

ハンドルネームは、10文字以下で指定してください。

メールアドレスに正しい形式を指定してください。

名前は必ず指定してください。

ハンドルネームは、10文字以下で指定してください。

メールアドレスに正しい形式を指定してください。

Laravel – フォームリクエスト

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

概要

FormRequestクラスは、ユーザー権限の認証と入力のバリデーションを専用に扱う
実装は、artisanでFormRequestクラスを継承したクラスを生成し、認証やバリデーションの内容を記述
コントローラーのインジェクションをRequestからFormRequestの継承クラスに変更することで、チェック機能をコントローラーから分離することができる

準備

バリデーションで使ったアプリケーションを利用する。

ビュー

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

    <form method="post">
      @csrf
      <p><input type="text" name="name" placeholder="ユーザー名"></p>
      <p><input type="text" name="handlename" placeholder="ハンドルネーム"></p>
      <p><input type="text" name="email" placeholder="メールアドレス"></p>
      <input type="submit" value="送信">
    </form>
    <hr>

    @foreach ($errors->all() as $error)
      <p>{{ $error }}</p>
    @endforeach

    @if (isset($user))
      <p>ユーザーネーム：{{ $user['name'] }}</p>
      <p>ハンドルネーム：{{ $user['handlename'] }}</p>
      <p>メールアドレス：{{ $user['email'] }}</p>
    @endif

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

@csrf

</form>

<hr>

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

<p>{{ $error }}</p>

@endforeach

@if (isset($user))

<p>ユーザーネーム：{{ $user['name'] }}</p>

<p>ハンドルネーム：{{ $user['handlename'] }}</p>

<p>メールアドレス：{{ $user['email'] }}</p>

@endif

コントローラーのアクション

  public function showValidation(Request $request) {
    $request->validate([
      'name' => ['required'],
      'handlename' => ['required', 'max:10'],
      'email' => ['required', 'regex:/^\w+@\w+$/'],
    ]);

    $user = [
      'name' => $request->input('name'),
      'handlename' => $request->input('handlename'),
      'email' => $request->input('email'),
    ];

    return view('samples.validation_example_form', [
      'title' => 'バリデーションサンプル結果',
      'user' => $user,
    ]);
  }

public function showValidation(Request $request) {

$request->validate([

'name' => ['required'],

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

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

]);

$user = [

'name' => $request->input('name'),

'handlename' => $request->input('handlename'),

'email' => $request->input('email'),

];

return view('samples.validation_example_form', [

'title' => 'バリデーションサンプル結果',

'user' => $user,

]);

}

フォームリクエストクラスの生成

以下のコマンドでFormRequestを継承したクラスを作成する。

php artisan make:request リクエストクラス名

[vagrant@localhost laravel_tutorial]$ php artisan make:request RegistrationRequest
Request created successfully.

1 2	[vagrant@localhost laravel_tutorial]$ php artisan make:request RegistrationRequest Request created successfully.

リクエストクラスは、app/Http/Requestsディレクトリー下に作成される。

[vagrant@localhost laravel_tutorial]$ ls app/Http/Requests/
RegistrationRequest.php

1 2	[vagrant@localhost laravel_tutorial]$ ls app/Http/Requests/ RegistrationRequest.php

リクエストクラスの内容。ユーザー認証のためのauthorize()メソッドと、バリデーションのためのrules()メソッドが定義されている。

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class RegistrationRequest 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 [
            //
        ];
    }
}

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class RegistrationRequest 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 [

];

}

アクションの引数の変更

コントローラーの先頭でリクエストクラスをuseでインポート
コントローラーのアクションのメソッドインジェクションをRequestからリクエストクラスに変更
validate()メソッドはアクションには書かない

今回の例の場合。

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

// リクエストクラスのインポート
use App\Http\Requests\RegistrationRequest;

class ValidationExampleController extends Controller
{
  .....
  public function showValidation(RegistrationRequest $request) {
    // バリデーションの記述は不要

    $user = [
      'name' => $request->input('name'),
      'handlename' => $request->input('handlename'),
      'email' => $request->input('email'),
    ];

    return view('samples.validation_example_form', [
      'title' => 'バリデーションの結果',
      'user' => $user,
    ]);
  }
}

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

// リクエストクラスのインポート

use App\Http\Requests\RegistrationRequest;

class ValidationExampleController extends Controller

{

.....

public function showValidation(RegistrationRequest $request) {

// バリデーションの記述は不要

$user = [

'name' => $request->input('name'),

'handlename' => $request->input('handlename'),

'email' => $request->input('email'),

];

return view('samples.validation_example_form', [

'title' => 'バリデーションの結果',

'user' => $user,

]);

}

ユーザー認証の記述

準備中。認証された場合はauthorize()メソッドの戻り値がtrue。

バリデーションルールの記述

rules()メソッドの戻り値の配列に、バリデーションルールを書く。

準備したコントローラーのバリデーション部分をリクエストクラスに記述。

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class RegistrationRequest extends FormRequest
{
    public function authorize()
    .....

    public function rules()
    {
        return [
          'name' => ['required'],
          'handlename' => ['required', 'max:10'],
          'email' => ['required', 'regex:/^\w+@\w+$/'],
        ];
    }
}

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class RegistrationRequest extends FormRequest

{

public function authorize()

.....

public function rules()

{

return [

'name' => ['required'],

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

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

];

}

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

フォームリクエストのmessages()メソッドをオーバーライドすることで、メッセージのカスタマイズができる。

参考：Laravel 6.x バリデーション～エラーメッセージのカスタマイズ

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

PHP – 名前空間～namespace

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

概要

PHPの名前空間(namespace)は、Javaのパッケージのようにコード群をカプセル化し、異なる名前空間の間での名前の衝突を避ける役割を持つ。

namespace 名前空間名;

namespaceが記述された以降のコードはその名前空間に属する
同じ名前空間内では、クラス名などはそのまま記述
異なる名前空間のクラスなどを用いるときは、絶対パスを使うかuse文で名前空間を指定する(このuse文はトレイトのuseとは異なる)

クラスの例

以下の例は、異なる名前空間のクラスを利用する場合。

名前空間Bでクラス名MyClassだけを記述すると、名前空間BのMyClassが使われる
絶対パス\A\MyClassと記述すると、名前空間AのMyClassが使われる
use \A\MyClassを記述すると、MyClassと記述したときに名前空間AのMyClassが使われる(as ...でエイリアスも指定できる)

namespace A;

class MyClass {
  public function show() {
    echo "名前空間Aのクラス\n";
  }
}


namespace B;

class MyClass {
  public function show() {
    echo "名前空間Bのクラス\n";
  }
}

$obj = new MyClass();
$obj->show();

$obj = new \A\MyClass();
$obj->show();


namespace C;

use \A\MyClass; // use A\MyClassでもよい
$obj = new MyClass();
$obj->show();


// 名前空間Bのクラス
// 名前空間Aのクラス
// 名前空間Aのクラス

namespace A;

class MyClass {

public function show() {

echo "名前空間Aのクラス\n";

}

namespace B;

class MyClass {

public function show() {

echo "名前空間Bのクラス\n";

}

$obj = new MyClass();

$obj->show();

$obj = new \A\MyClass();

$obj->show();

namespace C;

use \A\MyClass; // use A\MyClassでもよい

$obj = new MyClass();

$obj->show();

// 名前空間Bのクラス

// 名前空間Aのクラス

関数の場合

以下の例は、異なる名前空間の関数を利用する場合。

名前空間Bで関数名funcだけを記述すると、名前空間Bのfuncが使われる
絶対パス\A\funcと記述すると、名前空間Aのfuncが使われる
use function \A\funcを記述すると、funcと記述したときに名前空間Aのfuncが使われる(as ...でエイリアスも指定できる)

namespace A;

function func() {
  echo "名前空間Aの関数\n";
}


namespace B;

function func() {
  echo "名前空間Bの関数\n";
}

func();
\A\func();


namespace C;

use function \A\func;
func();


// 名前空間Bの関数
// 名前空間Aの関数
// 名前空間Aの関数

namespace A;

function func() {

echo "名前空間Aの関数\n";

}

namespace B;

function func() {

echo "名前空間Bの関数\n";

}

func();

\A\func();

namespace C;

use function \A\func;

func();

// 名前空間Bの関数

// 名前空間Aの関数

定数の場合

以下の例は、異なる名前空間の定数を利用する場合。

名前空間Bで関数名CONSTANTだけを記述すると、名前空間BのCONSTANTが使われる
絶対パス\A\CONSTANTと記述すると、名前空間AのCONSTANTが使われる
use const \A\CONSTANTを記述すると、CONSTANTと記述したときに名前空間AのCONSTANTが使われる(as ...でエイリアスも指定できる)

namespace A;

const CONSTANT = '名前空間Aの定数';


namespace B;

const CONSTANT = '名前空間Bの定数';

echo CONSTANT . "\n";
echo \A\CONSTANT . "\n";


namespace C;

use const \A\CONSTANT;
echo CONSTANT . "\n";


// 名前空間Bの定数
// 名前空間Aの定数
// 名前空間Aの定数

namespace A;

const CONSTANT = '名前空間Aの定数';

namespace B;

const CONSTANT = '名前空間Bの定数';

echo CONSTANT . "\n";

echo \A\CONSTANT . "\n";

namespace C;

use const \A\CONSTANT;

echo CONSTANT . "\n";

// 名前空間Bの定数

// 名前空間Aの定数

変数は名前空間によらずグローバル

変数は、それが定義された名前空間によらずグローバルスコープになる。

namespace A;

$var = '変数は名前空間によらずグローバル';
echo $var . "\n";


namespace B;

echo $var . "\n";


namespace C;

echo $var . "\n";


// 変数はグローバル
// 変数はグローバル
// 変数はグローバル

namespace A;

$var = '変数は名前空間によらずグローバル';

echo $var . "\n";

namespace B;

echo $var . "\n";

namespace C;

echo $var . "\n";

// 変数はグローバル

外部ファイルに分ける場合

外部ファイルで名前空間を設定している場合、インクルードしたコードで明示的に名前空間を指定する。

以下の例では2つのPHPファイルを準備し、それぞれの名前空間を設定している。

namespace_a.php

<?php

namespace A;

class MyClass {
  public function show() {
    echo "名前空間AのMyClass\n";
  }
}

<?php

namespace A;

class MyClass {

public function show() {

echo "名前空間AのMyClass\n";

}

namespace_b.php

<?php

namespace B;

class MyClass {
  public function show() {
    echo "名前空間BのMyClass\n";
  }
}

<?php

namespace B;

class MyClass {

public function show() {

echo "名前空間BのMyClass\n";

}

そして別のファイルでこれらのファイルを読み込んで実行する。

インクルード後に名前空間なしでクラス名のみ指定すると、クラスが見つからずエラーになる。

<?php

require 'namespace_a.php';
require 'namespace_b.php';

$obj = MyClass();

// Error: Class 'MyClass' not found in ...

<?php

require 'namespace_a.php';

require 'namespace_b.php';

$obj = MyClass();

// Error: Class 'MyClass' not found in ...

絶対パスかuseを使えば名前空間に応じたクラスを指定できる。

<?php

require 'namespace_a.php';
require 'namespace_b.php';

$obj = new \A\MyClass();
$obj->show();

// 名前空間AのMyClass

use \B\MyClass;
$obj = new MyClass();
$obj->show();

// 名前空間BのMyClass

<?php

require 'namespace_a.php';

require 'namespace_b.php';

$obj = new \A\MyClass();

$obj->show();

// 名前空間AのMyClass

use \B\MyClass;

$obj = new MyClass();

$obj->show();

// 名前空間BのMyClass

名前空間の部分指定

名前空間をパスで設定した場合、useでその一部を指定することができる。

以下の例では、

名前空間japan\aichiの中でMyClassAとMyClassBを定義
名前空間japan\osakaの中でMyClassを定義
use japan\aichiとすることで、japan\aichi→aichiとして使えるようになる
- japan\aichi\MyClassA→aichi\MyClassA
- japan\aichi\MyClassB→aichi\MyClassB
use japan\osakaとすることで、japan\osaka→osakaとして使えるようになる
- japan\osaka\MyClass→osaka\MyClass

<?php

namespace japan\aichi;

class MyClassA {
  public function show() {
    echo "名前空間\japan\aichiのMyClassA\n";
  }
}

class MyClassB {
  public function show() {
    echo "名前空間\japan\aichiのMyClassB\n";
  }
}


namespace japan\osaka;

class MyClass {
  public function show() {
    echo "名前空間\japan\osakaのMyClass\n";
  }
}

// 名前空間の一部をuseし、japan\aichiをaichiとして使えるようにする
use japan\aichi;

$obj = new aichi\MyClassA();
$obj->show();
$obj = new aichi\MyClassB();
$obj->show();

// 名前空間\japan\aichiのMyClassA
// 名前空間\japan\aichiのMyClassB

// 名前空間の一部をuseし、japan\osakaをosakaとして使えるようにする
use japan\osaka;
$obj =new osaka\MyClass();
$obj->show();

// 名前空間\japan\osakaのMyClass

<?php

namespace japan\aichi;

class MyClassA {

public function show() {

echo "名前空間\japan\aichiのMyClassA\n";

}

class MyClassB {

public function show() {

echo "名前空間\japan\aichiのMyClassB\n";

}

namespace japan\osaka;

class MyClass {

public function show() {

echo "名前空間\japan\osakaのMyClass\n";

}

// 名前空間の一部をuseし、japan\aichiをaichiとして使えるようにする

use japan\aichi;

$obj = new aichi\MyClassA();

$obj->show();

$obj = new aichi\MyClassB();

$obj->show();

// 名前空間\japan\aichiのMyClassA

// 名前空間\japan\aichiのMyClassB

// 名前空間の一部をuseし、japan\osakaをosakaとして使えるようにする

use japan\osaka;

$obj =new osaka\MyClass();

$obj->show();

// 名前空間\japan\osakaのMyClass

PHP – クラス定数

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

クラスの中で、constキーワードで定数を定義できる。

クラス内でアクセスする場合はself::でアクセス
クラス外でアクセスする場合はクラス名::でアクセス(変数::でも可能)

<?php

class MyClass {
  const MY_CONSTANT = 'my constant value';

  public function show() {
    echo self::MY_CONSTANT . "\n";
  }
}

$obj = new MyClass();

echo MyClass::MY_CONSTANT . "\n";
echo $obj::MY_CONSTANT . "\n";
echo $obj->show();

// my constant value
// my constant value
// my constant value

<?php

class MyClass {

const MY_CONSTANT = 'my constant value';

public function show() {

echo self::MY_CONSTANT . "\n";

}

$obj = new MyClass();

echo MyClass::MY_CONSTANT . "\n";

echo $obj::MY_CONSTANT . "\n";

echo $obj->show();

// my constant value

self::、クラス名::などをつけないと、警告が出たうえで定数名自体が文字列として解釈される。

class MyClass {
  const MY_CONSTANT = 'my constant value';

  public function show() {
    MY_CONSTANT . "\n";
  }
}

$obj = new MyClass();

echo MY_CONSTANT . "\n";
echo $obj->show();

// PHP Warning:  Use of undefined constant MY_CONSTANT - assumed 'MY_CONSTANT' (this will throw an Error in a future version of PHP)
// PHP Warning:  Use of undefined constant MY_CONSTANT - assumed 'MY_CONSTANT' (this will throw an Error in a future version of PHP)

class MyClass {

const MY_CONSTANT = 'my constant value';

public function show() {

MY_CONSTANT . "\n";

}

$obj = new MyClass();

echo MY_CONSTANT . "\n";

echo $obj->show();

// PHP Warning: Use of undefined constant MY_CONSTANT - assumed 'MY_CONSTANT' (this will throw an Error in a future version of PHP)

定数なので値を再代入することはできない。

<?php

class MyClass {
  const CONSTANT = 'constatnt value';

  public function show() {
    // self::CONSTANT = 'another constant valuse';
    // エラー：PHP Parse error:  syntax error, unexpected '='
  }
}

$obj = new MyClass();
$obj->show();

// MyClass::CONSTANT = 'another constant value';
// エラー：PHP Parse error:  syntax error, unexpected '='

<?php

class MyClass {

const CONSTANT = 'constatnt value';

public function show() {

// self::CONSTANT = 'another constant valuse';

// エラー：PHP Parse error: syntax error, unexpected '='

}

$obj = new MyClass();

$obj->show();

// MyClass::CONSTANT = 'another constant value';

// エラー：PHP Parse error: syntax error, unexpected '='

const定義の右辺に定義済みの定数、算術式を使うことができる。しかし関数は使用できない。

<?php

class MyClass {
  const CONST1 = 2;
  const CONST2 = 3;
  const CONST3 = self::CONST1 + self::CONST2;
//  const CONST4 = sqrt(CONST1);
//  関数は使えない：Constant expression contains invalid operations
}

echo MyClass::CONST3 . "\n";

// 5

<?php

class MyClass {

const CONST1 = 2;

const CONST2 = 3;

const CONST3 = self::CONST1 + self::CONST2;

// const CONST4 = sqrt(CONST1);

// 関数は使えない：Constant expression contains invalid operations

}

echo MyClass::CONST3 . "\n";

// 5

定数定義の際にアクセス修飾子を使えて、アクセス制限ができる。省略した場合はpublic。

<?php

class MyClass {
  public const PUBLIC_CONST = 'public constant';
  private const PRIVATE_CONST = 'private constant';

  public function show() {
    echo self::PUBLIC_CONST . "\n";
    echo self::PRIVATE_CONST . "\n";
  }
}

$obj = new MyClass();
$obj->show();

echo MyClass::PUBLIC_CONST . "\n";
// echo MyClass::PRIVATE_CONST . "\n";
// エラー：PHP Fatal error:  Uncaught Error: Cannot access private const MyClass::PRIVATE_CONST

// public constant
// private constant
// public constant
// PHP Fatal error:  Uncaught Error: Cannot access private const MyClass::PRIVATE_CONST in ...

<?php

class MyClass {

public const PUBLIC_CONST = 'public constant';

private const PRIVATE_CONST = 'private constant';

public function show() {

echo self::PUBLIC_CONST . "\n";

echo self::PRIVATE_CONST . "\n";

}

$obj = new MyClass();

$obj->show();

echo MyClass::PUBLIC_CONST . "\n";

// echo MyClass::PRIVATE_CONST . "\n";

// エラー：PHP Fatal error: Uncaught Error: Cannot access private const MyClass::PRIVATE_CONST

// public constant

// private constant

// public constant

// PHP Fatal error: Uncaught Error: Cannot access private const MyClass::PRIVATE_CONST in ...

PHP – gettype()/is_* – 型の確認

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

概要

値が特定のプリミティブ型かどうか、何かのクラスのインスタンスかどうかを確認する方法。

gettype()は型の名前の文字列を返す
is_*はそれぞれの型に合致しているかどうかをチェック

クラス関係の確認についてはこちらを参照、

gettype()

gettype()は、引数で与えられた値の型を文字列として返す。以下の例のほか、resource、unknown typeが準備されている。

vars = [true, 1, 3.14, 'abcd', ['acd', 1], new Exception(), null];

foreach ($vars as $var) {
  echo gettype($var) . "\n";
}

// boolean
// integer
// double
// string
// array
// object
// NULL

vars = [true, 1, 3.14, 'abcd', ['acd', 1], new Exception(), null];

foreach ($vars as $var) {

echo gettype($var) . "\n";

}

// boolean

// integer

// double

// string

// array

// object

// NULL

is_*() – 型の確認

is_*(値)で値の型が合致しているかをチェック。

is_bool
is_numeric, is_finite, is_infinite, is_nan
is_int/is_integer, is_long, is_float/is_double/is_real
is_string
is_array
is_object, is_subclass_of

echo is_bool(true) ? "true\n" : "false\n";        // true
echo is_bool(1) ? "true\n" : "false\n";           // false
echo is_finite(3.14) ? "true\n" : "false\n";      // true
echo is_infinite(1.0 / 0) ? "true\n" : "false\n"; // true
echo is_nan(0 / 0) ? "true\n" : "false\n";        // true
// 0除算はwarningが出る

echo is_bool(true) ? "true\n" : "false\n"; // true

echo is_bool(1) ? "true\n" : "false\n"; // false

echo is_finite(3.14) ? "true\n" : "false\n"; // true

echo is_infinite(1.0 / 0) ? "true\n" : "false\n"; // true

echo is_nan(0 / 0) ? "true\n" : "false\n"; // true

// 0除算はwarningが出る