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

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

基本

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

$closure = function() {
  echo 'I am a closure.', PHP_EOL;
};
$closure();
// I am a closure.

$closure = function() {

echo 'I am a closure.', PHP_EOL;

};

$closure();

// I am a closure.

戻り値を返す例。

$closure = function() {
  return 'A closure returning string' . PHP_EOL;
};
echo $closure();
// A closure returning string

$closure = function() {

return 'A closure returning string' . PHP_EOL;

};

echo $closure();

// A closure returning string

引数をとる例。

$double = function($num) {
  $result = $num . ' times 2 equals ' . $num * 2 . PHP_EOL;
  return $result;
};
echo $double(9);
// 9 times 2 equals 18

$double = function($num) {

$result = $num . ' times 2 equals ' . $num * 2 . PHP_EOL;

return $result;

};

echo $double(9);

// 9 times 2 equals 18

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

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

$call = 'Hello';

$greet = function($name) use($call) {
  echo $call, ', ', $name, '!', PHP_EOL;
};

$call = 'Hi';

$greet('John');
// Hello, John!

$call = 'Hello';

$greet = function($name) use($call) {

echo $call, ', ', $name, '!', PHP_EOL;

};

$call = 'Hi';

$greet('John');

// Hello, John!

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

コールバック

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

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

function greet($name, $callback) {
  echo $callback($name) . PHP_EOL;
}

function greet($name, $callback) {

echo $callback($name) . PHP_EOL;

}

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

greet('Jane', function($name) {
  return 'Hi, ' . $name;
});
// Hi, Jane

greet('Jane', function($name) {

return 'Hi, ' . $name;

});

// Hi, Jane

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

greet('George', function($name) {
  return 'Hello ' . $name . '. How are you?';
});
// Hello George. How are you?

greet('George', function($name) {

return 'Hello ' . $name . '. How are you?';

});

// Hello George. How are you?

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

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

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

<?php

$callback1 = function($name) {
  echo 'callback1 usese ', $name, ' for a message.', PHP_EOL;
};

$callback2 = function($name) {
  echo 'callback2 uses ', $name, ' for another message.', PHP_EOL;
};

function dispatch($name, $callback) {
  $callback($name);
}

dispatch('Allen', $callback1);
// callback1 usese Allen for a message.

dispatch('Ben', $callback2);
// callback2 uses Ben for another message.

<?php

$callback1 = function($name) {

echo 'callback1 usese ', $name, ' for a message.', PHP_EOL;

};

$callback2 = function($name) {

echo 'callback2 uses ', $name, ' for another message.', PHP_EOL;

};

function dispatch($name, $callback) {

$callback($name);

}

dispatch('Allen', $callback1);

// callback1 usese Allen for a message.

dispatch('Ben', $callback2);

// callback2 uses Ben for another message.

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

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

function callback1($name) {
  echo 'callback1 usese ', $name, ' for a message.', PHP_EOL;
}

function callback2($name) {
  echo 'callback2 uses ', $name, ' for another message.', PHP_EOL;
}

function another_dispatch($name, $callback) {
  $callback($name);
}

another_dispatch('Allen', 'callback1');
// callback1 usese Allen for a message.

another_dispatch('Ben', 'callback2');
// callback2 uses Ben for another message.

function callback1($name) {

echo 'callback1 usese ', $name, ' for a message.', PHP_EOL;

}

function callback2($name) {

echo 'callback2 uses ', $name, ' for another message.', PHP_EOL;

}

function another_dispatch($name, $callback) {

$callback($name);

}

another_dispatch('Allen', 'callback1');

// callback1 usese Allen for a message.

another_dispatch('Ben', 'callback2');

// callback2 uses Ben for another message.

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

array_map()の例

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

array_map($callback, $array);

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

<?php

$array = range(1, 5);

$mapped_array = array_map(function($n) { return $n * $n; }, $array);

var_export($mapped_array); echo PHP_EOL;

// array (
//   0 => 1,
//   1 => 4,
//   2 => 9,
//   3 => 16,
//   4 => 25,
// )

<?php

$array = range(1, 5);

$mapped_array = array_map(function($n) { return $n * $n; }, $array);

var_export($mapped_array); echo PHP_EOL;

// array (

// 0 => 1,

// 1 => 4,

// 2 => 9,

// 3 => 16,

// 4 => 25,

// )

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

PHP – 関数 – 可変関数

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

基本

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

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

<?php

function add(int $a, int $b) {
  echo $a + $b, PHP_EOL;
}

function subtract(int $a, int $b) {
  echo $a - $b, PHP_EOL;
}

$f = 'add';
$f(1, 2);
// 3

$f = 'subtract';
$f(1, 2);
// -1

<?php

function add(int $a, int $b) {

echo $a + $b, PHP_EOL;

}

function subtract(int $a, int $b) {

echo $a - $b, PHP_EOL;

}

$f = 'add';

$f(1, 2);

// 3

$f = 'subtract';

$f(1, 2);

// -1

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

$f = 'multiply';
$f(1, 2);
// Error: Call to undefined function multiply()

$f = 100;
$f(1, 2);
// Error: Function name must be a string

$f = 'multiply';

$f(1, 2);

// Error: Call to undefined function multiply()

$f = 100;

$f(1, 2);

// Error: Function name must be a string

言語構造の場合

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

$f = 'eval';
$f('echo "Hello" . PHP_EOL;');
// Error: Call to undefined function eval()

function wrapper($str) {
  return eval($str);
}
$f = 'wrapper';
$f('echo "Hello" . PHP_EOL;');
// Hello

$f = 'eval';

$f('echo "Hello" . PHP_EOL;');

// Error: Call to undefined function eval()

function wrapper($str) {

return eval($str);

}

$f = 'wrapper';

$f('echo "Hello" . PHP_EOL;');

// Hello

ビルトイン関数

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

$f = 'sqrt';
echo $f(2), PHP_EOL;
// 1.4142135623731

$f = 'sqrt';

echo $f(2), PHP_EOL;

// 1.4142135623731

メソッド

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

class Person {
  public static function greet() {
    echo 'Hello', PHP_EOL;
  }

  private $name;

  public function __construct($name) {
    $this->name = $name;
  }

  public function introduce() {
    echo 'My name is ', $this->name, PHP_EOL;
  }
}

$tom = new Person('Tom');

$say_a_word = 'greet';
Person::$say_a_word();
// Hello

$say_a_word = 'introduce';
$tom->$say_a_word();
// My name is Tom

class Person {

public static function greet() {

echo 'Hello', PHP_EOL;

}

private $name;

public function __construct($name) {

$this->name = $name;

}

public function introduce() {

echo 'My name is ', $this->name, PHP_EOL;

}

$tom = new Person('Tom');

$say_a_word = 'greet';

Person::$say_a_word();

// Hello

$say_a_word = 'introduce';

$tom->$say_a_word();

// My name is Tom

PHP – 関数 – 可変長引数

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

…$args

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

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

<?php

function var_args(string ...$args) {
  echo var_export($args, true) . PHP_EOL;
  return;
}

var_args('Allen', 'Bill', 'Charley');
// array (
//   0 => 'Allen',
//   1 => 'Bill',
//   2 => 'Charley',
// )

var_args('Allen');
// array (
//   0 => 'Allen',
// )

var_args();
// array (
// )

<?php

function var_args(string ...$args) {

echo var_export($args, true) . PHP_EOL;

return;

}

var_args('Allen', 'Bill', 'Charley');

// array (

// 0 => 'Allen',

// 1 => 'Bill',

// 2 => 'Charley',

// )

var_args('Allen');

// array (

// 0 => 'Allen',

// )

var_args();

// array (

// )

型の混在

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

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

function mixed_args(...$args) {
  var_dump($args, true);
  return;
}

mixed_args('zero', 1, 2.0);
// array(3) {
//   [0] =>
//   string(4) "zero"
//   [1] =>
//   int(1)
//   [2] =>
//   double(2)
// }

function mixed_args(...$args) {

var_dump($args, true);

return;

}

mixed_args('zero', 1, 2.0);

// array(3) {

// [0] =>

// string(4) "zero"

// [1] =>

// int(1)

// [2] =>

// double(2)

// }

単純引数との混在

最後尾は可能

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

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

unction following($arg1, ...$others) {
  var_dump($arg1);
  var_dump($others);
  return;
}

following('one', 1, 'three');
// array(2) {
//   [0] =>
//   int(2)
//   [1] =>
//   string(5) "three"
// }

following('one');
// string(3) "one"
// array(0) {
// }

following();
// ArgumentCountError: Too few arguments to function following(), 0 passed

unction following($arg1, ...$others) {

var_dump($arg1);

var_dump($others);

return;

}

following('one', 1, 'three');

// array(2) {

// [0] =>

// int(2)

// [1] =>

// string(5) "three"

// }

following('one');

// string(3) "one"

// array(0) {

// }

following();

// ArgumentCountError: Too few arguments to function following(), 0 passed

先頭や中間は不可

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

function middle($head, ...$args, $tail) {
  return;
}
// Fatal error: Only the last parameter can be variadic

function preceding(...$args, $another) {
  return;
}
// Fatal error: Only the last parameter can be variadic

function middle($head, ...$args, $tail) {

return;

}

// Fatal error: Only the last parameter can be variadic

function preceding(...$args, $another) {

return;

}

// Fatal error: Only the last parameter can be variadic

逆の使い方

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

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

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

$array = [2, 3, 1, 5, 4];
echo max(...$array) . PHP_EOL;
// 5

echo min(...$array) . PHP_EOL;
// 1

$array = [2, 3, 1, 5, 4];

echo max(...$array) . PHP_EOL;

// 5

echo min(...$array) . PHP_EOL;

// 1

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

$array = [2, 4];
echo pow(...$array) . PHP_EOL;
// 16

$array = [2, 4];

echo pow(...$array) . PHP_EOL;

// 16

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

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

概要

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

例

function dices(int $dices, int $trials=5, string $separator=',') {
  for ($i = 0; $i < $dices; $i++) {
    echo random_int(1, 6);
    for ($j = 1; $j < $trials; $j++) {
      echo $separator . random_int(1, 6);
    }
    echo PHP_EOL;
  }
}

dices(2, 5, ',');
// 2,4,5,3,5
// 2,5,5,1,2

dices(2);
// 4,3,4,1,1
// 2,1,3,6,4

dices(2, ',');
// TypeError: Argument 2 passed to dices() must be of the type int, string given

function dices(int $dices, int $trials=5, string $separator=',') {

for ($i = 0; $i < $dices; $i++) {

echo random_int(1, 6);

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

echo $separator . random_int(1, 6);

}

echo PHP_EOL;

}

dices(2, 5, ',');

// 2,4,5,3,5

// 2,5,5,1,2

dices(2);

// 4,3,4,1,1

// 2,1,3,6,4

dices(2, ',');

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

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

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

function dices(int $dices, $trials=5, string $separator=',') {
  for ($i = 0; $i < $dices; $i++) {
    echo random_int(1, 6);
    for ($j = 1; $j < $trials; $j++) {
      echo $separator . random_int(1, 6);
    }
    echo PHP_EOL;
  }
}

dices(2, ',');
// 2
// 5

function dices(int $dices, $trials=5, string $separator=',') {

for ($i = 0; $i < $dices; $i++) {

echo random_int(1, 6);

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

echo $separator . random_int(1, 6);

}

echo PHP_EOL;

}

dices(2, ',');

// 2

// 5

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をサーバー上で実行する場合、変数の内容をブラウザーに表示させるいくつかの方法を整理。いずれの方法でも改行に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 – ログイン処理の流れ

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);