トップページ　→関数リファレンス　→Windows 用のモジュール　→COM　→COM関数

関数・クラス解説

com_event_sink

version:PHP 4 >= 4.2.0, PHP 5, PHP 7 (公式)

COM オブジェクトのイベントを PHP オブジェクトに接続する

公式リファレンス

書式

com_event_sink ( variant $comobject , object $sinkobject [, mixed $sinkinterface ] ) : bool

説明

comobject が生成したイベントを PHP オブジェクト sinkobject に通知するよう、COM に指示します。

この機能を利用する際には注意しましょう。もし以下の例のようなことを行いたいのであれば、Web サーバー上でそれを行うことにはまったく意味がありません。

パラメータ

comobject
sinkobject: sinkobject には、要求されるディスパッチインターフェイスと同じ名前のメソッドを持つクラスのインスタンスを指定する必要があります。この要求を満たすクラスを作成するために、 com_print_typeinfo() を使用することができます。
sinkinterface: PHP は comobject に関連するタイプライブラリで指定されたデフォルトのディスパッチインターフェイスを使用しようとしますが、使用させたいインターフェイス名を sinkinterface に指定することで、それを上書きすることが可能です。

返値

成功した場合に TRUE を、失敗した場合に FALSE を返します。

注意

警告 PHP 8.0.0 より前のバージョンでは、イベントハンドラから exit() を呼ぶことはサポートされていませんでした。そうしてしまうと、PHP がハングする可能性もありました。この事象は、イベントハンドラから例外を投げてメインのコードでキャッチし、 exit() を呼び出すことで回避できます。

サンプル

例1 COM イベントシンクの例 

class IEEventSinker {
    var $terminated = false;

   function ProgressChange($progress, $progressmax) {
      echo "ダウンロードの進行状況: $progress / $progressmax\n";
    }

    function DocumentComplete(&$dom, $url) {
      echo "ドキュメント $url 完了\n";
    }

    function OnQuit() {
      echo "終了!\n";
      $this->terminated = true;
    }
}
$ie = new COM("InternetExplorer.Application");
$sink = new IEEventSinker();
com_event_sink($ie, $sink, "DWebBrowserEvents2");
$ie->Visible = true;
$ie->Navigate("http://www.example.org");
while(!$sink->terminated) {
  com_message_pump(4000);
}
$ie = null;