php-doc-en/reference/com/com.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/com.xml, last change in rev 1.12 -->
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.com" xmlns="http://docbook.org/ns/docbook">
 <titleabbrev>COM</titleabbrev>
 <title>The COM class</title>
 <partintro>

 <section xml:id="class.com.class">
  <title>Description</title>
  <simpara>
   The COM class allows you to instantiate an OLE compatible COM object and
   call its methods and access its properties.
  </simpara>
  <simpara>
   <literal>$obj = new COM("Application.ID")</literal>
  </simpara>
 </section>
 <section xml:id="com.com">
  <title>Methods</title>
  <methodsynopsis>
   <methodname>COM::__construct</methodname>
   <methodparam><type>string</type><parameter>module_name</parameter></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>server_name</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>codepage</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>typelib</parameter></methodparam>
  </methodsynopsis>
  <para>
   COM class constructor. The parameters have the following meanings:
   <variablelist>
    <varlistentry>
     <term>module_name</term>
     <listitem>
      <simpara>
       Can be a ProgID, Class ID or Moniker that names the component to load.
      </simpara>
      <simpara>
       A ProgID is typically the application or DLL name, followed by a period,
       followed by the object name. e.g: <literal>Word.Application</literal>.
      </simpara>
      <simpara>
       A Class ID is the UUID that uniquely identifies a given class.
      </simpara>
      <simpara>
       A Moniker is a special form of naming, similar in concept to a URL
       scheme, that identifies a resource and specifies how it should be
       loaded.  As an example, you could load up Word and get an object
       representing a word document by specifying the full path to the word
       document as the module name, or you can use <literal>LDAP:</literal> as
       a moniker to use the ADSI interface to LDAP.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>server_name</term>
     <listitem>
      <simpara>
       The name of the DCOM server on which the component should be loaded and
       run.  If &null;, the object is run using the default for the
       application.  The default is typically to run it on the local machine,
       although the administrator might have configured the application to
       launch on a different machine.
      </simpara>
      <simpara>
       If you specify a non-&null; value for server, PHP will refuse to load
       the object unless the <xref
       linkend="ini.com.allow-dcom"/> configuration option
       is set to &true;.
      </simpara>
      <para>
       If <parameter>server_name</parameter> is an array, it should contain the
       following elements (case sensitive!).  Note that they are all optional
       (although you need to specify both Username and Password together); if
       you omit the Server setting, the default server will be used (as
       mentioned above), and the instantiation of the object will not be
       affected by the <xref linkend="ini.com.allow-dcom"/>
       directive.
       <table>
        <title>DCOM server name</title>
        <tgroup cols="3">
         <thead>
          <row>
           <entry><parameter>server_name</parameter> key</entry>
           <entry>type</entry>
           <entry>description</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>Server</entry>
           <entry>string</entry>
           <entry>The name of the server.</entry>
          </row>
          <row>
           <entry>Username</entry>
           <entry>string</entry>
           <entry>The username to connect as.</entry>
          </row>
          <row>
           <entry>Password</entry>
           <entry>string</entry>
           <entry>The password for <parameter>Username</parameter>.</entry>
          </row>
          <row>
           <entry>Flags</entry>
           <entry>integer</entry>
           <entry>One or more of the following constants, logically OR'd together:
            <constant>CLSCTX_INPROC_SERVER</constant>,
            <constant>CLSCTX_INPROC_HANDLER</constant>,
            <constant>CLSCTX_LOCAL_SERVER</constant>,
            <constant>CLSCTX_REMOTE_SERVER</constant>,
            <constant>CLSCTX_SERVER</constant> and
            <constant>CLSCTX_ALL</constant>.  The default value if not
            specified here is <constant>CLSCTX_SERVER</constant> if you also
            omit <parameter>Server</parameter>, or
            <constant>CLSCTX_REMOTE_SERVER</constant> if you do specify a
            server.  You should consult the Microsoft documentation for
            CoCreateInstance for more information on the meaning of these
            constants; you will typically never have to use them.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>codepage</term>
     <listitem>
      <simpara>
       Specifies the codepage that is used to convert strings to
       unicode-strings and vice versa.  The conversion is applied whenever a
       PHP string is passed as a parameter or returned from a method of this
       COM object.  The code page is sticky in PHP 5, which means that it will
       propagate to objects and variants returned from the object.
      </simpara>
      <simpara>
       Possible values are
       <constant>CP_ACP</constant> (use system default ANSI code page - the
       default if this parameter is omitted),
       <constant>CP_MACCP</constant>,
       <constant>CP_OEMCP</constant>, <constant>CP_SYMBOL</constant>,
       <constant>CP_THREAD_ACP</constant> (use codepage/locale set for the
       current executing thread), <constant>CP_UTF7</constant>
       and <constant>CP_UTF8</constant>.  You may also use the number for a
       given codepage; consult the Microsoft documentation for more details on
       codepages and their numeric values.
      </simpara>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </section>

 <section xml:id="class.com.overloadedmethods">
  <title>Overloaded Methods</title>
  <para>
   The returned object is an overloaded object, which means that PHP does
   not see any fixed methods as it does with regular classes; instead, any
   property or method accesses are passed through to COM.
  </para>
  <para>
   Starting with PHP 5, PHP will automatically detect methods that accept
   parameters by reference, and will automatically convert regular PHP
   variables to a form that can be passed by reference.  This means that you
   can call the method very naturally; you needn't go to any extra effort in
   your code.
  </para>
 </section>

 <section xml:id="class.com.falsemethods">
  <title>Pseudo Methods</title>
  <para>
   In PHP versions prior to 5, a number of not very pleasant hacks meant that
   the following method names were not passed through to COM and were handled
   directly by PHP.  PHP 5 eliminates these things; read the details below to
   determine how to fix your scripts.  These magic method names are case
   insensitive.
  </para>
  <methodsynopsis xml:id="com.addref">
   <type>void</type><methodname>COM::AddRef</methodname>
   <void/>
  </methodsynopsis>
  <simpara>
   Artificially adds a reference count to the COM object.
  </simpara>
  <warning>
   <simpara>
    You should never need to use this method. It exists as a logical complement
    to the Release() method below.
   </simpara>
  </warning>
  <methodsynopsis xml:id="com.release">
   <type>void</type><methodname>COM::Release</methodname>
   <void/>
  </methodsynopsis>
  <simpara>
   Artificially removes a reference count from the COM object.
  </simpara>
  <warning>
   <simpara>
    You should never need to use this method.  Its existence in PHP is a bug
    designed to work around a bug that keeps COM objects running longer than
    they should.
   </simpara>
  </warning>
 </section>
 <section xml:id="class.com.iteratormethods">
  <title>Pseudo Methods for Iterating</title>
  <para>
   These pseudo methods are only available if
   <function>com_isenum</function> returns &true;, in which case, they hide
   any methods with the same names that might otherwise be provided by the
   COM object.  These methods have all been eliminated in PHP 5, and you
   should use <xref linkend="com.examples.foreach"/> instead.
  </para>
  <methodsynopsis xml:id="com.all">
   <type>variant</type><methodname>COM::All</methodname>
   <void/>
  </methodsynopsis>
  <simpara>
   Returns a variant representing a SafeArray that has 10 elements;
   each element will be an empty/null variant.  This function was supposed to
   return an array containing all the elements from the iterator, but was
   never completed.  Do not use.
  </simpara>
  <methodsynopsis xml:id="com.next">
   <type>variant</type><methodname>COM::Next</methodname>
   <void/>
  </methodsynopsis>
  <simpara>
   Returns a variant representing the next element available from
   the iterator, or &false; when there are no more elements.
  </simpara>
  <methodsynopsis xml:id="com.prev">
   <type>variant</type><methodname>COM::Prev</methodname>
   <void/>
  </methodsynopsis>
  <simpara>Returns a variant representing the previous element available from
   the iterator, or &false; when there are no more elements.
  </simpara>
  <methodsynopsis xml:id="com.reset">
   <type>void</type><methodname>COM::Reset</methodname>
   <void/>
  </methodsynopsis>
  <simpara>
   Rewinds the iterator back to the start.
  </simpara>
 </section>
 <section xml:id="class.com.examples">
  <title>COM examples</title>
  <para>
   <example xml:id="example.com1">
    <title>COM example (1)</title>
    <programlisting role="php">
<![CDATA[
<?php
// starting word
$word = new COM("word.application") or die("Unable to instantiate Word");
echo "Loaded Word, version {$word->Version}\n";

//bring it to front
$word->Visible = 1;

//open an empty document
$word->Documents->Add();

//do some weird stuff
$word->Selection->TypeText("This is a test...");
$word->Documents[1]->SaveAs("Useless test.doc");

//closing word
$word->Quit();

//free the object
$word = null;
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example xml:id="example.com2">
    <title>COM example (2)</title>
    <programlisting role="php">
<![CDATA[
<?php

$conn = new COM("ADODB.Connection") or die("Cannot start ADO");
$conn->Open("Provider=SQLOLEDB; Data Source=localhost;
Initial Catalog=database; User ID=user; Password=password");

$rs = $conn->Execute("SELECT * FROM sometable");    // Recordset

$num_columns = $rs->Fields->Count();
echo $num_columns . "\n";

for ($i=0; $i < $num_columns; $i++) {
    $fld[$i] = $rs->Fields($i);
}

$rowcount = 0;
while (!$rs->EOF) {
    for ($i=0; $i < $num_columns; $i++) {
        echo $fld[$i]->value . "\t";
    }
    echo "\n";
    $rowcount++;            // increments rowcount
    $rs->MoveNext();
}

$rs->Close();
$conn->Close();

$rs = null;
$conn = null;

?>
]]>
    </programlisting>
   </example>
  </para>
 </section>

 </partintro>
</phpdoc:classref>

<!-- 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
-->