無名関数はクロージャとも呼ばれ、
関数名を指定せずに関数を作成できるようにするものです。
callable
パラメータとして使う際に便利ですが、用途はそれにとどまりません。
例1 無名関数の例
<?php
echo preg_replace_callback('~-([a-z])~', function ($match) {
return strtoupper($match[1]);
}, 'hello-world');
// helloWorld と出力します
?>
クロージャは、変数の値として使用することもできます。 PHP は、そのような記述があると自動的に内部クラス Closure のインスタンスに変換します。 変数へのクロージャの代入は、他の代入と同じように記述し、 同じく最後にセミコロンをつけます。
例2 変数への無名関数の代入
<?php
$greet = function($name)
{
printf("Hello %s\r\n", $name);
};
$greet('World');
$greet('PHP');
?>
クロージャは、変数を親のスコープから引き継ぐことができます。
引き継ぐ変数は、use で渡さなければなりません。
PHP 7.1 以降は、引き継ぐ値に スーパーグローバル や
$this、
およびパラメータと同じ名前の変数を含めてはいけません。
戻り値の型は、
use の 後
に置かなければいけません。
例3 親のスコープからの変数の引き継ぎ
<?php
$message = 'hello';
// "use" がない場合
$example = function () {
var_dump($message);
};
$example();
// $message を引き継ぎます
$example = function () use ($message) {
var_dump($message);
};
$example();
// 引き継がれた変数の値は、関数が定義された時点のものであり、
// 関数が呼ばれた時点のものではありません
$message = 'world';
$example();
// $message をリセットします
$message = 'hello';
// リファレンス渡しで引き継ぎます
$example = function () use (&$message) {
var_dump($message);
};
$example();
// 親のスコープで変更された値が、
// 関数呼び出しの内部にも反映されます
$message = 'world';
$example();
// クロージャは、通常の引数も受け付けます
$example = function ($arg) use ($message) {
var_dump($arg . ' ' . $message);
};
$example("hello");
// 戻り値の型は、use の後に置きます
$example = function () use ($message): string {
return "hello $message";
};
var_dump($example());
?>
上の例の出力は、 たとえば以下のようになります。
Notice: Undefined variable: message in /example.php on line 6 NULL string(5) "hello" string(5) "hello" string(5) "hello" string(5) "world" string(11) "hello world" string(11) "hello world"
PHP 8.0.0 以降では、親のスコープを継承した変数の一覧の最後にカンマを付けられるようになりました。 このカンマは無視されます。
親のスコープからの変数の引き継ぎは、グローバル変数を使うのとは 異なります。グローバル変数は、 関数が実行されるかどうかにかかわらずグローバルスコープに存在します。 クロージャの親スコープは、クロージャが宣言されている関数です (関数の呼び出し元のスコープである必要はありません)。 次の例を参照ください。
例4 クロージャのスコープ
<?php
// 基本的なショッピングカートで、追加した商品の一覧や各商品の
// 数量を表示します。カート内の商品の合計金額を計算するメソッド
// では、クロージャをコールバックとして使用します。
class Cart
{
const PRICE_BUTTER = 1.00;
const PRICE_MILK = 3.00;
const PRICE_EGGS = 6.95;
protected $products = array();
public function add($product, $quantity)
{
$this->products[$product] = $quantity;
}
public function getQuantity($product)
{
return isset($this->products[$product]) ? $this->products[$product] :
FALSE;
}
public function getTotal($tax)
{
$total = 0.00;
$callback =
function ($quantity, $product) use ($tax, &$total)
{
$pricePerItem = constant(__CLASS__ . "::PRICE_" .
strtoupper($product));
$total += ($pricePerItem * $quantity) * ($tax + 1.0);
};
array_walk($this->products, $callback);
return round($total, 2);
}
}
$my_cart = new Cart;
// カートに商品を追加します
$my_cart->add('butter', 1);
$my_cart->add('milk', 3);
$my_cart->add('eggs', 6);
// 合計に消費税 5% を付加した金額を表示します
print $my_cart->getTotal(0.05) . "\n";
// 結果は 54.29 です
?>
例5 $this の自動バインド
<?php
class Test
{
public function testing()
{
return function() {
var_dump($this);
};
}
}
$object = new Test;
$function = $object->testing();
$function();
?>
上の例の出力は以下となります。
object(Test)#1 (0) {
}
クラスのコンテキストで宣言した場合は、現在のクラスが自動的にバインドされて、
関数のスコープで $this が使えるようになります。
現在のクラスへの自動バインドを望まない場合は、
static な無名関数
を使いましょう。
static を付けて無名関数を宣言することができます。 こうすることで、現在のクラスが無名関数を自動的にバインドすることがなくなります。 オブジェクトも、実行時にはバインドされなくなります。
例6 static な無名関数内での $this の使用例
<?php
class Foo
{
function __construct()
{
$func = static function() {
var_dump($this);
};
$func();
}
};
new Foo();
?>
上の例の出力は以下となります。
Notice: Undefined variable: this in %s on line %d NULL
例7 static な無名関数へのオブジェクトのバインド
<?php
$func = static function() {
// 関数の本体
};
$func = $func->bindTo(new StdClass);
$func();
?>
上の例の出力は以下となります。
Warning: Cannot bind an instance to a static closure in %s on line %d
注意: クロージャ内から func_num_args()、 func_get_arg() および func_get_args() を使用することができます。