Edit Report a Bug

    com_event_sink

    (PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

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

    説明

    com_event_sink(variant $variant, object $sink_object, array|string|null $sink_interface = null): bool

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

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

    パラメータ

    variant

    sink_object

    sink_object には、要求されるディスパッチ インターフェイスと同じ名前のメソッドを持つクラスのインスタンスを 指定する必要があります。この要求を満たすクラスを作成するために、 com_print_typeinfo() を使用することができます。

    sink_interface

    PHP は variant に関連するタイプライブラリで 指定されたデフォルトのディスパッチインターフェイスを使用しようと しますが、使用させたいインターフェイス名を sink_interface に指定することで、それを 上書きすることが可能です。

    戻り値

    成功した場合に true を、失敗した場合に false を返します。

    変更履歴

    バージョン 説明
    8.0.0 sink_interface は、nullable になりました。

    例

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

    <?php
    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;
    ?>

    注意

    警告

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

    参考

    • com_print_typeinfo() - ディスパッチインターフェイスのために、PHP のクラス定義を出力する
    • com_message_pump() - COM メッセージを処理し、timeoutms ミリ秒の間待つ

    add a note add a note

    User Contributed Notes 2 notes

    up
    1
    veggie
    7 years ago
    I got voice recognition working. I'm not sure why the way I called the sink function made it work but I'm more about results right now. This small example had me rolling on the floor laughing.

    <?php
    /*
    * Search this for more info on the voice stuff:
    * Automation Interfaces and Objects (SAPI 5.4)
    */

    //directions:
    //php friend.php
    //then fire up windows voice recognition and turn it on and say stuff

    $voice = new COM("SAPI.SpVoice");

    print     "Hit control+c to end.\n";
    print     "Friend: Hello friend!\n";

    $voice->Speak("Hello friend!");

    class     listen
    {
       
        function     Recognition($StreamNumber, $StreamPosition, $RecognitionType, $ISpeechRecoResult)
        {
           
                $phrase = $ISpeechRecoResult->PhraseInfo;
                $text = $phrase->GetText();
           
            print     "\nYou:$text\n";
        
           
            global     $voice;
                $say = array('oh', 'nice', 'humm', 'interesting', 'you dont say', 'uh huh', 'right', 'what', 'ha ha', 'you have got to be joking', 'right back at you buddy');
                $idx = rand(0, count($say)-1);
           
            print     "Friend: " . $say[$idx] . "\n";
                $voice->Speak($say[$idx]);
           
        }
       
    }

    $recog = new COM("SAPI.SpSharedRecognizer");

    $context = $recog->CreateRecoContext();

    //SRERecognition = 16 (default)
    //SREAllEvents = 393215
    //$context->EventInterests = 393215;

    //try to listen to events on context
    $listen = new listen(); //event handler
    if (!com_event_sink($context, $listen, "RecognizerStateChange"))
    {
        print     "Unable to sink events\n";
        exit;
    }

    $grammar = $context->CreateGrammar();

    $i = $grammar->DictationLoad();

    $s = $grammar->DictationSetState(1); //1=on, 0=off

    while(true)
    {
       
        if(!    com_message_pump(1000))
        {
            print     ".";
        }
       
    }

    ?>
    up
    0
    fjortiz
    19 years ago
    In case someone needs a skeleton sink for ADODB.Connection events:

    class ADOConnectionEventSink    {

        function BeginTransComplete( $translevel, $objerror, $status, $objconn )    {
            return 0;
        }

        function CommitTransComplete( $objerror, $status, $objconn )    {
            return 0;
        }

        function RolbackTransComplete( $objerror, $status, $objconn )    {
            return 0;
        }

        function WillConnect ( $ConnectionString, $userid, $psword, $options, $status, $objconn )    {
            return 0;
        }

        function ConnectComplete ( $objerror, $status, $objconn)    {
            return 0;
        }

        function Disconnect( $status, $objConn )    {
            return 0;
        }

        function WillExecute ( $src, $cursortyp, $locktyp, $options, $status, $objcomm, $objrs, $objconn )    {
            return 0;
        }

        function ExecuteComplete ( $recaffected, $objerror, $status, $objcomm, $objrs, $objconn )    {
            return 0;
        }

        function InfoMessage ( $objerror, $status, $objconn)    {
            return 0;
        }
    }

    // later on...
    $db = new COM("ADODB.Connection", NULL, $charPage);
    $sink = new ADOConnectionEventSink();
    com_event_sink($db, $sink, "ConnectionEvents");
    //...
    add a note add a note
    To Top