PHP – 関数 – 引数の型指定

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

概要

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

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

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

function dice($trials, $separator) {
  echo random_int(1, 6);
  for ($i = 1; $i < $trials; $i++) {
    echo $separator . random_int(1, 6);
  }
  echo PHP_EOL;
}

dice(5, ',');
// 1,3,6,2,1

dice(5, 0);
// 504040401

dice(2.1, ',');
// 4,2,1

dice('2.1', ',');
// 3,6,1

dice('five', ',');
// 6

function dice($trials, $separator) {

echo random_int(1, 6);

for ($i = 1; $i < $trials; $i++) {

echo $separator . random_int(1, 6);

}

echo PHP_EOL;

}

dice(5, ',');

// 1,3,6,2,1

dice(5, 0);

// 504040401

dice(2.1, ',');

// 4,2,1

dice('2.1', ',');

// 3,6,1

dice('five', ',');

// 6

挙動は以下の通り。

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

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

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

function dice_checked(int $trials, string $separator) {
  echo random_int(1, 6);
  for ($i = 1; $i < $trials; $i++) {
    echo $separator . random_int(1, 6);
  }
  echo PHP_EOL;
}

dice_checked(5, ',');
// 5,6,1,4,2

//dice_checked(5, 0);
// 306020303

dice(2.1, ',');
// 1,5,1

dice('2.1', ',');
// 3,6,3

dice_checked('five', ',');
// TypeError: Argument 1 passed to dice_checked() must be of the type int, string given

function dice_checked(int $trials, string $separator) {

echo random_int(1, 6);

for ($i = 1; $i < $trials; $i++) {

echo $separator . random_int(1, 6);

}

echo PHP_EOL;

}

dice_checked(5, ',');

// 5,6,1,4,2

//dice_checked(5, 0);

// 306020303

dice(2.1, ',');

// 1,5,1

dice('2.1', ',');

// 3,6,3

dice_checked('five', ',');

// TypeError: Argument 1 passed to dice_checked() must be of the type int, string given

挙動は以下の通り。

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

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

PHP – 変数のコンソール表示

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

概要

PHPをコマンドラインで実行する場合に、変数の内容をコンソールに表示させるいくつかの方法を整理。JavaScriptのconsole.log()に比べて、何となく帯に短し襷に長し。個人的には使うとしたらview_export()か。

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

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

変数の内容をコンソールではなくブラウザーに表示する場合はこちら。

準備

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

$int = 100;
$str = '文字列';
$arr = [1, 2.0, 'three', '四'];
$asc = [
  'one' => 1,
  2 => '弐',
  '実数3' => 3.0,
];

$int = 100;

$str = '文字列';

$arr = [1, 2.0, 'three', '四'];

$asc = [

'one' => 1,

2 => '弐',

'実数3' => 3.0,

];

var_dump

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

変数ごとの表示後に改行される
変数を複数指定しても、別々に実行したのと同じ結果
キー・値の文字列はダブルクォートで囲まれる
実数はfloat[1]の様に表示される

var_dump($int, $str);
// int(100)
// string(9) "文字列"

var_dump($arr);
// array(4) {
//   [0]=>
//   int(1)
//   [1]=>
//   float(2)
//   [2]=>
//   string(5) "three"
//   [3]=>
//   string(3) "四"
// }

var_dump($asc);
// array(3) {
//   ["one"]=>
//   int(1)
//   [2]=>
//   string(3) "弐"
//   ["実数3"]=>
//   float(3)
// }

var_dump($int, $str);

// int(100)

// string(9) "文字列"

var_dump($arr);

// array(4) {

// [0]=>

// int(1)

// [1]=>

// float(2)

// [2]=>

// string(5) "three"

// [3]=>

// string(3) "四"

// }

var_dump($asc);

// array(3) {

// ["one"]=>

// int(1)

// [2]=>

// string(3) "弐"

// ["実数3"]=>

// float(3)

// }

var_export

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

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

var_export($int); echo PHP_EOL;
// 100

var_export($str); echo PHP_EOL;
// '文字列'

var_export($arr); echo PHP_EOL;
// array (
//   0 => 1,
//   1 => 2.0,
//   2 => 'three',
//   3 => '四',
// )

var_export($asc); echo PHP_EOL;
// array (
//   'one' => 1,
//   2 => '弐',
//   '実数3' => 3.0,
// )

var_export($int); echo PHP_EOL;

// 100

var_export($str); echo PHP_EOL;

// '文字列'

var_export($arr); echo PHP_EOL;

// array (

// 0 => 1,

// 1 => 2.0,

// 2 => 'three',

// 3 => '四',

// )

var_export($asc); echo PHP_EOL;

// array (

// 'one' => 1,

// 2 => '弐',

// '実数3' => 3.0,

// )

print_r

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

単純変数の表示後は改行されないが、配列の表示後は改行される
文字列はクォートで囲まれない
実数の小数部がゼロの時、整数と同じ表示になる
配列の要素末尾にカンマは付かない

print_r($int); echo PHP_EOL;
100

print_r($str); echo PHP_EOL;
文字列

print_r($arr);
Array
(
    [0] => 1
    [1] => 2
    [2] => three
    [3] => 四
)

print_r($asc);
Array
(
    [one] => 1
    [2] => 弐
    [実数3] => 3
)

print_r($int); echo PHP_EOL;

100

print_r($str); echo PHP_EOL;

文字列

print_r($arr);

Array

(

[0] => 1

[1] => 2

[2] => three

[3] => 四

)

print_r($asc);

Array

(

[one] => 1

[2] => 弐

[実数3] => 3

)

json_encode

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

echo json_encode($int) . PHP_EOL;
// "100"

echo json_encode($str, JSON_UNESCAPED_UNICODE) . PHP_EOL;
// "文字列"

echo json_encode($arr, JSON_UNESCAPED_UNICODE) . PHP_EOL;
// "Array\n(\n    [0] => 1\n    [1] => 2\n    [2] => three\n    [3] => 四\n)\n"

echo json_encode($asc, JSON_UNESCAPED_UNICODE) . PHP_EOL;
// "Array\n(\n    [one] => 1\n    [2] => 弐\n    [実数3] => 3\n)\n"

echo json_encode($int) . PHP_EOL;

// "100"

echo json_encode($str, JSON_UNESCAPED_UNICODE) . PHP_EOL;

// "文字列"

echo json_encode($arr, JSON_UNESCAPED_UNICODE) . PHP_EOL;

// "Array\n(\n [0] => 1\n [1] => 2\n [2] => three\n [3] => 四\n)\n"

echo json_encode($asc, JSON_UNESCAPED_UNICODE) . PHP_EOL;

// "Array\n(\n [one] => 1\n [2] => 弐\n [実数3] => 3\n)\n"

何とか'\n'を改行として表示するなら、以下の様にするか。

eval('echo ' . json_encode($asc, JSON_UNESCAPED_UNICODE) . ';');
// Array
// (
//     [one] => 1
//     [2] => 弐
//     [実数3] => 3
// )

eval('echo ' . json_encode($asc, JSON_UNESCAPED_UNICODE) . ';');

// Array

// (

// [one] => 1

// [2] => 弐

// [実数3] => 3

// )

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

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

概要

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

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

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

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

準備

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

$int = 100;
$str = '文字列';
$arr = [1, 2.0, 'three', '四'];
$asc = [
  'one' => 1,
  2 => '弐',
  '実数3' => 3.0,
];

$int = 100;

$str = '文字列';

$arr = [1, 2.0, 'three', '四'];

$asc = [

'one' => 1,

2 => '弐',

'実数3' => 3.0,

];

var_dump

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

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

var_dump($int, $str); echo '<br>';
// int(100)
// string(9) "文字列"

var_dump($arr); echo '<br>';
// array(4) { [0]=> int(1) [1]=> float(2) [2]=> string(5) "three" [3]=> string(3) "四" }

var_dump($asc); echo '<br>';
// array(3) { ["one"]=> int(1) [2]=> string(3) "弐" ["実数3"]=> float(3) }

var_dump($int, $str); echo '<br>';

// int(100)

// string(9) "文字列"

var_dump($arr); echo '<br>';

// array(4) { [0]=> int(1) [1]=> float(2) [2]=> string(5) "three" [3]=> string(3) "四" }

var_dump($asc); echo '<br>';

// array(3) { ["one"]=> int(1) [2]=> string(3) "弐" ["実数3"]=> float(3) }

var_export

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

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

var_export($int); echo '<br>';
// 100

var_export($str); echo '<br>';
// '文字列'

var_export($arr); echo '<br>';
// array ( 0 => 1, 1 => 2.0, 2 => 'three', 3 => '四', )

var_export($asc); echo '<br>';
// array ( 'one' => 1, 2 => '弐', '実数3' => 3.0, )

var_export($int); echo '<br>';

// 100

var_export($str); echo '<br>';

// '文字列'

var_export($arr); echo '<br>';

// array ( 0 => 1, 1 => 2.0, 2 => 'three', 3 => '四', )

var_export($asc); echo '<br>';

// array ( 'one' => 1, 2 => '弐', '実数3' => 3.0, )

print_r

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

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

print_r($int); echo '<br>';
// 100

print_r($str); echo '<br>';
// 文字列

print_r($arr); echo '<br>';
// Array ( [0] => 1 [1] => 2 [2] => three [3] => 四 )

print_r($asc); echo '<br>';
// Array ( [one] => 1 [2] => 弐 [実数3] => 3 )

print_r($int); echo '<br>';

// 100

print_r($str); echo '<br>';

// 文字列

print_r($arr); echo '<br>';

// Array ( [0] => 1 [1] => 2 [2] => three [3] => 四 )

print_r($asc); echo '<br>';

// Array ( [one] => 1 [2] => 弐 [実数3] => 3 )

json_encode

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

echo json_encode($int) . '<br>';
"100"

echo json_encode($str, JSON_UNESCAPED_UNICODE) . '<br>';
"文字列"

echo json_encode($arr, JSON_UNESCAPED_UNICODE) . '<br>';
"Array\n(\n [0] => 1\n [1] => 2\n [2] => three\n [3] => 四\n)\n"

echo json_encode($asc, JSON_UNESCAPED_UNICODE) . '<br>';
"Array\n(\n [one] => 1\n [2] => 弐\n [実数3] => 3\n)\n"

echo json_encode($int) . '<br>';

"100"

echo json_encode($str, JSON_UNESCAPED_UNICODE) . '<br>';

"文字列"

echo json_encode($arr, JSON_UNESCAPED_UNICODE) . '<br>';

"Array\n(\n [0] => 1\n [1] => 2\n [2] => three\n [3] => 四\n)\n"

echo json_encode($asc, JSON_UNESCAPED_UNICODE) . '<br>';

"Array\n(\n [one] => 1\n [2] => 弐\n [実数3] => 3\n)\n"

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

eval('echo ' . json_encode($asc, JSON_UNESCAPED_UNICODE) . ';');
// Array ( [one] => 1 [2] => 弐 [実数3] => 3 )

1 2	eval('echo ' . json_encode($asc, JSON_UNESCAPED_UNICODE) . ';'); // Array ( [one] => 1 [2] => 弐 [実数3] => 3 )

PHP – 変数の文字列表現

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

概要

特にデバッグ段階を意図して、変数の内容を文字列化する方法を整理する。

単純な文字列化

単純変数

単純変数はそのまま出力したり文字列連結したりできる。

echo $int . "\n";
// 100

echo $str . "\n";
// 文字列

echo $int . "\n";

// 100

echo $str . "\n";

// 文字列

配列

配列は自動的には文字列化されない。

echo $arr;
// PHP Notice:  Array to string conversion in /home...

echo $asc;
// PHP Notice:  Array to string conversion in /home...

echo $arr;

// PHP Notice: Array to string conversion in /home...

echo $asc;

// PHP Notice: Array to string conversion in /home...

implode()関数を使えば、指定したセパレーターで配列の文字列化は可能。

echo implode(',', $arr) . "\n";
// 1,2,three,四

echo implode(',', $asc) . "\n";
// 1,弐,3

echo implode(',', $arr) . "\n";

// 1,2,three,四

echo implode(',', $asc) . "\n";

// 1,弐,3

print_r

print_r()関数は配列も含めて変数の内容を文字列化して表示するが、第2引数にtrueを指定することで、文字列化された変数の内容を戻り値とするように変更できる。

単純変数のみPHP_EOLが末尾に付加され、配列の末尾にはPHP_EOLは付かない。

echo print_r($int, true) . "\n";
// 100

echo print_r($str, true) . "\n";
// 文字列

echo print_r($arr, true);
// -------- コンソールの場合 --------
// Array
// (
//     [0] => 1
//     [1] => 2
//     [2] => three
//     [3] => 四
// )
// -------- ブラウザーの場合 --------
// Array ( [0] => 1 [1] => 2 [2] => three [3] => 四 )

echo print_r($asc, true);
// -------- コンソールの場合 --------
// Array
// (
//     [one] => 1
//     [2] => 弐
//     [実数3] => 3
// )
// -------- ブラウザーの場合 --------
// Array ( [one] => 1 [2] => 弐 [実数3] => 3 )

echo print_r($int, true) . "\n";

// 100

echo print_r($str, true) . "\n";

// 文字列

echo print_r($arr, true);

// -------- コンソールの場合 --------

// Array

// (

// [0] => 1

// [1] => 2

// [2] => three

// [3] => 四

// )

// -------- ブラウザーの場合 --------

// Array ( [0] => 1 [1] => 2 [2] => three [3] => 四 )

echo print_r($asc, true);

// -------- コンソールの場合 --------

// Array

// (

// [one] => 1

// [2] => 弐

// [実数3] => 3

// )

// -------- ブラウザーの場合 --------

// Array ( [one] => 1 [2] => 弐 [実数3] => 3 )

var_export

var_export()関数は配列も含めて変数の内容を文字列化して表示するが、第2引数にtrueを指定することで、文字列化された変数の内容を戻り値とするように変更できる。

単純変数・配列に関わらず、末尾にPHP_EOLは付加されない。

echo var_export($int, true) . "\n";
// 100

echo var_export($str, true) . "\n";
// '文字列'

echo var_export($arr, true) . "\n";
// -------- コンソールの場合 --------
// array (
//   0 => 1,
//   1 => 2.0,
//   2 => 'three',
//   3 => '四',
// )
// -------- ブラウザーの場合 --------
// array ( 0 => 1, 1 => 2.0, 2 => 'three', 3 => '四', )

echo var_export($asc, true) . "\n";
// -------- コンソールの場合 --------
// array (
//   'one' => 1,
//   2 => '弐',
//   '実数3' => 3.0,
// )
// -------- ブラウザーの場合 --------
// array ( 'one' => 1, 2 => '弐', '実数3' => 3.0, )

echo var_export($int, true) . "\n";

// 100

echo var_export($str, true) . "\n";

// '文字列'

echo var_export($arr, true) . "\n";

// -------- コンソールの場合 --------

// array (

// 0 => 1,

// 1 => 2.0,

// 2 => 'three',

// 3 => '四',

// )

// -------- ブラウザーの場合 --------

// array ( 0 => 1, 1 => 2.0, 2 => 'three', 3 => '四', )

echo var_export($asc, true) . "\n";

// -------- コンソールの場合 --------

// array (

// 'one' => 1,

// 2 => '弐',

// '実数3' => 3.0,

// )

// -------- ブラウザーの場合 --------

// array ( 'one' => 1, 2 => '弐', '実数3' => 3.0, )

PHP/Laravel – console.log

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

ちょっと小回りが利かない

webアプリケーション開発の過程で変数の内容をちょっと確認したいとき、Laravelならdump()やdd()が使えるが、エラーの場合は内容が確認できなかったり、確認の都度実行を停止しなければならなかったりする。

実行させながら変数の内容を表示させるには、var_dump()などの関数でブラウザーに内容を表示させるのが一般的だが、表示が崩れ、ページが遷移すると確認できない。

JSを使った簡易な対応

Railsのようにサーバーコンソールへの出力やJavascriptのconsole.logのように、ページとは別のところで変数の内容を確認したいとき、標準出力に振り向けるような設定もあるようだが、以下のコードでとりあえずブラウザーのコンソールへの表示ができる。

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

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

文字列や配列の表現中にシングルクォートやダブルクォートが含まれるとエラーが出る場合もあるので、変数を結合するときにjson_encode()を使っている。

実行例

以下はPHPでの実行例で、上のコードを関数化している。Laravelならヘルパー、staticクラス、staticメソッドのトレイトなどで準備することが考えられる。

<?php

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

$int = 100;
$str = '文字列';
$arr = [1, 2.0, 'three', '四'];
$asc = [
  'one' => 1,
  2 => '弐',
  '実数3' => 3.0,
];

console_log($int);
console_log($str);
console_log($arr);
console_log($asc);

echo <<<END
<html>
  <head>
    <title>console.logテスト</title>
  </head>
  <body>
    <h1>console.logテスト</h1>
  </body>
</html>
END;

console_log($int);
console_log($str);
console_log($arr);
console_log($asc);

<?php

function console_log($var) {

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

}

$int = 100;

$str = '文字列';

$arr = [1, 2.0, 'three', '四'];

$asc = [

'one' => 1,

2 => '弐',

'実数3' => 3.0,

];

console_log($int);

console_log($str);

console_log($arr);

console_log($asc);

echo <<<END

<html>

<head>

<title>console.logテスト</title>

</head>

<body>

<h1>console.logテスト</h1>

</body>

</html>

END;

console_log($int);

console_log($str);

console_log($arr);

console_log($asc);

以下は実行の結果生成されたHMTL例で、HTMLドキュメント出力の前段だとhead要素内、出力後だとbody要素内にscript要素が配置される。

<html>
  <head>
    <script>console.log(100);</script>
    <script>console.log("文字列");</script>
    <script>console.log([1,2,"three","四"]);</script>
    <script>console.log({"one":1,"2":"弐","実数3":3});</script>  
    <title>console.logテスト</title>
  </head>
  <body>
    <h1>console.logテスト</h1>
    <script>console.log(100);</script>
    <script>console.log("文字列");</script>
    <script>console.log([1,2,"three","四"]);</script>
    <script>console.log({"one":1,"2":"弐","実数3":3});</script>  
  </body>
</html>

<html>

<head>

<title>console.logテスト</title>

</head>

<body>

<h1>console.logテスト</h1>

</body>

</html>

以下はコンソールへの出力部分。これで実行を止めずに変数の確認ができる。

100
文字列
▶(4) [1, 2, 'three', '四']
▶{2: '弐', one: 1, 実数3: 3}

100

文字列

▶(4) [1, 2, 'three', '四']

▶{2: '弐', one: 1, 実数3: 3}

Laravelの場合

コントローラーのメソッドに定義

コントローラーでメソッドを定義する方法で可能。

コントローラーのstaticメソッドでconsole_log()を定義
コントローラー内は$this->console_log()で呼び出し
ビューでは{{ namespace\controller::console_log() }}で呼び出し

コントローラーの例

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

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

  public function show() {
    $this->console_log('log in action before calling view');

    return view('console_log_test');
  }
}

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class ConsoleLogController extends Controller

{

public static function console_log($var) {

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

}

public function show() {

$this->console_log('log in action before calling view');

return view('console_log_test');

}

ビューの例

<!DOCTYPE html>
<html lang="ja" dir="ltr">
  <head>
    <meta charset="utf-8">
    <title>console_logテスト</title>
  </head>
  <body>
    <h1>console_logテスト</h1>
    {{ App\Http\Controllers\ConsoleLogController::console_log('log in view') }}
  </body>
</html>

<!DOCTYPE html>

<head>

<title>console_logテスト</title>

</head>

<body>

<h1>console_logテスト</h1>

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

</body>

</html>

ルーティングからConsoleLogController@show()が実行されると、ブラウザーにビューが表示され、F12キーで以下の表示が確認できる。

log in action before calling view
log in view

1 2	log in action before calling view log in view

ヘルパーコントローラーを作成する方法

以下のようにヘルパーコントローラーをapp/Http/Controllers下に作成し、staticメソッドとしてconsole_log()を定義。

php artisan make:controller HelperController

<?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>';

}

コントローラーのアクションでは以下の様に呼び出す。

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

1	HelperController::console_log('log in action before calling view by Helper');

ビューでは以下の様に呼び出す。

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

1	{{ App\Http\Controllers\HelperController::console_log('log in view by Helper') }}

Vagrant/Linux環境でPHPサーバーを起動する

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

概要

VagrantのLinux上でPHPのビルトインサーバーを立ち上げる。

ゲスト側IPアドレスの確認

Vagrant環境下でip aやifconfig -aを実行してネットワークインタフェイスのアドレスを確認する。

[vagrant@localhost php]$ ip a
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000
    link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
    inet 127.0.0.1/8 scope host lo
       valid_lft forever preferred_lft forever
    inet6 ::1/128 scope host
       valid_lft forever preferred_lft forever
2: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP group default qlen 1000
    link/ether 08:00:27:0e:4e:dd brd ff:ff:ff:ff:ff:ff
    inet 10.0.2.15/24 brd 10.0.2.255 scope global noprefixroute dynamic eth0
       valid_lft 74563sec preferred_lft 74563sec
    inet6 fe80::10ae:de8c:87bc:71ab/64 scope link noprefixroute
       valid_lft forever preferred_lft forever

[vagrant@localhost php]$ ip a

1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000

link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00

inet 127.0.0.1/8 scope host lo

valid_lft forever preferred_lft forever

inet6 ::1/128 scope host

valid_lft forever preferred_lft forever

2: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP group default qlen 1000

link/ether 08:00:27:0e:4e:dd brd ff:ff:ff:ff:ff:ff

inet 10.0.2.15/24 brd 10.0.2.255 scope global noprefixroute dynamic eth0

valid_lft 74563sec preferred_lft 74563sec

inet6 fe80::10ae:de8c:87bc:71ab/64 scope link noprefixroute

valid_lft forever preferred_lft forever

サーバーの起動

ビルトインサーバーの起動コマンドは以下のとおり。

php -S ホスト:ポート -t ドキュメントルート
php --server ホスト:ポート --docroot ドキュメントルート

ホスト部分に、確認したIPアドレスを指定する。ドキュメントルートに、実行ファイルが置かれる場所を指定する。

$ php -S 10.0.2.15:3000 -t ~/test/php

1	$ php -S 10.0.2.15:3000 -t ~/test/php

ブラウザーでの表示

ブラウザーでのURL指定は以下のとおり。

http://localhost:3000/phpファイル名

1	http://localhost:3000/phpファイル名

Laravel – RegisterController

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

概要

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

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

method	URL	action	name
GET	/register	showRegistrationForm	register
POST	/register	register

ソースコード

<?php

namespace App\Http\Controllers\Auth;

use App\Http\Controllers\Controller;
use App\Providers\RouteServiceProvider;
use App\User;
use Illuminate\Foundation\Auth\RegistersUsers;
use Illuminate\Support\Facades\Hash;
use Illuminate\Support\Facades\Validator;

class RegisterController extends Controller
{
    /*
    |--------------------------------------------------------------------------
    | Register Controller
    |--------------------------------------------------------------------------
    |
    | This controller handles the registration of new users as well as their
    | validation and creation. By default this controller uses a trait to
    | provide this functionality without requiring any additional code.
    |
    */

    use RegistersUsers;

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

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

    /**
     * Get a validator for an incoming registration request.
     *
     * @param  array  $data
     * @return \Illuminate\Contracts\Validation\Validator
     */
    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'],
        ]);
    }

    /**
     * Create a new user instance after a valid registration.
     *
     * @param  array  $data
     * @return \App\User
     */
    protected function create(array $data)
    {
        return User::create([
            'name' => $data['name'],
            'email' => $data['email'],
            'password' => Hash::make($data['password']),
        ]);
    }
}

<?php

namespace App\Http\Controllers\Auth;

use App\Http\Controllers\Controller;

use App\Providers\RouteServiceProvider;

use App\User;

use Illuminate\Foundation\Auth\RegistersUsers;

use Illuminate\Support\Facades\Hash;

use Illuminate\Support\Facades\Validator;

class RegisterController extends Controller

{

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

| Register Controller

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

| This controller handles the registration of new users as well as their

| validation and creation. By default this controller uses a trait to

| provide this functionality without requiring any additional code.

use RegistersUsers;

/**

* Where to redirect users after registration.

* @var string

protected $redirectTo = RouteServiceProvider::HOME;

/**

* Create a new controller instance.

* @return void

public function __construct()

{

$this->middleware('guest');

}

/**

* Get a validator for an incoming registration request.

* @param array $data

* @return \Illuminate\Contracts\Validation\Validator

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'],

]);

}

/**

* Create a new user instance after a valid registration.

* @param array $data

* @return \App\User

protected function create(array $data)

{

return User::create([

'name' => $data['name'],

'email' => $data['email'],

'password' => Hash::make($data['password']),

]);

}

内容

コントローラーの機能

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

このコントローラーは、新規ユーザーの登録、入力バリデーション、データ作成とともに行う
デフォルトではこの機能をIlluminate\Foundation\Auth\RegistersUsersトレイトで実装し、追加のコードなしで上記の機能を提供

RegistersUsersトレイトの導入

use RegistersUsers;

1	use RegistersUsers;

登録後の遷移先

protected $redirectTo = RouteServiceProvider::HOME;

1	protected $redirectTo = RouteServiceProvider::HOME;

登録後の遷移先を設定している。

コントローラーの生成

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

public function __construct()

{

$this->middleware('guest');

}

コントローラー生成時のコンストラクター。

入力バリデーション

メールアドレスをユーザーIDとして使うため、入力バリデーションでemailにuniqueの制約をかけている。

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'],
    ]);
}

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'],

]);

}

Userモデルインスタンスの作成

ユーザー登録時、パスワードにHash()メソッドを適用して暗号化している。

protected function create(array $data)
{
    return User::create([
        'name' => $data['name'],
        'email' => $data['email'],
        'password' => Hash::make($data['password']),
    ]);
}

protected function create(array $data)

{

return User::create([

'name' => $data['name'],

'email' => $data['email'],

'password' => Hash::make($data['password']),

]);

}

Laravel – $this->guard()

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

ログイン認証の例

たとえばログイン認証のLoginControllerに使われるIllumination\Foundation\Auth\AuthenticatesUsersトレイトのlogin()メソッドは次のような内容。

public function login(Request $request)
{
    // 入力バリデーション
    $this->validateLogin($request);

    // 連続ログインエラーへの対応
    if (method_exists($this, 'hasTooManyLoginAttempts') &&
        $this->hasTooManyLoginAttempts($request)) {
        $this->fireLockoutEvent($request);

        return $this->sendLockoutResponse($request);
    }

    // ログイン認証処理
    if ($this->attemptLogin($request)) {
        return $this->sendLoginResponse($request);
    }

    // ログイン失敗の場合の失敗回数インクリメント
    $this->incrementLoginAttempts($request);

    // ログイン失敗時の処理
    return $this->sendFailedLoginResponse($request);
}

public function login(Request $request)

{

// 入力バリデーション

$this->validateLogin($request);

// 連続ログインエラーへの対応

if (method_exists($this, 'hasTooManyLoginAttempts') &&

$this->hasTooManyLoginAttempts($request)) {

$this->fireLockoutEvent($request);

return $this->sendLockoutResponse($request);

}

// ログイン認証処理

if ($this->attemptLogin($request)) {

return $this->sendLoginResponse($request);

}

// ログイン失敗の場合の失敗回数インクリメント

$this->incrementLoginAttempts($request);

// ログイン失敗時の処理

return $this->sendFailedLoginResponse($request);

}

この中で呼ばれているログイン認証処理のattemptLogin()メソッドは、同じトレイトで定義されている。

protected function attemptLogin(Request $request)
{
    return $this->guard()->attempt(
        $this->credentials($request), $request->filled('remember')
    );
}

protected function attemptLogin(Request $request)

{

return $this->guard()->attempt(

$this->credentials($request), $request->filled('remember')

);

}

ここでguard()というメソッドが出てくる。これは同じAuthenticatesUsersトレイトの最後の方で以下のように定義されているが、そもそもどういうものかよくわからなかったので掘り下げてみたら、どんどん深みにはまってしまった。

/**
 * Get the guard to be used during authentication.
 *
 * @return \Illuminate\Contracts\Auth\StatefulGuard
 */
protected function guard()
{
    return Auth::guard();
}

/**

* Get the guard to be used during authentication.

* @return \Illuminate\Contracts\Auth\StatefulGuard

protected function guard()

{

return Auth::guard();

}

guard()が見当たらない

AuthenticatesUsersトレイトでAuth::guard()が呼ばれているので、まずAuthクラスについて調べてみる。

AuthクラスはAuthenticatesUsersトレイトの最初で以下のようにuse定義されている。

<?php

namespace Illuminate\Foundation\Auth;

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Illuminate\Validation\ValidationException;

trait AuthenticatesUsers
{
    .....
}

<?php

namespace Illuminate\Foundation\Auth;

use Illuminate\Http\Request;

use Illuminate\Support\Facades\Auth;

use Illuminate\Validation\ValidationException;

trait AuthenticatesUsers

{

.....

}

そこでIlluminate\Foundation\Authクラスを見てみると、コメントにstaticメソッドらしきものが書かれているが、クラス定義の本体にはguard()メソッドが見当たらない。

/**
 * @method static \Illuminate\Contracts\Auth\Guard|\Illuminate\Contracts\Auth\StatefulGuard guard(string|null $name = null)
.....

class Auth extends Facade
{
    .....
}

/**

* @method static \Illuminate\Contracts\Auth\Guard|\Illuminate\Contracts\Auth\StatefulGuard guard(string|null $name = null)

.....

class Auth extends Facade

{

.....

}

Authクラスの継承元のIlluminate\Support\Facades\Facadeクラスも見てみたが、useしているトレイトも含めてguard()メソッドは定義されていない。

<?php

namespace Illuminate\Support\Facades;

use Closure;
use Mockery;
use Mockery\MockInterface;
use RuntimeException;

abstract class Facade
{
    .....
}

<?php

namespace Illuminate\Support\Facades;

use Closure;

use Mockery;

use Mockery\MockInterface;

use RuntimeException;

abstract class Facade

{

.....

}

マジックメソッド__callStatic()を使っている

__callStatic()の内容

いくつかのサイトを参考にしたところ、__callStatic()というマジックメソッドを使っていることがわかってきた。このマジックメソッドは、クラスに定義されていないstaticメソッドが呼ばれた際に実行される。

Facadeクラスを見てみると、以下のように__callStatic()が定義されていた。

/**
 * Handle dynamic, static calls to the object.
 *
 * @param  string  $method
 * @param  array  $args
 * @return mixed
 *
 * @throws \RuntimeException
 */
public static function __callStatic($method, $args)
{
    $instance = static::getFacadeRoot();

    if (! $instance) {
        throw new RuntimeException('A facade root has not been set.');
    }

    return $instance->$method(...$args);
}

/**

* Handle dynamic, static calls to the object.

* @param string $method

* @param array $args

* @return mixed

* @throws \RuntimeException

public static function __callStatic($method, $args)

{

$instance = static::getFacadeRoot();

if (! $instance) {

throw new RuntimeException('A facade root has not been set.');

}

return $instance->$method(...$args);

}

最初にあったAuth::guard()スタティックメソッドを呼ぶと、このマジックメソッドが呼ばれ、引数の$methodは'guard'、$argsは空の配列となる。

以下で、この__callStatic()の内容を読んでいく。

getFacadeRoot()

メソッドの最初でgetFacadeRoot()メソッドが呼ばれている。最終的に$instanceにはAuthManagerのインスタンスが返されるが、その道筋を追ってみた。最後の部分だけがまだ理解できておらず、参考サイトの受け売りだが。

$instance = static::getFacadeRoot()

1	$instance = static::getFacadeRoot()

このメソッドは同じFacadeクラスで定義されていて、getFacadeAccessor()を引数に与えたresolveFacadeInstance()の戻り値を返している。

/**
 * Get the root object behind the facade.
 *
 * @return mixed
 */
public static function getFacadeRoot()
{
    return static::resolveFacadeInstance(static::getFacadeAccessor());
}

/**

* Get the root object behind the facade.

* @return mixed

public static function getFacadeRoot()

{

return static::resolveFacadeInstance(static::getFacadeAccessor());

}

getFacadeAccessor()

ここでstaticメソッドgetFacaceAccessor()は、Facadeクラスとこれを継承したAuthクラスの両方で定義されている。

FacadeクラスでのgetFacadeAccessor()の定義は、単に「メソッドが定義されていない」という例外を返す。

/**
 * Get the registered name of the component.
 *
 * @return string
 *
 * @throws \RuntimeException
 */
protected static function getFacadeAccessor()
{
    throw new RuntimeException('Facade does not implement getFacadeAccessor method.');
}

/**

* Get the registered name of the component.

* @return string

* @throws \RuntimeException

protected static function getFacadeAccessor()

{

throw new RuntimeException('Facade does not implement getFacadeAccessor method.');

}

一方、Facadeを継承したAuthクラスで定義されたgetFacadeAccessor()は文字列'auth'を返す。

/**
 * Get the registered name of the component.
 *
 * @return string
 */
protected static function getFacadeAccessor()
{
    return 'auth';
}

/**

* Get the registered name of the component.

* @return string

protected static function getFacadeAccessor()

{

return 'auth';

}

getFacadeRoot()がFacadeを継承したAuthクラスから呼ばれると、AuthクラスのstaticメソッドがFacadeクラスのstaticメソッドをオーバーライドして実行される。

この結果、resolveFacadeInstance()の引数には文字列'auth'が与えられる。

resolveFacadeInstance()

引数に'auth'を与えられたresolveFacadeInstance('auth')の挙動を見てみる。

/**
 * Resolve the facade root instance from the container.
 *
 * @param  object|string  $name
 * @return mixed
 */
protected static function resolveFacadeInstance($name)
{
    if (is_object($name)) {
        return $name;
    }

    if (isset(static::$resolvedInstance[$name])) {
        return static::$resolvedInstance[$name];
    }

    if (static::$app) {
        return static::$resolvedInstance[$name] = static::$app[$name];
    }
}

/**

* Resolve the facade root instance from the container.

* @param object|string $name

* @return mixed

protected static function resolveFacadeInstance($name)

{

if (is_object($name)) {

return $name;

}

if (isset(static::$resolvedInstance[$name])) {

return static::$resolvedInstance[$name];

}

if (static::$app) {

return static::$resolvedInstance[$name] = static::$app[$name];

}

流れは以下の通り。

引数$nameの内容は文字列なので、1つ目のifブロックはスルー。
static::$resolvedInstanceはFacadeで定義されていて、$nameに対応したインスタンスがあればそのインスタンスが得られる。
もしインスタンスが登録されていなければ、最後のifブロックでstatic::$app['auth']の内容が登録されて、そのインスタンスが返される。

この$app['auth']がわからなかった。こちらのサイトの内容をひとまず丸呑みする。

static::$appはヘルパーメソッドapp()と同じ動作をする
- static::$app[‘auth]はapp()[‘auth’]と同じ意味
- これはサービスコンテナからauthサービスのインスタンスが起動させる下記のコードと同じことを表す
  
  PHP
  
  app()->make('auth')
  
  1
  
  app()->make('auth')

app()->make(‘auth’)で作成されるサービスはIlluminate\Auth\AuthServiceProviderのregisterメソッドによって登録されており、Immulminate\Auth\AuthMangaerがインスタンス化されている

class AuthServiceProvider extends ServiceProvider
{
    public function register()
    {
        $this->registerAuthenticator();
        $this->registerUserResolver();
        $this->registerAccessGate();
        $this->registerRequirePassword();
        $this->registerRequestRebindHandler();
        $this->registerEventRebindHandler();
    }

    protected function registerAuthenticator()
    {
        $this->app->singleton('auth', function ($app) {
            // Once the authentication service has actually been requested by the developer
            // we will set a variable in the application indicating such. This helps us
            // know that we need to set any queued cookies in the after event later.
            $app['auth.loaded'] = true;

            return new AuthManager($app);
        });

        $this->app->singleton('auth.driver', function ($app) {
            return $app['auth']->guard();
        });
    }
    .....
}

class AuthServiceProvider extends ServiceProvider

{

public function register()

{

$this->registerAuthenticator();

$this->registerUserResolver();

$this->registerAccessGate();

$this->registerRequirePassword();

$this->registerRequestRebindHandler();

$this->registerEventRebindHandler();

}

protected function registerAuthenticator()

{

$this->app->singleton('auth', function ($app) {

// Once the authentication service has actually been requested by the developer

// we will set a variable in the application indicating such. This helps us

// know that we need to set any queued cookies in the after event later.

$app['auth.loaded'] = true;

return new AuthManager($app);

});

$this->app->singleton('auth.driver', function ($app) {

return $app['auth']->guard();

});

}

.....

}

__callStatic()の戻り値

$instanceが適正にセットされれば、_callStatic()は以下のように戻り値を返す。

return $instance->$method(...$args);

1	return $instance->$method(...$args);

__callStatic()が呼ばれたときの$methodがguard()、引数は空だったので、戻り値のメソッドはAuthManager::guard()となる。

guard()はSessionGuard()になる

AuthManager::guard()

結局、attemptLogin()->guard()はAuthManager::guard()となり、その内容は以下の通り。

/**
 * Attempt to get the guard from the local cache.
 *
 * @param  string|null  $name
 * @return \Illuminate\Contracts\Auth\Guard|\Illuminate\Contracts\Auth\StatefulGuard
 */
public function guard($name = null)
{
    $name = $name ?: $this->getDefaultDriver();

    return $this->guards[$name] ?? $this->guards[$name] = $this->resolve($name);
}

/**

* Attempt to get the guard from the local cache.

* @param string|null $name

* @return \Illuminate\Contracts\Auth\Guard|\Illuminate\Contracts\Auth\StatefulGuard

public function guard($name = null)

{

$name = $name ?: $this->getDefaultDriver();

return $this->guards[$name] ?? $this->guards[$name] = $this->resolve($name);

}

引数なしで呼ばれるので、$nameはAuthManager::getDefaultDriver()となる。その内容は以下の通り。

public function getDefaultDriver()
{
    return $this->app['config']['auth.defaults.guard'];
}

public function getDefaultDriver()

{

return $this->app['config']['auth.defaults.guard'];

}

このメソッドは、configディレクトリーにあるauth.phpのdefaultsのキー'guard'に対する値を返す。デフォルトでその内容は'web'となっている。

'defaults' => [
    'guard' => 'web',
    'passwords' => 'users',
],

'defaults' => [

'guard' => 'web',

'passwords' => 'users',

そして、最後のreturn文にある$this->guards[$name]は$this->guards['web']となるが、これが存在しない場合は??演算子の右側が評価されて、AuthManager::resolve('web')が内容としてセットされる。

AuthManager::resolve()

AuthManager::resolve()の内容は以下の通り。

protected function resolve($name)
{
    $config = $this->getConfig($name);

    if (is_null($config)) {
        throw new InvalidArgumentException("Auth guard [{$name}] is not defined.");
    }

    if (isset($this->customCreators[$config['driver']])) {
        return $this->callCustomCreator($name, $config);
    }

    $driverMethod = 'create'.ucfirst($config['driver']).'Driver';

    if (method_exists($this, $driverMethod)) {
        return $this->{$driverMethod}($name, $config);
    }

    throw new InvalidArgumentException(
        "Auth driver [{$config['driver']}] for guard [{$name}] is not defined."
    );
}

protected function resolve($name)

{

$config = $this->getConfig($name);

if (is_null($config)) {

throw new InvalidArgumentException("Auth guard [{$name}] is not defined.");

}

if (isset($this->customCreators[$config['driver']])) {

return $this->callCustomCreator($name, $config);

}

$driverMethod = 'create'.ucfirst($config['driver']).'Driver';

if (method_exists($this, $driverMethod)) {

return $this->{$driverMethod}($name, $config);

}

throw new InvalidArgumentException(

"Auth driver [{$config['driver']}] for guard [{$name}] is not defined."

);

}

最初の実行文で呼ばれるgetConfig('web')により、config/auth.phpのguardsセクションの'web'キーに対応する値が$configとしてセットされる。

protected function getConfig($name)
{
    return $this->app['config']["auth.guards.{$name}"];
}

protected function getConfig($name)

{

return $this->app['config']["auth.guards.{$name}"];

}

auth.phpの該当する部分は以下の通り。

'guards' => [
    'web' => [
        'driver' => 'session',
        'provider' => 'users',
    ],

    'api' => [
        'driver' => 'token',
        'provider' => 'users',
        'hash' => false,
    ],
],

'guards' => [

'web' => [

'driver' => 'session',

'provider' => 'users',

'api' => [

'driver' => 'token',

'provider' => 'users',

'hash' => false,

そして、$driverMethodに文字列連結で生成された文字列'createSessionDriver'が格納される。

$driverMethod = 'create'.ucfirst($config['driver']).'Driver';

1	$driverMethod = 'create'.ucfirst($config['driver']).'Driver';

createSessionDriver()メソッドはAuthManagerに存在するので、ifブロック内の$this->createSessionDriver($name, $config)が実行される。

if (method_exists($this, $driverMethod)) {
    return $this->{$driverMethod}($name, $config);
}

if (method_exists($this, $driverMethod)) {

return $this->{$driverMethod}($name, $config);

}

createSessionDriver()を見ると、$guardとして\Illuminate\Auth\SessionGuardクラスのインスタンスが格納される。

public function createSessionDriver($name, $config)
{
    $provider = $this->createUserProvider($config['provider'] ?? null);

    $guard = new SessionGuard($name, $provider, $this->app['session.store']);

    // When using the remember me functionality of the authentication services we
    // will need to be set the encryption instance of the guard, which allows
    // secure, encrypted cookie values to get generated for those cookies.
    if (method_exists($guard, 'setCookieJar')) {
        $guard->setCookieJar($this->app['cookie']);
    }

    if (method_exists($guard, 'setDispatcher')) {
        $guard->setDispatcher($this->app['events']);
    }

    if (method_exists($guard, 'setRequest')) {
        $guard->setRequest($this->app->refresh('request', $guard, 'setRequest'));
    }

    return $guard;
}

public function createSessionDriver($name, $config)

{

$provider = $this->createUserProvider($config['provider'] ?? null);

$guard = new SessionGuard($name, $provider, $this->app['session.store']);

// When using the remember me functionality of the authentication services we

// will need to be set the encryption instance of the guard, which allows

// secure, encrypted cookie values to get generated for those cookies.

if (method_exists($guard, 'setCookieJar')) {

$guard->setCookieJar($this->app['cookie']);

}

if (method_exists($guard, 'setDispatcher')) {

$guard->setDispatcher($this->app['events']);

}

if (method_exists($guard, 'setRequest')) {

$guard->setRequest($this->app->refresh('request', $guard, 'setRequest'));

}

return $guard;

}

SessionGuardクラスはattempt()メソッドを持つので、最初のattemptLogin()メソッドは以下を実行していることになる。

protected function attemptLogin(Request $request)
{
    return $SessionGuardのインスタンス->attempt(
        $this->credentials($request), $request->filled('remember')
    );
}

protected function attemptLogin(Request $request)

{

return $SessionGuardのインスタンス->attempt(

$this->credentials($request), $request->filled('remember')

);

}

参考サイト

Laravel – ログイン処理の流れ

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

ログインフォーム表示

ルーティング定義

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

メソッド：GET
URL：login
アクション：Auth\LoginController@showLoginForm
ルート名：login

showLoginFormアクション

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

.....
use Illuminate\Foundation\Auth\AuthenticatesUsers;
.....

class LoginController extends Controller
{
    .....
    use AuthenticatesUsers;
    .....
}

.....

use Illuminate\Foundation\Auth\AuthenticatesUsers;

.....

class LoginController extends Controller

{

.....

use AuthenticatesUsers;

.....

}

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

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

trait AuthenticatesUsers
{
    .....
    public function showLoginForm()
    {
        <span class="pl-k">return</span> <span class="pl-en"><span class="pl-token" data-hydro-click="{&quot;event_type&quot;:&quot;code_navigation.click_on_symbol&quot;,&quot;payload&quot;:{&quot;action&quot;:&quot;click_on_symbol&quot;,&quot;repository_id&quot;:7548986,&quot;ref&quot;:&quot;6.x&quot;,&quot;language&quot;:&quot;PHP&quot;,&quot;originating_url&quot;:&quot;https://github.com/laravel/framework/blob/6.x/src/Illuminate/Foundation/Auth/AuthenticatesUsers.php&quot;,&quot;user_id&quot;:null}}" data-hydro-click-hmac="ef26ce1776afd7f9cd106dc44ebf6df058d74ede58cd7afd624f89705e45f651">view</span></span>(<span class="pl-s">'auth.login'</span>);
    }
    .....
}

trait AuthenticatesUsers

{

.....

public function showLoginForm()

{

<span class="pl-k">return</span> <span class="pl-en"><span class="pl-token" data-hydro-click="{"event_type":"code_navigation.click_on_symbol","payload":{"action":"click_on_symbol","repository_id":7548986,"ref":"6.x","language":"PHP","originating_url":"https://github.com/laravel/framework/blob/6.x/src/Illuminate/Foundation/Auth/AuthenticatesUsers.php","user_id":null}}" data-hydro-click-hmac="ef26ce1776afd7f9cd106dc44ebf6df058d74ede58cd7afd624f89705e45f651">view</span></span>(<span class="pl-s">'auth.login'</span>);

}

.....

}

フォームからのPOSTとログイン実行

ルーティング定義

ルーティングファイルにAuth::routes();を記述することで、以下のルーティングが定義される。

メソッド：POST
URI：login
アクション：Auth\LoginController@login

loginアクション

showLoginFormアクションと同じく、loginアクションもAuthenticatesUsersトレイトで定義されている。

trait AuthenticatesUsers
{
    <span class="pl-k">use</span> <span class="pl-v">RedirectsUsers</span>, <span class="pl-v">ThrottlesLogins</span>;
    .....
    public function login(Request $request)
    {
        $this->validateLogin($request);

        // If the class is using the ThrottlesLogins trait, we can automatically throttle
        // the login attempts for this application. We'll key this by the username and
        // the IP address of the client making these requests into this application.
        if (method_exists($this, 'hasTooManyLoginAttempts') &&
            $this->hasTooManyLoginAttempts($request)) {
            $this->fireLockoutEvent($request);

            return $this->sendLockoutResponse($request);
        }

        if ($this->attemptLogin($request)) {
            return $this->sendLoginResponse($request);
        }

        // If the login attempt was unsuccessful we will increment the number of attempts
        // to login and redirect the user back to the login form. Of course, when this
        // user surpasses their maximum number of attempts they will get locked out.
        $this->incrementLoginAttempts($request);

        return $this->sendFailedLoginResponse($request);
    }
    ....
}

trait AuthenticatesUsers

{

<span class="pl-k">use</span> <span class="pl-v">RedirectsUsers</span>, <span class="pl-v">ThrottlesLogins</span>;

.....

public function login(Request $request)

{

$this->validateLogin($request);

// If the class is using the ThrottlesLogins trait, we can automatically throttle

// the login attempts for this application. We'll key this by the username and

// the IP address of the client making these requests into this application.

if (method_exists($this, 'hasTooManyLoginAttempts') &&

$this->hasTooManyLoginAttempts($request)) {

$this->fireLockoutEvent($request);

return $this->sendLockoutResponse($request);

}

if ($this->attemptLogin($request)) {

return $this->sendLoginResponse($request);

}

// If the login attempt was unsuccessful we will increment the number of attempts

// to login and redirect the user back to the login form. Of course, when this

// user surpasses their maximum number of attempts they will get locked out.

$this->incrementLoginAttempts($request);

return $this->sendFailedLoginResponse($request);

}

....

}

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

バリデーション

最初はログインフォームのバリデーション。

 $this->validateLogin($request);

1	$this->validateLogin($request);

validateLogin()メソッドは同じAuthenticatesUsersトレイトで定義されている

protected function validateLogin(Request $request)
{
    $request->validate([
        $this->username() => 'required|string',
        'password' => 'required|string',
    ]);
}

protected function validateLogin(Request $request)

{

$request->validate([

$this->username() => 'required|string',

'password' => 'required|string',

]);

}

連続エラー時の抑止処理

次はログインエラーが連続したときのログイン抑止処理。ここで捕捉されなければ後段のログイン認証に移る。

if (method_exists($this, 'hasTooManyLoginAttempts') &&
    $this->hasTooManyLoginAttempts($request)) {
    $this->fireLockoutEvent($request);

    return $this->sendLockoutResponse($request);
}

if (method_exists($this, 'hasTooManyLoginAttempts') &&

$this->hasTooManyLoginAttempts($request)) {

$this->fireLockoutEvent($request);

return $this->sendLockoutResponse($request);

}

ここで呼ばれているhasTooManyLoginAttempts()、fireLockoutEvent()、sendLockoutResponse()の各メソッドは全てThrottlesLoginsトレイトで定義されている

hasTooManyLoginAttempts()はログイントライ回数のがmaxAttempts()(デフォルトでは5回)を越えているかどうかをチェック

protected function hasTooManyLoginAttempts(Request $request)
{
    return $this->limiter()->tooManyAttempts(
        $this->throttleKey($request), $this->maxAttempts()
    );
}

protected function hasTooManyLoginAttempts(Request $request)

{

return $this->limiter()->tooManyAttempts(

$this->throttleKey($request), $this->maxAttempts()

);

}

fireLockoutEvent()はLockoutイベントを発火させる

Illuminate\Foundation\Auth\ThrottlesLogins
PHP

protected function fireLockoutEvent(Request $request) { event(new Lockout($request)); }

1
2
3
4

protected function fireLockoutEvent(Request $request)
{
event(new Lockout($request));
}

sendLockoutResponse()は一定時間ログインを抑止する

    protected function sendLockoutResponse(Request $request)
    {
        $seconds = $this->limiter()->availableIn(
            $this->throttleKey($request)
        );

        throw ValidationException::withMessages([
            $this->username() => [Lang::get('auth.throttle', [
                'seconds' => $seconds,
                'minutes' => ceil($seconds / 60),
            ])],
        ])->status(Response::HTTP_TOO_MANY_REQUESTS);
    }

protected function sendLockoutResponse(Request $request)

{

$seconds = $this->limiter()->availableIn(

$this->throttleKey($request)

);

throw ValidationException::withMessages([

$this->username() => [Lang::get('auth.throttle', [

'seconds' => $seconds,

'minutes' => ceil($seconds / 60),

])],

])->status(Response::HTTP_TOO_MANY_REQUESTS);

}

表示例。秒数は30秒程度で試行ごとに変化した。

Too many login attempts. Please try again in 37 seconds.

認証チェック

上記で、バリデーションと連続トライ回数以内の確認が通ったなら、attemptLogin()で認証チェックを行う。

if ($this->attemptLogin($request)) {
    return $this->sendLoginResponse($request);
}

if ($this->attemptLogin($request)) {

return $this->sendLoginResponse($request);

}

attemptLogin()は同じAuthenticatesUsersトレイトで定義されている。

protected function attemptLogin(Request $request)
{
    return $this->guard()->attempt(
        $this->credentials($request), $request->filled('remember')
    );
}

protected function attemptLogin(Request $request)

{

return $this->guard()->attempt(

$this->credentials($request), $request->filled('remember')

);

}

$this->guard()はファサード関係の複雑な処理を経て、\Illuminate\Auth\SessionGuardクラスのインスタンスとなる
$this->credentials()は以下のように定義されていて、ユーザー名とパスワードが認証に使われる

Illuminate\Foundation\Auth\AuthenticatesUsers
PHP

protected function credentials(Request $request) { return $request->only($this->username(), 'password'); }

1
2
3
4

protected function credentials(Request $request)
{
return $request->only($this->username(), 'password');
}

SessionGuard::attempt()は以下のように認証・ログインを行う

public function attempt(array $credentials = [], $remember = false)
{
    $this->fireAttemptEvent($credentials, $remember);

    $this->lastAttempted = $user = $this->provider->retrieveByCredentials($credentials);

    // If an implementation of UserInterface was returned, we'll ask the provider
    // to validate the user against the given credentials, and if they are in
    // fact valid we'll log the users into the application and return true.
    if ($this->hasValidCredentials($user, $credentials)) {
        $this->login($user, $remember);

        return true;
    }

    // If the authentication attempt fails we will fire an event so that the user
    // may be notified of any suspicious attempts to access their account from
    // an unrecognized user. A developer may listen to this event as needed.
    $this->fireFailedEvent($user, $credentials);

    return false;
}

public function attempt(array $credentials = [], $remember = false)

{

$this->fireAttemptEvent($credentials, $remember);

$this->lastAttempted = $user = $this->provider->retrieveByCredentials($credentials);

// If an implementation of UserInterface was returned, we'll ask the provider

// to validate the user against the given credentials, and if they are in

// fact valid we'll log the users into the application and return true.

if ($this->hasValidCredentials($user, $credentials)) {

$this->login($user, $remember);

return true;

}

// If the authentication attempt fails we will fire an event so that the user

// may be notified of any suspicious attempts to access their account from

// an unrecognized user. A developer may listen to this event as needed.

$this->fireFailedEvent($user, $credentials);

return false;

}

SessionGuard::login()メソッドでは、セッション更新、Rememberトークン処理、ユーザーのセットなどが行われる

ログイン失敗時のカウント

ログイン失敗時には失敗回数をカウントアップする。この結果は連続エラーのチェックで参照される。

// If the login attempt was unsuccessful we will increment the number of attempts
// to login and redirect the user back to the login form. Of course, when this
// user surpasses their maximum number of attempts they will get locked out.
$this->incrementLoginAttempts($request);

return $this->sendFailedLoginResponse($request);

// If the login attempt was unsuccessful we will increment the number of attempts

// to login and redirect the user back to the login form. Of course, when this

// user surpasses their maximum number of attempts they will get locked out.

$this->incrementLoginAttempts($request);

return $this->sendFailedLoginResponse($request);

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)にリダイレクトされる