【PHP8.x】Closure::__invoke()メソッドの使い方

Copy
1<?php
2
3/**
4 * クロージャを定義します。
5 * このクロージャは、関数のように呼び出されたときにClosureクラスの__invokeメソッドが実行されます。
6 * リファレンス情報「引数: mixed ...$args」に従い、様々な型の可変長引数を受け取ります。
7 */
8$processor = function (mixed ...$args): string {
9    if (empty($args)) {
10        return "引数は提供されませんでした。\n";
11    }
12
13    // 受け取ったすべての引数を処理し、出力用の文字列を生成します。
14    $outputParts = ["受け取った引数 (" . count($args) . "個):"];
15    foreach ($args as $index => $arg) {
16        // 引数の型に応じて適切な文字列表現を生成します。
17        if (is_string($arg)) {
18            $outputParts[] = "'" . $arg . "'"; // 文字列はクォートする
19        } elseif (is_array($arg)) {
20            $outputParts[] = "配列[" . implode(', ', $arg) . "]";
21        } elseif (is_bool($arg)) {
22            $outputParts[] = ($arg ? "true" : "false");
23        } elseif (is_object($arg)) {
24            $outputParts[] = "オブジェクト(" . get_class($arg) . ")";
25        } elseif (is_null($arg)) {
26            $outputParts[] = "NULL";
27        } else {
28            $outputParts[] = (string) $arg;
29        }
30    }
31    return implode(' ', $outputParts) . "\n";
32};
33
34// クロージャを関数のように呼び出し、様々な型の引数を渡します。
35// 内部的には、$processorオブジェクトのClosure::__invokeメソッドが実行されます。
36echo $processor("Hello PHP", 8, true);
37echo $processor(["apple", "banana"], 123.45, new stdClass());
38echo $processor("単一の引数", null);
39echo $processor(); // 引数なしの場合
40
41// 引数をPHP 8で導入された名前付き引数のように渡すこともできますが、
42// クロージャの__invokeは通常の関数の呼び出し規則に従うため、ここでは位置引数として扱われます。
43// echo $processor(name: "PHP", version: 8); // これはエラーにはならないが、上記と同じようにmixedで受け取る
44?>

PHP 8におけるClosure::__invokeメソッドは、クロージャ（匿名関数）が定義された変数を関数のように呼び出した際に、内部的に実行される特殊なメソッドです。クロージャはClosureクラスのインスタンスであり、この__invokeメソッドが、そのインスタンスを通常の関数のように呼び出すことを可能にしています。

このメソッドはmixed ...$argsという形で定義されており、呼び出し時に任意の型の引数をいくつでも（可変長で）受け取ることができます。引数が全くない場合も、問題なく呼び出し可能です。また、戻り値もmixedと定義されているため、どのような型の値でも返すことができます。

サンプルコードでは、定義されたクロージャ$processorが、呼び出し時に渡された引数を一つ一つ確認し、それらを分かりやすい文字列として整形して返しています。文字列、数値、配列、真偽値、オブジェクトなど、様々な型の引数を受け取り、その内容を結合したメッセージを生成することで、クロージャが非常に柔軟な引数処理能力を持つことが示されています。これにより、クロージャを通常の関数とほぼ同じ感覚で、多様なデータ処理に活用できることがわかります。

Copy
1<?php
2
3/**
4 * このクロージャ（無名関数）は、関数のように呼び出されたときに
5 * 内部的に Closure::__invoke() メソッドを実行します。
6 *
7 * Closure::__invoke() は、PHPのClosureクラスのインスタンス（クロージャ）が
8 * オブジェクトとしてではなく、関数として呼び出されたときに自動的に実行される
9 * マジックメソッドです。
10 *
11 * この例では、任意の数の引数（mixed ...$args）を受け取り、それら全てを連結した文字列を返します。
12 */
13$concatenateArguments = function (mixed ...$args): string {
14    $result = ""; // 結果を格納する文字列
15    foreach ($args as $arg) {
16        // 引数がスカラ型（文字列、数値、真偽値など）であれば直接連結します。
17        // そうでない場合（配列、オブジェクトなど）は、その型名を文字列として追加します。
18        if (is_scalar($arg)) {
19            $result .= (string)$arg;
20        } else {
21            $result .= "[" . gettype($arg) . "]";
22        }
23    }
24    return $result; // 連結された文字列を返します
25};
26
27// クロージャを関数のように呼び出します。
28// この呼び出しによって、内部的に $concatenateArguments オブジェクトの
29// Closure::__invoke() メソッドが実行され、定義されたロジックが動作します。
30echo "例1: 文字列の連結\n";
31echo $concatenateArguments("Hello", " ", "World", "!"); // 出力: Hello World!
32echo "\n\n";
33
34echo "例2: 数値と真偽値の連結\n";
35echo $concatenateArguments(123, 45.6, true); // 出力: 12345.61
36echo "\n\n";
37
38echo "例3: 異なる型の引数の連結（配列とオブジェクトを含む）\n";
39echo $concatenateArguments("Mix", " ", ["array_value"], " ", new stdClass()); // 出力: Mix [array] [object]
40echo "\n";
41
42?>

PHPのClosure::__invokeメソッドは、クロージャ（無名関数）が関数のように呼び出されたときに、内部で自動的に実行される特別なメソッドです。これにより、クロージャのインスタンスを直接呼び出し、その中に定義された処理を実行することが可能になります。

このサンプルコードでは、$concatenateArgumentsというクロージャを定義しています。これは、mixed ...$argsという形で任意の数のどんな型の引数でも受け取ることができます。受け取った引数は、それぞれが文字列や数値、真偽値のような単純な値（スカラ型）であればそのまま文字列として連結されます。もし引数が配列やオブジェクトのような複雑な型であれば、その型名を文字列として連結します。最終的に、これらの処理を経て連結された一つの文字列を返します。

このように定義されたクロージャを「$concatenateArguments("Hello", "World")」のように関数と同じ形式で呼び出すと、__invokeメソッドが働き、内部のロジックが実行されます。これにより、複数の引数を結合したり、異なる型の値を統合して表示したりする処理が簡潔に実現できます。

Copy
1<?php
2
3/**
4 * Closure::__invoke の使い所を示すサンプルコード。
5 *
6 * PHPにおいて、無名関数（クロージャ）は内部的に`Closure`クラスのインスタンスです。
7 * この`Closure`インスタンスを変数に代入し、その変数を関数のように呼び出す際、
8 * 内部的に`Closure`クラスの`__invoke`マジックメソッドが実行されます。
9 * これにより、オブジェクトがまるで関数であるかのように振る舞うことができます。
10 */
11
12/**
13 * 渡された引数を結合し、指定された挨拶を前置するクロージャを生成します。
14 *
15 * @param string $greeting クロージャが返す文字列の接頭辞として使う挨拶。
16 * @return Closure 複数の引数を受け取り、それらを結合して返すクロージャ。
17 */
18function createGreeter(string $greeting): Closure
19{
20    // 無名関数（クロージャ）を定義し、返します。
21    // このクロージャは、任意の数の引数を受け取ることができます (`mixed ...$args`)。
22    // このクロージャが呼び出されたとき、PHPの内部でClosure::__invoke()が実行されます。
23    return function (mixed ...$args) use ($greeting): string {
24        // 受け取った引数を文字列に変換し、カンマとスペースで結合します。
25        // array_mapと無名関数で各引数を文字列にキャストしています。
26        $combinedArgs = implode(', ', array_map(fn($arg) => (string)$arg, $args));
27        
28        // 挨拶と結合された引数を返します。
29        return $greeting . ': ' . $combinedArgs;
30    };
31}
32
33// createGreeter関数を呼び出して、挨拶の機能を内包したクロージャ（Closureインスタンス）を取得します。
34$sayHello = createGreeter("こんにちは");
35
36// $sayHelloは`Closure`インスタンスですが、関数のように直接呼び出すことができます。
37// この呼び出しの際、内部的に $sayHello オブジェクトの Closure::__invoke() メソッドが実行されます。
38echo $sayHello('皆さん', 'PHP', 8) . PHP_EOL; // 出力: こんにちは: 皆さん, PHP, 8
39
40// 別の引数で同じクロージャを呼び出す例。
41echo $sayHello('世界') . PHP_EOL; // 出力: こんにちは: 世界
42
43// 別のGreetingで新しいクロージャを作成する例。
44$sayGoodbye = createGreeter("さようなら");
45echo $sayGoodbye('また明日') . PHP_EOL; // 出力: さようなら: また明日
46
47?>

PHPにおいて、Closure::__invokeメソッドは、無名関数（クロージャ）を関数のように呼び出す際に内部的に実行される特殊なマジックメソッドです。クロージャはPHPの内部ではClosureクラスのインスタンスであり、この__invokeがあることで、オブジェクトがまるで関数であるかのように振る舞うことができます。

サンプルコードでは、createGreeter関数が、指定された挨拶を記憶したクロージャを生成し、返します。この返されるクロージャは、mixed ...$argsとして任意の数の引数を受け取ることができ、それらを文字列に変換して結合し、記憶した挨拶を前置した文字列を返します。これが__invokeメソッドが実際に返す値となります。

例えば、$sayHello = createGreeter("こんにちは"); のようにcreateGreeter関数を呼び出すと、「こんにちは」という挨拶を内包したClosureインスタンスが$sayHello変数に代入されます。その後、echo $sayHello('皆さん', 'PHP', 8); のように$sayHello変数を直接関数として呼び出すと、内部的に$sayHelloオブジェクトのClosure::__invokeメソッドが自動的に実行されます。このとき、クロージャに渡された引数（'皆さん', 'PHP', 8）が__invokeメソッドの引数として渡され、クロージャ内で定義された処理（引数を結合し、挨拶を前置する）が実行され、「こんにちは: 皆さん, PHP, 8」という文字列が戻り値として返されます。このように、__invokeメソッドは、クロージャが柔軟に振る舞うための仕組みを提供しています。