Laravel – フォーム入力・データ登録

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

create, store～データの入力と登録

リソースルーティングでは、以下を意図している。

create: 登録するデータを作成する。フォーム入力の場合、フォームを持つビューを表示する。
store: データをデータベースに登録する。createがフォーム入力の場合、フォームのaction先をこのルートにする。

前提

モデルデータの操作で準備した枠組みを使う。ユーザー認証機能を持ち、ユーザーごとに入力されたシンプルな投稿記事Postを扱う。

流れ

ドメイン名/posts/createをGETリクエスト
posts.createルートでPostsControllerのcreateアクションを実行
createアクションで入力フォームを含むビューを表示
入力フォームのactionからposts.storeへルーティング
posts.storeルートでPostControllerのstoreアクションを実行
storeアクションでデータベースにデータを登録

createアクションの呼び出し

リソースルーティングで以下のように設定されていて、ドメイン/posts/createからPostControllerのcreateアクションにルーティングされる。ルーティング名はposts.create。

$ php artisan route:list
+--------+-----------+------------------------+------------------+------------------------------------------------------------------------+--------------+
| Domain | Method    | URI                    | Name             | Action                                                                 | Middleware   |
+--------+-----------+------------------------+------------------+------------------------------------------------------------------------+--------------+
........
|        | POST      | posts                  | posts.store      | App\Http\Controllers\PostController@store                              | web,auth     |
|        | GET|HEAD  | posts                  | posts.index      | App\Http\Controllers\PostController@index                              | web,auth     |
|        | GET|HEAD  | posts/create           | posts.create     | App\Http\Controllers\PostController@create                             | web,auth     |
|        | GET|HEAD  | posts/{post}           | posts.show       | App\Http\Controllers\PostController@show                               | web,auth     |
|        | DELETE    | posts/{post}           | posts.destroy    | App\Http\Controllers\PostController@destroy                            | web,auth     |
|        | PUT|PATCH | posts/{post}           | posts.update     | App\Http\Controllers\PostController@update                             | web,auth     |
|        | GET|HEAD  | posts/{post}/edit      | posts.edit       | App\Http\Controllers\PostController@edit                               | web,auth     |
........

$ php artisan route:list

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

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

........

| | GET|HEAD | posts/{post} | posts.show | App\Http\Controllers\PostController@show | web,auth |

| | DELETE | posts/{post} | posts.destroy | App\Http\Controllers\PostController@destroy | web,auth |

| | PUT|PATCH | posts/{post} | posts.update | App\Http\Controllers\PostController@update | web,auth |

| | GET|HEAD | posts/{post}/edit | posts.edit | App\Http\Controllers\PostController@edit | web,auth |

........

コントローラー～createアクション

コントローラーでは、ビューの$titleを設定してresources/views/posts/create.blade.phpを表示させるだけ。

class PostController extends Controller
{
    ........
    public function create()
    {
        return view('posts.create', [
            'title' => '新規投稿'
        ]);
    }
    ........
}

class PostController extends Controller

{

........

public function create()

{

return view('posts.create', [

'title' => '新規投稿'

]);

}

........

}

入力フォームビュー

bladeテンプレート

投稿を入力するフォームはposts/create.blade.phpに以下の要領で記述。

<form action="{{ route('posts.store') }}" method="post">
  @csrf
  <div>
    <input type="text" name="comment" placeholder="コメントを入力">
  </div>
  <input type="submit" value="投稿">
</form>

@csrf

<div>

</div>

</form>

actionで指定しているroute('posts.store')はデータベースへの登録アクションstoreへのルーティング。

$ php artisan route:list
+--------+-----------+------------------------+------------------+------------------------------------------------------------------------+--------------+
| Domain | Method    | URI                    | Name             | Action                                                                 | Middleware   |
+--------+-----------+------------------------+------------------+------------------------------------------------------------------------+--------------+
........
|        | POST      | posts                  | posts.store      | App\Http\Controllers\PostController@store                              | web,auth     |
|        | GET|HEAD  | posts                  | posts.index      | App\Http\Controllers\PostController@index                              | web,auth     |
|        | GET|HEAD  | posts/create           | posts.create     | App\Http\Controllers\PostController@create                             | web,auth     |
|        | GET|HEAD  | posts/{post}           | posts.show       | App\Http\Controllers\PostController@show                               | web,auth     |
|        | DELETE    | posts/{post}           | posts.destroy    | App\Http\Controllers\PostController@destroy                            | web,auth     |
|        | PUT|PATCH | posts/{post}           | posts.update     | App\Http\Controllers\PostController@update                             | web,auth     |
|        | GET|HEAD  | posts/{post}/edit      | posts.edit       | App\Http\Controllers\PostController@edit                               | web,auth     |
........

$ php artisan route:list

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

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

........

| | GET|HEAD | posts/{post} | posts.show | App\Http\Controllers\PostController@show | web,auth |

| | DELETE | posts/{post} | posts.destroy | App\Http\Controllers\PostController@destroy | web,auth |

| | PUT|PATCH | posts/{post} | posts.update | App\Http\Controllers\PostController@update | web,auth |

| | GET|HEAD | posts/{post}/edit | posts.edit | App\Http\Controllers\PostController@edit | web,auth |

........

フォームリクエスト～バリデーション

フォーム入力のバリデーションをフォームリクエストに記述する。

まず、以下のコマンドでフォームリクエストを作成。

$ php artisan make:request PostRequest

1	$ php artisan make:request PostRequest

app/Http/Requestsディレクトリーに作成されたPostRequest.phpを編集し、バリデーションルールを追加。ここでは唯一のフォーム入力commentに対して、入力必須(required)と最大200文字(max:200)を配列で設定している。

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class PostRequest extends FormRequest
{
    ........
    public function rules()
    {
        return [
            'comment' => ['required', 'max:200'],
        ];
    }
}

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class PostRequest extends FormRequest

{

........

public function rules()

{

return [

'comment' => ['required', 'max:200'],

];

}

コントローラー～storeアクション

use指定

PostControllerでPostモデルとPostのフォームリクエストを使うため、以下のようにファイル冒頭でuse指定する(個別の名前空間指定が不要になる)。

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

use App\Post;
use App\Http\Requests\PostRequest;

class PostController extends Controller
{
    ........
}

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

use App\Post;

use App\Http\Requests\PostRequest;

class PostController extends Controller

{

........

}

storeアクション

入力フォームのaction先で指定されたアクションメソッドで、フォームの入力をデータベースに書き込む。

class PostController extends Controller
{
    ........
    public function store(PostRequest $request)
    {
        Post::create([
          'comment' => $request->comment,
        ]);

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

class PostController extends Controller

{

........

public function store(PostRequest $request)

{

Post::create([

'comment' => $request->comment,

]);

return redirect()->route('posts.index');

}

........

}

ここではPostクラスが継承しているModelクラスのcreate()メソッドで、フォームリクエストのパラメーターをセットしてデータを書き込んでいる。

入力バリデーションはマスアサインメント実行時にフォームリクエストで実行され、エラーがあれば$errorsに格納される
Post::create()は最終的にEloquent/Builderのcreate()が実行されるらしい(参照：モデルのcreate()メソッドはどこに？)

データ書き込み後posts.indexにリダイレクトしているが、これは投稿記事一覧表示へのルーティング。

モデルでの$fillable設定

create()メソッドによる登録はマスアサインメントになるので、モデルに$fillableを定義しておく。

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    protected $fillable = ['user_id', 'comment', 'image_name'];
}

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Post extends Model

{

protected $fillable = ['user_id', 'comment', 'image_name'];

}

確認

ユーザーログイン状態でドメイン名/posts/createをGETリクエストすると入力フォームのページが表示され、投稿ボタンを押すとデータが登録される。

たとえばuser1とuser2をユーザー登録しておいて・・・

mysql> SELECT * FROM users\G
*************************** 1. row ***************************
               id: 1
             name: user1
            email: user1@mail.com
email_verified_at: NULL
         password: $2y$10$45lbfGBk84uzZQLi3lahmulUVSQ75xeNSJC42FmS.ayCaW6WyZtfS
   remember_token: NULL
       created_at: 2021-10-09 10:24:22
       updated_at: 2021-10-09 10:24:22
*************************** 2. row ***************************
               id: 2
             name: user2
            email: user2@mail.com
email_verified_at: NULL
         password: $2y$10$dVAMHnafJLvx4HSyypRfwubvM8ARlAKGa6tqV647xxiBc4i34kixG
   remember_token: NULL
       created_at: 2021-10-09 10:25:59
       updated_at: 2021-10-09 10:25:59
2 rows in set (0.00 sec)

mysql> SELECT * FROM users\G

*************************** 1. row ***************************

id: 1

name: user1

email: user1@mail.com

email_verified_at: NULL

password: $2y$10$45lbfGBk84uzZQLi3lahmulUVSQ75xeNSJC42FmS.ayCaW6WyZtfS

remember_token: NULL

created_at: 2021-10-09 10:24:22

updated_at: 2021-10-09 10:24:22

*************************** 2. row ***************************

id: 2

name: user2

email: user2@mail.com

email_verified_at: NULL

password: $2y$10$dVAMHnafJLvx4HSyypRfwubvM8ARlAKGa6tqV647xxiBc4i34kixG

remember_token: NULL

created_at: 2021-10-09 10:25:59

updated_at: 2021-10-09 10:25:59

2 rows in set (0.00 sec)

それぞれの記事を投稿した結果は以下の通り。

mysql> SELECT * FROM posts;
+----+---------+--------------------------+---------------------+---------------------+
| id | user_id | comment                  | created_at          | updated_at          |
+----+---------+--------------------------+---------------------+---------------------+
|  1 |       1 | user1の1つ目の投稿       | 2021-10-09 10:34:47 | 2021-10-09 10:34:47 |
|  2 |       1 | user1の2つ目の投稿       | 2021-10-09 10:35:01 | 2021-10-09 10:35:01 |
|  3 |       2 | user2の1つ目の投稿       | 2021-10-09 10:35:32 | 2021-10-09 10:35:32 |
|  4 |       2 | user2の2つ目の投稿       | 2021-10-09 10:35:45 | 2021-10-09 10:35:45 |
+----+---------+--------------------------+------------+---------------------+---------------------+
4 rows in set (0.00 sec)

mysql> SELECT * FROM posts;

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

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

| 1 | 1 | user1の1つ目の投稿 | 2021-10-09 10:34:47 | 2021-10-09 10:34:47 |

| 2 | 1 | user1の2つ目の投稿 | 2021-10-09 10:35:01 | 2021-10-09 10:35:01 |

| 3 | 2 | user2の1つ目の投稿 | 2021-10-09 10:35:32 | 2021-10-09 10:35:32 |

| 4 | 2 | user2の2つ目の投稿 | 2021-10-09 10:35:45 | 2021-10-09 10:35:45 |

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

4 rows in set (0.00 sec)

Laravel – モデルのcreate()メソッドはどこに？

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

Modelにcreate()メソッドがない

LaravelのUserや作成したモデルで呼び出すcreate()メソッドについて調べた過程。

たとえばLaravelでモデルとコントローラーをPost、PostControllerのように生成し、store()アクション内でマスアサインメントによってデータを登録する場合に、以下のように書き、モデルクラスのスタティックメソッドcreate()を呼び出している。

class PostController extends Controller
{
    ........
    public function store(Request $request)
    {
        Post::create([
          'comment' => $request->comment,
        ]);

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

class PostController extends Controller

{

........

public function store(Request $request)

{

Post::create([

'comment' => $request->comment,

]);

return redirect()->route('posts.index');

}

........

}

ここでPostモデルのクラスを見てみると、EloquentのModelクラスを継承している。

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
}

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Post extends Model

{

}

ところがIlluminate\Database\Eloquent\Modelクラスなどをたどってみても、create()メソッドが見当たらなかった。

マジックメソッドで実装している

以下のように、Modelクラスではマジックメソッド__call()、__callstatic()が定義されている。

    public function __call($method, $parameters)
    {
        if (in_array($method, ['increment', 'decrement'])) {
            return $this->$method(...$parameters);
        }

        if ($resolver = (static::$relationResolvers[get_class($this)][$method] ?? null)) {
            return $resolver($this);
        }

        return $this->forwardCallTo($this->newQuery(), $method, $parameters);
    }

    public static function __callStatic($method, $parameters)
    {
        return (new static)->$method(...$parameters);
    }

public function __call($method, $parameters)

{

if (in_array($method, ['increment', 'decrement'])) {

return $this->$method(...$parameters);

}

if ($resolver = (static::$relationResolvers[get_class($this)][$method] ?? null)) {

return $resolver($this);

}

return $this->forwardCallTo($this->newQuery(), $method, $parameters);

}

public static function __callStatic($method, $parameters)

{

return (new static)->$method(...$parameters);

}

まず、Post::create()が実行されると、

Postクラスにはstatic create()がない
継承元のModelクラスにもstatic create()がない
Model::__callstatic()が呼ばれる
new staticがlate static bindingで実行されてnew Post()と解釈される
Postインスタンスにはcreate()がない
継承元のModelにもcreate()がない
Model::__call()が呼ばれる

この__call()メソッドの動作はよくわかっていないが、create()の場合は最終的に以下が実行されるようだ。

return $this->forwardCallTo($this->newQuery(), $method, $parameters);

1	return $this->forwardCallTo($this->newQuery(), $method, $parameters);

forwardCallTo()はModelでuseしているForwardsCallsトレイトのメソッドを呼んでいるが、要するにnewQuery()の戻り値のオブジェクトで定義されている$method(この場合はcreate())を呼んでいる。

trait ForwardsCalls
{
    protected function forwardCallTo($object, $method, $parameters)
    {
        try {
            return $object->{$method}(...$parameters);
        } catch (Error|BadMethodCallException $e) {
            ........
        }
    }
    ........
}

trait ForwardsCalls

{

protected function forwardCallTo($object, $method, $parameters)

{

try {

return $object->{$method}(...$parameters);

} catch (Error|BadMethodCallException $e) {

........

}

........

}

ここからどんどん複雑になっていくので手に負えなくなるが、参考サイトを拝見するとEloquent\Builderというクラスのインスタンスが戻り値になるようで、その中にcreate()が定義されていた。

参考サイト：【Laravel】第1回 Eloquent ソースコードリーディング – モデルの取得

尻切れトンボになってしまうが、ひとまずここまで。

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

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

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

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

<?php

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

<?php

class MyClass

{

public function __call($method, $args) {

echo '$method:';

var_export($method);

echo PHP_EOL;

echo '$args:' . PHP_EOL;

var_export($args);

echo PHP_EOL;

}

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

$instance = new MyClass();

$instance->method1();
// $method:'method1'
// $args:
// array (
// )

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

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

$instance = new MyClass();

$instance->method1();

// $method:'method1'

// $args:

// array (

// )

$instance->myMethod(1);

// $method:'myMethod'

// $args:

// array (

// 0 => 1,

// )

$instance->myMethod(1, "two");

// $method:'myMethod'

// $args:

// array (

// 0 => 1,

// 1 => 'two',

// )

Laravel – マイグレーションコマンド

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

表示

status

マイグレーションの状態表示

$ php artisan migrate:status

1	$ php artisan migrate:status

SQLの表示

migrateコマンドのオプションに--pretendを指定すると、マイグレーションにおけるテーブル生成のクエリーを表示する。

$ php artisan migrate --pretend

1	$ php artisan migrate --pretend

migrate:rollbackコマンドでも指定可能だが、rollbackの時と同じメッセージが出力される。他のコマンドでは、--pretendは指定できない。

マイグレーションの実行

マイグレートされていない全マイグレーションファイルのマイグレート

$ php artisan migrate

1	$ php artisan migrate

ロールバック

rollback

直前のマイグレーションのロールバック

$ php artisan migrate:rollback

1	$ php artisan migrate:rollback

指定したステップ分のロールバック(--step=1は指定なしと同じ)

$ php artisan migrate:rollback --setp=ステップ数

1	$ php artisan migrate:rollback --setp=ステップ数

マイグレーションの再実行

reset

実行済みの全マイグレーションのロールバック

$ php artisan migrate:reset

1	$ php artisan migrate:reset

refresh

実行済みの全マイグレーションファイルをロールバックし、マイグレーションを実行。

$ php artisan migrate:refresh

1	$ php artisan migrate:refresh

マイグレート済みの各マイグレーションファイルのdown()メソッドが実行された後、全マイグレーションファイルのup()メソッドが実行される。

デフォルトのdown()メソッドはテーブルをドロップするのみなので、後述のfreshと同じ効果。

fresh

全テーブルをドロップした後、全マイグレーションファイルをマイグレート。

$ php artisan migrate:fresh

1	$ php artisan migrate:fresh

ロールバックは行われずテーブルが再度新規に構築される。各マイグレーションファイルのdown()メソッドは実行されず、up()メソッドのみが実行される。

Laravel – モデル – 外部キー

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

外部キーの準備

通常、外部キーは相手方テーブルで自動連番として生成されたキーを対象とすることが多い。

例えば参照先のテーブルのプライマリーキーが'id'であるとして、これがAuto Incrementの場合にはマイグレーションファイルでは以下のように定義される。

$table->bigIncrements('id');

これにより生成されるカラムのデータ型はunsignedBigIntegerとなるので、参照元のテーブルで外部キーを設定するときは以下のように定義する。

$table->unsignedBigInteger('参照先テーブル名の単数形_id');

例えば参照先テーブルをcustomersとすると、マイグレーションファイルでは以下のように書かれる。

class CreateCustomersTable extends Migration
{
    public function up()
    {
        Schema::create('customers', function (Blueprint $table) {
            $table->bigIncrements('id');
            ........
        });
    }
    ........
}

class CreateCustomersTable extends Migration

{

public function up()

{

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

$table->bigIncrements('id');

........

});

}

........

}

ordersテーブルから上記のcustomersテーブルを参照する場合、ordersテーブルの外部キーは以下のように記述する。

class CreateOrdersTable extends Migration
{
    public function up()
    {
        Schema::create('orders', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->unsignedBigInteger('customer_id');
            ........
        });
    }
    ........
}

class CreateOrdersTable extends Migration

{

public function up()

{

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

$table->bigIncrements('id');

$table->unsignedBigInteger('customer_id');

........

});

}

........

}

外部キーの設定

Laravelのモデルに外部キーを設定する場合、マイグレーションファイルでforeign()メソッドを使う。

具体的には、テーブルを作成するクラスのup()メソッドで呼ばれるSchema::create()メソッド内に以下を記述。

$table->foreign('外部キー')->references('参照キー')->on('参照テーブル');

外部キー制約

マイグレーションファイルで外部キーを設定した場合、デフォルトの外部キー制約はRESTRICTになる。この制約をCASCADEやSET NULLに変更することができる。

削除、更新に対する制約はonDelete()、onUpdate()をメソッドチェーンに追加して設定する。

$table->foreign('外部キー')->references('参照キー')->on('参照テーブル')
->onDelete('CASCADE')->onUpdate('CASCADE');

1 2	$table->foreign('外部キー')->references('参照キー')->on('参照テーブル') ->onDelete('CASCADE')->onUpdate('CASCADE');

引数は大文字でも小文字でもよく、CASCADE、SET NULL、RESTRICTの何れかを指定する。

コード例

たとえば.投稿記事のPostモデルのテーブルがuser_idカラムを持ち、ここにUsersモデルのidを外部キーとする場合、PostのマイグレーションファイルのCreatePostsTableクラスのup()メソッドに、外部キー設定の行を記述する。

class CreatePostsTable extends Migration
{
    public function up()
    {
        Schema::create('posts', function (Blueprint $table) {
            $table->bigIncrements('id');

            // ユーザーIDの外部キー
            $table->unsignedBigInteger('user_id');
            ........

            $table->foreign('user_id')->references('id')->on('users')
            ->onUpdate('cascade')
            ->onDelete('cascade');
        });
    }
    ........
}

class CreatePostsTable extends Migration

{

public function up()

{

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

$table->bigIncrements('id');

// ユーザーIDの外部キー

$table->unsignedBigInteger('user_id');

........

$table->foreign('user_id')->references('id')->on('users')

->onUpdate('cascade')

->onDelete('cascade');

});

}

........

}

Laravel – ログアウト

2021-10-04 / tau / コメントする

概要

基本的な流れの一つ。

form要素のアクションでlogoutを指定して、submitボタンを配置
LoginControllerでloggedOut()メソッドをオーバーライドしてリダイレクト先を指定

ログアウトボタンの配置

フォームとボタンによる方法

ログアウト機能を実装するビューで以下のようなform要素を記述。

<form action="{{ route('logout') }}" method="post">
  @csrf
  <input type="submit" value="ログアウト">
</form>

@csrf

</form>

アンカー要素による方法

ログアウト機能を実装するビューで以下のようなアンカー要素を記述。

<a href="/logout">ログアウト</a>

1	<a href="/logout">ログアウト</a>

アンカー要素はGETメソッドを発行するので、以下のルーティングをroutes/web.phpに追加。

Route::get('/logout', 'Auth\LoginController@logout');

1	Route::get('/logout', 'Auth\LoginController@logout');

その他の方法

このほか、form要素にhiddenタイプのinput要素を配置して、アンカータグでログアウトさせる方法もあるらしい。

ログアウト後のリダイレクト先を変更

LoginControllerで以下の様にloggedOut()メソッドをオーバーライドし、リダイレクト先を指定。

class LoginController extends Controller
{
    ....
    protected function loggedOut(\Illuminate\Http\Request $request) {
      return redirect('login');
    }
}

class LoginController extends Controller

{

....

protected function loggedOut(\Illuminate\Http\Request $request) {

return redirect('login');

}

メソッドインジェクションのRequestは、ファイル冒頭でuseするならフルネームスペースでなくてもよい。

Laravel – アクセス制限

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

ミドルウェアの適用

コントローラー単位でアクション→ビューにアクセス制限をかける場合。コントローラーのコンストラクターでアクセス制限のミドルウェアを適用する。

$this->middleware('auth')

特定のアクションのみに適用したり、逆に適用除外にするには、only()/except()を使う。

たとえばマーケットサイトのCartControllerへのルーティングで、ログインユーザーのみ処理させるには以下の様にコントローラーを書く。

class CartController extends Controller
{
    public function __construct()
    {
        $this->middleware('auth');
    }

    /**
     * Display a listing of the resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function index()
    {
        ....
    }

    ....
}

class CartController extends Controller

{

public function __construct()

{

$this->middleware('auth');

}

/**

* Display a listing of the resource.

* @return \Illuminate\Http\Response

public function index()

{

....

}

....

}

こうすると、ログイン状態でアクセスするとindexなどのアクションが実行されてビューに遷移するが、ログイン状態でない場合はログインページに遷移する。

middleware(‘auth’)

コンストラクターの$this->midlleware('auth')は、コントローラーの全アクションに対して名前'auth'のミドルウェアを適用する。

'auth'はKernel.phpでルートミドルウェアAuthenticateに結び付けられている。

protected $routeMiddleware = [
    'auth' => \App\Http\Middleware\Authenticate::class,
    'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
    'bindings' => \Illuminate\Routing\Middleware\SubstituteBindings::class,
    ....
];

protected $routeMiddleware = [

'auth' => \App\Http\Middleware\Authenticate::class,

'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,

'bindings' => \Illuminate\Routing\Middleware\SubstituteBindings::class,

....

];

Authenticateミドルウェア

Authenticateミドルウェアは、Laravelのプロジェクト作成時にapp/Middlewareディレクトリーに生成されている。

このミドルウェアのhandle()メソッドはIlluminate\Auth\Middleware\Authenticateで定義されている
$request->expectsJson()でログイン状態にあるかどうかを判定しているようだが、その流れはよくわかっていない

この'login'へのルーティングを変更すると、未ログインの場合の遷移先を変更できる。

<?php

namespace App\Http\Middleware;

use Illuminate\Auth\Middleware\Authenticate as Middleware;

class Authenticate extends Middleware
{
    /**
     * Get the path the user should be redirected to when they are not authenticated.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return string|null
     */
    protected function redirectTo($request)
    {
        if (! $request->expectsJson()) {
            return route('login');
        }
    }
}

<?php

namespace App\Http\Middleware;

use Illuminate\Auth\Middleware\Authenticate as Middleware;

class Authenticate extends Middleware

{

/**

* Get the path the user should be redirected to when they are not authenticated.

* @param \Illuminate\Http\Request $request

* @return string|null

protected function redirectTo($request)

{

if (! $request->expectsJson()) {

return route('login');

}

Laravel – ログインユーザーの取得

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

ログインユーザーとプロパティーの取得

ログイン済みのユーザーは、staticメソッド\Auth::user()で取得できる。

ログインユーザーのプロパティーは、以下のように取得できる。

\Auth::user()->id;
\Auth::user()->name;
\Auth::user()->email;
....

\Auth::user()->id;

\Auth::user()->name;

\Auth::user()->email;

....

Authは名前空間のルートにあるので先頭の'\'が必要(\Auth)。

なお、\Auth::user()は未ログイン状態ではエラーとなるので、コントローラーでアクセス制限をかけるか、\Auth::check()か@auth....@endauthディレクティブでチェックを入れる。

例

例えば以下は、ビューでログインユーザーを表示させる例。

<p>ようこそ、{{ Auth::user()->name }}さん</p>

1	<p>ようこそ、{{ Auth::user()->name }}さん</p>

ただし未ログイン状態のときはエラーになる。ログイン状態の時だけ実行する書き方として、以下の2通りがある。

@if (Auth::check())
  <p>ようこそ、{{ Auth::user()->name }}さん</p>
@endif

@if (Auth::check())

@endif

または

@auth
  <p>ようこそ、{{ Auth::user()->name }}さん</p>
@endauth

@auth

@endauth

Laravel – LoginController

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

概要

LoginControllerは、Laravelのプロジェクト開始時にapp/Http/Controllers/Authディレクトリー下に生成される。

ルーティングファイルにAuth:routes()を記述することで、このコントローラーの各アクションは以下のようにURLと結び付けられる。

method	URL	action	name
GET	/login	showLoginForm	login
POST	/login	login

ソースコード

<?php

namespace App\Http\Controllers\Auth;

use App\Http\Controllers\Controller;
use App\Providers\RouteServiceProvider;
use Illuminate\Foundation\Auth\AuthenticatesUsers;

class LoginController extends Controller
{
    /*
    |--------------------------------------------------------------------------
    | Login Controller
    |--------------------------------------------------------------------------
    |
    | This controller handles authenticating users for the application and
    | redirecting them to your home screen. The controller uses a trait
    | to conveniently provide its functionality to your applications.
    |
    */

    use AuthenticatesUsers;

    /**
     * Where to redirect users after login.
     *
     * @var string
     */
    protected $redirectTo = RouteServiceProvider::HOME;

    /**
     * Create a new controller instance.
     *
     * @return void
     */
    public function __construct()
    {
        $this->middleware('guest')->except('logout');
    }
}

<?php

namespace App\Http\Controllers\Auth;

use App\Http\Controllers\Controller;

use App\Providers\RouteServiceProvider;

use Illuminate\Foundation\Auth\AuthenticatesUsers;

class LoginController extends Controller

{

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

| Login Controller

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

| This controller handles authenticating users for the application and

| redirecting them to your home screen. The controller uses a trait

| to conveniently provide its functionality to your applications.

use AuthenticatesUsers;

/**

* Where to redirect users after login.

* @var string

protected $redirectTo = RouteServiceProvider::HOME;

/**

* Create a new controller instance.

* @return void

public function __construct()

{

$this->middleware('guest')->except('logout');

}

内容

コントローラーの機能

ソースコード冒頭のコメントの要旨は以下の通り。

このコントローラーは、アプリケーションにおけるユーザー認証とホームページへの遷移を行う
コントローラーはトレイト(AuthrsenticatesUsers)を用いてこの機能を導入している。

AuthenticatesUsersトレイトの導入

AuthenticatesUsersはLaravelで準備されたトレイトで、showLoginFormアクション、loginアクションを実装している。

use AuthenticatesUsers;

1	use AuthenticatesUsers;

登録後の遷移先

ログイン後の遷移先を設定している。ログイン後の遷移先を変更するには、ここでリダイレクト先を変更するか、HOME定数を変更する。

protected $redirectTo = RouteServiceProvider::HOME;

1	protected $redirectTo = RouteServiceProvider::HOME;

RouteServiceProviderはコントローラーの冒頭でuseされている。

use App\Providers\RouteServiceProvider;

1	use App\Providers\RouteServiceProvider;

RouteServiceProviderを見ると、public定数HOMEは'/home'に設定されている。

public const HOME = '/home';

1	public const HOME = '/home';

ミドルウェアの適用

コントローラーのコンストラクターでミドルウェアを適用している。

public function __construct()
{
    $this->middleware('guest')->except('logout');
}

public function __construct()

{

$this->middleware('guest')->except('logout');

}

'guest'はKernel.phpでルートミドルウェアの名前として定義されていて、RedirectIfAuthenticatedミドルウェアを指している。

protected $routeMiddleware = [
    'auth' => \App\Http\Middleware\Authenticate::class,
    'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
    'bindings' => \Illuminate\Routing\Middleware\SubstituteBindings::class,
    'cache.headers' => \Illuminate\Http\Middleware\SetCacheHeaders::class,
    'can' => \Illuminate\Auth\Middleware\Authorize::class,
    'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
    'password.confirm' => \Illuminate\Auth\Middleware\RequirePassword::class,
    'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,
    'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
    'verified' => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class,
];

protected $routeMiddleware = [

'auth' => \App\Http\Middleware\Authenticate::class,

'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,

'bindings' => \Illuminate\Routing\Middleware\SubstituteBindings::class,

'cache.headers' => \Illuminate\Http\Middleware\SetCacheHeaders::class,

'can' => \Illuminate\Auth\Middleware\Authorize::class,

'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,

'password.confirm' => \Illuminate\Auth\Middleware\RequirePassword::class,

'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,

'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,

'verified' => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class,

];

RedirectIfAuthenticatedミドルウェアはコントローラー実行前にAuth::guard()メソッドを呼び出している。

<?php

namespace App\Http\Middleware;

use App\Providers\RouteServiceProvider;
use Closure;
use Illuminate\Support\Facades\Auth;

class RedirectIfAuthenticated
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @param  string|null  $guard
     * @return mixed
     */
    public function handle($request, Closure $next, $guard = null)
    {
        if (Auth::guard($guard)->check()) {
            return redirect(RouteServiceProvider::HOME);
        }

        return $next($request);
    }
}

<?php

namespace App\Http\Middleware;

use App\Providers\RouteServiceProvider;

use Closure;

use Illuminate\Support\Facades\Auth;

class RedirectIfAuthenticated

{

/**

* Handle an incoming request.

* @param \Illuminate\Http\Request $request

* @param \Closure $next

* @param string|null $guard

* @return mixed

public function handle($request, Closure $next, $guard = null)

{

if (Auth::guard($guard)->check()) {

return redirect(RouteServiceProvider::HOME);

}

return $next($request);

}

Laravel – middleware

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

概要

ミドルウェアを作成・登録する手順は以下のとおり

artisanでミドルウェアを作成
ミドルウェアの処理内容を記述
ミドルウェアを登録
ルーティングでミドルウェアの組み込みを設定

参考サイト：【Laravel】ルーティングのミドルウェアとは？作成手順と実例

準備

以下のルーティング、コントローラー、ビューを準備する。

ルーティング：

Route::get('middleware', 'MiddlewareExampleController@show');

1	Route::get('middleware', 'MiddlewareExampleController@show');

コントローラー：

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class MiddlewareExampleController extends Controller
{

  public function show() {
    HelperController::console_log('in action before calling view');

    return view('middleware_test');
  }
}

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class MiddlewareExampleController extends Controller

{

public function show() {

HelperController::console_log('in action before calling view');

return view('middleware_test');

}

ビュー:

<!DOCTYPE html>
<html lang="ja" dir="ltr">
  <head>
    <meta charset="utf-8">
    <title>middlewareテスト</title>
  </head>
  <body>
    <h1>ミドルウェアテスト</h1>
    {{ App\Http\Controllers\HelperController::console_log('in view') }}
  </body>
</html>

<!DOCTYPE html>

<head>

<title>middlewareテスト</title>

</head>

<body>

<h1>ミドルウェアテスト</h1>

{{ App\Http\Controllers\HelperController::console_log('in view') }}

</body>

</html>

なおコントローラーとビューで、以下のヘルパーコントローラーのconsole_log()メソッドで表示をさせていて、ミドルウェアでもこのメソッドを使っていく。

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class HelperController extends Controller
{
  public static function console_log($var) {
    echo '<script>console.log(', json_encode($var, JSON_UNESCAPED_UNICODE), ');</script>';
  }
}み

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class HelperController extends Controller

{

public static function console_log($var) {

echo '<script>console.log(', json_encode($var, JSON_UNESCAPED_UNICODE), ');</script>';

}

}み

ミドルウェアの作成・登録手順

ミドルウェアの作成

以下のコマンドでミドルウェアのファイルを作成。

php artisan make:middleware ミドルウェア名

ファイルはapp/Http/Middlewareディレクトリー下に作成される(middlewareはuncountableだが、状況によってはmiddlewaresという複数形もあり得るらしい)。

$ php artisan make:middleware SampleBeforeMiddleware
Middleware created successfully.
$ ls -Al app/Http/Middleware/
合計 32
-rw-rw-r--. 1 vagrant vagrant 469  9月  7 16:19 Authenticate.php
-rw-rw-r--. 1 vagrant vagrant 335  9月  7 16:19 CheckForMaintenanceMode.php
-rw-rw-r--. 1 vagrant vagrant 294  9月  7 16:19 EncryptCookies.php
-rw-rw-r--. 1 vagrant vagrant 582  9月  7 16:19 RedirectIfAuthenticated.php
-rw-rw-r--. 1 vagrant vagrant 342  9月 13 19:14 SampleBeforeMiddleware.php
-rw-rw-r--. 1 vagrant vagrant 340  9月  7 16:19 TrimStrings.php
-rw-rw-r--. 1 vagrant vagrant 436  9月  7 16:19 TrustProxies.php
-rw-rw-r--. 1 vagrant vagrant 463  9月  7 16:19 VerifyCsrfToken.php

$ php artisan make:middleware SampleBeforeMiddleware

Middleware created successfully.

$ ls -Al app/Http/Middleware/

合計 32

-rw-rw-r--. 1 vagrant vagrant 469 9月 7 16:19 Authenticate.php

-rw-rw-r--. 1 vagrant vagrant 335 9月 7 16:19 CheckForMaintenanceMode.php

-rw-rw-r--. 1 vagrant vagrant 294 9月 7 16:19 EncryptCookies.php

-rw-rw-r--. 1 vagrant vagrant 582 9月 7 16:19 RedirectIfAuthenticated.php

-rw-rw-r--. 1 vagrant vagrant 342 9月 13 19:14 SampleBeforeMiddleware.php

-rw-rw-r--. 1 vagrant vagrant 340 9月 7 16:19 TrimStrings.php

-rw-rw-r--. 1 vagrant vagrant 436 9月 7 16:19 TrustProxies.php

-rw-rw-r--. 1 vagrant vagrant 463 9月 7 16:19 VerifyCsrfToken.php

作成されたファイルの内容。

<?php

namespace App\Http\Middleware;

use Closure;

class SampleBeforeMiddleware
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        return $next($request);
    }
}

<?php

namespace App\Http\Middleware;

use Closure;

class SampleBeforeMiddleware

{

/**

* Handle an incoming request.

* @param \Illuminate\Http\Request $request

* @param \Closure $next

* @return mixed

public function handle($request, Closure $next)

{

return $next($request);

}

ミドルウェアの処理内容の記述

ミドルウェアの処理には、その実行タイミングに応じた書き方がある。

それらについては後述するが、ここでは仮にhandle()メソッドに別途準備したconsole_log()で表示をさせている。

public function handle($request, Closure $next)
{
    \App\Http\Controllers\HelperController::console_log('in middleware');

    return $next($request);
}

public function handle($request, Closure $next)

{

\App\Http\Controllers\HelperController::console_log('in middleware');

return $next($request);

}

ミドルウェアの登録

登録の種類と手順

作成したミドルウェアはapp/Http/Kernel.phpファイルで登録する。

登録方法により、グローバル登録、ルーティング登録、グループ登録の3種がある。

グローバル登録

Kernelクラスの$middlewareプロパティーに作成したミドルウェアを加えると、すべてのルーティングにミドルウェアが適用される。

以下の例では、デフォルトで生成・登録されるミドルウェアに加えてSampleBeforeMiddlewareを登録している。

protected $middleware = [
    \App\Http\Middleware\TrustProxies::class,
    \App\Http\Middleware\CheckForMaintenanceMode::class,
    \Illuminate\Foundation\Http\Middleware\ValidatePostSize::class,
    \App\Http\Middleware\TrimStrings::class,
    \Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,
    \App\Http\Middleware\SampleBeforeMiddleware::class,
];

protected $middleware = [

\App\Http\Middleware\TrustProxies::class,

\App\Http\Middleware\CheckForMaintenanceMode::class,

\Illuminate\Foundation\Http\Middleware\ValidatePostSize::class,

\App\Http\Middleware\TrimStrings::class,

\Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,

\App\Http\Middleware\SampleBeforeMiddleware::class,

];

ルート登録

Kernelクラスの$routeMiddlewareプロパティーに、名前とともにミドルウェアを登録する。

以下の例では、デフォルトで生成・登録されるミドルウェアに加えて、SampleBeforeMiddlewareを'routed_middleware'という名前で登録している。

protected $routeMiddleware = [
    'auth' => \App\Http\Middleware\Authenticate::class,
    'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
    'bindings' => \Illuminate\Routing\Middleware\SubstituteBindings::class,
    'cache.headers' => \Illuminate\Http\Middleware\SetCacheHeaders::class,
    'can' => \Illuminate\Auth\Middleware\Authorize::class,
    'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
    'password.confirm' => \Illuminate\Auth\Middleware\RequirePassword::class,
    'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,
    'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
    'verified' => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class,
    'test_name' => \App\Http\Middleware\SampleBeforeMiddleware::class,
];

protected $routeMiddleware = [

'auth' => \App\Http\Middleware\Authenticate::class,

'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,

'bindings' => \Illuminate\Routing\Middleware\SubstituteBindings::class,

'cache.headers' => \Illuminate\Http\Middleware\SetCacheHeaders::class,

'can' => \Illuminate\Auth\Middleware\Authorize::class,

'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,

'password.confirm' => \Illuminate\Auth\Middleware\RequirePassword::class,

'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,

'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,

'verified' => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class,

'test_name' => \App\Http\Middleware\SampleBeforeMiddleware::class,

];

グループ登録

Kernelクラスの$middlewareGroupsプロパティーに、グループ名をキーとし、ミドルウェアの配列を値として登録する。

以下の例では、デフォルトで登録される2つのグループ'web'、'api'に加えて’test'というグループを追加し、そのグループにSampleBeforeMiddlewareを登録している。

protected $middlewareGroups = [
    'web' => [
        \App\Http\Middleware\EncryptCookies::class,
        \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
        \Illuminate\Session\Middleware\StartSession::class,
        // \Illuminate\Session\Middleware\AuthenticateSession::class,
        \Illuminate\View\Middleware\ShareErrorsFromSession::class,
        \App\Http\Middleware\VerifyCsrfToken::class,
        \Illuminate\Routing\Middleware\SubstituteBindings::class,
    ],

    'api' => [
        'throttle:60,1',
        \Illuminate\Routing\Middleware\SubstituteBindings::class,
    ],

    'test_group' => [
      \App\Http\Middleware\SampleBeforeMiddleware::class,
    ],
];

protected $middlewareGroups = [

'web' => [

\App\Http\Middleware\EncryptCookies::class,

\Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,

\Illuminate\Session\Middleware\StartSession::class,

// \Illuminate\Session\Middleware\AuthenticateSession::class,

\Illuminate\View\Middleware\ShareErrorsFromSession::class,

\App\Http\Middleware\VerifyCsrfToken::class,

\Illuminate\Routing\Middleware\SubstituteBindings::class,

'api' => [

'throttle:60,1',

\Illuminate\Routing\Middleware\SubstituteBindings::class,

'test_group' => [

\App\Http\Middleware\SampleBeforeMiddleware::class,

];

ミドルウェアの適用

グローバル登録の場合は全適用

グローバル登録されたミドルウェアは、ルーティング設定がなくても全てのコントローラーのアクションに適用される。

この結果、アプリケーションの任意のURLにアクセスすると、ブラウザーのコンソールに以下の様に表示される。

in SampleBeforeMiddleware@handle
in show action before calling view
in view

in SampleBeforeMiddleware@handle

in show action before calling view

in view

ルーティングファイルでの適用

ルート登録・グループ登録のいずれの場合も、ルーティングで特定のルートにミドルウェアを適用できる。

ルートミドルウェアの場合は登録した名前で適用。

Route::get('middleware', 'MiddlewareExampleController@show')
  ->middleware('test_name');

1 2	Route::get('middleware', 'MiddlewareExampleController@show') ->middleware('test_name');

グループミドルウェアの場合は登録したグループ名で適用。

Route::get('middleware', 'MiddlewareExampleController@show')
  ->middleware('test_group');

1 2	Route::get('middleware', 'MiddlewareExampleController@show') ->middleware('test_group');

結果はいずれも同じで、以下のようにブラウザーのコンソールに表示される。

in SampleBeforeMiddleware@handle
in show action before calling view
in view

in SampleBeforeMiddleware@handle

in show action before calling view

in view

コントローラーのコンストラクターでの適用

コントローラーのコンストラクターの中で、middleware()メソッドの引数にミドルウェアの登録名やグループ名を指定して適用できる。

この場合、ルーティングファイルで設定しなくても、当該コントローラーのアクションに対してミドルウェアが適用される。

以下はルートミドルウェア名で登録する場合。

class MiddlewareExampleController extends Controller
{
  public function __construct() {
    $this->middleware('test_name');
  }

  public function show() {
    HelperController::console_log('in show action before calling view');

    return view('middleware_test');
  }
}

class MiddlewareExampleController extends Controller

{

public function __construct() {

$this->middleware('test_name');

}

public function show() {

HelperController::console_log('in show action before calling view');

return view('middleware_test');

}

以下はグループ名で適用する場合。

public function __construct() {
  $this->middleware('test_group');
}

public function __construct() {

$this->middleware('test_group');

}

結果はいずれも同じで、以下のようにブラウザーのコンソールに表示される。

in SampleBeforeMiddleware@handle
in show action before calling view
in view

in SampleBeforeMiddleware@handle

in show action before calling view

in view

ミドルウェアの条件

before middleware

コントローラーが呼ばれる前に実行すべき文を、$next($request)の実行より前に書く。

このとき、$requestからパラメーターを取り出し、その条件に応じた処理をさせることができる。

class SampleBeforeMiddleware
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        // ここに$requestに対する条件に応じた処理を書く
        \App\Http\Controllers\HelperController::console_log('in SampleBeforeMiddleware@handle');

        return $next($request);
    }
}

class SampleBeforeMiddleware

{

/**

* Handle an incoming request.

* @param \Illuminate\Http\Request $request

* @param \Closure $next

* @return mixed

public function handle($request, Closure $next)

{

// ここに$requestに対する条件に応じた処理を書く

\App\Http\Controllers\HelperController::console_log('in SampleBeforeMiddleware@handle');

return $next($request);

}

after middleware

handle()メソッド内で$next($request)を実行した後に、その結果に応じた処理を記述すると、コントローラーの実行後・ビュー表示前にその内容が処理される。

terminate()メソッド内に処理を記述すると、それらはビュー表示後に実行される。

class SampleAfterMiddleware
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        $response = $next($request);

        // ここに$responseに対する条件に応じたコントローラー実行後の処理を書く
        \App\Http\Controllers\HelperController::console_log('in SampleAfterMiddleware@handle');

        return $response;
    }

    public function terminate($request, $response) {
        // ここにビュー表示後の処理を書く
        \App\Http\Controllers\HelperController::console_log('in SampleAfterMiddleware@terminate');
    }
}

class SampleAfterMiddleware

{

/**

* Handle an incoming request.

* @param \Illuminate\Http\Request $request

* @param \Closure $next

* @return mixed

public function handle($request, Closure $next)

{

$response = $next($request);

// ここに$responseに対する条件に応じたコントローラー実行後の処理を書く

\App\Http\Controllers\HelperController::console_log('in SampleAfterMiddleware@handle');

return $response;

}

public function terminate($request, $response) {

// ここにビュー表示後の処理を書く

\App\Http\Controllers\HelperController::console_log('in SampleAfterMiddleware@terminate');

}

ここで、この2つのミドルウェアをKernelクラスでグループ登録する。

protected $middlewareGroups = [
    ....

    'middleware_group' => [
      \App\Http\Middleware\SampleBeforeMiddleware::class,
      \App\Http\Middleware\SampleAfterMiddleware::class,
    ],
];

protected $middlewareGroups = [

....

'middleware_group' => [

\App\Http\Middleware\SampleBeforeMiddleware::class,

\App\Http\Middleware\SampleAfterMiddleware::class,

];

ルーティングへの適用はグループ名で。

Route::get('middleware', 'MiddlewareExampleController@show')
  ->middleware('middleware_group');

1 2	Route::get('middleware', 'MiddlewareExampleController@show') ->middleware('middleware_group');

実行すると、ブラウザーのコンソールに以下の様に表示される。

in SampleBeforeMiddleware@handle
in show action before calling view
in SampleAfterMiddleware@handle
in view
in SampleAfterMiddleware@terminate

in SampleBeforeMiddleware@handle

in show action before calling view

in SampleAfterMiddleware@handle

in view

in SampleAfterMiddleware@terminate

なお、上記ではルーティングファイルでミドルウェアを適用したが、コントローラーのコンストラクターで適用しても結果は同じ。

only/except～部分指定と除外

準備

コントローラーのコンストラクターでミドルウェアを適用する場合、コントローラーの特定のアクションのみに適用したり、適用除外にしたりすることができる。

まず、以下のようなルーティング定義、コントローラーを準備する。ミドルウェアとビューはこれまで使ってきたものと同じ。

ルーティング：

Route::get('middleware/select', 'MiddlewareExampleController@select');
Route::get('middleware/ignore', 'MiddlewareExampleController@ignore');

1 2	Route::get('middleware/select', 'MiddlewareExampleController@select'); Route::get('middleware/ignore', 'MiddlewareExampleController@ignore');

コントローラー：

class MiddlewareExampleController extends Controller
{
  public function __construct() {
    $this->middleware('test_group');
  }

  public function select() {
    HelperController::console_log('in select action before calling view');

    return view('middleware_test');
  }

  public function ignore() {
    HelperController::console_log('in ignore action before calling view');

    return view('middleware_test');
  }
}

class MiddlewareExampleController extends Controller

{

public function __construct() {

$this->middleware('test_group');

}

public function select() {

HelperController::console_log('in select action before calling view');

return view('middleware_test');

}

public function ignore() {

HelperController::console_log('in ignore action before calling view');

return view('middleware_test');

}

ここで2つのURLをブラウザーで指定すると、それぞれ以下の様に表示される。

middleware/select

in SampleBeforeMiddleware@handle
in select action before calling view
in SampleAfterMiddleware@handle
in view
in SampleAfterMiddleware@terminate

in SampleBeforeMiddleware@handle

in select action before calling view

in SampleAfterMiddleware@handle

in view

in SampleAfterMiddleware@terminate

middleware/ignore

in SampleBeforeMiddleware@handle
in ignore action before calling view
in SampleAfterMiddleware@handle
in view
in SampleAfterMiddleware@terminate

in SampleBeforeMiddleware@handle

in ignore action before calling view

in SampleAfterMiddleware@handle

in view

in SampleAfterMiddleware@terminate

only()～部分指定

コンストラクター内のmiddleware()に対してonly()メソッドを実行すると、引数の配列で与えたアクション群に対してだけミドルウェアが適用される。

以下の例ではselect()メソッドのみ適用対象としていて、ignore()メソッドにはミドルウェアは適用されない。

public function __construct() {
  $this->middleware('test_group')->only(['select']);
}

public function __construct() {

$this->middleware('test_group')->only(['select']);

}

この結果、middleware/selectにアクセスした結果は先の結果と変わらないが、middleware/ignoreにアクセスした場合はミドルウェアが実行されず、以下のようなコンソール表示になる。

in ignore action before calling view
ignore:9 in view

1 2	in ignore action before calling view ignore:9 in view

except()～除外指定

コンストラクター内のmiddleware()に対してexcept()メソッドを実行すると、引数の配列で与えたアクション群に対してだけミドルウェアが適用されなくなる。

以下の例ではignore()メソッドのみ適用除外となり、ミドルウェアが適用されない。

public function __construct() {
  $this->middleware('test_group')->except(['ignore']);
}

public function __construct() {

$this->middleware('test_group')->except(['ignore']);

}

結果はonly()の場合と同じになる。