php invokeとは

Question

PHPでのinvokeとはどのようなものなのでしょうか？
具体的にはスクリプトがオブジェクトを関数としてコールしようとした際にコールされます。の意味がわかりません。他のものとは違う点やなぜそれを使う場面があるのかなどを教えていただけると幸いです。

PHPマニュアルを見た際には以下の説明が記載されており、これだけでは理解することはできませんでした。

__invoke() ¶
__invoke ([ $... ] ) : mixed

__invoke() メソッドは、 スクリプトがオブジェクトを関数としてコールしようとした際にコールされます。

注意:

この機能は PHP 5.3.0 以降で使用可能です。

例4 __invoke() の使用

<?php
class CallableClass
{
    public function __invoke($x)
    {
        var_dump($x);
    }
}
$obj = new CallableClass;
$obj(5);
var_dump(is_callable($obj));
?>

上の例の出力は以下となります。

int(5)
bool(true)

Comments

[hentaiman]

他のものとは？どれも動きが違うのでどれに対しての違いですか？

[退会済みユーザー]

説明不十分でした。

普通の関数とはどの様な点が違うのかをお聞きしたいと思っております！

Answer 1

スクリプトがオブジェクトを関数としてコールしようとした際にコールされます。

オブジェクト化したクラス（クラスのインスタンス）の持つメソッドを実行するには、ご存じの通り以下のようにメソッドを明示的に呼び出す必要があります

class ABC{
  public function ioputs(){
    echo 'called';
  }
}
$obj = new ABC();
$obj->ioputs();

__invokeを定義すると、以下のようにメソッドを指定せずにインスタンス自身を実行した時に呼び出される関数となります

class EFG{
  public function __invoke(){
    echo 'called';
  }
}
$obj = new EFG();
$obj();
$obj->__invoke();//明示的に呼び出すことも可能

なぜそれを使う場面が

以下のようにclass変数によって動作の変わるfunctionを引数に取る関数を定義する場面では使いどころがありそうですが、正直言ってフレームワーク自作するとかでもない限り使いどころは無さそうです。

class INV{
  public $talk = true;

  public function __invoke(){
    if($this->talk){
      $this->talk();
    }else{
      $this->mute();
    }
  }
  public function talk(){
    echo 'talk';
  }
  public function mute(){
    echo '';
  }
}

function func($inFunc){
  $inFunc();
}

$obj = new INV();
func($obj);
$obj->talk=false;
func($obj);

Comments

[退会済みユーザー]

ご回答ありがとうございます。
一点疑問に残るのですが、この場合__construct() でも同じ動作を実装できるかと思うのですがどうでしょうか？

[hentaiman]

出来ませんよ。newした時の動作なので。
この辺の特殊なメソッドは実際試して動作確認した方が早く理解できますよ。

[退会済みユーザー]

下記のサンプルを自身で作成してみて理解することができました。
https://paiza.io/projects/RATl1Bz4DydbMmVFQb0-0Q

Laravel等でinvokeを使用するのはアクションが1つだけであり、そのコントローラーだけを呼び出すだけど実行されるためでしょうか？

[hentaiman]

laravel5.xは使った事ありますが、そのコメントだけだとどの部分のこと言ってるのか分かりません。
呼び出し方法と、invokeが使われている具体的なソースと行を提示して新たに質問するのが良いでしょう。

Answer 2

callableやクロージャの説明見たほうが分かりやすい。
https://www.php.net/manual/ja/language.types.callable.php
https://www.php.net/manual/ja/functions.anonymous.php

入門としては関数を入れた変数に()を付けて実行できる。

$func = function() {
    return 'test';
};

echo $func();

call_user_funcでも同じ。

echo call_user_func($func);

このcall_user_func()に渡せる形式がいろいろとある。

関数ではなくクラスインスタンスとメソッド。

$foo = new Foo();
call_user_func([$foo, 'bar']);
// $foo->bar()と同じ

__invokeはここでメソッドを省略したい時に使える。
メソッドが指定されてなければ__invokeが実行される。

$foo = new Foo();
call_user_func($foo);

最初の()を付ける形も可能。

$foo = new Foo();
$foo();
// $foo->__invoke()を省略してると考えればいい

とはいえ素のPHPで使う場面は少ない。
関数の例はよく使うけど__invokeはLaravelで初めて使った人が多そう。

Comments

[退会済みユーザー]

ご回答ありがとうございます！

Laravelで使われる__invokeに関してはどうして使われるのか分からないのですが、1つのControllerで1つの関数しかない場合__invokeを使用されることが多いのでしょうか？