com-event-sink.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 20216b916ed583938672cd09c2c2f430351430d1 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="function.com-event-sink" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>com_event_sink</refname>
  <refpurpose>Connecte des événements d'un objet COM sur un objet PHP</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>com_event_sink</methodname>
   <methodparam><type>variant</type><parameter>variant</parameter></methodparam>
   <methodparam><type>object</type><parameter>sink_object</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>array</type><type>string</type><type>null</type></type><parameter>sink_interface</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Connecte des événements de l'objet COM
   <parameter>variant</parameter> sur un l'objet PHP
   <parameter>sink_object</parameter>.
  </para>
  <para>
   Soyez prudent sur l'utilisation de cette fonctionnalité ;
   si vous faites quelque chose de similaire à l'exemple
   ci-dessous, cela n'a pas de sens de le lancer sur un serveur Web.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>variant</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>sink_object</parameter></term>
     <listitem>
      <para>
       <parameter>sink_object</parameter> devra être une instance de la classe
       avec des noms de méthodes suivant le dispinterface désiré ; vous devriez
       utiliser <function>com_print_typeinfo</function> pour l'aide à la
       génération d'un gabarit de classe pour cela.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>sink_interface</parameter></term>
     <listitem>
      <para>
       PHP devrait être capable d'utiliser le type par défaut de dispinterface
       spécifié par la Typelib associée avec l'objet <parameter>variant</parameter>,
       mais vous pouvez changer cela en spécifiant dans le paramètre
       <parameter>sink_interface</parameter> le dispinterface que vous
       souhaitez utiliser.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>sink_interface</parameter> is nullable now.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple de connexions d'événements COM</title>
    <programlisting role="php">
<![CDATA[
<?php
class IEEventSinker {
    var $terminated = false;

   function ProgressChange($progress, $progressmax) {
      echo "Progression du téléchargement : $progress / $progressmax\n";
    }

    function DocumentComplete(&$dom, $url) {
      echo "Document $url terminé\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;
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <caution>
   <para>
    Antérieur à PHP 8.0.0, 
    Prior to PHP 8.0.0, appeller <function>exit</function> depuis n'importe
    quel gestionnaire d'événement n'est pas supporté, et peut causer PHP à
    planter. Ceci peut être contourné en lançant une exception depuis un
    gestionnaire d'événement, attrapant l'exception dans le code principal,
    et appeller <function>exit</function> là.
   </para>
  </caution>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>com_print_typeinfo</function></member>
    <member><function>com_message_pump</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->