mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
Move classes outside from functions
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322198 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jakub Vrana
parent
08acb98bb9
commit
122f551481
4 changed files with 65 additions and 56 deletions
|
|
@ -58,6 +58,9 @@
|
|||
&reference.com.constants;
|
||||
&reference.com.error-handling;
|
||||
&reference.com.examples;
|
||||
&reference.com.com;
|
||||
&reference.com.dotnet;
|
||||
&reference.com.variant;
|
||||
&reference.com.reference;
|
||||
|
||||
</book>
|
||||
|
|
|
|||
|
|
@ -1,25 +1,25 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<!-- splitted from ./en/functions/com.xml, last change in rev 1.12 -->
|
||||
<refentry xml:id="class.com" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>COM</refname>
|
||||
<refpurpose>COM class</refpurpose>
|
||||
</refnamediv>
|
||||
<refsynopsisdiv>
|
||||
<synopsis>$obj = new <classname>COM</classname>("Application.ID")</synopsis>
|
||||
</refsynopsisdiv>
|
||||
<refsect1 xml:id="class.com.class">
|
||||
<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>
|
||||
</refsect1>
|
||||
<refsect1 xml:id="class.com.constructor">
|
||||
<simpara>
|
||||
<literal>$obj = new COM("Application.ID")</literal>
|
||||
</simpara>
|
||||
</section>
|
||||
<section xml:id="com.com">
|
||||
<title>Methods</title>
|
||||
<methodsynopsis>
|
||||
<type>com</type><methodname>COM::COM</methodname>
|
||||
<methodname>COM::COM</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>
|
||||
|
|
@ -151,9 +151,9 @@
|
|||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</section>
|
||||
|
||||
<refsect1 xml:id="class.com.overloadedmethods">
|
||||
<section xml:id="class.com.overloadedmethods">
|
||||
<title>Overloaded Methods</title>
|
||||
<para>
|
||||
The returned object is an overloaded object, which means that PHP does
|
||||
|
|
@ -172,9 +172,9 @@
|
|||
of the <xref linkend="class.variant"/> class to wrap the
|
||||
byref parameters.
|
||||
</para>
|
||||
</refsect1>
|
||||
</section>
|
||||
|
||||
<refsect1 xml:id="class.com.falsemethods">
|
||||
<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
|
||||
|
|
@ -183,7 +183,7 @@
|
|||
determine how to fix your scripts. These magic method names are case
|
||||
insensitive.
|
||||
</para>
|
||||
<methodsynopsis>
|
||||
<methodsynopsis xml:id="com.addref">
|
||||
<type>void</type><methodname>COM::AddRef</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
|
@ -196,7 +196,7 @@
|
|||
to the Release() method below.
|
||||
</simpara>
|
||||
</warning>
|
||||
<methodsynopsis>
|
||||
<methodsynopsis xml:id="com.release">
|
||||
<type>void</type><methodname>COM::Release</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
|
@ -210,8 +210,8 @@
|
|||
they should.
|
||||
</simpara>
|
||||
</warning>
|
||||
</refsect1>
|
||||
<refsect1 xml:id="class.com.iteratormethods">
|
||||
</section>
|
||||
<section xml:id="class.com.iteratormethods">
|
||||
<title>Pseudo Methods for Iterating</title>
|
||||
<para>
|
||||
These pseudo methods are only available if
|
||||
|
|
@ -220,7 +220,7 @@
|
|||
COM object. These methods have all been eliminated in PHP 5, and you
|
||||
should use <xref linkend="com.examples.foreach"/> instead.
|
||||
</para>
|
||||
<methodsynopsis>
|
||||
<methodsynopsis xml:id="com.all">
|
||||
<type>variant</type><methodname>COM::All</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
|
@ -230,7 +230,7 @@
|
|||
return an array containing all the elements from the iterator, but was
|
||||
never completed. Do not use.
|
||||
</simpara>
|
||||
<methodsynopsis>
|
||||
<methodsynopsis xml:id="com.next">
|
||||
<type>variant</type><methodname>COM::Next</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
|
@ -238,22 +238,22 @@
|
|||
Returns a variant representing the next element available from
|
||||
the iterator, or &false; when there are no more elements.
|
||||
</simpara>
|
||||
<methodsynopsis>
|
||||
<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>
|
||||
<methodsynopsis xml:id="com.reset">
|
||||
<type>void</type><methodname>COM::Reset</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
<simpara>
|
||||
Rewinds the iterator back to the start.
|
||||
</simpara>
|
||||
</refsect1>
|
||||
<refsect1 xml:id="class.com.examples">
|
||||
</section>
|
||||
<section xml:id="class.com.examples">
|
||||
<title>COM examples</title>
|
||||
<para>
|
||||
<example xml:id="example.com1">
|
||||
|
|
@ -326,8 +326,10 @@ $conn = null;
|
|||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
</section>
|
||||
|
||||
</partintro>
|
||||
</phpdoc:classref>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
|
|
@ -1,24 +1,24 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<refentry xml:id="class.dotnet" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>DOTNET</refname>
|
||||
<refpurpose>DOTNET class</refpurpose>
|
||||
</refnamediv>
|
||||
<refsynopsisdiv>
|
||||
<synopsis>$obj = new <classname>DOTNET</classname>("assembly", "classname")</synopsis>
|
||||
</refsynopsisdiv>
|
||||
<refsect1 xml:id="class.dotnet.class">
|
||||
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.dotnet" xmlns="http://docbook.org/ns/docbook">
|
||||
<titleabbrev>DOTNET</titleabbrev>
|
||||
<title>The DOTNET class</title>
|
||||
<partintro>
|
||||
|
||||
<section xml:id="class.dotnet.class">
|
||||
<title>Description</title>
|
||||
<simpara>
|
||||
The DOTNET class allows you to instantiate a class from a .Net assembly and
|
||||
call its methods and access its properties.
|
||||
</simpara>
|
||||
</refsect1>
|
||||
<refsect1 xml:id="class.dotnet.constructor">
|
||||
<simpara>
|
||||
<literal>$obj = new DOTNET("assembly", "classname")</literal>
|
||||
</simpara>
|
||||
</section>
|
||||
<section xml:id="dotnet.dotnet">
|
||||
<title>Methods</title>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>DOTNET::DOTNET</methodname>
|
||||
<methodname>DOTNET::DOTNET</methodname>
|
||||
<methodparam><type>string</type><parameter>assembly_name</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>codepage</parameter></methodparam>
|
||||
|
|
@ -63,8 +63,10 @@
|
|||
of this feature.
|
||||
</para>
|
||||
</note>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
</section>
|
||||
|
||||
</partintro>
|
||||
</phpdoc:classref>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
|
|
@ -1,14 +1,11 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<refentry xml:id="class.variant" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>VARIANT</refname>
|
||||
<refpurpose>VARIANT class</refpurpose>
|
||||
</refnamediv>
|
||||
<refsynopsisdiv>
|
||||
<synopsis>$vVar = new <classname>VARIANT</classname>($var)</synopsis>
|
||||
</refsynopsisdiv>
|
||||
<refsect1 xml:id="class.variant.class">
|
||||
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.variant" xmlns="http://docbook.org/ns/docbook">
|
||||
<titleabbrev>VARIANT</titleabbrev>
|
||||
<title>VARIANT class</title>
|
||||
<partintro>
|
||||
|
||||
<section xml:id="class.variant.class">
|
||||
<title>Description</title>
|
||||
<simpara>
|
||||
The VARIANT is COM's equivalent of the PHP zval; it is a structure that
|
||||
|
|
@ -16,11 +13,14 @@
|
|||
class provided by the COM extension allows you to have more control over
|
||||
the way that PHP passes values to and from COM.
|
||||
</simpara>
|
||||
</refsect1>
|
||||
<refsect1 xml:id="class.variant.constructor">
|
||||
<simpara>
|
||||
<literal>$vVar = new VARIANT($var)</literal>
|
||||
</simpara>
|
||||
</section>
|
||||
<section xml:id="variant.variant">
|
||||
<title>Methods</title>
|
||||
<methodsynopsis>
|
||||
<type>object</type><methodname>VARIANT::VARIANT</methodname>
|
||||
<methodname>VARIANT::VARIANT</methodname>
|
||||
<methodparam choice="opt"><type>mixed</type><parameter>value</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>codepage</parameter></methodparam>
|
||||
|
|
@ -125,8 +125,10 @@ print "The value is " . $v . "<br/>";
|
|||
<para>
|
||||
See also <function>variant_get_type</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
</section>
|
||||
|
||||
</partintro>
|
||||
</phpdoc:classref>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
Loading…
Reference in a new issue