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

Обязывает объект COM пробрасывать сообщения, созданные variant в объект PHP sink_object.

Будьте осторожны с этой возможностью. Если вы будете делать что-то похожее на пример ниже, то это не будет иметь никакого смысла при запуске в контексте веб-сервера.

Список параметров

variant
sink_object: sink_object должен быть экземпляром класса с методами, названными как в выбранном диспетчерском интерфейсе; вы можете использовать функцию com_print_typeinfo() для помощи в генерации шаблона класса.
sink_interface: PHP будет пытаться использовать тип диспетчерского интерфейса по умолчанию, как указано в библиотеке типов, связанной с variant, но вы можете изменить такое поведение, задав в sink_interface имя желаемого диспетчерского интерфейса.

Возвращаемые значения

Возвращает true в случае успешного выполнения или false в случае возникновения ошибки.

Список изменений

Версия	Описание
8.0.0	`sink_interface` теперь допускает значение null.

Примеры

Пример #1 Пример com_event_sink

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

   function ProgressChange($progress, $progressmax) {
      echo "Прогресс загрузки: $progress / $progressmax\n";
    }

    function DocumentComplete(&$dom, $url) {
      echo "Загрузка $url завершена\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;
?>

Примечания

Предостережение

До PHP 8.0.0 вызов exit() из любого обработчика события не поддерживался и мог привести к зависанию PHP. Это можно обойти, выбрасывая исключение из обработчика события, перехватывая исключение в основном коде и вызывая оттуда exit().

Смотрите также

com_print_typeinfo() - Печатает определение класса PHP для интерфейса, наследующего IDispatch
com_message_pump() - Обработка сообщений COM, пришедших не позднее timeoutms миллисекунд после её запуска

add a note

User Contributed Notes 2 notes

down

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 ".";
    }
    
}

?>

down

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