com_event_sink

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

    com_event_sink — Connect events from a COM object to a PHP object

    Description

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

    Instructs COM to sink events generated by variant into the PHP object sink_object.

    Be careful how you use this feature; if you are doing something similar to the example below, then it doesn't really make sense to run it in a web server context.

    Parameters

    variant

    sink_object

    sink_object should be an instance of a class with methods named after those of the desired dispinterface; you may use com_print_typeinfo() to help generate a template class for this purpose.

    sink_interface

    PHP will attempt to use the default dispinterface type specified by the typelibrary associated with variant, but you may override this choice by setting sink_interface to the name of the dispinterface that you want to use.

    Return Values

    Returns true on success or false on failure.

    Changelog

    Version Description
    8.0.0 sink_interface is nullable now.

    Examples

    Example #1 COM event sink example

    <?php
    class IEEventSinker {
    var     $terminated = false;

    function     ProgressChange($progress, $progressmax) {
    echo     "Download progress: $progress / $progressmax\n";
    }

    function     DocumentComplete(&$dom, $url) {
    echo     "Document $url complete\n";
    }

    function     OnQuit() {
    echo     "Quit!\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;
    ?>

    Notes

    Caution

    Prior to PHP 8.0.0, calling exit() from any of the event handlers is not supported, and may cause PHP to hang. This can be worked around by throwing an exception from the event handler, catching the exception in the main code, and calling exit() from there.

    See Also

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 2 notes

    up
    1
    veggie
    8 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
    To Top