Laravel – アクセス制限

ミドルウェアの適用

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

$this->middleware('auth')

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

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

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

middleware(‘auth’)

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

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

Authenticateミドルウェア

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

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

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

 

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

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

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

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

または

 

Laravel – LoginController

概要

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

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

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

ソースコード

内容

コントローラーの機能

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

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

AuthenticatesUsersトレイトの導入

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

登録後の遷移先

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

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

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

ミドルウェアの適用

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

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

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

 

Laravel – middleware

概要

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

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

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

準備

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

ルーティング:

コントローラー:

ビュー:

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

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

ミドルウェアの作成

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

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

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

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

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

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

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

ミドルウェアの登録

登録の種類と手順

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

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

グローバル登録

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

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

ルート登録

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

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

グループ登録

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

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

ミドルウェアの適用

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ミドルウェアの条件

before middleware

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

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

after middleware

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

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

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

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

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

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

only/except~部分指定と除外

準備

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

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

ルーティング:

コントローラー:

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

middleware/select

middleware/ignore

only()~部分指定

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

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

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

except()~除外指定

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

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

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

 

PHP – 関数 – 無名関数/クロージャ―/コールバック

基本

無名関数(anonymous function)はfunction()で定義。無名関数はクロージャ―(closure)とも呼ばれる。

戻り値を返す例。

引数をとる例。

use~エンクロージャーの変数

クロージャ―の外側(エンクロージャー)のスコープの変数をクロージャ―内で使う場合は、useを加える。

useで持ち込まれるエンクロージャーの変数の値は、関数定義前に定義された内容。上の例では$greetに関数が定義される前の'Hello'が使われていて、実行前の'Hi'は使われない。

コールバック

無名関数を使ったコールバック

以下の関数は、引数$callbackを関数として想定し、その引数に$nameを与えた結果を表示する。

$nameに文字列'Jane'を与え、$callbackに無名関数を与えて実行。この無名関数は引数の$nameを使って"Hi, $name"とい文字列を返す。

$callbackに違う動作をする無名関数を与えて実行。この無名関数は引数の$nameを使って"Hello $name. How arey you?"という文字列を返す。

変数に定義した無名関数のコールバック

コールバックを都度無名関数で定義するのではなく、あらかじめ変数に定義しておいた関数を渡すことができる。

これによって、メッセージのディスパッチなどが柔軟に行えるようになる。

可変関数によるコールバック

コールバックを可変関数で実装した例が以下の通り。

なお、無名関数を変数に代入した場合の変数名とfunctionで定義した関数名は重複してもエラーとならない。

array_map()の例

コールバックを使った内部関数にarray_map()がある。

array_map($callback, $array);

コールバックで直接無名関数を定義し、配列の各要素の自乗を要素とする配列を計算させる。

もちろん引数のコールバックに、変数に定義した関数や可変関数を用いることもできる。

 

PHP – 関数 – 可変関数

基本

可変関数は、変数に格納された文字列を関数名として解釈して実行するもの。

変数の後に()がある場合、PHPは変数の値の文字列を関数名として実行しようとする。

文字列に対応する関数が存在しない場合や値が文字列でない場合にはエラーとなる。

言語構造の場合

echoevalといった言語構造については、可変関数として使えない。これらを使う場合にはラッパー関数を定義する。

ビルトイン関数

ビルトイン関数は使用可能。

メソッド

クラスのstaticメソッドやインスタンスメソッドに対しても使用可能。

 

PHP – 関数 – 可変長引数

…$args

関数の引数を...変数名のように指定すると、任意の個数の変数を渡すことができる。

受け取った関数では、配列$argsの各要素に引数の値がセットされている(要素数が0や1の場合も配列)。

型の混在

上の例ではstring型を指定して全ての引数を文字列として扱っていて、すべての値がstring型である(あるいはキャスト可能である)必要がある。

型を指定しない場合は、与えられたそれぞれの引数の型のままで配列に格納される。

単純引数との混在

最後尾は可能

通常の引数が並んだその後、最後尾に可変長引数を置くことができる。

可変長以外の引数はデフォルト値がなければ省略できないが、可変長引数は0個でもよい。

先頭や中間は不可

可変長引数を先頭や単純引数の間に置くことはできない。

逆の使い方

複数の引数を...$arrayで受けると、それらを要素とした$arrayが得られる。逆に$arrayが配列の時...$arrayは分解された各要素を返す

これらはコレクションでもないばらばらの値なので、echoで出力したりforeachで使うことはできない。

以下の例では、配列を1つ1つの要素に分解して、それらを引数に与えて最大値・最小値を得ている。

以下の例では、2つの引数を配列の要素として準備して関数に与えている。

 

PHP – 関数 – デフォルト引数

概要

  • 関数定義時に引数のデフォルト値を指定することができる
  • デフォルト値を指定した引数は、関数呼び出し時に省略することができる
  • 関数呼び出し時に指定された引数は、定義された引数の順番に充てられる
    • PHP8.0以降は名前付きを使うことができるため、必要な引数のみ値をセットできる

最後の関数呼び出しでは、int $dices2を、int $trials','をセットすることになるので、2つ目の引数の型が合わずにエラーとなる。

2つ目の引数$trialsの型指定をしていなければ、','は数値表現ではないので0とみなされ、以下のような結果になる(各試行の際に必ず1度サイコロが降られる)。

 

PHP – 関数 – 引数の型指定

概要

  • 新しいバージョンのPHPでは関数の引数の型を指定できる
  • ただし型チェックの前にキャストが試みられて、その結果が指定された型に合致しない場合はTypeErrorが出る
  • なので以下のような場合は(少なくとも型チェックでは)エラーにならない
    • 文字列型の引数に数値を与える場合
    • 数値型のタイプが異なる場合
    • 数値型の引数に与える文字列が数値として解釈可能な場合
  • これらの挙動にdeclare(strict_types=1)は影響しない

通常は型チェックされない

以下のコードをコンソールで実行する。動作確認のため引数範囲のチェックは行っていない。

挙動は以下の通り。

  • 文字列型を想定した引数に数値型の値をセットすると、文字列型にキャストされる
  • 整数型を想定した引数に実数型の値をセットすると、整数型にキャストされる
  • 数値型を想定した引数に文字列型をセットすると、
    • 数値に変換できる場合はその数値にキャストされる
    • 数値に変換できない場合は0として扱われる

引数の型を明示できるが一部キャストされる

以下のように引数の型を明示する。

挙動は以下の通り。

  • string型の引数にint型をセットすると、string型にキャストされる
  • int型の引数にfloat型の値をセットすると、int型にキャストされる
  • int型の引数にstring型の値をセットすると、
    • 数値表現の文字列ならキャストされる
    • 数値表現の文字列でないならTypeErrorになる

なお、ファイルの冒頭にdeclare(strict_types=1)を加えても結果は変わらない。

 

PHP – 変数のブラウザー表示

 

概要

PHPをサーバー上で実行する場合、変数の内容をブラウザーに表示させるいくつかの方法を整理。いずれの方法でも改行にPHP_EOLが使われるので、ブラウザー上では改行として機能せず空白文字になる。

var_export()print_r()については、結果の文字列を表示させるのではなく、戻り値として扱うことができる。

jason_encode()は趣旨が少し違うが一応加えておく。

コンソールに表示する場合に対して、PHP_EOLが改行として機能せず空白文字になる。

準備

以下のような変数・値を表示させる。

var_dump

var_dump()は引数の変数の内容を型まで含めて詳しく表示する。少し冗長。

  • 変数ごとの表示後や配列の要素間に改行コードが入るが、ブラウザー上では空白文字になる
  • 変数を複数指定しても、別々に実行したのと同じ結果
  • キー・値の文字列はダブルクォートで囲まれる
  • 実数はfloat[1]の様に表示される

var_export

var_export()は、var_dump()より簡潔な形で表示する。

  • 改行コードは全て空白文字になる
  • 結果をPHPのソースにコピー・ペーストして使える(改行が空白文字となっていてもok)
  • キー・値の文字列はシングルクォートで囲まれる
  • 実数は小数部がゼロでも1.0のように表示される
  • 配列の各要素末尾にカンマが付く

print_r

print_r()var_export()より更に簡潔に表示する。

  • 改行コードは全て空白文字になる
  • 文字列はクォートで囲まれない
  • 実数の小数部がゼロの時、整数と同じ表示になる
  • 配列の要素末尾にカンマは付かない

json_encode

変数の内容をJSON形式で返す。オプションのJSON_UNESCAPED_UNICODEを指定しないと、マルチバイト文字がHex表示になる。

以下の様にすれば、'\n'が改行としては機能しないが空白にはなる。