Laravel – ユーザー登録処理の流れ

2021-09-06 / tau / コメントする

登録フォーム表示

ルーティング定義

ルーティングファイルにAuth::routes();を記述することでユーザー認証関係のルーティングが自動設定される。その中には、以下の登録フォーム表示のルーティングも含まれている。

メソッド：GET
URL：register
アクション：Auth\RegisterController@showRegistrationForm
ルート名：register

アクション

RegisterControllerコントローラーはRegistersUsersトレイトを利用していて、その中でshowRegistrationFormアクションが定義されている。

.....
use Illuminate\Foundation\Auth\RegistersUsers;
.....

class RegisterController extends Controller
{
    .....
    use RegistersUsers;
    .....
}

.....

use Illuminate\Foundation\Auth\RegistersUsers;

.....

class RegisterController extends Controller

{

.....

use RegistersUsers;

.....

}

RegistersUsersトレイトのshowRegistrationForm()アクションメソッドは以下の通りで、auth.registerビューをレンダリングしている。

auth.registerビューは初期状態では存在しないので、コマンドで生成するかカスタムで作成する必要がある。

trait RegistersUsers
{
    .....
    public function showRegistrationForm()
    {
        return view('auth.register');
    }
    .....
}

trait RegistersUsers

{

.....

public function showRegistrationForm()

{

return view('auth.register');

}

.....

}

フォームからのPOSTと登録実行

ルーティング定義

ルーティングファイルへのAuth::routes();の記述によって、以下のルーティングも定義される。

メソッド：POST
URI：register
アクション：Auth\RegisterController@register

アクション

showRegistrationFormアクションと同じく、registerアクションもRegisterControllerでuseされるRegistersUsersトレイトで定義されている。

trait RegistersUsers
{
    use RedirectsUsers;
    .....
    public function register(Request $request)
    {
        $this->validator($request->all())->validate();

        event(new Registered($user = $this->create($request->all())));

        $this->guard()->login($user);

        return $this->registered($request, $user)
                        ?: redirect($this->redirectPath());
    }
    ....
}

trait RegistersUsers

{

use RedirectsUsers;

.....

public function register(Request $request)

{

$this->validator($request->all())->validate();

event(new Registered($user = $this->create($request->all())));

$this->guard()->login($user);

return $this->registered($request, $user)

?: redirect($this->redirectPath());

}

....

}

このアクションの動作は以下の通り。

$this->validator($request->all())->validate();

1	$this->validator($request->all())->validate();

マスアサインメント$request->all()のための$fillableはapp\User.phpモデルで定義しておく

入力されたフィールド群を検証するvalidator()メソッドで検証条件を定義

validator()はRegistersUsersトレイトを利用する親元のRegisterControllersで定義

class RegisterController extends Controller
{
    .....
    protected function validator(array $data)
    {
        return Validator::make($data, [
            'name' => ['required', 'string', 'max:255'],
            'email' => ['required', 'string', 'email', 'max:255', 'unique:users'],
            'password' => ['required', 'string', 'min:8', 'confirmed'],
        ]);
    }
    .....
}

class RegisterController extends Controller

{

.....

protected function validator(array $data)

{

return Validator::make($data, [

'name' => ['required', 'string', 'max:255'],

'email' => ['required', 'string', 'email', 'max:255', 'unique:users'],

'password' => ['required', 'string', 'min:8', 'confirmed'],

]);

}

.....

}

戻り値のValidatorインスタンスのvalidate()メソッドで検証実行

event(new Registered($user = $this->create($request->all())));

1	event(new Registered($user = $this->create($request->all())));

RegistersUsersトレイトを利用する親元のRegisterControllerのcreate()メソッドを呼んでデータ作成
そのUserインスタンスを与えて登録済みのイベント発行

$this->guard()->login($user);

1	$this->guard()->login($user);

$user登録後にそのユーザーでログイン
ここで現れる$this-guard()は\Illuminate\Auth\SessionGuardクラスのインスタンスを返すが、かなり深掘りしないと流れを掴めない。

return $this->registered($request, $user)
                ?: redirect($this->redirectPath());

1 2	return $this->registered($request, $user) ?: redirect($this->redirectPath());

$this->registered()は登録確認のようだが、同じトレイトで空で定義されている

PHP

protected function registered(Request $request, $user) { // }

1
2
3
4

    protected function registered(Request $request, $user)
    {
        //
    }
このため三項演算子のfalse側に書かれているredirect($this->redirectPath())がreturnの戻り値となる

redirectPath()はRegistersUsersトレイトでさらにuseされたRedirectsUsersトレイトで定義されていて、

redirectTo()メソッドが定義されていれば実行
$redirectTo属性が定義されていればそこにリダイレクト

いずれでもなければ/homeにリダイレクト

namespace Illuminate\Foundation\Auth;

trait RedirectsUsers
{
    public function redirectPath()
    {
        if (method_exists($this, 'redirectTo')) {
            return $this->redirectTo();
        }

        return property_exists($this, 'redirectTo') ? $this->redirectTo : '/home';
    }
}

namespace Illuminate\Foundation\Auth;

trait RedirectsUsers

{

public function redirectPath()

{

if (method_exists($this, 'redirectTo')) {

return $this->redirectTo();

}

return property_exists($this, 'redirectTo') ? $this->redirectTo : '/home';

}

初期状態ではこのトレイトの親元RegisterControllerで$redirectToが定義されているので、この内容(RouteServiceProvider::HOME)にリダイレクトされる

Laravel – Userモデル

2021-09-06 / tau / コメントする

概要

Laravelプロジェクト作成時にUserモデルのapp/User.phpファイルが自動作成される。この中で、認証関係について調べてみた。

User.phpファイルの内容

app/User.phpの内容は以下のとおり。

<?php

namespace App;

use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{
    use Notifiable;

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'name', 'email', 'password',
    ];

    /**
     * The attributes that should be hidden for arrays.
     *
     * @var array
     */
    protected $hidden = [
        'password', 'remember_token',
    ];

    /**
     * The attributes that should be cast to native types.
     *
     * @var array
     */
    protected $casts = [
        'email_verified_at' => 'datetime',
    ];
}

<?php

namespace App;

use Illuminate\Contracts\Auth\MustVerifyEmail;

use Illuminate\Foundation\Auth\User as Authenticatable;

use Illuminate\Notifications\Notifiable;

class User extends Authenticatable

{

use Notifiable;

/**

* The attributes that are mass assignable.

* @var array

protected $fillable = [

'name', 'email', 'password',

];

/**

* The attributes that should be hidden for arrays.

* @var array

protected $hidden = [

'password', 'remember_token',

];

/**

* The attributes that should be cast to native types.

* @var array

protected $casts = [

'email_verified_at' => 'datetime',

];

}

認証関係

UserクラスはModelクラスを(直接には)継承していない
UserクラスはAuthenticatableクラスを継承している
AuthenticatableクラスはIlluminate\Foundation\Auth\Userのエイリアスとして定義されている。

Illuminate\Foundation\Auth\Userクラス

UserモデルクラスがAuthenticatbleクラスとして継承しているIlluminate\Foundation\Auth\Userクラスの要点は以下のとおり。

Modelクラスを継承している(L14)
AuthenticatableContractインターフェイスを適用している(L15)
- AuthenticatableContractはIlluminate\Contracts\Auth\Authenticatableインターフェイスのエイリアス(L15)
AuthenticatableContractインターフェイスのメソッドは、Illuminate\Auth\Authenticatableトレイトで実装(L19, L5)

同じAuthenticatableという名前でインターフェイスとトレイトがあるのがややこしい。

<?php

namespace Illuminate\Foundation\Auth;

use Illuminate\Auth\Authenticatable;
use Illuminate\Auth\MustVerifyEmail;
use Illuminate\Auth\Passwords\CanResetPassword;
use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Foundation\Auth\Access\Authorizable;

class User extends Model implements
    AuthenticatableContract,
    AuthorizableContract,
    CanResetPasswordContract
{
    use Authenticatable, Authorizable, CanResetPassword, MustVerifyEmail;
}

<?php

namespace Illuminate\Foundation\Auth;

use Illuminate\Auth\Authenticatable;

use Illuminate\Auth\MustVerifyEmail;

use Illuminate\Auth\Passwords\CanResetPassword;

use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;

use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;

use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;

use Illuminate\Database\Eloquent\Model;

use Illuminate\Foundation\Auth\Access\Authorizable;

class User extends Model implements

AuthenticatableContract,

AuthorizableContract,

CanResetPasswordContract

{

use Authenticatable, Authorizable, CanResetPassword, MustVerifyEmail;

}

Authenticatableインターフェース

Illuminate\Contracts\Auth\Authenticatableインターフェイスは、識別子やパスワード、セッションに関する6つのメソッドの実装を要請する。

Userクラスでこのインターフェイスを適用する際には、エイリアスでAuthenticatbleContractという別名で扱っている。

<?php

namespace Illuminate\Contracts\Auth;

interface Authenticatable
{
    // userの一意な識別子名をstringで返す
    public function getAuthIdentifierName();

    // userの一意な識別子を返す(mixed型)
    public function getAuthIdentifier();

    // userのパスワードをstringで返す
    public function getAuthPassword();

    // "remember me"セッションのトークンをstringで返す
    public function getRememberToken();

    // "remember me"セッションのトークンをstringで与えて設定する
    public function setRememberToken($value);

    // "remember me"トークンのカラム名をstringで返す
    public function getRememberTokenName();
}

<?php

namespace Illuminate\Contracts\Auth;

interface Authenticatable

{

// userの一意な識別子名をstringで返す

public function getAuthIdentifierName();

// userの一意な識別子を返す(mixed型)

public function getAuthIdentifier();

// userのパスワードをstringで返す

public function getAuthPassword();

// "remember me"セッションのトークンをstringで返す

public function getRememberToken();

// "remember me"セッションのトークンをstringで与えて設定する

public function setRememberToken($value);

// "remember me"トークンのカラム名をstringで返す

public function getRememberTokenName();

}

Authenticatableトレイト

Illuminate\Auth\Authenticatableトレイトは、Authenticatableインターフェイスで要請された6つのメソッドを実装する。

<?php

namespace Illuminate\Auth;

trait Authenticatable
{
    // "remember me"トークンのカラム名
    protected $rememberTokenName = 'remember_token';

    // userの一意な識別子名をstringで返す
    public function getAuthIdentifierName()
    {
        return $this->getKeyName();
    }

    // userの一意な識別子を返す(mixed型)
    public function getAuthIdentifier()
    {
        return $this->{$this->getAuthIdentifierName()};
    }

    // userのパスワードをstringで返す
    public function getAuthPassword()
    {
        return $this->password;
    }

    // "remember me"セッションのトークンをstringで返す
    public function getRememberToken()
    {
        if (! empty($this->getRememberTokenName())) {
            return (string) $this->{$this->getRememberTokenName()};
        }
    }

    // "remember me"セッションのトークンをstringで与えて設定する
    public function setRememberToken($value)
    {
        if (! empty($this->getRememberTokenName())) {
            $this->{$this->getRememberTokenName()} = $value;
        }
    }

    // "remember me"トークンのカラム名をstringで返す
    public function getRememberTokenName()
    {
        return $this->rememberTokenName;
    }
}

<?php

namespace Illuminate\Auth;

trait Authenticatable

{

// "remember me"トークンのカラム名

protected $rememberTokenName = 'remember_token';

// userの一意な識別子名をstringで返す

public function getAuthIdentifierName()

{

return $this->getKeyName();

}

// userの一意な識別子を返す(mixed型)

public function getAuthIdentifier()

{

return $this->{$this->getAuthIdentifierName()};

}

// userのパスワードをstringで返す

public function getAuthPassword()

{

return $this->password;

}

// "remember me"セッションのトークンをstringで返す

public function getRememberToken()

{

if (! empty($this->getRememberTokenName())) {

return (string) $this->{$this->getRememberTokenName()};

}

// "remember me"セッションのトークンをstringで与えて設定する

public function setRememberToken($value)

{

if (! empty($this->getRememberTokenName())) {

$this->{$this->getRememberTokenName()} = $value;

}

// "remember me"トークンのカラム名をstringで返す

public function getRememberTokenName()

{

return $this->rememberTokenName;

}

要約

要約すると、プロジェクトで生成されるUserクラスはIlluminate\Foundation\Auth\Userクラスを継承することによって、

Illuminate\Database\Eloquent\Modelクラスを継承している
Authenticatableインターフェイスの6つのメソッドを実装している
- これにより、ユーザー認証と継続セッションの機能が実装される。

通知関係

UserモデルクラスはIlluminate\Notifications\Notifiableトレイトを実装している。

.....
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{
    use Notifiable;
    ....
}

.....

use Illuminate\Notifications\Notifiable;

class User extends Authenticatable

{

use Notifiable;

....

}

属性関係

$fillable

フォームのデータをマスアサインメントで取り込むための設定。

    protected $fillable = [
        'name', 'email', 'password',
    ];

protected $fillable = [

'name', 'email', 'password',

];

$hidden

モデルを変換する際に、指定した属性を含めないための指定。

    protected $hidden = [
        'password', 'remember_token',
    ];

protected $hidden = [

'password', 'remember_token',

];

$cast

データベースの読み込み時にstringから特定のデータ型にキャストするための指定。

    protected $casts = [
        'email_verified_at' => 'datetime',
    ];

protected $casts = [

'email_verified_at' => 'datetime',

];

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

Userモデルクラスファイルとともに、以下のマイグレーションファイルもLaravelにより生成される。

<?php

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

class CreateUsersTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('users', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->string('name');
            $table->string('email')->unique();
            $table->datetime('email_verified_at')->nullable();
            $table->string('password');
            $table->rememberToken();
            $table->datetime('created_at');
            $table->datetime('updated_at');
        });
    }

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

<?php

use Illuminate\Database\Migrations\Migration;

use Illuminate\Database\Schema\Blueprint;

use Illuminate\Support\Facades\Schema;

class CreateUsersTable extends Migration

{

/**

* Run the migrations.

* @return void

public function up()

{

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

$table->bigIncrements('id');

$table->string('name');

$table->string('email')->unique();

$table->datetime('email_verified_at')->nullable();

$table->string('password');

$table->rememberToken();

$table->datetime('created_at');

$table->datetime('updated_at');

});

}

/**

* Reverse the migrations.

* @return void

public function down()

{

Schema::dropIfExists('users');

}

artisan migrateコマンドで生成されたテーブルの構造は以下のとおり。

mysql> DESCRIBE users;
+-------------------+-----------------+------+-----+---------+----------------+
| Field             | Type            | Null | Key | Default | Extra          |
+-------------------+-----------------+------+-----+---------+----------------+
| id                | bigint unsigned | NO   | PRI | NULL    | auto_increment |
| name              | varchar(255)    | NO   |     | NULL    |                |
| email             | varchar(255)    | NO   | UNI | NULL    |                |
| email_verified_at | datetime        | YES  |     | NULL    |                |
| password          | varchar(255)    | NO   |     | NULL    |                |
| remember_token    | varchar(100)    | YES  |     | NULL    |                |
| created_at        | datetime        | NO   |     | NULL    |                |
| updated_at        | datetime        | NO   |     | NULL    |                |
+-------------------+-----------------+------+-----+---------+----------------+
8 rows in set (0.02 sec)

mysql> DESCRIBE users;

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

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

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

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

8 rows in set (0.02 sec)

ユーザー認証

基本的なユーザー認証の設定はこちらを参照。

また、ユーザー登録処理の内容、ログイン処理の内容についてはそれぞれのリンクを参照。

Laravel6 – ユーザー認証

2021-09-06 / tau / コメントする

プロジェクト開始時に作成されるファイル

Userモデル

プロジェクトを作成すると、appディレクトリー下にUser.phpが作成される。

Userモデルの内容についてはこちらを参照。

<?php

namespace App;

use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{
    use Notifiable;

    // マスアサインメントの対象となる属性
    protected $fillable = [
        'name', 'email', 'password',
    ];

    // 秘匿する属性
    protected $hidden = [
        'password', 'remember_token',
    ];

    // データベース読み込み時にキャストする属性
    protected $casts = [
        'email_verified_at' => 'datetime',
    ];
}

<?php

namespace App;

use Illuminate\Contracts\Auth\MustVerifyEmail;

use Illuminate\Foundation\Auth\User as Authenticatable;

use Illuminate\Notifications\Notifiable;

class User extends Authenticatable

{

use Notifiable;

// マスアサインメントの対象となる属性

protected $fillable = [

'name', 'email', 'password',

];

// 秘匿する属性

protected $hidden = [

'password', 'remember_token',

];

// データベース読み込み時にキャストする属性

protected $casts = [

'email_verified_at' => 'datetime',

];

}

コントローラー

プロジェクトを作成すると、Controllers/Authディレクトリー下に以下の認証用コントローラー群が自動的に作成される。

[vagrant@localhost laravel_photo]$ ls app/Http/Controllers/Auth/ -Al
合計 24
-rw-rw-r--. 1 vagrant vagrant 1024  5月 12 05:47 ConfirmPasswordController.php
-rw-rw-r--. 1 vagrant vagrant  667  5月 12 05:47 ForgotPasswordController.php
-rw-rw-r--. 1 vagrant vagrant 1002  5月 12 05:47 LoginController.php
-rw-rw-r--. 1 vagrant vagrant 1950  5月 12 05:47 RegisterController.php
-rw-rw-r--. 1 vagrant vagrant  844  5月 12 05:47 ResetPasswordController.php
-rw-rw-r--. 1 vagrant vagrant 1130  5月 12 05:47 VerificationController.php

[vagrant@localhost laravel_photo]$ ls app/Http/Controllers/Auth/ -Al

合計 24

-rw-rw-r--. 1 vagrant vagrant 1024 5月 12 05:47 ConfirmPasswordController.php

-rw-rw-r--. 1 vagrant vagrant 667 5月 12 05:47 ForgotPasswordController.php

-rw-rw-r--. 1 vagrant vagrant 1002 5月 12 05:47 LoginController.php

-rw-rw-r--. 1 vagrant vagrant 1950 5月 12 05:47 RegisterController.php

-rw-rw-r--. 1 vagrant vagrant 844 5月 12 05:47 ResetPasswordController.php

-rw-rw-r--. 1 vagrant vagrant 1130 5月 12 05:47 VerificationController.php

ルーティング設定

ユーザー認証のためのルーティング

プロジェクト作成後にUserモデルと必要なコントローラーはLaravelにより作成されるが、ルーティングは設定が必要になる。

ルーティングファイルに以下の1行を記載すると、ユーザー認証用の各種ルーティングがまとめて定義される。

Auth::routes();

1	Auth::routes();

ルーティングリスト

関係するルーティングは以下の通りで、ログイン関係とユーザー登録関係が定義されている。

[vagrant@localhost laravel_photo]$ php artisan route:list
+--------+-----------+------------------------+------------------+------------------------------------------------------------------------+--------------+
| Domain | Method    | URI                    | Name             | Action                                                                 | Middleware   |
+--------+-----------+------------------------+------------------+------------------------------------------------------------------------+--------------+
|        | GET|HEAD  | /                      |                  | Closure                                                                | web          |
|        | GET|HEAD  | api/user               |                  | Closure                                                                | api,auth:api |
.....
|        | GET|HEAD  | login                  | login            | App\Http\Controllers\Auth\LoginController@showLoginForm                | web,guest    |
|        | POST      | login                  |                  | App\Http\Controllers\Auth\LoginController@login                        | web,guest    |
|        | POST      | logout                 | logout           | App\Http\Controllers\Auth\LoginController@logout                       | web          |
|        | GET|HEAD  | password/confirm       | password.confirm | App\Http\Controllers\Auth\ConfirmPasswordController@showConfirmForm    | web,auth     |
|        | POST      | password/confirm       |                  | App\Http\Controllers\Auth\ConfirmPasswordController@confirm            | web,auth     |
|        | POST      | password/email         | password.email   | App\Http\Controllers\Auth\ForgotPasswordController@sendResetLinkEmail  | web          |
|        | GET|HEAD  | password/reset         | password.request | App\Http\Controllers\Auth\ForgotPasswordController@showLinkRequestForm | web          |
|        | POST      | password/reset         | password.update  | App\Http\Controllers\Auth\ResetPasswordController@reset                | web          |
|        | GET|HEAD  | password/reset/{token} | password.reset   | App\Http\Controllers\Auth\ResetPasswordController@showResetForm        | web          |
.....
|        | GET|HEAD  | register               | register         | App\Http\Controllers\Auth\RegisterController@showRegistrationForm      | web,guest    |
|        | POST      | register               |                  | App\Http\Controllers\Auth\RegisterController@register                  | web,guest    |
+--------+-----------+------------------------+------------------+------------------------------------------------------------------------+--------------+

[vagrant@localhost laravel_photo]$ php artisan route:list

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

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

| | GET|HEAD | / | | Closure | web |

.....

| | GET|HEAD | password/reset/{token} | password.reset | App\Http\Controllers\Auth\ResetPasswordController@showResetForm | web |

.....

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

ビューの作成

自動作成の場合

php artisan ui vue --authコマンドでユーザー認証に必要なビューを作成
作成されるビューはresources/views/authディレクトリー下に配置

カスタムビュー作成の場合

authディレクトリーの作成

resources/viewsディレクトリー下にauthディレクトリーを作成
作成したauthディレクトリー下に必要なビューを定められたファイル名と内容で作成

登録用フォームビューの作成～register.blade.php

authディレクトリー下に、以下フォームを含む内容でregister.blade.phpを作成。ビュー名はLaravelが生成するコントローラーで想定されているされるため、これに合わせる必要がある。

たとえばユーザー登録フォームのビュー名はRegisterControllerでuseされているRegistersUsersトレイトのshowRegistrationForm()メソッドにおいて、'auth.register'として呼ばれる。

  <form method="post" action="{{ route('register') }}">
    @csrf
    <div>
      <label>ユーザー名: <input type="text" name="name"></label>
    </div>
    <div>
      <label>メールアドレス: <input type="email" name="email"></label>
    </div>
    <div>
      <label>パスワード: <input type="password" name="password"></label>
    </div>
    <div>
      <label>パスワード: <input type="password" name="password_confirmation"></label>
    </div>

    <div>
      <input type="submit" value="登録">
    </div>
  </form>

@csrf

<div>

<label>ユーザー名: <input type="text" name="name"></label>

</div>

<div>

<label>メールアドレス: <input type="email" name="email"></label>

</div>

<div>

<label>パスワード: <input type="password" name="password"></label>

</div>

<div>

<label>パスワード: <input type="password" name="password_confirmation"></label>

</div>

<div>

</div>

</form>

ブラウザーからURL:ドメイン名/registerでアクセスすると以下のようなフォームが表示される。

カスタマイズしていない状態で登録ボタンを押すと、URL:ドメイン名/homeにリダイレクトされる(後述のように、そのままでは404エラーになる)。

ログインフォームビューの作成～login.blade.php

authディレクトリー下に、以下のフォームを含む内容でlogin.blade.phpを作成。

  <form method="post" action="{{ route('login') }}">
    <div>
      <label>メールアドレス: <input type="email" name="email"></label>
    </div>
    <div>
      <label>パスワード: <input type="password" name="password"></label>
    </div>
    <div>
      <input type="submit" value="ログイン">
    </div>
  </form>

<div>

<label>メールアドレス: <input type="email" name="email"></label>

</div>

<div>

<label>パスワード: <input type="password" name="password"></label>

</div>

<div>

</div>

</form>

ブラウザーからURL:ドメイン名/loginでアクセスすると以下のようなフォームが表示される。

カスタマイズしていない状態で登録ボタンを押すと、URL:ドメイン名/homeにリダイレクトされる。

コントローラー設定

ログイン後の画面遷移

たとえばユーザーログイン後のトップページを'posts/index'とする。

デフォルト設定～404エラー

カスタマイズしていない状態では以下の様になっているが、このままログインすると404エラーとなる。

ルーティングファイル→特に設定なし
コントローラー

Controllers/Auth/LogiinController.php
PHP

protected $redirectTo = RouteServiceProvider::HOME;

1

protected $redirectTo = RouteServiceProvider::HOME;

このときブラウザーのURL表示はhttp://localhost:3000/homeとなっている。

方法1～コントロールファイルを変更

以下の様に$redirectToの定義を編集すると、意図したページに遷移する。

protected $redirectTo = 'posts/index';

または

protected $redirectTo = 'posts';

protected $redirectTo = 'posts/index';

または

protected $redirectTo = 'posts';

方法2～ルーティングファイルに追加

コントローラーが以下の様に生成直後の状態で・・・

protected $redirectTo = RouteServiceProvider::HOME;

1	protected $redirectTo = RouteServiceProvider::HOME;

ルーティングファイルに以下の1行を追加する。

Route::get('home', 'PostController@index');

1	Route::get('home', 'PostController@index');

なお、上記をルーティングファイルに追加すれば、コントローラーの定義は以下でもよい。

protected $redirectTo = 'home';

1	protected $redirectTo = 'home';

ルート名は使えない

ルート名が設定されていても、以下の表現はエラーになる(Constant expression contains invalid operations)。

protected $redirectTo = route('posts.index');

1	protected $redirectTo = route('posts.index');

ユーザー登録後の画面遷移

RegisterControllerでもデフォルトで以下の様に定義されている。

protected $redirectTo = RouteServiceProvider::HOME;

1	protected $redirectTo = RouteServiceProvider::HOME;

LoginControllerと同じようにルーティング設定をすることで、ユーザー登録後の遷移先を設定することができる。

ユーザー認証処理の詳細

ユーザー登録処理の内容、ログイン処理の内容についてはそれぞれのリンクを参照。

2038年問題対応

Laravelでモデルの雛形を生成する場合、MySQLだと作成日時と更新日時のtimestamp型の2038年問題が内包される。

database/migrationsディレクトリー下のマイグレーションファイル、...create_users_table.phpのtimestampsをdatetime型に修正しておくべき。

ログアウト処理

ログアウト処理についてはこちら。

PHP – マジックメソッド – __callStatic()

2021-09-05 / tau / コメントする

__callStatic()はマジックメソッドの一つで、実行させようとしたクラスのstaticメソッドが存在しない時に呼ばれる。

以下の例では、MyClassに__callStatic()メソッドのみが定義されている。__callStatic()の内容は、引数の$methodと$argsを表示させるようにしている。

<?php

class MyClass
{
  public static function __callStatic($method, $args) {
    echo '$method:';
    var_export($method);
    echo PHP_EOL;
    echo '$args:' . PHP_EOL;
    var_export($args);
    echo PHP_EOL;
  }
}

<?php

class MyClass

{

public static function __callStatic($method, $args) {

echo '$method:';

var_export($method);

echo PHP_EOL;

echo '$args:' . PHP_EOL;

var_export($args);

echo PHP_EOL;

}

このクラスに存在しないstaticメソッドを、引数なし、引数1個、2個で実行した場合の実行結果。引数は配列として$argsにセットされ、引数がない場合は空の配列、引数が1個の場合は要素数1(要素番号0)の配列となる。

MyClass::method1();
// $method:'method1'
// $args:
// array (
// )

MyClass::myMethod(1);
// $method:'myMethod'
// $args:
// array (
//   0 => 1,
// )

MyClass::myMethod(1, "two");
// $method:'myMethod'
// $args:
// array (
//   0 => 1,
//   1 => 'two',
// )

MyClass::method1();

// $method:'method1'

// $args:

// array (

// )

MyClass::myMethod(1);

// $method:'myMethod'

// $args:

// array (

// 0 => 1,

// )

MyClass::myMethod(1, "two");

// $method:'myMethod'

// $args:

// array (

// 0 => 1,

// 1 => 'two',

// )

インスタンスに対して存在しないstaticメソッドを呼んで__callStatic()が実行される場合、通常のstaticメソッドと違って'->'はエラーになる。

<?php

class MyClass
{
  public static function static_method() {
    echo "static method\n";
  }

  public static function __callStatic($method, $args) {
    echo "__callStatic called.\n";
  }
}

$instance = new MyClass();

$instance->static_method();
// static method

$instance::static_method();
// static method

$instance::method1('undefined static method');
//__callStatic called.

$instance->method1('undefined static method');
// Uncaught Error: Call to undefined method MyClass::method1()

<?php

class MyClass

{

public static function static_method() {

echo "static method\n";

}

public static function __callStatic($method, $args) {

echo "__callStatic called.\n";

}

$instance = new MyClass();

$instance->static_method();

// static method

$instance::static_method();

// static method

$instance::method1('undefined static method');

//__callStatic called.

$instance->method1('undefined static method');

// Uncaught Error: Call to undefined method MyClass::method1()

Laravel – artisan – ルーティングリストの表示

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

下記コマンドでルーティングのリストが表示される。

php artisan route:list

ただし、各ルーティングで呼ばれるコントローラー・アクションが定義されていなければならない。

実行例。

[vagrant@localhost laravel_photo]$ php artisan route:list
+--------+-----------+-------------------+---------------+---------------------------------------------+--------------+
| Domain | Method    | URI               | Name          | Action                                      | Middleware   |
+--------+-----------+-------------------+---------------+---------------------------------------------+--------------+
|        | GET|HEAD  | /                 |               | Closure                                     | web          |
|        | GET|HEAD  | api/user          |               | Closure                                     | api,auth:api |
|        | POST      | items             | items.store   | App\Http\Controllers\ItemController@store   | web          |
|        | GET|HEAD  | items             | items.index   | App\Http\Controllers\ItemController@index   | web          |
|        | GET|HEAD  | items/create      | items.create  | App\Http\Controllers\ItemController@create  | web          |
|        | DELETE    | items/{item}      | items.destroy | App\Http\Controllers\ItemController@destroy | web          |
|        | PUT|PATCH | items/{item}      | items.update  | App\Http\Controllers\ItemController@update  | web          |
|        | GET|HEAD  | items/{item}      | items.show    | App\Http\Controllers\ItemController@show    | web          |
|        | GET|HEAD  | items/{item}/edit | items.edit    | App\Http\Controllers\ItemController@edit    | web          |
+--------+-----------+-------------------+---------------+---------------------------------------------+--------------+

[vagrant@localhost laravel_photo]$ php artisan route:list

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

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

| | GET|HEAD | / | | Closure | web |

| | DELETE | items/{item} | items.destroy | App\Http\Controllers\ItemController@destroy | web |

| | PUT|PATCH | items/{item} | items.update | App\Http\Controllers\ItemController@update | web |

| | GET|HEAD | items/{item} | items.show | App\Http\Controllers\ItemController@show | web |

| | GET|HEAD | items/{item}/edit | items.edit | App\Http\Controllers\ItemController@edit | web |

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

Laravel – 名前付きルート

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

記述方法

ルーティングのname()メソッドで、ルートに名前を付けることができる。

Route::メソッド('URL', 'コントローラー@アクション')->name('ルート名');

この名前を使ってルーティングのURLを得るには、route()ヘルパーを使う。

route('ルート名')

URLにルートパラメーターを含む場合、route()でパラメーターの値を設定して、これを含むURLを得ることができる。

route('ルート名', ['パラメーター' => 値])

ルートパラメーターが複数ある場合は連想配列の要素として列挙。いずれのパラメーターも省略することはできない。

route('ルート名', ['パラメーター1' => 値1, 'パラメーター2' => 値2])

例

ルーティングで以下のように記述する。

Route::get('/named_route', 'SampleController@named_route')->name('named_route');
Route::get('/named_route/{param}/set', 'SampleController@parameter_set')
  ->name('parameter_set');
Route::get('/named_route/first/{param1}/second/{param2}', 'SampleController@parameter_set')
  ->name('two_parameters');

Route::get('/named_route', 'SampleController@named_route')->name('named_route');

Route::get('/named_route/{param}/set', 'SampleController@parameter_set')

->name('parameter_set');

Route::get('/named_route/first/{param1}/second/{param2}', 'SampleController@parameter_set')

->name('two_parameters');

コントローラーのnamed_route()アクションでビューを呼び出す。

  public function named_route() {
    return view('samples.named_route', [
      'title' => '名前付きルート'
    ]);
  }

public function named_route() {

return view('samples.named_route', [

'title' => '名前付きルート'

]);

}

ビューの中で、route()ヘルパーによってルーティングのURLを表示させる。

<!DOCTYPE html>
<html lang="ja" dir="ltr">
  <head>
    <meta charset="utf-8">
    <title>{{ $title }}</title>
  </head>
  <body>
    <h1>{{ $title }}</h1>

    <p>{{ route('named_route') }}</p>
    <p>{{ route('parameter_set', ['param' => 100]) }}</p>
    <p>{{ route('two_parameters', ['param1' => 100, 'param2' => 200 ])}}</p>
  </body>
</html>

<!DOCTYPE html>

<head>

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

</head>

<body>

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

<p>{{ route('named_route') }}</p>

<p>{{ route('parameter_set', ['param' => 100]) }}</p>

<p>{{ route('two_parameters', ['param1' => 100, 'param2' => 200 ])}}</p>

</body>

</html>

結果は以下のように表示される。

名前付きルート
http://localhost:3000/named_route
http://localhost:3000/named_route/100/set
http://localhost:3000/named_route/first/100/second/200

メリット

たとえばアンカータグのURLにルートパラメーターを含む場合、文字列で結合するよりも可読性が高くなる。

URLを変更した場合でも、ルーティングファイルのみ書き換えればよい。

このほか、RESTに基づくリソースルーティングの場合は、自動的に名前が付けられる。

Laravel – データモデル操作

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

概要

Laravelにおけるデータモデルの操作をまとめる。

例としてStickyNoteというアプリケーションを仮定する。StickyNoteは付箋紙のようなアプリケーションで、タイトルとメモ本文を扱う。このアプリケーションを通して、フォーム入力、データの読み込み、書き込み、更新、削除の流れをそれぞれ整理。

データ構造

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

マイグレーションファイルにより、StickyNotesの個々の付箋メモのデータ構造を定義。タイトル(title)とメモ本文(body)を定義している。

class CreateDiariesTable extends Migration
{
    .....
    public function up()
    {
        Schema::create('diaries', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->string('title', 20);
            $table->string('title', 100);
            $table->datetime('created_at');
            $table->datetime('updated_at');
        });
    }
    .....
}

class CreateDiariesTable extends Migration

{

.....

public function up()

{

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

$table->bigIncrements('id');

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

$table->string('title', 100);

$table->datetime('created_at');

$table->datetime('updated_at');

});

}

.....

}

データベース

マイグレーションの結果得られるテーブルの構造。

mysql> describe diaries;
+------------+-----------------+------+-----+---------+----------------+
| Field      | Type            | Null | Key | Default | Extra          |
+------------+-----------------+------+-----+---------+----------------+
| id         | bigint unsigned | NO   | PRI | NULL    | auto_increment |
| title      | varchar(20)     | NO   |     | NULL    |                |
| body       | varchar(100)    | NO   |     | NULL    |                |
| created_at | datetime        | NO   |     | NULL    |                |
| updated_at | datetime        | NO   |     | NULL    |                |
+------------+-----------------+------+-----+---------+----------------+
5 rows in set (0.00 sec)

mysql> describe diaries;

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

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

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

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

5 rows in set (0.00 sec)

データの読み込み

ルーティング

ドメイン名/sticky_noteのURL指定に対してコントローラーStickyNoteControllerのindexアクションを呼び出す。

routes/web.php

Route::get('/sticky_note', 'StickyNoteController@index');

1	Route::get('/sticky_note', 'StickyNoteController@index');

コントローラーでの処理～all()による全データ取得

全データ取得はコントローラーのスタティックメソッドall()を使い、結果はレコード単位の配列で得られる。

ここでは、

indexアクションで$sticky_notesに表示対象の全データを取得
取得した配列をビューに渡して遷移
モデルを記述するときはフルパスで書くか冒頭でuse宣言

app/Https/Controllers/StickyNoteController.php

\App\StickyNoteのようにモデルをフルパスで指定する必要がある。あるいは冒頭でuse \App\StickyNoteとしてもよい。

class StickyNoteController extends Controller
{
  .....
  public function index() {
    // データベースから全データ取得
    $sticky_notes = \App\StickyNote::all();
    // ページ遷移
    return view('sticky_note.index', [
      'title' => '付箋紙',
      'sticky_notes' => $sticky_notes,
    ]);
  }
  .....
}

class StickyNoteController extends Controller

{

.....

public function index() {

// データベースから全データ取得

$sticky_notes = \App\StickyNote::all();

// ページ遷移

return view('sticky_note.index', [

'title' => '付箋紙',

'sticky_notes' => $sticky_notes,

]);

}

.....

}

ビューによる表示

ビューで受け取った配列をループで表示させている。データベースのカラムに対応した属性で、各カラムのデータが得られる。

resources/views/sticky_note/index.blade.html

      @forelse ($sticky_notes as $sticky_note)
        <div>{{ $sticky_note->title }}</div>
        <div>{{ $sticky_note->body }}</div>
      @empty
        <p>付箋紙が登録されていません。</p>
      @endforelse

@forelse ($sticky_notes as $sticky_note)

<div>{{ $sticky_note->title }}</div>

<div>{{ $sticky_note->body }}</div>

@empty

<p>付箋紙が登録されていません。</p>

@endforelse

データの書き込み

フォームでの入力と送信

書き込むデータをフォーム入力し、POTSTで送信する。

resources/views/create.blade.php

  <form method="post" action="/sticky_note">
    @csrf
    <div>
      <label>タイトル: <input type="text" name="title"></label>
    </div>
    <div>
      <label>メモ内容: <input type="text" name="body"></label> 
    </div>
    <input type="submit" value="送信">
  </form>

@csrf

<div>

</div>

<div>

</div>

</form>

ルーティング～POSTに対する書き込み処理

POSTのルーティング先をコントローラーのstore()アクションとしている。

routes/web.php

Route::post('/sticky_note', 'StickyNoteController@store');

1	Route::post('/sticky_note', 'StickyNoteController@store');

コントローラーでの処理～create()によるデータ書き込み

ルーティング先のアクションではフォームリクエストを引数にとり、マスアサインメントと登録処理を1行で記述している。

また、アクションで引用するモデルとフォームリクエストのクラスをuseでインポートしている。

ここでは、

コントローラーの冒頭で、モデルStickyNoteとフォームリクエストStickyNoteRequestをuseでインポート
フォームリクエストStickyNoteRequestを引数にとっている
リクエストのonly()メソッドでマスアサイン
アサイン結果をモデルStickyNoteのcreate()スタティックメソッドの引数に与え、データを登録
トップページにリダイレクト

app/Https/Controllers/StickyNoteController.php

// カスタムモデル
use App\StickyNote;
// カスタムフォームリクエスト
use App\Http\Requests\StickyNoteRequest;

class StickyNoteController extends Controller
{
  .....
  public function store(StickyNoteRequest $request) {
    // マスアサインメント結果をDBに新規登録
    StickyNote::create($request->only(['title', 'body']));
    // トップページにリダイレクト
    return redirect('/sticky_note');
  }
  .....
}

// カスタムモデル

use App\StickyNote;

// カスタムフォームリクエスト

use App\Http\Requests\StickyNoteRequest;

class StickyNoteController extends Controller

{

.....

public function store(StickyNoteRequest $request) {

// マスアサインメント結果をDBに新規登録

StickyNote::create($request->only(['title', 'body']));

// トップページにリダイレクト

return redirect('/sticky_note');

}

.....

}

モデルでの$fillable定義

コントローラーでのマスアサインメントを有効にするため、データモデルで$fillableプロパティーを定義。

ここでは、StickyNoteモデルクラスで$fillableをpublic宣言して、読み込むプロパティーをtitleとbodyの2つに限定している。

app/StickyNote.php

class StickyNote extends Model
{
  public $fillable = ['title', 'body'];
}

class StickyNote extends Model

{

public $fillable = ['title', 'body'];

}

データの更新

ルーティング

更新対象を指定するデータのidがルートパラメーターで指定されてGETされることを想定
- URLにルートパラメーター{id}を含めている
- GETメソッドでトップページなど他のページを区別するために、URLに/editを付けている
GETを受け取ったらeditアクションにルーティング
たとえばアンカータグでここに飛ばしたい場合は、url()ヘルパーを使って以下のように指定する
- <a href="{{ url('/diaries') . '/' . $diary->id . '/edit' }}">

routes/web.php

Route::get('/sticky_note/{id}/edit', 'StickyNoteController@edit')
  ->where('id', '^\d+$');

1 2	Route::get('/sticky_note/{id}/edit', 'StickyNoteController@edit') ->where('id', '^\d+$');

コントローラーでの処理～find()による更新対象の取得

ルーティングで設定されたルートパラメーターは、アクションの引数で参照する
モデルのfind()スタティックメソッドで、idに対応するモデルのインスタンスを取得
取得したモデルインスタンスを、更新用のフォームを持つビューに渡す
- 遷移先のビューでidに対応するデータを初期表示するため

app/Https/Controllers/StickyNoteController.php

  public function edit($id) {
    // ルートパラメーターから更新するインスタンスを取得
    $sticky_note = \App\StickyNote::find($id);
    // 更新するインスタンスを渡して編集ページを表示
    return view('edit', [
      'title' => '内容編集',
      'body' => $body,
    ]);
  }

public function edit($id) {

// ルートパラメーターから更新するインスタンスを取得

$sticky_note = \App\StickyNote::find($id);

// 更新するインスタンスを渡して編集ページを表示

return view('edit', [

'title' => '内容編集',

'body' => $body,

]);

}

フォームでの入力と送信

更新用のフォームを表示する
フォームの各要素に、受け取ったデータのタイトルと本文を初期表示する
更新結果はPATCHメソッドで送信
- HTTPにはGETとPOSTしかないので、formタグではPOSTを指定し、@method()ディレクティブでPATCHを指定している
- 送信先のactionで、idをルートパラメーターとして付加している

resources/views/edit.blade.php

  <form method="post" action="{{ url('/sticky_note') . '/' . $sticky_note->id }}">
    @csrf
    @method('PATCH')
    <div>
      <label>タイトル:
        <input type="text" name="title" value="{{ $sticky_note->title }}">
      </label>
    </div>
    <div>
      <label>メモ内容:
        <input type="text" name="body" value="{{ $sticky_note->body }}">
      </label>
    </div>
    <input type="submit" value="保存">
  </form>

@csrf

@method('PATCH')

<div>

<label>タイトル:

<input type="text" name="title" value="{{ $sticky_note->title }}">

</label>

</div>

<div>

<label>メモ内容:

</label>

</div>

</form>

ルーティング

PATCHメソッドによるルートパラメーターidを含むURLへの送信を、update()アクションにルーティング。

routes/web.php

Route::patch('/sticky_note/{id}', 'StickyNoteController@update')
  ->where('id', '^\d+$');

1 2	Route::patch('/sticky_note/{id}', 'StickyNoteController@update') ->where('id', '^\d+$');

コントローラーでの処理～update()による更新処理

データの書き込みと同じような手順。

ルートパラメーターを引数で受け取り
- 引数の順番は、フォームリクエスト、ルートパラメーターの順番
find()の引数にidを与えてデータを取得
マスアサインメントでデータを更新
トップページへリダイレクト

app/Https/Controllers/StickyNoteController.php

  public function update(StickyNoteRequest $request, $id) {
    // ルートパラメーターから更新するインスタンスを取得
    $diary = \App\StickyNote::find($id);
    // マスアサインメント結果をで更新
    $diary->update($request->only(['title', 'body']));
    // トップページへリダイレクト
    return redirect('/sticky_note');
  }

public function update(StickyNoteRequest $request, $id) {

// ルートパラメーターから更新するインスタンスを取得

$diary = \App\StickyNote::find($id);

// マスアサインメント結果をで更新

$diary->update($request->only(['title', 'body']));

// トップページへリダイレクト

return redirect('/sticky_note');

}

データの削除

ビュー～削除対象指定

全データを表示する際に、各データをフォームで表示し、データごとに削除ボタンを置く
削除ボタンが押されると、DELETEメソッドでidをルートパラメーターに含むURLを呼び出す
HTTPにはGETとPOSTしかないため、@methodディレクティブでDELETEを指定

routes/web.php

      @forelse ($sticky_notes as $sticky_note)
        <form method="post" action="{{ url('/sticky_note') . '/' . $sticky_note->id }}">
          @csrf
          @method('DELETE')
          <div>{{ $sticky_note->title }}</div>
          <input type="submit" value="削除">
        </form>
      @empty
        <p>付箋紙が登録されていません。</p>
      @endforelse

@forelse ($sticky_notes as $sticky_note)

@csrf

@method('DELETE')

<div>{{ $sticky_note->title }}</div>

</form>

@empty

<p>付箋紙が登録されていません。</p>

@endforelse

ルーティング

DELETEメソッドで所定のURLが要求された場合に、destroy()アクションにルーティング。

routes/web.php

Route::delete('/diaries/{id}', 'DiaryController@destroy')
  ->where('id', '^\d+$');

1 2	Route::delete('/diaries/{id}', 'DiaryController@destroy') ->where('id', '^\d+$');

コントローラーでの処理～delete()による削除

ルートパラメーターで受け取ったidでデータを取り出し
得られたデータをdelete()で削除
トップページにリダイレクト

app/Https/Controllers/StickyNoteController.php

  public function destroy($id) {
    // ルートパラメーターから削除する対象を取得
    $Sticky_note = \App\StickyNote::find($id);
    // 対象を削除
    $Stocky_note->delete();
    // トップページへリダイレクト
    return redirect('/sticky_note');
  }

public function destroy($id) {

// ルートパラメーターから削除する対象を取得

$Sticky_note = \App\StickyNote::find($id);

// 対象を削除

$Stocky_note->delete();

// トップページへリダイレクト

return redirect('/sticky_note');

}

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 バリデーション～エラーメッセージのカスタマイズ