cvs: phpdoc /en/functions apache.xml array.xml aspell.xml bc.xml bzip2.xml calendar.xml ccvs.xml classobj.xml com.xml cpdf.xml crack.xml ctype.xml
curl.xml cybercash.xml cybermut.xml cyrus.xml datetime.xml dba.xml dbase.xml dbm.xml dbplus.xml dbx.xml dio.xml dir.xml domxml.xml dotnet.xml
errorfunc.xml exec.xml fbsql.xml fdf.xml filepro.xml filesystem.xml fribidi.xml ftp.xml funchand.xml gettext.xml gmp.xml http.xml hw.xml ibase.xml
icap.xml iconv.xml ifx.xml iisfunc.xml image.xml imap.xml info.xml ingres_ii.xml ircg.xml java.xml ldap.xml mail.xml mailparse.xml math.xml
mbstring.xml mcal.xml mcrypt.xml mhash.xml ming.xml misc.xml mnogosearch.xml msession.xml msql.xml mssql.xml muscat.xml mysql.xml ncurses.xml
network.xml nis.xml notes.xml oci8.xml openssl.xml oracle.xml outcontrol.xml overload.xml ovrimos.xml pcntl.xml pcre.xml pdf.xml pfpro.xml pgsql.xml
posix.xml printer.xml pspell.xml qtdom.xml readline.xml recode.xml regex.xml satellite.xml sem.xml sesam.xml session.xml shmop.xml snmp.xml
sockets.xml strings.xml swf.xml sybase.xml uodbc.xml url.xml var.xml vpopmail.xml w32api.xml wddx.xml xml.xml xmlrpc.xml xslt.xml yaz.xml zip.xml
zlib.xml

From: Date: Sat, 02 Feb 2002 15:36:18 +0000
Subject: cvs: phpdoc /en/functions apache.xml array.xml aspell.xml bc.xml bzip2.xml calendar.xml ccvs.xml classobj.xml com.xml cpdf.xml crack.xml ctype.xml
curl.xml cybercash.xml cybermut.xml cyrus.xml datetime.xml dba.xml dbase.xml dbm.xml dbplus.xml dbx.xml dio.xml dir.xml domxml.xml dotnet.xml
errorfunc.xml exec.xml fbsql.xml fdf.xml filepro.xml filesystem.xml fribidi.xml ftp.xml funchand.xml gettext.xml gmp.xml http.xml hw.xml ibase.xml
icap.xml iconv.xml ifx.xml iisfunc.xml image.xml imap.xml info.xml ingres_ii.xml ircg.xml java.xml ldap.xml mail.xml mailparse.xml math.xml
mbstring.xml mcal.xml mcrypt.xml mhash.xml ming.xml misc.xml mnogosearch.xml msession.xml msql.xml mssql.xml muscat.xml mysql.xml ncurses.xml
network.xml nis.xml notes.xml oci8.xml openssl.xml oracle.xml outcontrol.xml overload.xml ovrimos.xml pcntl.xml pcre.xml pdf.xml pfpro.xml pgsql.xml
posix.xml printer.xml pspell.xml qtdom.xml readline.xml recode.xml regex.xml satellite.xml sem.xml sesam.xml session.xml shmop.xml snmp.xml
sockets.xml strings.xml swf.xml sybase.xml uodbc.xml url.xml var.xml vpopmail.xml w32api.xml wddx.xml xml.xml xmlrpc.xml xslt.xml yaz.xml zip.xml
zlib.xml
Groups: php.doc 
Request: Send a blank email to phpdoc+get-969341803@lists.php.net to get a copy of this message
hholzgra Sat Feb 2 10:36:18 2002 EDT Modified files: /phpdoc/en/functions apache.xml array.xml aspell.xml bc.xml bzip2.xml calendar.xml ccvs.xml classobj.xml com.xml cpdf.xml crack.xml ctype.xml curl.xml cybercash.xml cybermut.xml cyrus.xml datetime.xml dba.xml dbase.xml dbm.xml dbplus.xml dbx.xml dio.xml dir.xml domxml.xml dotnet.xml errorfunc.xml exec.xml fbsql.xml fdf.xml filepro.xml filesystem.xml fribidi.xml ftp.xml funchand.xml gettext.xml gmp.xml http.xml hw.xml ibase.xml icap.xml iconv.xml ifx.xml iisfunc.xml image.xml imap.xml info.xml ingres_ii.xml ircg.xml java.xml ldap.xml mail.xml mailparse.xml math.xml mbstring.xml mcal.xml mcrypt.xml mhash.xml ming.xml misc.xml mnogosearch.xml msession.xml msql.xml mssql.xml muscat.xml mysql.xml ncurses.xml network.xml nis.xml notes.xml oci8.xml openssl.xml oracle.xml outcontrol.xml overload.xml ovrimos.xml pcntl.xml pcre.xml pdf.xml pfpro.xml pgsql.xml posix.xml printer.xml pspell.xml qtdom.xml readline.xml recode.xml regex.xml satellite.xml sem.xml sesam.xml session.xml shmop.xml snmp.xml sockets.xml strings.xml swf.xml sybase.xml uodbc.xml url.xml var.xml vpopmail.xml w32api.xml wddx.xml xml.xml xmlrpc.xml xslt.xml yaz.xml zip.xml zlib.xml Log: en Upgrade to DocBook4

Index: phpdoc/en/functions/apache.xml diff -u phpdoc/en/functions/apache.xml:1.22 phpdoc/en/functions/apache.xml:1.23 --- phpdoc/en/functions/apache.xml:1.22 Wed Jan 2 13:05:03 2002 +++ phpdoc/en/functions/apache.xml Sat Feb 2 10:35:52 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.22 $ --> +<!-- $Revision: 1.23 $ --> <reference id="ref.apache"> <title>Apache-specific Functions</title> <titleabbrev>Apache</titleabbrev> @@ -14,12 +14,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>apache_lookup_uri</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>apache_lookup_uri</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> This performs a partial request for a URI. It goes just far enough to obtain all the important information about the given @@ -65,17 +63,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>apache_note</function></funcdef> - <paramdef>string <parameter>note_name</parameter></paramdef> - <paramdef>string - <parameter> - <optional>note_value</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>apache_note</methodname> + <methodparam><type>string</type><parameter>note_name</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + note_value + </parameter></methodparam> + </methodsynopsis> <para> <function>apache_note</function> is an Apache-specific function which gets and sets values in a request's @@ -96,12 +90,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ascii2ebcdic</function></funcdef> - <paramdef>string <parameter>ascii_str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ascii2ebcdic</methodname> + <methodparam><type>string</type><parameter>ascii_str</parameter></methodparam> + </methodsynopsis> <para> <function>ascii2ebcdic</function> is an Apache-specific function which is available only on EBCDIC based operating systems (OS/390, BS2000). @@ -122,12 +114,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ebcdic2ascii</function></funcdef> - <paramdef>string <parameter>ebcdic_str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ebcdic2ascii</methodname> + <methodparam><type>string</type><parameter>ebcdic_str</parameter></methodparam> + </methodsynopsis> <para> <function>ebcdic2ascii</function> is an Apache-specific function which is available only on EBCDIC based operating systems (OS/390, BS2000). @@ -148,12 +138,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>getallheaders</function></funcdef> + <methodsynopsis> + <type>array</type><methodname>getallheaders</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This function returns an associative array of all the HTTP headers in the current request. @@ -202,12 +190,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>virtual</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>virtual</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> <function>virtual</function> is an Apache-specific function which is equivalent to &lt;!--#include virtual...--&gt; in mod_include. @@ -230,12 +216,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>apache_child_terminate</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>apache_child_terminate</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> <function>apache_child_terminate</function> will terminate the Apache process executing the current PHP request once it is completed. It may be @@ -256,14 +240,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>apache_setenv</function></funcdef> - <paramdef>string <parameter>variable</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - <paramdef>bool <parameter><optional>walk_to_top</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>apache_setenv</methodname> + <methodparam><type>string</type><parameter>variable</parameter></methodparam> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>walk_to_top</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -292,3 +274,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/array.xml diff -u phpdoc/en/functions/array.xml:1.156 phpdoc/en/functions/array.xml:1.157 --- phpdoc/en/functions/array.xml:1.156 Sun Jan 27 11:47:17 2002 +++ phpdoc/en/functions/array.xml Sat Feb 2 10:35:52 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.156 $ --> +<!-- $Revision: 1.157 $ --> <reference id="ref.array"> <title>Array Functions</title> <titleabbrev>Arrays</titleabbrev> @@ -36,14 +36,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>array</function></funcdef> - <paramdef>mixed - <parameter><optional>...</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>array</methodname> + <methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam> + </methodsynopsis> <para> Returns an array of the parameters. The parameters can be given an index with the <literal>=&gt;</literal> operator. @@ -152,13 +148,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>array_change_key_case</function></funcdef> - <paramdef>array <parameter>input</parameter></paramdef> - <paramdef>int <parameter><optional>case</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>array_change_key_case</methodname> + <methodparam><type>array</type><parameter>input</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>case</parameter></methodparam> + </methodsynopsis> <para> <function>array_change_key_case</function> changes the keys in the <parameter>input</parameter> array to @@ -201,14 +195,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>array_chunk</function></funcdef> - <paramdef>array <parameter>input</parameter></paramdef> - <paramdef>int <parameter>size</parameter></paramdef> - <paramdef>bool <parameter><optional>preserve_keys</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>array_chunk</methodname> + <methodparam><type>array</type><parameter>input</parameter></methodparam> + <methodparam><type>int</type><parameter>size</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>preserve_keys</parameter></methodparam> + </methodsynopsis> <para> <function>array_chunk</function> splits the array into several arrays with <parameter>size</parameter> values @@ -291,12 +283,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>array_count_values</function></funcdef> - <paramdef>array <parameter>input</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>array_count_values</methodname> + <methodparam><type>array</type><parameter>input</parameter></methodparam> + </methodsynopsis> <para> <function>array_count_values</function> returns an array using the values of the <parameter>input</parameter> array as keys and @@ -336,16 +326,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>array_diff</function></funcdef> - <paramdef>array <parameter>array1</parameter></paramdef> - <paramdef>array <parameter>array2</parameter></paramdef> - <paramdef>array - <parameter><optional> ...</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>array_diff</methodname> + <methodparam><type>array</type><parameter>array1</parameter></methodparam> + <methodparam><type>array</type><parameter>array2</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter> ...</parameter></methodparam> + </methodsynopsis> <para> <function>array_diff</function> returns an array containing all the values of <parameter>array1</parameter> @@ -398,15 +384,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>array_filter</function></funcdef> - <paramdef>array <parameter>input</parameter></paramdef> - <paramdef>mixed - <parameter><optional>callback</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>array_filter</methodname> + <methodparam><type>array</type><parameter>input</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>callback</parameter></methodparam> + </methodsynopsis> <para> <function>array_filter</function> returns an array containing all the elements of <parameter>input</parameter> @@ -475,12 +457,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>array_flip</function></funcdef> - <paramdef>array <parameter>trans</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>array_flip</methodname> + <methodparam><type>array</type><parameter>trans</parameter></methodparam> + </methodsynopsis> <para> <function>array_flip</function> returns an <type>array</type> in flip order, i.e. keys from <parameter>trans</parameter> become values and @@ -546,14 +526,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>array_fill</function></funcdef> - <paramdef>int <parameter>start_index</parameter></paramdef> - <paramdef>int <parameter>num</parameter></paramdef> - <paramdef>mixed <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>array_fill</methodname> + <methodparam><type>int</type><parameter>start_index</parameter></methodparam> + <methodparam><type>int</type><parameter>num</parameter></methodparam> + <methodparam><type>mixed</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> <function>array_fill</function> fills an array with <parameter>num</parameter> entries of the value of the @@ -596,16 +574,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>array_intersect</function></funcdef> - <paramdef>array <parameter>array1</parameter></paramdef> - <paramdef>array <parameter>array2</parameter></paramdef> - <paramdef>array - <parameter><optional> ...</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>array_intersect</methodname> + <methodparam><type>array</type><parameter>array1</parameter></methodparam> + <methodparam><type>array</type><parameter>array2</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter> ...</parameter></methodparam> + </methodsynopsis> <para> <function>array_intersect</function> returns an array containing all the values of <parameter>array1</parameter> @@ -663,13 +637,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>array_key_exists</function></funcdef> - <paramdef>mixed <parameter>key</parameter></paramdef> - <paramdef>array <parameter>search</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>array_key_exists</methodname> + <methodparam><type>mixed</type><parameter>key</parameter></methodparam> + <methodparam><type>array</type><parameter>search</parameter></methodparam> + </methodsynopsis> <para> <function>array_key_exists</function> returns &true; if the given <parameter>key</parameter> is set in the array. @@ -708,17 +680,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>array_keys</function></funcdef> - <paramdef>array <parameter>input</parameter></paramdef> - <paramdef>mixed - <parameter> - <optional>search_value</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>array_keys</methodname> + <methodparam><type>array</type><parameter>input</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter> + search_value + </parameter></methodparam> + </methodsynopsis> <para> <function>array_keys</function> returns the keys, numeric and string, from the <parameter>input</parameter> array. @@ -809,16 +777,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>array_map</function></funcdef> - <paramdef>mixed <parameter>callback</parameter></paramdef> - <paramdef>array <parameter>arr1</parameter></paramdef> - <paramdef>array - <parameter><optional>arr2...</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>array_map</methodname> + <methodparam><type>mixed</type><parameter>callback</parameter></methodparam> + <methodparam><type>array</type><parameter>arr1</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>arr2...</parameter></methodparam> + </methodsynopsis> <para> <function>array_map</function> returns an array containing all the elements of <parameter>arr1</parameter> after applying the @@ -1014,16 +978,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>array_merge</function></funcdef> - <paramdef>array <parameter>array1</parameter></paramdef> - <paramdef>array <parameter>array2</parameter></paramdef> - <paramdef>array - <parameter><optional>...</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>array_merge</methodname> + <methodparam><type>array</type><parameter>array1</parameter></methodparam> + <methodparam><type>array</type><parameter>array2</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>...</parameter></methodparam> + </methodsynopsis> <para> <function>array_merge</function> merges the elements of two or more arrays together so that the values of one are appended to @@ -1077,16 +1037,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>array_merge_recursive</function></funcdef> - <paramdef>array <parameter>array1</parameter></paramdef> - <paramdef>array <parameter>array2</parameter></paramdef> - <paramdef>array - <parameter><optional>...</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>array_merge_recursive</methodname> + <methodparam><type>array</type><parameter>array1</parameter></methodparam> + <methodparam><type>array</type><parameter>array2</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>...</parameter></methodparam> + </methodsynopsis> <para> <function>array_merge_recursive</function> merges the elements of two or more arrays together so that the values of one are appended @@ -1148,21 +1104,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>array_multisort</function></funcdef> - <paramdef>array <parameter>ar1</parameter></paramdef> - <paramdef>mixed - <parameter><optional>arg</optional></parameter> - </paramdef> - <paramdef>mixed - <parameter><optional>...</optional></parameter> - </paramdef> - <paramdef>array - <parameter><optional>...</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>array_multisort</methodname> + <methodparam><type>array</type><parameter>ar1</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>arg</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>...</parameter></methodparam> + </methodsynopsis> <para> <function>array_multisort</function> can be used to sort several arrays at once or a multi-dimensional array according by one of @@ -1264,14 +1212,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>array_pad</function></funcdef> - <paramdef>array <parameter>input</parameter></paramdef> - <paramdef>int <parameter>pad_size</parameter></paramdef> - <paramdef>mixed <parameter>pad_value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>array_pad</methodname> + <methodparam><type>array</type><parameter>input</parameter></methodparam> + <methodparam><type>int</type><parameter>pad_size</parameter></methodparam> + <methodparam><type>mixed</type><parameter>pad_value</parameter></methodparam> + </methodsynopsis> <para> <function>array_pad</function> returns a copy of the <parameter>input</parameter> padded to size specified by @@ -1312,12 +1258,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>array_pop</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>array_pop</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + </methodsynopsis> <para> <function>array_pop</function> pops and returns the last value of the <parameter>array</parameter>, shortening the @@ -1369,16 +1313,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>array_push</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - <paramdef>mixed - <parameter><optional>...</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>array_push</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam> + </methodsynopsis> <para> <function>array_push</function> treats <parameter>array</parameter> as a stack, and pushes the passed @@ -1438,15 +1378,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>array_rand</function></funcdef> - <paramdef>array <parameter>input</parameter></paramdef> - <paramdef>int - <parameter><optional>num_req</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>array_rand</methodname> + <methodparam><type>array</type><parameter>input</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>num_req</parameter></methodparam> + </methodsynopsis> <para> <function>array_rand</function> is rather useful when you want to pick one or more random entries out of an array. It takes an @@ -1490,15 +1426,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>array_reverse</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - <paramdef>bool - <parameter><optional>preserve_keys</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>array_reverse</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>preserve_keys</parameter></methodparam> + </methodsynopsis> <para> <function>array_reverse</function> takes input <parameter>array</parameter> and returns a new array with the @@ -1569,16 +1501,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>array_reduce</function></funcdef> - <paramdef>array <parameter>input</parameter></paramdef> - <paramdef>mixed <parameter>callback</parameter></paramdef> - <paramdef>int - <parameter><optional>initial</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>array_reduce</methodname> + <methodparam><type>array</type><parameter>input</parameter></methodparam> + <methodparam><type>mixed</type><parameter>callback</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>initial</parameter></methodparam> + </methodsynopsis> <para> <function>array_reduce</function> applies iteratively the <parameter>callback</parameter> function to the elements of the @@ -1633,12 +1561,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>array_shift</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>array_shift</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + </methodsynopsis> <para> <function>array_shift</function> shifts the first value of the <parameter>array</parameter> off and returns it, shortening the @@ -1687,18 +1613,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>array_slice</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - <paramdef>int <parameter>offset</parameter></paramdef> - <paramdef>int - <parameter> - <optional>length</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>array_slice</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + <methodparam><type>int</type><parameter>offset</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + length + </parameter></methodparam> + </methodsynopsis> <para> <function>array_slice</function> returns a sequence of elements from the <parameter>array</parameter> specified by the @@ -1751,21 +1673,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>array_splice</function></funcdef> - <paramdef>array <parameter>input</parameter></paramdef> - <paramdef>int <parameter>offset</parameter></paramdef> - <paramdef>int - <parameter><optional>length</optional></parameter> - </paramdef> - <paramdef>array - <parameter> - <optional>replacement</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>array_splice</methodname> + <methodparam><type>array</type><parameter>input</parameter></methodparam> + <methodparam><type>int</type><parameter>offset</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter> + replacement + </parameter></methodparam> + </methodsynopsis> <para> <function>array_splice</function> removes the elements designated by <parameter>offset</parameter> and @@ -1861,12 +1777,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>array_sum</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>array_sum</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + </methodsynopsis> <para> <function>array_sum</function> returns the sum of values in an array as an integer or float. @@ -1912,12 +1826,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>array_unique</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>array_unique</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + </methodsynopsis> <para> <function>array_unique</function> takes input <parameter>array</parameter> and returns a new array @@ -2009,18 +1921,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>array_unshift</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - <paramdef>mixed - <parameter> - <optional>...</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>array_unshift</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter> + ... + </parameter></methodparam> + </methodsynopsis> <para> <function>array_unshift</function> prepends passed elements to the front of the <parameter>array</parameter>. Note that the list @@ -2072,12 +1980,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>array_values</function></funcdef> - <paramdef>array <parameter>input</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>array_values</methodname> + <methodparam><type>array</type><parameter>input</parameter></methodparam> + </methodsynopsis> <para> <function>array_values</function> returns all the values from the <parameter>input</parameter> array. @@ -2143,16 +2049,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>array_walk</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - <paramdef>string <parameter>func</parameter></paramdef> - <paramdef>mixed - <parameter><optional>userdata</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>array_walk</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + <methodparam><type>string</type><parameter>func</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>userdata</parameter></methodparam> + </methodsynopsis> <simpara> Applies the user-defined function named by <parameter>func</parameter> to each element of <parameter>array</parameter>. @@ -2256,15 +2158,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>arsort</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - <paramdef>int - <parameter><optional>sort_flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>arsort</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>sort_flags</parameter></methodparam> + </methodsynopsis> <para> This function sorts an array such that array indices maintain their correlation with the array elements they are associated @@ -2318,15 +2216,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>asort</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - <paramdef>int - <parameter><optional>sort_flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>asort</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>sort_flags</parameter></methodparam> + </methodsynopsis> <para> This function sorts an array such that array indices maintain their correlation with the array elements they are associated @@ -2382,15 +2276,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>compact</function></funcdef> - <paramdef>mixed <parameter>varname</parameter></paramdef> - <paramdef>mixed - <parameter><optional>...</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>compact</methodname> + <methodparam><type>mixed</type><parameter>varname</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam> + </methodsynopsis> <para> <function>compact</function> takes a variable number of parameters. Each parameter can be either a string containing the @@ -2451,12 +2341,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>count</function></funcdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>count</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> <para> Returns the number of elements in <parameter>var</parameter>, which is typically an <type>array</type> (since anything else will have @@ -2522,12 +2410,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>current</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>current</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + </methodsynopsis> <para> Every array has an internal pointer to its "current" element, which is initialized to the first element inserted into the @@ -2568,12 +2454,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>each</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>each</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + </methodsynopsis> <para> Returns the current key and value pair from the array <parameter>array</parameter> and advances the array cursor. This @@ -2671,12 +2555,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>end</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>end</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + </methodsynopsis> <para> <function>end</function> advances <parameter>array</parameter>'s internal pointer to the last element, and returns that element. @@ -2698,18 +2580,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>extract</function></funcdef> - <paramdef>array <parameter>var_array</parameter></paramdef> - <paramdef>int - <parameter><optional>extract_type</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>prefix</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>extract</methodname> + <methodparam><type>array</type><parameter>var_array</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>extract_type</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>prefix</parameter></methodparam> + </methodsynopsis> <para> This function is used to import variables from an array into the current symbol table. It takes an associative array @@ -2888,16 +2764,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>in_array</function></funcdef> - <paramdef>mixed <parameter>needle</parameter></paramdef> - <paramdef>array <parameter>haystack</parameter></paramdef> - <paramdef>bool - <parameter><optional>strict</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>in_array</methodname> + <methodparam><type>mixed</type><parameter>needle</parameter></methodparam> + <methodparam><type>array</type><parameter>haystack</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>strict</parameter></methodparam> + </methodsynopsis> <para> Searches <parameter>haystack</parameter> for <parameter>needle</parameter> and returns &true; @@ -3011,14 +2883,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>array_search</function></funcdef> - <paramdef>mixed <parameter>needle</parameter></paramdef> - <paramdef>array <parameter>haystack</parameter></paramdef> - <paramdef>bool <parameter><optional>strict</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>array_search</methodname> + <methodparam><type>mixed</type><parameter>needle</parameter></methodparam> + <methodparam><type>array</type><parameter>haystack</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>strict</parameter></methodparam> + </methodsynopsis> <para> Searches <parameter>haystack</parameter> for <parameter>needle</parameter> and returns the key if it is found in @@ -3044,12 +2914,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>key</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>key</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + </methodsynopsis> <para> <function>key</function> returns the index element of the current array position. @@ -3067,15 +2935,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>krsort</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - <paramdef>int - <parameter><optional>sort_flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>krsort</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>sort_flags</parameter></methodparam> + </methodsynopsis> <para> Sorts an array by key in reverse order, maintaining key to data correlations. This is useful mainly for associative arrays. @@ -3126,15 +2990,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ksort</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - <paramdef>int - <parameter><optional>sort_flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ksort</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>sort_flags</parameter></methodparam> + </methodsynopsis> <para> Sorts an array by key, maintaining key to data correlations. This is useful mainly for associative arrays. @@ -3193,12 +3053,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>list</function></funcdef> - <varargs/> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>list</methodname> + <methodparam rep="repeat"><type>mixed</type><parameter>...</parameter></methodparam> + </methodsynopsis> <para> Like <function>array</function>, this is not really a function, but a language construct. <function>list</function> is used to @@ -3245,12 +3103,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>natsort</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>natsort</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + </methodsynopsis> <para> This function implements a sort algorithm that orders alphanumeric strings in the way a human being would. This is @@ -3322,12 +3178,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>natcasesort</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>natcasesort</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + </methodsynopsis> <para> This function implements a sort algorithm that orders alphanumeric strings in the way a human being would. This is @@ -3362,12 +3216,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>next</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>next</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + </methodsynopsis> <para> Returns the array element in the next place that's pointed by the internal array pointer, or &false; if @@ -3406,12 +3258,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>pos</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>pos</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + </methodsynopsis> <simpara> This is an <link linkend="aliases">alias</link> for <function>current</function>. @@ -3431,12 +3281,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>prev</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>prev</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + </methodsynopsis> <para> Returns the array element in the previous place that's pointed by the internal array pointer, or &false; if there are no more @@ -3471,13 +3319,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>range</function></funcdef> - <paramdef>mixed <parameter>low</parameter></paramdef> - <paramdef>mixed <parameter>high</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>range</methodname> + <methodparam><type>mixed</type><parameter>low</parameter></methodparam> + <methodparam><type>mixed</type><parameter>high</parameter></methodparam> + </methodsynopsis> <para> <function>range</function> returns an array of elements from <parameter>low</parameter> to <parameter>high</parameter>, @@ -3537,12 +3383,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>reset</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>reset</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + </methodsynopsis> <para> <function>reset</function> rewinds <parameter>array</parameter>'s internal pointer to the first element. @@ -3566,15 +3410,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>rsort</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - <paramdef>int - <parameter><optional>sort_flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>rsort</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>sort_flags</parameter></methodparam> + </methodsynopsis> <para> This function sorts an array in reverse order (highest to lowest). <example> @@ -3627,12 +3467,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>shuffle</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>shuffle</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + </methodsynopsis> <para> This function shuffles (randomizes the order of the elements in) an array. You must use <function>srand</function> to seed this @@ -3666,12 +3504,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>sizeof</function></funcdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>sizeof</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> <para> The <function>sizeof</function> function is an <link linkend="aliases">alias</link> for <function>count</function>. @@ -3689,15 +3525,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>sort</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - <paramdef>int - <parameter><optional>sort_flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>sort</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>sort_flags</parameter></methodparam> + </methodsynopsis> <para> This function sorts an array. Elements will be arranged from lowest to highest when this function has completed. @@ -3779,13 +3611,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>uasort</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - <paramdef>function <parameter>cmp_function</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>uasort</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + <methodparam><type>function</type><parameter>cmp_function</parameter></methodparam> + </methodsynopsis> <para> This function sorts an array such that array indices maintain their correlation with the array elements they are associated @@ -3819,13 +3649,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>uksort</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - <paramdef>function <parameter>cmp_function</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>uksort</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + <methodparam><type>function</type><parameter>cmp_function</parameter></methodparam> + </methodsynopsis> <para> This function will sort the keys of an array using a user-supplied comparison function. If the array you wish to sort @@ -3883,13 +3711,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>usort</function></funcdef> - <paramdef>array <parameter>array</parameter></paramdef> - <paramdef>string <parameter>cmp_function</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>usort</methodname> + <methodparam><type>array</type><parameter>array</parameter></methodparam> + <methodparam><type>string</type><parameter>cmp_function</parameter></methodparam> + </methodsynopsis> <para> This function will sort an array by its values using a user-supplied comparison function. If the array you wish to sort @@ -4072,3 +3898,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/aspell.xml diff -u phpdoc/en/functions/aspell.xml:1.21 phpdoc/en/functions/aspell.xml:1.22 --- phpdoc/en/functions/aspell.xml:1.21 Wed Dec 12 15:46:37 2001 +++ phpdoc/en/functions/aspell.xml Sat Feb 2 10:35:52 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.21 $ --> +<!-- $Revision: 1.22 $ --> <reference id="ref.aspell"> <title>Aspell functions [deprecated]</title> <titleabbrev>Aspell</titleabbrev> @@ -32,14 +32,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>aspell_new</function></funcdef> - <paramdef>string <parameter>master</parameter></paramdef> - <paramdef>string - <parameter><optional>personal</optional></parameter> </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>aspell_new</methodname> + <methodparam><type>string</type><parameter>master</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>personal</parameter></methodparam> + </methodsynopsis> <!-- TODO: personal??? --> <simpara> <function>aspell_new</function> opens up a new dictionary and @@ -66,13 +63,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>aspell_check</function></funcdef> - <paramdef>int <parameter>dictionary_link</parameter></paramdef> - <paramdef>string <parameter>word</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>aspell_check</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + <methodparam><type>string</type><parameter>word</parameter></methodparam> + </methodsynopsis> <simpara> <function>aspell_check</function> checks the spelling of a word and returns &true; if the spelling is correct, &false; if not. @@ -105,13 +100,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>aspell_check_raw</function></funcdef> - <paramdef>int <parameter>dictionary_link</parameter></paramdef> - <paramdef>string <parameter>word</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>aspell_check_raw</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + <methodparam><type>string</type><parameter>word</parameter></methodparam> + </methodsynopsis> <simpara> <function>aspell_check_raw</function> checks the spelling of a word, without changing its case or trying to trim it in any way @@ -143,13 +136,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>aspell_suggest</function></funcdef> - <paramdef>int <parameter>dictionary_link</parameter></paramdef> - <paramdef>string <parameter>word</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>aspell_suggest</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + <methodparam><type>string</type><parameter>word</parameter></methodparam> + </methodsynopsis> <simpara> <function>aspell_suggest</function> returns an array of possible spellings for the given word. @@ -197,3 +188,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/bc.xml diff -u phpdoc/en/functions/bc.xml:1.20 phpdoc/en/functions/bc.xml:1.21 --- phpdoc/en/functions/bc.xml:1.20 Tue Jan 29 17:30:30 2002 +++ phpdoc/en/functions/bc.xml Sat Feb 2 10:35:52 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.20 $ --> +<!-- $Revision: 1.21 $ --> <reference id="ref.bc"> <title>BCMath Arbitrary Precision Mathematics Functions</title> <titleabbrev>BC math</titleabbrev> @@ -30,16 +30,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>bcadd</function></funcdef> - <paramdef>string <parameter>left_operand</parameter></paramdef> - <paramdef>string <parameter>right_operand</parameter></paramdef> - <paramdef>int - <parameter><optional>scale</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>bcadd</methodname> + <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> + <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> <para> Adds the <parameter>left_operand</parameter> to the <parameter>right_operand</parameter> and returns the sum in a @@ -60,16 +56,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>bccomp</function></funcdef> - <paramdef>string <parameter>left_operand</parameter></paramdef> - <paramdef>string <parameter>right_operand</parameter></paramdef> - <paramdef>int - <parameter><optional>scale</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>bccomp</methodname> + <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> + <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> <para> Compares the <parameter>left_operand</parameter> to the <parameter>right_operand</parameter> and returns the result as an @@ -92,16 +84,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>bcdiv</function></funcdef> - <paramdef>string <parameter>left_operand</parameter></paramdef> - <paramdef>string <parameter>right_operand</parameter></paramdef> - <paramdef>int - <parameter><optional>scale</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>bcdiv</methodname> + <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> + <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> <para> Divides the <parameter>left_operand</parameter> by the <parameter>right_operand</parameter> and returns the result. The @@ -123,13 +111,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>bcmod</function></funcdef> - <paramdef>string <parameter>left_operand</parameter></paramdef> - <paramdef>string <parameter>modulus</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>bcmod</methodname> + <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> + <methodparam><type>string</type><parameter>modulus</parameter></methodparam> + </methodsynopsis> <para> Get the modulus of the <parameter>left_operand</parameter> using <parameter>modulus</parameter>. @@ -147,16 +133,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>bcmul</function></funcdef> - <paramdef>string <parameter>left_operand</parameter></paramdef> - <paramdef>string <parameter>right_operand</parameter></paramdef> - <paramdef>int - <parameter><optional>scale</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>bcmul</methodname> + <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> + <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> <para> Multiply the <parameter>left_operand</parameter> by the <parameter>right_operand</parameter> and returns the result. The @@ -178,16 +160,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>bcpow</function></funcdef> - <paramdef>string <parameter>x</parameter></paramdef> - <paramdef>string <parameter>y</parameter></paramdef> - <paramdef>int - <parameter><optional>scale</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>bcpow</methodname> + <methodparam><type>string</type><parameter>x</parameter></methodparam> + <methodparam><type>string</type><parameter>y</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> <para> Raise <parameter>x</parameter> to the power <parameter>y</parameter>. The optional @@ -209,12 +187,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>bcscale</function></funcdef> - <paramdef>int <parameter>scale</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>bcscale</methodname> + <methodparam><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> <para> This function sets the default scale parameter for all subsequent bc math functions that do not explicitly specify a scale @@ -232,15 +208,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>bcsqrt</function></funcdef> - <paramdef>string <parameter>operand</parameter></paramdef> - <paramdef>int - <parameter><optional>scale</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>bcsqrt</methodname> + <methodparam><type>string</type><parameter>operand</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> <para> Return the square root of the <parameter>operand</parameter>. The optional <parameter>scale</parameter> parameter sets the @@ -261,16 +233,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>bcsub</function></funcdef> - <paramdef>string <parameter>left_operand</parameter></paramdef> - <paramdef>string <parameter>right_operand</parameter></paramdef> - <paramdef>int - <parameter><optional>scale</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>bcsub</methodname> + <methodparam><type>string</type><parameter>left_operand</parameter></methodparam> + <methodparam><type>string</type><parameter>right_operand</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> <para> Subtracts the <parameter>right_operand</parameter> from the <parameter>left_operand</parameter> and returns the result in a @@ -306,3 +274,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/bzip2.xml diff -u phpdoc/en/functions/bzip2.xml:1.15 phpdoc/en/functions/bzip2.xml:1.16 --- phpdoc/en/functions/bzip2.xml:1.15 Sun Jan 6 21:55:54 2002 +++ phpdoc/en/functions/bzip2.xml Sat Feb 2 10:35:52 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.15 $ --> +<!-- $Revision: 1.16 $ --> <reference id="ref.bzip2"> <title>Bzip2 Compression Functions</title> <titleabbrev>Bzip2</titleabbrev> @@ -66,12 +66,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>bzclose</function></funcdef> - <paramdef>int <parameter>bz</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>bzclose</methodname> + <methodparam><type>int</type><parameter>bz</parameter></methodparam> + </methodsynopsis> <para> Closes the bzip2 file referenced by the pointer <parameter>bz</parameter>. </para> @@ -96,18 +94,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>bzcompress</function></funcdef> - <paramdef>string <parameter>source</parameter></paramdef> - <paramdef>int - <parameter><optional>blocksize</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>workfactor</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>bzcompress</methodname> + <methodparam><type>string</type><parameter>source</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>blocksize</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>workfactor</parameter></methodparam> + </methodsynopsis> <para> <function>bzcompress</function> compresses the <parameter>source</parameter> string and returns it as bzip2 @@ -156,15 +148,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>bzdecompress</function></funcdef> - <paramdef>string <parameter>source</parameter></paramdef> - <paramdef>int - <parameter><optional>small</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>bzdecompress</methodname> + <methodparam><type>string</type><parameter>source</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>small</parameter></methodparam> + </methodsynopsis> <para> <function>bzdecompress</function> decompresses the <parameter>source</parameter> string containing bzip2 encoded @@ -211,12 +199,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>bzerrno</function></funcdef> - <paramdef>int <parameter>bz</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>bzerrno</methodname> + <methodparam><type>int</type><parameter>bz</parameter></methodparam> + </methodsynopsis> <para> Returns the error number of any bzip2 error returned by the file pointer <parameter>bz</parameter>. @@ -235,12 +221,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>bzerror</function></funcdef> - <paramdef>int <parameter>bz</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>bzerror</methodname> + <methodparam><type>int</type><parameter>bz</parameter></methodparam> + </methodsynopsis> <para> Returns the error number and error string, in an associative array, of any bzip2 error returned by the file pointer @@ -275,12 +259,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>bzerrstr</function></funcdef> - <paramdef>int <parameter>bz</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>bzerrstr</methodname> + <methodparam><type>int</type><parameter>bz</parameter></methodparam> + </methodsynopsis> <para> Returns the error string of any bzip2 error returned by the file pointer <parameter>bz</parameter>. @@ -299,12 +281,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>bzflush</function></funcdef> - <paramdef>int <parameter>bz</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>bzflush</methodname> + <methodparam><type>int</type><parameter>bz</parameter></methodparam> + </methodsynopsis> <para> Forces a write of all buffered bzip2 data for the file pointer <parameter>bz</parameter>. @@ -326,13 +306,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>bzopen</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>string <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>bzopen</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>string</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> Opens a bzip2 (.bz2) file for reading or writing. <parameter>filename</parameter> is the name of the file to @@ -375,15 +353,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>bzread</function></funcdef> - <paramdef>int <parameter>bz</parameter></paramdef> - <paramdef>int - <parameter><optional>length</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>bzread</methodname> + <methodparam><type>int</type><parameter>bz</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> <para> <function>bzread</function> reads up to <parameter>length</parameter> bytes from the bzip2 file pointer @@ -422,16 +396,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>bzwrite</function></funcdef> - <paramdef>int <parameter>bz</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>int - <parameter><optional>length</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>bzwrite</methodname> + <methodparam><type>int</type><parameter>bz</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> <para> <function>bzwrite</function> writes the contents of the string <parameter>data</parameter> to the bzip2 file stream pointed to @@ -484,3 +454,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/calendar.xml diff -u phpdoc/en/functions/calendar.xml:1.22 phpdoc/en/functions/calendar.xml:1.23 --- phpdoc/en/functions/calendar.xml:1.22 Fri Jan 25 02:14:04 2002 +++ phpdoc/en/functions/calendar.xml Sat Feb 2 10:35:52 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.22 $ --> +<!-- $Revision: 1.23 $ --> <reference id="ref.calendar"> <title>Calendar functions</title> <titleabbrev>Calendar</titleabbrev> @@ -36,12 +36,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>jdtogregorian</function></funcdef> - <paramdef>int <parameter>julianday</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>jdtogregorian</methodname> + <methodparam><type>int</type><parameter>julianday</parameter></methodparam> + </methodsynopsis> <para> Converts Julian Day Count to a string containing the Gregorian date in the format of "month/day/year". @@ -58,14 +56,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gregoriantojd</function></funcdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gregoriantojd</methodname> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam><type>int</type><parameter>day</parameter></methodparam> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + </methodsynopsis> <para> Valid Range for Gregorian Calendar 4714 B.C. to 9999 A.D.</para> <para> @@ -102,12 +98,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>jdtojulian</function></funcdef> - <paramdef>int <parameter>julianday</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>jdtojulian</methodname> + <methodparam><type>int</type><parameter>julianday</parameter></methodparam> + </methodsynopsis> <para> Converts Julian Day Count to a string containing the Julian Calendar Date in the format of "month/day/year". @@ -124,14 +118,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>juliantojd</function></funcdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>juliantojd</methodname> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam><type>int</type><parameter>day</parameter></methodparam> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + </methodsynopsis> <para> Valid Range for Julian Calendar 4713 B.C. to 9999 A.D. </para> @@ -155,12 +147,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>jdtojewish</function></funcdef> - <paramdef>int <parameter>julianday</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>jdtojewish</methodname> + <methodparam><type>int</type><parameter>julianday</parameter></methodparam> + </methodsynopsis> <para> Converts a Julian Day Count the the Jewish Calendar. </para> @@ -176,14 +166,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>jewishtojd</function></funcdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>jewishtojd</methodname> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam><type>int</type><parameter>day</parameter></methodparam> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + </methodsynopsis> <para> Although this function can handle dates all the way back to the year 1 (3761 B.C.), such use may not be meaningful. The Jewish calendar has @@ -203,12 +191,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>jdtofrench</function></funcdef> - <paramdef>int <parameter>juliandaycount</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>jdtofrench</methodname> + <methodparam><type>int</type><parameter>juliandaycount</parameter></methodparam> + </methodsynopsis> <para> Converts a Julian Day Count to the French Republican Calendar. </para> @@ -225,14 +211,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>frenchtojd</function></funcdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>frenchtojd</methodname> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam><type>int</type><parameter>day</parameter></methodparam> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + </methodsynopsis> <para> Converts a date from the French Republican Calendar to a Julian Day Count. @@ -253,13 +237,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>jdmonthname</function></funcdef> - <paramdef>int <parameter>julianday</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>jdmonthname</methodname> + <methodparam><type>int</type><parameter>julianday</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> Returns a string containing a month name. <parameter>mode</parameter> tells this function which calendar to @@ -320,13 +302,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>jddayofweek</function></funcdef> - <paramdef>int <parameter>julianday</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>jddayofweek</methodname> + <methodparam><type>int</type><parameter>julianday</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> Returns the day of the week. Can return a string or an integer depending on the mode. @@ -376,12 +356,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>easter_date</function></funcdef> - <paramdef>int <parameter>year</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>easter_date</methodname> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + </methodsynopsis> <para> Returns the UNIX timestamp corresponding to midnight on Easter of the given year. If no year is specified, the current year is @@ -438,12 +416,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>easter_days</function></funcdef> - <paramdef>int <parameter>year</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>easter_days</methodname> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + </methodsynopsis> <para> Returns the number of days after March 21 on which Easter falls for a given year. If no year is specified, the current year is @@ -497,14 +473,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>unixtojd</function></funcdef> - <paramdef>int - <parameter><optional>timestamp</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>unixtojd</methodname> + <methodparam choice="opt"><type>int</type><parameter>timestamp</parameter></methodparam> + </methodsynopsis> <para> Return the Julian Day for a UNIX <parameter>timestamp</parameter> (seconds since 1.1.1970), or for the current day if no @@ -523,12 +495,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>jdtounix</function></funcdef> - <paramdef>int <parameter>jday</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>jdtounix</methodname> + <methodparam><type>int</type><parameter>jday</parameter></methodparam> + </methodsynopsis> <para> This function will return a UNIX timestamp corresponding to the Julian Day given in <parameter>jday</parameter> or &false; if @@ -549,14 +519,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>cal_days_in_month</function></funcdef> - <paramdef>int <parameter>calendar</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>cal_days_in_month</methodname> + <methodparam><type>int</type><parameter>calendar</parameter></methodparam> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + </methodsynopsis> <para> This function will return the number of days in the <parameter>month</parameter> of <parameter>year</parameter> for @@ -576,15 +544,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>cal_to_jd</function></funcdef> - <paramdef>int <parameter>calendar</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>cal_to_jd</methodname> + <methodparam><type>int</type><parameter>calendar</parameter></methodparam> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam><type>int</type><parameter>day</parameter></methodparam> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -597,13 +563,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>cal_from_jd</function></funcdef> - <paramdef>int <parameter>jd</parameter></paramdef> - <paramdef>int <parameter>calendar</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>cal_from_jd</methodname> + <methodparam><type>int</type><parameter>jd</parameter></methodparam> + <methodparam><type>int</type><parameter>calendar</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -617,12 +581,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>cal_info</function></funcdef> - <paramdef>int <parameter>calendar</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>cal_info</methodname> + <methodparam><type>int</type><parameter>calendar</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -650,3 +612,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/ccvs.xml diff -u phpdoc/en/functions/ccvs.xml:1.9 phpdoc/en/functions/ccvs.xml:1.10 --- phpdoc/en/functions/ccvs.xml:1.9 Mon Dec 17 06:29:26 2001 +++ phpdoc/en/functions/ccvs.xml Sat Feb 2 10:35:52 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <!-- CCVS Documentation by Brendan W. McAdams <brendan@plexmedia.com> Copyright (c) 2000 by the PHP Group @@ -64,12 +64,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ccvs_init</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ccvs_init</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -83,12 +81,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ccvs_done</function></funcdef> - <paramdef>string <parameter>sess</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ccvs_done</methodname> + <methodparam><type>string</type><parameter>sess</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -102,13 +98,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ccvs_new</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>string <parameter>invoice</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ccvs_new</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>invoice</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -122,15 +116,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ccvs_add</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>string <parameter>invoice</parameter></paramdef> - <paramdef>string <parameter>argtype</parameter></paramdef> - <paramdef>string <parameter>argval</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ccvs_add</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>invoice</parameter></methodparam> + <methodparam><type>string</type><parameter>argtype</parameter></methodparam> + <methodparam><type>string</type><parameter>argval</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -144,13 +136,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ccvs_delete</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>string <parameter>invoice</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ccvs_delete</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>invoice</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -166,13 +156,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ccvs_auth</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>string <parameter>invoice</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ccvs_auth</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>invoice</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -188,13 +176,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ccvs_return</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>string <parameter>invoice</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ccvs_return</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>invoice</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -210,13 +196,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ccvs_reverse</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>string <parameter>invoice</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ccvs_reverse</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>invoice</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -232,13 +216,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ccvs_sale</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>string <parameter>invoice</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ccvs_sale</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>invoice</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -254,13 +236,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ccvs_void</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>string <parameter>invoice</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ccvs_void</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>invoice</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -274,13 +254,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ccvs_status</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>string <parameter>invoice</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ccvs_status</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>invoice</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -296,13 +274,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ccvs_count</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>string <parameter>type</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ccvs_count</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>type</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -318,14 +294,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ccvs_lookup</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>string <parameter>invoice</parameter></paramdef> - <paramdef>int <parameter>inum</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ccvs_lookup</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>invoice</parameter></methodparam> + <methodparam><type>int</type><parameter>inum</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -339,13 +313,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ccvs_report</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>string <parameter>type</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ccvs_report</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>type</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -362,14 +334,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ccvs_command</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>string <parameter>type</parameter></paramdef> - <paramdef>string <parameter>argval</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ccvs_command</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>type</parameter></methodparam> + <methodparam><type>string</type><parameter>argval</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -383,12 +353,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ccvs_textvalue</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ccvs_textvalue</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -417,3 +385,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/classobj.xml diff -u phpdoc/en/functions/classobj.xml:1.33 phpdoc/en/functions/classobj.xml:1.34 --- phpdoc/en/functions/classobj.xml:1.33 Sat Feb 2 06:04:19 2002 +++ phpdoc/en/functions/classobj.xml Sat Feb 2 10:35:53 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.33 $ --> +<!-- $Revision: 1.34 $ --> <reference id="ref.classobj"> <title>Class/Object Functions</title> <titleabbrev>Classes/Objects</titleabbrev> @@ -179,22 +179,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed - <function>call_user_method_array</function> - </funcdef> - <paramdef>string - <parameter>method_name</parameter> - </paramdef> - <paramdef>object - <parameter>obj</parameter> - </paramdef> - <paramdef>array - <parameter><optional>paramarr</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>call_user_method_array</methodname> + <methodparam><type>string</type><parameter>method_name</parameter></methodparam> + <methodparam><type>object</type><parameter>obj</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>paramarr</parameter></methodparam> + </methodsynopsis> <para> Calls a the method referred by <parameter>method_name</parameter> from the user defined <parameter>obj</parameter> object, using the parameters @@ -223,25 +213,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed - <function>call_user_method</function> - </funcdef> - <paramdef>string - <parameter>method_name</parameter> - </paramdef> - <paramdef>object - <parameter>obj</parameter> - </paramdef> - <paramdef>mixed - <parameter><optional>parameter</optional></parameter> - </paramdef> - <paramdef>mixed - <parameter><optional>...</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>call_user_method</methodname> + <methodparam><type>string</type><parameter>method_name</parameter></methodparam> + <methodparam><type>object</type><parameter>obj</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>parameter</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam> + </methodsynopsis> <para> Calls a the method referred by <parameter>method_name</parameter> from the user defined <parameter>obj</parameter> object. An example of usage @@ -294,12 +272,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>class_exists</function></funcdef> - <paramdef>string <parameter>class_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>class_exists</methodname> + <methodparam><type>string</type><parameter>class_name</parameter></methodparam> + </methodsynopsis> <para> This function returns &true; if the class given by <parameter>class_name</parameter> has been defined, @@ -315,12 +291,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>get_class</function></funcdef> - <paramdef>object <parameter>obj</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>get_class</methodname> + <methodparam><type>object</type><parameter>obj</parameter></methodparam> + </methodsynopsis> <para> This function returns the name of the class of which the object <parameter>obj</parameter> is an instance. Returns @@ -348,12 +322,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>get_class_methods</function></funcdef> - <paramdef>string <parameter>class_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>get_class_methods</methodname> + <methodparam><type>string</type><parameter>class_name</parameter></methodparam> + </methodsynopsis> <para> This function returns an array of method names defined for the class specified by <parameter>class_name</parameter>. @@ -436,12 +408,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>get_class_vars</function></funcdef> - <paramdef>string <parameter>class_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>get_class_vars</methodname> + <methodparam><type>string</type><parameter>class_name</parameter></methodparam> + </methodsynopsis> <para> This function will return an associative array of default properties of the class. The resulting array elements are in the @@ -511,12 +481,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>get_declared_classes</function></funcdef> + <methodsynopsis> + <type>array</type><methodname>get_declared_classes</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This function returns an array of the names of the declared classes in the current script. @@ -546,12 +514,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>get_object_vars</function></funcdef> - <paramdef>object <parameter>obj</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>get_object_vars</methodname> + <methodparam><type>object</type><parameter>obj</parameter></methodparam> + </methodsynopsis> <para> This function returns an associative array of defined object properties for the specified object <parameter>obj</parameter>. If variables @@ -620,12 +586,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>get_parent_class</function></funcdef> - <paramdef>mixed <parameter>obj</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>get_parent_class</methodname> + <methodparam><type>mixed</type><parameter>obj</parameter></methodparam> + </methodsynopsis> <para> If <parameter>obj</parameter> is an object, returns the name of the parent class of the class of which <parameter>obj</parameter> is an @@ -653,13 +617,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>is_a</function></funcdef> - <paramdef>object <parameter>object</parameter></paramdef> - <paramdef>string <parameter>class_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_a</methodname> + <methodparam><type>object</type><parameter>object</parameter></methodparam> + <methodparam><type>string</type><parameter>class_name</parameter></methodparam> + </methodsynopsis> <para> This function returns &true; if the object is of this class or has this class as one of its parents, &false; otherwise. @@ -681,13 +643,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>is_subclass_of</function></funcdef> - <paramdef>object <parameter>object</parameter></paramdef> - <paramdef>string <parameter>class_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_subclass_of</methodname> + <methodparam><type>object</type><parameter>object</parameter></methodparam> + <methodparam><type>string</type><parameter>class_name</parameter></methodparam> + </methodsynopsis> <para> This function returns &true; if the object <parameter>object</parameter>, belongs to a class which is a @@ -708,13 +668,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>method_exists</function></funcdef> - <paramdef>object <parameter>object</parameter></paramdef> - <paramdef>string <parameter>method_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>method_exists</methodname> + <methodparam><type>object</type><parameter>object</parameter></methodparam> + <methodparam><type>string</type><parameter>method_name</parameter></methodparam> + </methodsynopsis> <para> This function returns &true; if the method given by <parameter>method_name</parameter> has been defined for the given @@ -745,3 +703,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/com.xml diff -u phpdoc/en/functions/com.xml:1.30 phpdoc/en/functions/com.xml:1.31 --- phpdoc/en/functions/com.xml:1.30 Mon Jan 28 12:14:28 2002 +++ phpdoc/en/functions/com.xml Sat Feb 2 10:35:53 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.30 $ --> +<!-- $Revision: 1.31 $ --> <reference id="ref.com"> <title>COM support functions for Windows</title> <titleabbrev>COM</titleabbrev> @@ -44,14 +44,12 @@ </refsect1> <refsect1 id="class.com.constructor"> <title>Methods</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>COM::COM</function></funcdef> - <paramdef>string <parameter>module_name</parameter></paramdef> - <paramdef>string <parameter><optional>server_name</optional></parameter></paramdef> - <paramdef>int <parameter><optional>codepage</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>COM::COM</methodname> + <methodparam><type>string</type><parameter>module_name</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>server_name</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>codepage</parameter></methodparam> + </methodsynopsis> <para> COM class constructor. Parameters: <variablelist> @@ -177,14 +175,12 @@ </refsect1> <refsect1 id="class.variant.constructor"> <title>Methods</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>VARIANT::VARIANT</function></funcdef> - <paramdef>mixed <parameter><optional>value</optional></parameter></paramdef> - <paramdef>int <parameter><optional>type</optional></parameter></paramdef> - <paramdef>int <parameter><optional>codepage</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><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> + </methodsynopsis> <para> VARIANT class constructor. Parameters: <variablelist> @@ -236,22 +232,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>com_load</function></funcdef> - <paramdef>string <parameter>module name</parameter></paramdef> - <paramdef>string - <parameter> - <optional>server name</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>codepage</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>com_load</methodname> + <methodparam><type>string</type><parameter>module name</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + server name + </parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + codepage + </parameter></methodparam> + </methodsynopsis> <para> <function>com_load</function> creates a new COM component and returns a reference to it. Returns &false; on failure. Possible @@ -273,18 +263,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>com_invoke</function></funcdef> - <paramdef>resource <parameter>com_object</parameter></paramdef> - <paramdef>string <parameter>function_name</parameter></paramdef> - <paramdef>mixed - <parameter> - <optional>function parameters, ...</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>com_invoke</methodname> + <methodparam><type>resource</type><parameter>com_object</parameter></methodparam> + <methodparam><type>string</type><parameter>function_name</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter> + function parameters, ... + </parameter></methodparam> + </methodsynopsis> <para> <function>com_invoke</function> invokes a method of the COM component referenced by @@ -304,13 +290,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>com_propget</function></funcdef> - <paramdef>resource <parameter>com_object</parameter></paramdef> - <paramdef>string <parameter>property</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>com_propget</methodname> + <methodparam><type>resource</type><parameter>com_object</parameter></methodparam> + <methodparam><type>string</type><parameter>property</parameter></methodparam> + </methodsynopsis> <para> This function is an alias for <function>com_get</function>. </para> @@ -326,13 +310,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>com_get</function></funcdef> - <paramdef>resource <parameter>com_object</parameter></paramdef> - <paramdef>string <parameter>property</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>com_get</methodname> + <methodparam><type>resource</type><parameter>com_object</parameter></methodparam> + <methodparam><type>string</type><parameter>property</parameter></methodparam> + </methodsynopsis> <para> Returns the value of the <parameter>property</parameter> of the COM component referenced by <parameter>com_object</parameter>. @@ -350,14 +332,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>com_propput</function></funcdef> - <paramdef>resource <parameter>com_object</parameter></paramdef> - <paramdef>string <parameter>property</parameter></paramdef> - <paramdef>mixed <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>com_propput</methodname> + <methodparam><type>resource</type><parameter>com_object</parameter></methodparam> + <methodparam><type>string</type><parameter>property</parameter></methodparam> + <methodparam><type>mixed</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> This function is an alias for <function>com_set</function>. </para> @@ -373,14 +353,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>com_propset</function></funcdef> - <paramdef>resource <parameter>com_object</parameter></paramdef> - <paramdef>string <parameter>property</parameter></paramdef> - <paramdef>mixed <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>com_propset</methodname> + <methodparam><type>resource</type><parameter>com_object</parameter></methodparam> + <methodparam><type>string</type><parameter>property</parameter></methodparam> + <methodparam><type>mixed</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> This function is an alias for <function>com_set</function>. </para> @@ -396,14 +374,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>com_set</function></funcdef> - <paramdef>resource <parameter>com_object</parameter></paramdef> - <paramdef>string <parameter>property</parameter></paramdef> - <paramdef>mixed <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>com_set</methodname> + <methodparam><type>resource</type><parameter>com_object</parameter></methodparam> + <methodparam><type>string</type><parameter>property</parameter></methodparam> + <methodparam><type>mixed</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> Sets the value of the <parameter>property</parameter> of the COM component referenced by <parameter>com_object</parameter>. @@ -421,12 +397,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>com_addref</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>com_addref</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Increases the components reference counter. </para> @@ -442,12 +416,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>com_release</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>com_release</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Decreases the components reference counter. </para> @@ -461,12 +433,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>com_isenum</function></funcdef> - <paramdef>object <parameter>com_module</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>com_isenum</methodname> + <methodparam><type>object</type><parameter>com_module</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -480,13 +450,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>com_load_typelib</function></funcdef> - <paramdef>string <parameter>typelib_name</parameter></paramdef> - <paramdef>int <parameter><optional>case_insensitive</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>com_load_typelib</methodname> + <methodparam><type>string</type><parameter>typelib_name</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>case_insensitive</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -515,3 +483,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/cpdf.xml diff -u phpdoc/en/functions/cpdf.xml:1.38 phpdoc/en/functions/cpdf.xml:1.39 --- phpdoc/en/functions/cpdf.xml:1.38 Sat Jan 19 17:30:45 2002 +++ phpdoc/en/functions/cpdf.xml Sat Feb 2 10:35:53 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.38 $ --> +<!-- $Revision: 1.39 $ --> <reference id="ref.cpdf"> <title>ClibPDF functions</title> <titleabbrev>ClibPDF</titleabbrev> @@ -192,21 +192,17 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_add_annotation</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>llx</parameter></paramdef> - <paramdef>float <parameter>lly</parameter></paramdef> - <paramdef>float <parameter>urx</parameter></paramdef> - <paramdef>float <parameter>ury</parameter></paramdef> - <paramdef>string <parameter>title</parameter></paramdef> - <paramdef>string <parameter>content</parameter></paramdef> - <paramdef>int - <parameter><optional>mode</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_add_annotation</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>llx</parameter></methodparam> + <methodparam><type>float</type><parameter>lly</parameter></methodparam> + <methodparam><type>float</type><parameter>urx</parameter></methodparam> + <methodparam><type>float</type><parameter>ury</parameter></methodparam> + <methodparam><type>string</type><parameter>title</parameter></methodparam> + <methodparam><type>string</type><parameter>content</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_add_annotation</function> adds a note with the lower left corner at (<parameter>llx</parameter>, @@ -229,13 +225,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_add_outline</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_add_outline</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_add_outline</function> function adds a bookmark with text <parameter>text</parameter> that points to the current page. @@ -269,18 +263,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_arc</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>x-coor</parameter></paramdef> - <paramdef>float <parameter>y-coor</parameter></paramdef> - <paramdef>float <parameter>radius</parameter></paramdef> - <paramdef>float <parameter>start</parameter></paramdef> - <paramdef>float <parameter>end</parameter></paramdef> - <paramdef>int <parameter><optional>mode</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_arc</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> + <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> + <methodparam><type>float</type><parameter>radius</parameter></methodparam> + <methodparam><type>float</type><parameter>start</parameter></methodparam> + <methodparam><type>float</type><parameter>end</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_arc</function> function draws an arc with center at point @@ -308,12 +300,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_begin_text</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_begin_text</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_begin_text</function> function starts a text section. It must be ended with <function>cpdf_end_text</function>. @@ -344,16 +334,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_circle</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>x-coor</parameter></paramdef> - <paramdef>float <parameter>y-coor</parameter></paramdef> - <paramdef>float <parameter>radius</parameter></paramdef> - <paramdef>int <parameter><optional>mode</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_circle</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> + <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> + <methodparam><type>float</type><parameter>radius</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_circle</function> function draws a circle with center at point @@ -379,12 +367,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_clip</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_clip</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_clip</function> function clips all drawing to the current path. @@ -399,12 +385,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_close</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_close</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_close</function> function closes the pdf document. This should be the last function even after @@ -424,12 +408,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_closepath</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_closepath</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_closepath</function> function closes the current path. @@ -444,12 +426,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_closepath_fill_stroke</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_closepath_fill_stroke</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_closepath_fill_stroke</function> function closes, fills the interior of the current path with the current fill color and @@ -474,12 +454,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_closepath_stroke</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_closepath_stroke</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_closepath_stroke</function> function is a combination of <function>cpdf_closepath</function> and @@ -499,13 +477,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_continue_text</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_continue_text</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_continue_text</function> function outputs the string in <parameter>text</parameter> in the next line. @@ -526,19 +502,17 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_curveto</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>x1</parameter></paramdef> - <paramdef>float <parameter>y1</parameter></paramdef> - <paramdef>float <parameter>x2</parameter></paramdef> - <paramdef>float <parameter>y2</parameter></paramdef> - <paramdef>float <parameter>x3</parameter></paramdef> - <paramdef>float <parameter>y3</parameter></paramdef> - <paramdef>int <parameter><optional>mode</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_curveto</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>x1</parameter></methodparam> + <methodparam><type>float</type><parameter>y1</parameter></methodparam> + <methodparam><type>float</type><parameter>x2</parameter></methodparam> + <methodparam><type>float</type><parameter>y2</parameter></methodparam> + <methodparam><type>float</type><parameter>x3</parameter></methodparam> + <methodparam><type>float</type><parameter>y3</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_curveto</function> function draws a Bezier curve from the current point to the point @@ -569,12 +543,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_end_text</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_end_text</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_end_text</function> function ends a text section which was started with <function>cpdf_begin_text</function>. @@ -605,12 +577,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_fill</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_fill</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_fill</function> function fills the interior of the current path with the current fill color. @@ -633,12 +603,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_fill_stroke</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_fill_stroke</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_fill_stroke</function> function fills the interior of the current path with the current fill color and draws current path. @@ -662,12 +630,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_finalize</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_finalize</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_finalize</function> function ends the document. You still have to call <function>cpdf_close</function> @@ -685,13 +651,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_finalize_page</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>int <parameter>page number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_finalize_page</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>int</type><parameter>page number</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_finalize_page</function> function ends the page with page number <parameter>page number</parameter>. @@ -713,18 +677,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef> - void <function>cpdf_global_set_document_limits</function> - </funcdef> - <paramdef>int <parameter>maxpages</parameter></paramdef> - <paramdef>int <parameter>maxfonts</parameter></paramdef> - <paramdef>int <parameter>maximages</parameter></paramdef> - <paramdef>int <parameter>maxannotations</parameter></paramdef> - <paramdef>int <parameter>maxobjects</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_global_set_document_limits</methodname> + <methodparam><type>int</type><parameter>maxpages</parameter></methodparam> + <methodparam><type>int</type><parameter>maxfonts</parameter></methodparam> + <methodparam><type>int</type><parameter>maximages</parameter></methodparam> + <methodparam><type>int</type><parameter>maxannotations</parameter></methodparam> + <methodparam><type>int</type><parameter>maxobjects</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_global_set_document_limits</function> function sets several document limits. This function has to be called before @@ -744,23 +704,19 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>cpdf_import_jpeg</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>string <parameter>file name</parameter></paramdef> - <paramdef>float <parameter>x-coor</parameter></paramdef> - <paramdef>float <parameter>y-coor</parameter></paramdef> - <paramdef>float <parameter>angle</parameter></paramdef> - <paramdef>float <parameter>width</parameter></paramdef> - <paramdef>float <parameter>height</parameter></paramdef> - <paramdef>float <parameter>x-scale</parameter></paramdef> - <paramdef>float <parameter>y-scale</parameter></paramdef> - <paramdef>int - <parameter><optional>mode</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>cpdf_import_jpeg</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>string</type><parameter>file name</parameter></methodparam> + <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> + <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> + <methodparam><type>float</type><parameter>angle</parameter></methodparam> + <methodparam><type>float</type><parameter>width</parameter></methodparam> + <methodparam><type>float</type><parameter>height</parameter></methodparam> + <methodparam><type>float</type><parameter>x-scale</parameter></methodparam> + <methodparam><type>float</type><parameter>y-scale</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_import_jpeg</function> function opens an image stored in the file with the name <parameter>file @@ -788,15 +744,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_lineto</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>x-coor</parameter></paramdef> - <paramdef>float <parameter>y-coor</parameter></paramdef> - <paramdef>int <parameter><optional>mode</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_lineto</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> + <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_lineto</function> function draws a line from the current point to the point with coordinates @@ -823,17 +777,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_moveto</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>x-coor</parameter></paramdef> - <paramdef>float <parameter>y-coor</parameter></paramdef> - <paramdef>int - <parameter><optional>mode</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_moveto</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> + <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_moveto</function> function set the current point to the coordinates <parameter>x-coor</parameter> and @@ -855,16 +805,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>cpdf_newpath</function> - </funcdef> - <paramdef>int - <parameter>pdf document</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_newpath</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_newpath</function> starts a new path on the document given by the <parameter>pdf document</parameter> @@ -880,15 +824,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>cpdf_open</function></funcdef> - <paramdef>int <parameter>compression</parameter></paramdef> - <paramdef> - string <parameter><optional>filename</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>cpdf_open</methodname> + <methodparam><type>int</type><parameter>compression</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_open</function> function opens a new pdf document. The first parameter turns document compression @@ -927,12 +867,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_output_buffer</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_output_buffer</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_output_buffer</function> function outputs the pdf document to stdout. The document has to be created in memory which @@ -952,19 +890,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_page_init</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>int <parameter>page number</parameter></paramdef> - <paramdef>int <parameter>orientation</parameter></paramdef> - <paramdef>float <parameter>height</parameter></paramdef> - <paramdef>float <parameter>width</parameter></paramdef> - <paramdef> - float <parameter><optional>unit</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_page_init</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>int</type><parameter>page number</parameter></methodparam> + <methodparam><type>int</type><parameter>orientation</parameter></methodparam> + <methodparam><type>float</type><parameter>height</parameter></methodparam> + <methodparam><type>float</type><parameter>width</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>unit</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_page_init</function> function starts a new page with height <parameter>height</parameter> and width @@ -990,21 +924,17 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_place_inline_image</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>int <parameter>image</parameter></paramdef> - <paramdef>float <parameter>x-coor</parameter></paramdef> - <paramdef>float <parameter>y-coor</parameter></paramdef> - <paramdef>float <parameter>angle</parameter></paramdef> - <paramdef>float <parameter>width</parameter></paramdef> - <paramdef>float <parameter>height</parameter></paramdef> - <paramdef>int - <parameter><optional>mode</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_place_inline_image</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>int</type><parameter>image</parameter></methodparam> + <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> + <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> + <methodparam><type>float</type><parameter>angle</parameter></methodparam> + <methodparam><type>float</type><parameter>width</parameter></methodparam> + <methodparam><type>float</type><parameter>height</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_place_inline_image</function> function places an image created with the php image functions on the page at @@ -1031,17 +961,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_rect</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>x-coor</parameter></paramdef> - <paramdef>float <parameter>y-coor</parameter></paramdef> - <paramdef>float <parameter>width</parameter></paramdef> - <paramdef>float <parameter>height</parameter></paramdef> - <paramdef>int <parameter><optional>mode</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_rect</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> + <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> + <methodparam><type>float</type><parameter>width</parameter></methodparam> + <methodparam><type>float</type><parameter>height</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_rect</function> function draws a rectangle with its lower left corner at point @@ -1065,12 +993,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_restore</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_restore</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_restore</function> function restores the environment saved with <function>cpdf_save</function>. It works @@ -1102,15 +1028,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_rlineto</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>x-coor</parameter></paramdef> - <paramdef>float <parameter>y-coor</parameter></paramdef> - <paramdef>int <parameter><optional>mode</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_rlineto</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> + <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_rlineto</function> function draws a line from the current point to the relative point with coordinates @@ -1137,15 +1061,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_rmoveto</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>x-coor</parameter></paramdef> - <paramdef>float <parameter>y-coor</parameter></paramdef> - <paramdef>int <parameter><optional>mode</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_rmoveto</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> + <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_rmoveto</function> function set the current point relative to the coordinates <parameter>x-coor</parameter> and @@ -1170,13 +1092,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_rotate</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>angle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_rotate</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>angle</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_rotate</function> function set the rotation in degrees to <parameter>angle</parameter>. @@ -1193,13 +1113,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_rotate_text</function></funcdef> - <paramdef>int <parameter>pdfdoc</parameter></paramdef> - <paramdef>float <parameter>angle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_rotate_text</methodname> + <methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>float</type><parameter>angle</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1213,12 +1131,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_save</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_save</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_save</function> function saves the current environment. It works like the postscript command gsave. Very @@ -1238,13 +1154,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_save_to_file</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_save_to_file</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_save_to_file</function> function outputs the pdf document into a file if it has been created in memory. @@ -1267,14 +1181,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_scale</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>x-scale</parameter></paramdef> - <paramdef>float <parameter>y-scale</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_scale</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>x-scale</parameter></methodparam> + <methodparam><type>float</type><parameter>y-scale</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_scale</function> function set the scaling factor in both directions. @@ -1289,13 +1201,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_set_char_spacing</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>space</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_set_char_spacing</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>space</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_set_char_spacing</function> function sets the spacing between characters. @@ -1314,12 +1224,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_set_creator</function></funcdef> - <paramdef>string <parameter>creator</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_set_creator</methodname> + <methodparam><type>string</type><parameter>creator</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_set_creator</function> function sets the creator of a pdf document. @@ -1339,13 +1247,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_set_current_page</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>int <parameter>page number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_set_current_page</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>int</type><parameter>page number</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_set_current_page</function> function set the page on which all operations are performed. One can switch between pages @@ -1364,15 +1270,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_set_font</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>string <parameter>font name</parameter></paramdef> - <paramdef>float <parameter>size</parameter></paramdef> - <paramdef>string <parameter>encoding</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_set_font</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>string</type><parameter>font name</parameter></methodparam> + <methodparam><type>float</type><parameter>size</parameter></methodparam> + <methodparam><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_set_font</function> function sets the current font face, font size and encoding. Currently only @@ -1398,13 +1302,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_set_horiz_scaling</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>scale</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_set_horiz_scaling</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>scale</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_set_horiz_scaling</function> function sets the horizontal scaling to <parameter>scale</parameter> percent. @@ -1419,12 +1321,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_set_keywords</function></funcdef> - <paramdef>string <parameter>keywords</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_set_keywords</methodname> + <methodparam><type>string</type><parameter>keywords</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_set_keywords</function> function sets the keywords of a pdf document. @@ -1444,13 +1344,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_set leading</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>distance</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_set leading</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>distance</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_set_leading</function> function sets the distance between text lines. This will be used if text is output by @@ -1469,14 +1367,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_set_page_animation</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>int <parameter>transition</parameter></paramdef> - <paramdef>float <parameter>duration</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_set_page_animation</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>int</type><parameter>transition</parameter></methodparam> + <methodparam><type>float</type><parameter>duration</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_set_page_animation</function> function set the transition between following pages. @@ -1519,12 +1415,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_set_subject</function></funcdef> - <paramdef>string <parameter>subject</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_set_subject</methodname> + <methodparam><type>string</type><parameter>subject</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_set_subject</function> function sets the subject of a pdf document. @@ -1544,13 +1438,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_set_text_matrix</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>array <parameter>matrix</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_set_text_matrix</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>array</type><parameter>matrix</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_set_text_matrix</function> function sets a matrix which describes a transformation applied on the current @@ -1566,15 +1458,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_set_text_pos</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>x-coor</parameter></paramdef> - <paramdef>float <parameter>y-coor</parameter></paramdef> - <paramdef>int <parameter><optional>mode</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_set_text_pos</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> + <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_set_text_pos</function> function sets the position of text for the next <function>cpdf_show</function> @@ -1600,13 +1490,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_set_text_rendering</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_set_text_rendering</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_set_text_rendering</function> function determines how text is rendered. @@ -1628,13 +1516,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_set_text_rise</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_set_text_rise</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_set_text_rise</function> function sets the text rising to <parameter>value</parameter> units. @@ -1649,12 +1535,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_set_title</function></funcdef> - <paramdef>string <parameter>title</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_set_title</methodname> + <methodparam><type>string</type><parameter>title</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_set_title</function> function sets the title of a pdf document. @@ -1674,13 +1558,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_set_word_spacing</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>space</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_set_word_spacing</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>space</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_set_word_spacing</function> function sets the spacing between words. @@ -1699,14 +1581,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_setdash</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>white</parameter></paramdef> - <paramdef>float <parameter>black</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_setdash</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>white</parameter></methodparam> + <methodparam><type>float</type><parameter>black</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_setdash</function> function set the dash pattern <parameter>white</parameter> white units and @@ -1723,13 +1603,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_setflat</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_setflat</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_setflat</function> function set the flatness to a value between 0 and 100. @@ -1744,13 +1622,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_setgray</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>gray value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_setgray</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>gray value</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_setgray</function> function sets the current drawing and filling color to the given gray value. @@ -1769,13 +1645,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_setgray_fill</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_setgray_fill</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_setgray_fill</function> function sets the current gray value to fill a path. @@ -1793,13 +1667,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_setgray_stroke</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>gray value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_setgray_stroke</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>gray value</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_setgray_stroke</function> function sets the current drawing color to the given gray value. @@ -1817,13 +1689,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_setlinecap</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>int <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_setlinecap</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>int</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_setlinecap</function> function set the linecap parameter between a value of 0 and 2. 0 = butt end, 1 = round, @@ -1839,13 +1709,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_setlinejoin</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>long <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_setlinejoin</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>long</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_setlinejoin</function> function set the linejoin parameter between a value of 0 and 2. 0 = miter, 1 = @@ -1861,13 +1729,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_setlinewidth</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>width</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_setlinewidth</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>width</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_setlinewidth</function> function set the line width to <parameter>width</parameter>. @@ -1882,13 +1748,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_setmiterlimit</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_setmiterlimit</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_setmiterlimit</function> function set the miter limit to a value greater or equal than 1. @@ -1903,15 +1767,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_setrgbcolor</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>red value</parameter></paramdef> - <paramdef>float <parameter>green value</parameter></paramdef> - <paramdef>float <parameter>blue value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_setrgbcolor</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>red value</parameter></methodparam> + <methodparam><type>float</type><parameter>green value</parameter></methodparam> + <methodparam><type>float</type><parameter>blue value</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_setrgbcolor</function> function sets the current drawing and filling color to the given rgb color value. @@ -1930,15 +1792,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_setrgbcolor_fill</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>red value</parameter></paramdef> - <paramdef>float <parameter>green value</parameter></paramdef> - <paramdef>float <parameter>blue value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_setrgbcolor_fill</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>red value</parameter></methodparam> + <methodparam><type>float</type><parameter>green value</parameter></methodparam> + <methodparam><type>float</type><parameter>blue value</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_setrgbcolor_fill</function> function sets the current rgb color value to fill a path. @@ -1957,15 +1817,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_setrgbcolor_stroke</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>red value</parameter></paramdef> - <paramdef>float <parameter>green value</parameter></paramdef> - <paramdef>float <parameter>blue value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_setrgbcolor_stroke</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>red value</parameter></methodparam> + <methodparam><type>float</type><parameter>green value</parameter></methodparam> + <methodparam><type>float</type><parameter>blue value</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_setrgbcolor_stroke</function> function sets the current drawing color to the given rgb color value. @@ -1984,13 +1842,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_show</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_show</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_show</function> function outputs the string in <parameter>text</parameter> at the current position. @@ -2010,16 +1866,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_show_xy</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - <paramdef>float <parameter>x-coor</parameter></paramdef> - <paramdef>float <parameter>y-coor</parameter></paramdef> - <paramdef>int <parameter><optional>mode</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_show_xy</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> + <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_show_xy</function> function outputs the string <parameter>text</parameter> at position with coordinates @@ -2050,13 +1904,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>cpdf_stringwidth</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>cpdf_stringwidth</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_stringwidth</function> function returns the width of the string in <parameter>text</parameter>. It requires @@ -2077,14 +1929,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_set_font_directories</function></funcdef> - <paramdef>int <parameter>pdfdoc</parameter></paramdef> - <paramdef>string <parameter>pfmdir</parameter></paramdef> - <paramdef>string <parameter>pfbdir</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_set_font_directories</methodname> + <methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>string</type><parameter>pfmdir</parameter></methodparam> + <methodparam><type>string</type><parameter>pfbdir</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2100,13 +1950,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_set_font_map_file</function></funcdef> - <paramdef>int <parameter>pdfdoc</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_set_font_map_file</methodname> + <methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2122,13 +1970,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_set_viewer_preferences</function></funcdef> - <paramdef>int <parameter>pdfdoc</parameter></paramdef> - <paramdef>array <parameter>preferences</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_set_viewer_preferences</methodname> + <methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>array</type><parameter>preferences</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2142,12 +1988,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_stroke</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_stroke</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_stroke</function> function draws a line along current path. @@ -2166,22 +2010,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_text</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - <paramdef>float <parameter>x-coor</parameter></paramdef> - <paramdef>float <parameter>y-coor</parameter></paramdef> - <paramdef>int <parameter><optional>mode</optional></parameter></paramdef> - <paramdef> - float <parameter><optional>orientation</optional></parameter> - </paramdef> - <paramdef> - int <parameter><optional>alignmode</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_text</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> + <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>orientation</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>alignmode</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_text</function> function outputs the string <parameter>text</parameter> at position with coordinates @@ -2213,15 +2051,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_translate</function></funcdef> - <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>float <parameter>x-coor</parameter></paramdef> - <paramdef>float <parameter>y-coor</parameter></paramdef> - <paramdef>int <parameter><optional>mode</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_translate</methodname> + <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> + <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> + <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> The <function>cpdf_translate</function> function set the origin of coordinate system to the point (<parameter>x-coor</parameter>, @@ -2245,18 +2081,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>cpdf_set_action_url</function></funcdef> - <paramdef>int <parameter>pdfdoc</parameter></paramdef> - <paramdef>float <parameter>xll</parameter></paramdef> - <paramdef>float <parameter>yll</parameter></paramdef> - <paramdef>float <parameter>xur</parameter></paramdef> - <paramdef>float <parameter>xur</parameter></paramdef> - <paramdef>string <parameter>url</parameter></paramdef> - <paramdef>int <parameter><optional>mode</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>cpdf_set_action_url</methodname> + <methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>float</type><parameter>xll</parameter></methodparam> + <methodparam><type>float</type><parameter>yll</parameter></methodparam> + <methodparam><type>float</type><parameter>xur</parameter></methodparam> + <methodparam><type>float</type><parameter>xur</parameter></methodparam> + <methodparam><type>string</type><parameter>url</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2285,3 +2119,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/crack.xml diff -u phpdoc/en/functions/crack.xml:1.6 phpdoc/en/functions/crack.xml:1.7 --- phpdoc/en/functions/crack.xml:1.6 Sat Jan 19 18:11:32 2002 +++ phpdoc/en/functions/crack.xml Sat Feb 2 10:35:54 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <reference id="ref.crack"> <title>Crack functions</title> <titleabbrev>Crack functions</titleabbrev> @@ -63,12 +63,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>crack_opendict</function></funcdef> - <paramdef>string <parameter>dictionary</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>crack_opendict</methodname> + <methodparam><type>string</type><parameter>dictionary</parameter></methodparam> + </methodsynopsis> <para> Returns a dictionary resource identifier on success, or &false; on failure. </para> @@ -97,14 +95,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>crack_closedict</function></funcdef> - <paramdef>resource - <parameter><optional>dictionary</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>crack_closedict</methodname> + <methodparam choice="opt"><type>resource</type><parameter>dictionary</parameter></methodparam> + </methodsynopsis> <para> &return.success; </para> @@ -125,15 +119,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>crack_check</function></funcdef> - <paramdef>resource - <parameter><optional>dictionary</optional></parameter> - </paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>crack_check</methodname> + <methodparam choice="opt"><type>resource</type><parameter>dictionary</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if <parameter>password</parameter> is strong, or &false; otherwise. </para> @@ -154,12 +144,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>crack_getlastmessage</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>crack_getlastmessage</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>crack_getlastmessage</function> returns the message from the @@ -189,4 +177,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 - --> \ No newline at end of file + --> Index: phpdoc/en/functions/ctype.xml diff -u phpdoc/en/functions/ctype.xml:1.14 phpdoc/en/functions/ctype.xml:1.15 --- phpdoc/en/functions/ctype.xml:1.14 Fri Jan 25 09:01:05 2002 +++ phpdoc/en/functions/ctype.xml Sat Feb 2 10:35:55 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.14 $ --> +<!-- $Revision: 1.15 $ --> <reference id="ref.ctype"> <title>Character type functions</title> <titleabbrev>ctype</titleabbrev> @@ -34,12 +34,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ctype_alnum</function></funcdef> - <paramdef>string <parameter>c</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ctype_alnum</methodname> + <methodparam><type>string</type><parameter>c</parameter></methodparam> + </methodsynopsis> <para> See also <function>setlocale</function>. </para> @@ -53,12 +51,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ctype_alpha</function></funcdef> - <paramdef>string <parameter>c</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ctype_alpha</methodname> + <methodparam><type>string</type><parameter>c</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -71,12 +67,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ctype_cntrl</function></funcdef> - <paramdef>string <parameter>c</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ctype_cntrl</methodname> + <methodparam><type>string</type><parameter>c</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -89,12 +83,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ctype_digit</function></funcdef> - <paramdef>string <parameter>c</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ctype_digit</methodname> + <methodparam><type>string</type><parameter>c</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -107,12 +99,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ctype_lower</function></funcdef> - <paramdef>string <parameter>c</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ctype_lower</methodname> + <methodparam><type>string</type><parameter>c</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -125,12 +115,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ctype_graph</function></funcdef> - <paramdef>string <parameter>c</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ctype_graph</methodname> + <methodparam><type>string</type><parameter>c</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -143,12 +131,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ctype_print</function></funcdef> - <paramdef>string <parameter>c</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ctype_print</methodname> + <methodparam><type>string</type><parameter>c</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -164,12 +150,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ctype_punct</function></funcdef> - <paramdef>string <parameter>c</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ctype_punct</methodname> + <methodparam><type>string</type><parameter>c</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -182,12 +166,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ctype_space</function></funcdef> - <paramdef>string <parameter>c</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ctype_space</methodname> + <methodparam><type>string</type><parameter>c</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -200,12 +182,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ctype_upper</function></funcdef> - <paramdef>string <parameter>c</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ctype_upper</methodname> + <methodparam><type>string</type><parameter>c</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -220,12 +200,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ctype_xdigit</function></funcdef> - <paramdef>string <parameter>c</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ctype_xdigit</methodname> + <methodparam><type>string</type><parameter>c</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -253,3 +231,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/curl.xml diff -u phpdoc/en/functions/curl.xml:1.25 phpdoc/en/functions/curl.xml:1.26 --- phpdoc/en/functions/curl.xml:1.25 Wed Jan 9 19:46:06 2002 +++ phpdoc/en/functions/curl.xml Sat Feb 2 10:35:55 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.25 $ --> +<!-- $Revision: 1.26 $ --> <reference id="ref.curl"> <title>CURL, Client URL Library Functions</title> <titleabbrev>CURL</titleabbrev> @@ -71,18 +71,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>curl_init</function> - </funcdef> - <paramdef>string - <parameter> - <optional>url</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>curl_init</methodname> + <methodparam choice="opt"><type>string</type><parameter> + url + </parameter></methodparam> + </methodsynopsis> <para> The <function>curl_init</function> will initialize a new session and return a CURL handle for use with the @@ -126,22 +120,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool - <function>curl_setopt</function> - </funcdef> - <paramdef>int - <parameter>ch</parameter> - </paramdef> - <paramdef>string - <parameter>option</parameter> - </paramdef> - <paramdef>mixed - <parameter>value</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>curl_setopt</methodname> + <methodparam><type>int</type><parameter>ch</parameter></methodparam> + <methodparam><type>string</type><parameter>option</parameter></methodparam> + <methodparam><type>mixed</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> The <function>curl_setopt</function> function will set options for a CURL session identified by the <parameter>ch</parameter> @@ -528,16 +512,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool - <function>curl_exec</function> - </funcdef> - <paramdef>int - <parameter>ch</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>curl_exec</methodname> + <methodparam><type>int</type><parameter>ch</parameter></methodparam> + </methodsynopsis> <para> This function is should be called after you initialize a CURL session and all the options for the session are set. Its purpose @@ -555,16 +533,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>curl_close</function> - </funcdef> - <paramdef>int - <parameter>ch</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>curl_close</methodname> + <methodparam><type>int</type><parameter>ch</parameter></methodparam> + </methodsynopsis> <para> This function closes a CURL session and frees all resources. The CURL handle, <parameter>ch</parameter>, is also deleted. @@ -579,14 +551,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string - <function>curl_version</function> - </funcdef> + <methodsynopsis> + <type>string</type><methodname>curl_version</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> The <function>curl_version</function> function returns a string containing the current CURL version. @@ -601,12 +569,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>curl_errno</function></funcdef> - <paramdef>int <parameter>ch</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>curl_errno</methodname> + <methodparam><type>int</type><parameter>ch</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -622,12 +588,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>curl_error</function></funcdef> - <paramdef>int <parameter>ch</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>curl_error</methodname> + <methodparam><type>int</type><parameter>ch</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -643,13 +607,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>curl_getinfo</function></funcdef> - <paramdef>int <parameter>ch</parameter></paramdef> - <paramdef>int <parameter>opt</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>curl_getinfo</methodname> + <methodparam><type>int</type><parameter>ch</parameter></methodparam> + <methodparam><type>int</type><parameter>opt</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -678,3 +640,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/cybercash.xml diff -u phpdoc/en/functions/cybercash.xml:1.12 phpdoc/en/functions/cybercash.xml:1.13 --- phpdoc/en/functions/cybercash.xml:1.12 Sat Jan 19 17:52:03 2002 +++ phpdoc/en/functions/cybercash.xml Sat Feb 2 10:35:56 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.12 $ --> +<!-- $Revision: 1.13 $ --> <reference id="ref.cybercash"> <title>Cybercash payment functions</title> <titleabbrev>Cybercash</titleabbrev> @@ -20,14 +20,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>cybercash_encr</function></funcdef> - <paramdef>string <parameter>wmk</parameter></paramdef> - <paramdef>string <parameter>sk</parameter></paramdef> - <paramdef>string <parameter>inbuff</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>cybercash_encr</methodname> + <methodparam><type>string</type><parameter>wmk</parameter></methodparam> + <methodparam><type>string</type><parameter>sk</parameter></methodparam> + <methodparam><type>string</type><parameter>inbuff</parameter></methodparam> + </methodsynopsis> <para> The function returns an associative array with the elements "errcode" and, if "errcode" is &false;, "outbuff" (string), @@ -43,14 +41,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>cybercash_decr</function></funcdef> - <paramdef>string <parameter>wmk</parameter></paramdef> - <paramdef>string <parameter>sk</parameter></paramdef> - <paramdef>string <parameter>inbuff</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>cybercash_decr</methodname> + <methodparam><type>string</type><parameter>wmk</parameter></methodparam> + <methodparam><type>string</type><parameter>sk</parameter></methodparam> + <methodparam><type>string</type><parameter>inbuff</parameter></methodparam> + </methodsynopsis> <para> The function returns an associative array with the elements "errcode" and, if "errcode" is &false;, "outbuff" (string), @@ -66,14 +62,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string - <function>cybercash_base64_encode</function> - </funcdef> - <paramdef>string <parameter>inbuff</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>cybercash_base64_encode</methodname> + <methodparam><type>string</type><parameter>inbuff</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -86,14 +78,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string - <function>cybercash_base64_decode</function> - </funcdef> - <paramdef>string <parameter>inbuff</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>cybercash_base64_decode</methodname> + <methodparam><type>string</type><parameter>inbuff</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -121,3 +109,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/cybermut.xml diff -u phpdoc/en/functions/cybermut.xml:1.15 phpdoc/en/functions/cybermut.xml:1.16 --- phpdoc/en/functions/cybermut.xml:1.15 Sat Jan 19 17:56:44 2002 +++ phpdoc/en/functions/cybermut.xml Sat Feb 2 10:35:56 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.15 $ --> +<!-- $Revision: 1.16 $ --> <reference id="ref.cybermut"> <title>Cr&eacute;dit Mutuel CyberMUT functions</title> <titleabbrev>CyberMUT</titleabbrev> @@ -49,23 +49,21 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>cybermut_creerformulairecm</function></funcdef> - <paramdef>string <parameter>url_CM</parameter></paramdef> - <paramdef>string <parameter>version</parameter></paramdef> - <paramdef>string <parameter>TPE</parameter></paramdef> - <paramdef>string <parameter>montant</parameter></paramdef> - <paramdef>string <parameter>ref_commande</parameter></paramdef> - <paramdef>string <parameter>texte_libre</parameter></paramdef> - <paramdef>string <parameter>url_retour</parameter></paramdef> - <paramdef>string <parameter>url_retour_ok</parameter></paramdef> - <paramdef>string <parameter>url_retour_err</parameter></paramdef> - <paramdef>string <parameter>langue</parameter></paramdef> - <paramdef>string <parameter>code_societe</parameter></paramdef> - <paramdef>string <parameter>texte_bouton</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>cybermut_creerformulairecm</methodname> + <methodparam><type>string</type><parameter>url_CM</parameter></methodparam> + <methodparam><type>string</type><parameter>version</parameter></methodparam> + <methodparam><type>string</type><parameter>TPE</parameter></methodparam> + <methodparam><type>string</type><parameter>montant</parameter></methodparam> + <methodparam><type>string</type><parameter>ref_commande</parameter></methodparam> + <methodparam><type>string</type><parameter>texte_libre</parameter></methodparam> + <methodparam><type>string</type><parameter>url_retour</parameter></methodparam> + <methodparam><type>string</type><parameter>url_retour_ok</parameter></methodparam> + <methodparam><type>string</type><parameter>url_retour_err</parameter></methodparam> + <methodparam><type>string</type><parameter>langue</parameter></methodparam> + <methodparam><type>string</type><parameter>code_societe</parameter></methodparam> + <methodparam><type>string</type><parameter>texte_bouton</parameter></methodparam> + </methodsynopsis> <para> <function>cybermut_creerformulairecm</function> is used to generate the HTML form of request for payment. @@ -118,19 +116,17 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>cybermut_testmac</function></funcdef> - <paramdef>string <parameter>code_MAC</parameter></paramdef> - <paramdef>string <parameter>version</parameter></paramdef> - <paramdef>string <parameter>TPE</parameter></paramdef> - <paramdef>string <parameter>cdate</parameter></paramdef> - <paramdef>string <parameter>montant</parameter></paramdef> - <paramdef>string <parameter>ref_commande</parameter></paramdef> - <paramdef>string <parameter>texte_libre</parameter></paramdef> - <paramdef>string <parameter>code-retour</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>cybermut_testmac</methodname> + <methodparam><type>string</type><parameter>code_MAC</parameter></methodparam> + <methodparam><type>string</type><parameter>version</parameter></methodparam> + <methodparam><type>string</type><parameter>TPE</parameter></methodparam> + <methodparam><type>string</type><parameter>cdate</parameter></methodparam> + <methodparam><type>string</type><parameter>montant</parameter></methodparam> + <methodparam><type>string</type><parameter>ref_commande</parameter></methodparam> + <methodparam><type>string</type><parameter>texte_libre</parameter></methodparam> + <methodparam><type>string</type><parameter>code-retour</parameter></methodparam> + </methodsynopsis> <para> <function>cybermut_testmac</function> is used to make sure that there was not data diddling contained in the received message of confirmation. @@ -197,12 +193,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>cybermut_creerreponsecm</function></funcdef> - <paramdef>string <parameter>phrase</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>cybermut_creerreponsecm</methodname> + <methodparam><type>string</type><parameter>phrase</parameter></methodparam> + </methodsynopsis> <para> <function>cybermut_creerreponsecm</function> returns a string containing delivery acknowledgement message. @@ -240,3 +234,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/cyrus.xml diff -u phpdoc/en/functions/cyrus.xml:1.6 phpdoc/en/functions/cyrus.xml:1.7 --- phpdoc/en/functions/cyrus.xml:1.6 Wed Jan 9 19:38:23 2002 +++ phpdoc/en/functions/cyrus.xml Sat Feb 2 10:35:56 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <reference id="ref.cyrus"> <title>Cyrus IMAP administration functions</title> <titleabbrev>Cyradm functions</titleabbrev> @@ -18,20 +18,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>cyrus_connect</function></funcdef> - <paramdef>string - <parameter><optional>host</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>port</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>cyrus_connect</methodname> + <methodparam choice="opt"><type>string</type><parameter>host</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>port</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -45,27 +37,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>cyrus_authenticate</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - <paramdef>string - <parameter><optional>mechlist</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>service</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>user</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>minssf</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>maxssf</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>cyrus_authenticate</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>mechlist</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>service</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>user</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>minssf</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>maxssf</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -79,13 +59,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>cyrus_bind</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - <paramdef>array <parameter>callbacks</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>cyrus_bind</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>array</type><parameter>callbacks</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -99,13 +77,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>cyrus_unbind</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>trigger_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>cyrus_unbind</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>trigger_name</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -119,13 +95,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>cyrus_query</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>cyrus_query</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -139,12 +113,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>cyrus_close</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>cyrus_close</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -170,4 +142,5 @@ sgml-local-ecat-files:nil End: --> + Index: phpdoc/en/functions/datetime.xml diff -u phpdoc/en/functions/datetime.xml:1.65 phpdoc/en/functions/datetime.xml:1.66 --- phpdoc/en/functions/datetime.xml:1.65 Tue Jan 15 05:38:33 2002 +++ phpdoc/en/functions/datetime.xml Sat Feb 2 10:35:56 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.65 $ --> +<!-- $Revision: 1.66 $ --> <reference id="ref.datetime"> <title>Date and Time functions</title> <titleabbrev>Date/time</titleabbrev> @@ -11,14 +11,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>checkdate</function></funcdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>checkdate</methodname> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam><type>int</type><parameter>day</parameter></methodparam> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if the date given is valid; otherwise returns &false;. Checks the validity of the date formed by the arguments. A date @@ -56,17 +54,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>date</function></funcdef> - <paramdef>string <parameter>format</parameter></paramdef> - <paramdef>int - <parameter> - <optional>timestamp</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>date</methodname> + <methodparam><type>string</type><parameter>format</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + timestamp + </parameter></methodparam> + </methodsynopsis> <para> Returns a string formatted according to the given format string using the given integer <parameter>timestamp</parameter> or the current local time @@ -356,14 +350,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>getdate</function></funcdef> - <paramdef>int - <parameter><optional>timestamp</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>getdate</methodname> + <methodparam choice="opt"><type>int</type><parameter>timestamp</parameter></methodparam> + </methodsynopsis> <para> Returns an associative array containing the date information of the <parameter>timestamp</parameter>, or the current local time if @@ -446,12 +436,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>gettimeofday</function></funcdef> + <methodsynopsis> + <type>array</type><methodname>gettimeofday</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This is an interface to gettimeofday(2). It returns an associative array containing the data returned from the system @@ -489,15 +477,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>gmdate</function></funcdef> - <paramdef>string <parameter>format</parameter></paramdef> - <paramdef>int - <parameter><optional>timestamp</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>gmdate</methodname> + <methodparam><type>string</type><parameter>format</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timestamp</parameter></methodparam> + </methodsynopsis> <para> Identical to the <function>date</function> function except that the time returned is Greenwich Mean Time (GMT). For example, when @@ -527,20 +511,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gmmktime</function></funcdef> - <paramdef>int <parameter>hour</parameter></paramdef> - <paramdef>int <parameter>minute</parameter></paramdef> - <paramdef>int <parameter>second</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int - <parameter><optional>is_dst</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gmmktime</methodname> + <methodparam><type>int</type><parameter>hour</parameter></methodparam> + <methodparam><type>int</type><parameter>minute</parameter></methodparam> + <methodparam><type>int</type><parameter>second</parameter></methodparam> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam><type>int</type><parameter>day</parameter></methodparam> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>is_dst</parameter></methodparam> + </methodsynopsis> <para> Identical to <function>mktime</function> except the passed parameters represents a GMT date. @@ -557,15 +537,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>gmstrftime</function></funcdef> - <paramdef>string <parameter>format</parameter></paramdef> - <paramdef>int - <parameter><optional>timestamp</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>gmstrftime</methodname> + <methodparam><type>string</type><parameter>format</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timestamp</parameter></methodparam> + </methodsynopsis> <para> Behaves the same as <function>strftime</function> except that the time returned is Greenwich Mean Time (GMT). For example, when run @@ -596,21 +572,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>localtime</function></funcdef> - <paramdef>int - <parameter> - <optional>timestamp</optional> - </parameter> - </paramdef> - <paramdef>bool - <parameter> - <optional>is_associative</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>localtime</methodname> + <methodparam choice="opt"><type>int</type><parameter> + timestamp + </parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter> + is_associative + </parameter></methodparam> + </methodsynopsis> <para> The <function>localtime</function> function returns an array identical to that of the structure returned by the C function @@ -683,12 +653,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>microtime</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>microtime</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns the string "msec sec" where sec is the current time measured in the number of seconds since the Unix Epoch (0:00:00 @@ -734,20 +702,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mktime</function></funcdef> - <paramdef>int <parameter>hour</parameter></paramdef> - <paramdef>int <parameter>minute</parameter></paramdef> - <paramdef>int <parameter>second</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int - <parameter><optional>is_dst</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mktime</methodname> + <methodparam><type>int</type><parameter>hour</parameter></methodparam> + <methodparam><type>int</type><parameter>minute</parameter></methodparam> + <methodparam><type>int</type><parameter>second</parameter></methodparam> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam><type>int</type><parameter>day</parameter></methodparam> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>is_dst</parameter></methodparam> + </methodsynopsis> <para> <emphasis>Warning:</emphasis> Note the strange order of arguments, which differs from the order of arguments in a regular @@ -836,17 +800,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>strftime</function></funcdef> - <paramdef>string <parameter>format</parameter></paramdef> - <paramdef>int - <parameter> - <optional>timestamp</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>strftime</methodname> + <methodparam><type>string</type><parameter>format</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + timestamp + </parameter></methodparam> + </methodsynopsis> <para> Returns a string formatted according to the given format string using the given <parameter>timestamp</parameter> or the current @@ -1104,12 +1064,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>time</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>time</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns the current time measured in the number of seconds since the Unix Epoch (January 1 1970 00:00:00 GMT). @@ -1130,15 +1088,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>strtotime</function></funcdef> - <paramdef>string <parameter>time</parameter></paramdef> - <paramdef>int - <parameter><optional>now</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>strtotime</methodname> + <methodparam><type>string</type><parameter>time</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>now</parameter></methodparam> + </methodsynopsis> <simpara> The function expects to be given a string containing an English date format and will try to parse that format into a UNIX timestamp relative @@ -1216,3 +1170,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/dba.xml diff -u phpdoc/en/functions/dba.xml:1.18 phpdoc/en/functions/dba.xml:1.19 --- phpdoc/en/functions/dba.xml:1.18 Wed Dec 12 15:46:41 2001 +++ phpdoc/en/functions/dba.xml Sat Feb 2 10:35:57 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.18 $ --> +<!-- $Revision: 1.19 $ --> <reference id="ref.dba"> <title>Database (dbm-style) abstraction layer functions</title> <titleabbrev>dba</titleabbrev> @@ -180,12 +180,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>dba_close</function></funcdef> - <paramdef>int <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>dba_close</methodname> + <methodparam><type>int</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> <function>dba_close</function> closes the established database and frees all resources specified by @@ -212,13 +210,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>dba_delete</function></funcdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>int <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>dba_delete</methodname> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>int</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> <function>dba_delete</function> deletes the entry specified by <parameter>key</parameter> from the database specified with @@ -251,13 +247,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>dba_exists</function></funcdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>int <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>dba_exists</methodname> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>int</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> <function>dba_exists</function> checks whether the specified <parameter>key</parameter> exists in the database specified by @@ -289,13 +283,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>dba_fetch</function></funcdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>int <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>dba_fetch</methodname> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>int</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> <function>dba_fetch</function> fetches the data specified by <parameter>key</parameter> from the database specified with @@ -328,12 +320,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>dba_firstkey</function></funcdef> - <paramdef>int <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>dba_firstkey</methodname> + <methodparam><type>int</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> <function>dba_firstkey</function> returns the first key of the database specified by <parameter>handle</parameter> and resets @@ -363,14 +353,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>dba_insert</function></funcdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - <paramdef>int <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>dba_insert</methodname> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + <methodparam><type>int</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> <function>dba_insert</function> inserts the entry described with <parameter>key</parameter> and <parameter>value</parameter> into the @@ -408,12 +396,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>dba_nextkey</function></funcdef> - <paramdef>int <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>dba_nextkey</methodname> + <methodparam><type>int</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> <function>dba_nextkey</function> returns the next key of the database specified by <parameter>handle</parameter> and advances the internal @@ -442,15 +428,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dba_popen</function></funcdef> - <paramdef>string <parameter>path</parameter></paramdef> - <paramdef>string <parameter>mode</parameter></paramdef> - <paramdef>string <parameter>handler</parameter></paramdef> - <paramdef><parameter><optional>...</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dba_popen</methodname> + <methodparam><type>string</type><parameter>path</parameter></methodparam> + <methodparam><type>string</type><parameter>mode</parameter></methodparam> + <methodparam><type>string</type><parameter>handler</parameter></methodparam> + <methodparam choice="opt"><parameter>...</parameter></methodparam> + </methodsynopsis> <para> <function>dba_popen</function> establishes a persistent database instance @@ -492,15 +476,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dba_open</function></funcdef> - <paramdef>string <parameter>path</parameter></paramdef> - <paramdef>string <parameter>mode</parameter></paramdef> - <paramdef>string <parameter>handler</parameter></paramdef> - <paramdef><parameter><optional>...</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dba_open</methodname> + <methodparam><type>string</type><parameter>path</parameter></methodparam> + <methodparam><type>string</type><parameter>mode</parameter></methodparam> + <methodparam><type>string</type><parameter>handler</parameter></methodparam> + <methodparam choice="opt"><parameter>...</parameter></methodparam> + </methodsynopsis> <para> <function>dba_open</function> establishes a database instance for <parameter>path</parameter> with <parameter>mode</parameter> using @@ -541,12 +523,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>dba_optimize</function></funcdef> - <paramdef>int <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>dba_optimize</methodname> + <methodparam><type>int</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> <function>dba_optimize</function> optimizes the underlying database specified by <parameter>handle</parameter>. @@ -573,14 +553,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>dba_replace</function></funcdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - <paramdef>int <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>dba_replace</methodname> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + <methodparam><type>int</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> <function>dba_replace</function> replaces or inserts the entry described with <parameter>key</parameter> and <parameter>value</parameter> into the @@ -615,12 +593,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>dba_sync</function></funcdef> - <paramdef>int <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>dba_sync</methodname> + <methodparam><type>int</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> <function>dba_sync</function> synchronizes the database specified by <parameter>handle</parameter>. This will probably trigger a physical write @@ -662,3 +638,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/dbase.xml diff -u phpdoc/en/functions/dbase.xml:1.16 phpdoc/en/functions/dbase.xml:1.17 --- phpdoc/en/functions/dbase.xml:1.16 Sat Jan 19 18:11:32 2002 +++ phpdoc/en/functions/dbase.xml Sat Feb 2 10:35:57 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.16 $ --> +<!-- $Revision: 1.17 $ --> <reference id="ref.dbase"> <title>dBase functions</title> <titleabbrev>dBase</titleabbrev> @@ -38,13 +38,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbase_create</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>array <parameter>fields</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbase_create</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>array</type><parameter>fields</parameter></methodparam> + </methodsynopsis> <para> The <parameter>fields</parameter> parameter is an array of arrays, each array describing the format of one field in the @@ -136,13 +134,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbase_open</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>int <parameter>flags</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbase_open</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> The flags correspond to those for the open() system call. (Typically 0 means read-only, 1 means write-only, and 2 means @@ -163,12 +159,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>dbase_close</function></funcdef> - <paramdef>int <parameter>dbase_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>dbase_close</methodname> + <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> + </methodsynopsis> <para> Closes the database associated with <parameter>dbase_identifier</parameter>. @@ -183,12 +177,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>dbase_pack</function></funcdef> - <paramdef>int <parameter>dbase_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>dbase_pack</methodname> + <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> + </methodsynopsis> <para> Packs the specified database (permanently deleting all records marked for deletion using @@ -204,13 +196,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>dbase_add_record</function></funcdef> - <paramdef>int <parameter>dbase_identifier</parameter></paramdef> - <paramdef>array <parameter>record</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>dbase_add_record</methodname> + <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> + <methodparam><type>array</type><parameter>record</parameter></methodparam> + </methodsynopsis> <para> Adds the data in the <parameter>record</parameter> to the database. If the number of items in the supplied record isn't @@ -227,14 +217,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>dbase_replace_record</function></funcdef> - <paramdef>int <parameter>dbase_identifier</parameter></paramdef> - <paramdef>array <parameter>record</parameter></paramdef> - <paramdef>int <parameter>dbase_record_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>dbase_replace_record</methodname> + <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> + <methodparam><type>array</type><parameter>record</parameter></methodparam> + <methodparam><type>int</type><parameter>dbase_record_number</parameter></methodparam> + </methodsynopsis> <simpara> Replaces the data associated with the record <parameter>record_number</parameter> with the data in the @@ -258,13 +246,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>dbase_delete_record</function></funcdef> - <paramdef>int <parameter>dbase_identifier</parameter></paramdef> - <paramdef>int <parameter>record</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>dbase_delete_record</methodname> + <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>record</parameter></methodparam> + </methodsynopsis> <para> Marks <parameter>record</parameter> to be deleted from the database. To actually remove the record from the database, you @@ -280,13 +266,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>dbase_get_record</function></funcdef> - <paramdef>int <parameter>dbase_identifier</parameter></paramdef> - <paramdef>int <parameter>record</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>dbase_get_record</methodname> + <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>record</parameter></methodparam> + </methodsynopsis> <para> Returns the data from <parameter>record</parameter> in an array. The array is indexed starting at 0, and includes an @@ -322,15 +306,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array - <function>dbase_get_record_with_names</function> - </funcdef> - <paramdef>int <parameter>dbase_identifier</parameter></paramdef> - <paramdef>int <parameter>record</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>dbase_get_record_with_names</methodname> + <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>record</parameter></methodparam> + </methodsynopsis> <para> Returns the data from <parameter>record</parameter> in an associative array. The array also includes an associative member @@ -365,12 +345,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbase_numfields</function></funcdef> - <paramdef>int <parameter>dbase_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbase_numfields</methodname> + <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns the number of fields (columns) in the specified database. Field numbers are between 0 and dbase_numfields($db)-1, @@ -400,12 +378,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbase_numrecords</function></funcdef> - <paramdef>int <parameter>dbase_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbase_numrecords</methodname> + <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns the number of records (rows) in the specified database. Record numbers are between 1 and dbase_numrecords($db), @@ -436,3 +412,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/dbm.xml diff -u phpdoc/en/functions/dbm.xml:1.16 phpdoc/en/functions/dbm.xml:1.17 --- phpdoc/en/functions/dbm.xml:1.16 Wed Jan 9 19:43:33 2002 +++ phpdoc/en/functions/dbm.xml Sat Feb 2 10:35:57 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.16 $ --> +<!-- $Revision: 1.17 $ --> <reference id="ref.dbm"> <title>DBM Functions</title> <titleabbrev>DBM</titleabbrev> @@ -39,13 +39,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbmopen</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>string <parameter>flags</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbmopen</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>string</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> The first argument is the full-path filename of the DBM file to be opened and the second is the file open mode which is one of @@ -82,12 +80,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>dbmclose</function></funcdef> - <paramdef>int <parameter>dbm_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>dbmclose</methodname> + <methodparam><type>int</type><parameter>dbm_identifier</parameter></methodparam> + </methodsynopsis> <para> Unlocks and closes the specified database. </para> @@ -103,13 +99,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>dbmexists</function></funcdef> - <paramdef>int <parameter>dbm_identifier</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>dbmexists</methodname> + <methodparam><type>int</type><parameter>dbm_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if there is a value associated with the <parameter>key</parameter>. @@ -126,13 +120,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>dbmfetch</function></funcdef> - <paramdef>int <parameter>dbm_identifier</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>dbmfetch</methodname> + <methodparam><type>int</type><parameter>dbm_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + </methodsynopsis> <para> Returns the value associated with <parameter>key</parameter>. </para> @@ -148,14 +140,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbminsert</function></funcdef> - <paramdef>int <parameter>dbm_identifier</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbminsert</methodname> + <methodparam><type>int</type><parameter>dbm_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> Adds the value to the database with the specified key. </para> @@ -176,14 +166,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbmreplace</function></funcdef> - <paramdef>int <parameter>dbm_identifier</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbmreplace</methodname> + <methodparam><type>int</type><parameter>dbm_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> Replaces the value for the specified key in the database. </para> @@ -203,13 +191,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>dbmdelete</function></funcdef> - <paramdef>int <parameter>dbm_identifier</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>dbmdelete</methodname> + <methodparam><type>int</type><parameter>dbm_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + </methodsynopsis> <para> Deletes the value for <parameter>key</parameter> in the database. </para> @@ -228,12 +214,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>dbmfirstkey</function></funcdef> - <paramdef>int <parameter>dbm_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>dbmfirstkey</methodname> + <methodparam><type>int</type><parameter>dbm_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns the first key in the database. Note that no particular order is guaranteed since the database may be built using a hash-table, @@ -250,13 +234,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>dbmnextkey</function></funcdef> - <paramdef>int <parameter>dbm_identifier</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>dbmnextkey</methodname> + <methodparam><type>int</type><parameter>dbm_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + </methodsynopsis> <para> Returns the next key after <parameter>key</parameter>. By calling <function>dbmfirstkey</function> followed by successive @@ -287,12 +269,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>dblist</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>dblist</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> </refsect1> </refentry> @@ -318,3 +298,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/dbplus.xml diff -u phpdoc/en/functions/dbplus.xml:1.20 phpdoc/en/functions/dbplus.xml:1.21 --- phpdoc/en/functions/dbplus.xml:1.20 Sat Jan 19 18:33:12 2002 +++ phpdoc/en/functions/dbplus.xml Sat Feb 2 10:35:57 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.20 $ --> +<!-- $Revision: 1.21 $ --> <reference id="ref.dbplus"> <title>DB++ Functions</title> <titleabbrev>DB++</titleabbrev> @@ -289,13 +289,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_add</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>array <parameter>tuple</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_add</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>array</type><parameter>tuple</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> This function will add a tuple to a relation. The @@ -322,18 +320,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>dbplus_aql</function></funcdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>string - <parameter><optional>server</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>dbpath</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>dbplus_aql</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>server</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>dbpath</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_aql</function> will execute an AQL @@ -362,14 +354,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>dbplus_chdir</function></funcdef> - <paramdef>string - <parameter><optional>newdir</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>dbplus_chdir</methodname> + <methodparam choice="opt"><type>string</type><parameter>newdir</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_chdir</function> will change the virtual current @@ -391,12 +379,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_close</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_close</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Calling <function>dbplus_close</function> will close a relation @@ -412,13 +398,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_curr</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>array <parameter>tuple</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_curr</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>array</type><parameter>tuple</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_curr</function> will read the data for the @@ -450,12 +434,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>dbplus_errcode</function></funcdef> - <paramdef>int <parameter>errno</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>dbplus_errcode</methodname> + <methodparam><type>int</type><parameter>errno</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_errcode</function> returns a cleartext error @@ -473,12 +455,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_errno</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>dbplus_errno</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_errno</function> will return the error code @@ -497,14 +477,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_find</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>array <parameter>constraints</parameter></paramdef> - <paramdef>mixed <parameter>tuple</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_find</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>array</type><parameter>constraints</parameter></methodparam> + <methodparam><type>mixed</type><parameter>tuple</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_find</function> will place a constraint on the @@ -539,13 +517,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_first</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>array <parameter>tuple</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_first</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>array</type><parameter>tuple</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_curr</function> will read the data for the first @@ -575,12 +551,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_flush</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_flush</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_flush</function> will write all changes applied @@ -602,12 +576,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_freealllocks</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>dbplus_freealllocks</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_freeaalllocks</function> will free all tuple locks @@ -628,13 +600,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_freelock</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>string <parameter>tname</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_freelock</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>string</type><parameter>tname</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_freelock</function> will release a write lock on @@ -656,12 +626,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_freerlocks</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_freerlocks</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_freerlocks</function> will free all tuple locks held @@ -682,13 +650,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_getlock</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>string <parameter>tname</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_getlock</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>string</type><parameter>tname</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_getlock</function> will request a write lock on @@ -711,13 +677,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_getunique</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>int <parameter>uniqueid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_getunique</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>int</type><parameter>uniqueid</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_getunique</function> will obtain a number @@ -741,14 +705,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_info</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>array <parameter></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_info</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>array</type><parameter/></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Not implemented yet. @@ -763,13 +725,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_last</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>array <parameter>tuple</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_last</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>array</type><parameter>tuple</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_curr</function> will read the data for the last @@ -799,12 +759,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_lockrel</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_lockrel</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_lockrel</function> will request a write lock @@ -821,13 +779,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_next</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>array <parameter></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_next</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>array</type><parameter/></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_curr</function> will read the data for the next @@ -857,12 +813,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>dbplus_open</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>dbplus_open</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> The relation file <parameter>name</parameter> will be opened. @@ -887,13 +841,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_prev</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>array <parameter>tuple</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_prev</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>array</type><parameter>tuple</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_curr</function> will read the data for the next @@ -923,15 +875,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_rchperm</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>int <parameter>mask</parameter></paramdef> - <paramdef>string <parameter>user</parameter></paramdef> - <paramdef>string <parameter>group</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_rchperm</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>int</type><parameter>mask</parameter></methodparam> + <methodparam><type>string</type><parameter>user</parameter></methodparam> + <methodparam><type>string</type><parameter>group</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_rchperm</function> will change access @@ -949,14 +899,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>dbplus_rcreate</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>mixed <parameter>domlist</parameter></paramdef> - <paramdef>boolean <parameter><optional>overwrite</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>dbplus_rcreate</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>mixed</type><parameter>domlist</parameter></methodparam> + <methodparam choice="opt"><type>boolean</type><parameter>overwrite</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_rcreate</function> will create a new relation @@ -986,14 +934,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>dbplus_rcrtexact</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>boolean <parameter>overwrite</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>dbplus_rcrtexact</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>boolean</type><parameter>overwrite</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_rcrtexact</function> will create an exact but @@ -1013,14 +959,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>dbplus_rcrtlike</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>int <parameter>flag</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>dbplus_rcrtlike</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>int</type><parameter>flag</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_rcrtexact</function> will create an empty copy @@ -1040,12 +984,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_resolve</function></funcdef> - <paramdef>string <parameter>relation_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_resolve</methodname> + <methodparam><type>string</type><parameter>relation_name</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_resolve</function> will try to resolve the given @@ -1067,13 +1009,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>dbplus_rkeys</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>mixed <parameter>domlist</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>dbplus_rkeys</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>mixed</type><parameter>domlist</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_rkeys</function> will replace the current @@ -1094,13 +1034,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_restorepos</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>array <parameter>tuple</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_restorepos</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>array</type><parameter>tuple</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Not implemented yet. @@ -1115,12 +1053,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>dbplus_ropen</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>dbplus_ropen</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_ropen</function> will open the relation @@ -1140,13 +1076,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_rquery</function></funcdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>string <parameter>dbpath</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_rquery</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam><type>string</type><parameter>dbpath</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_rquery</function> performs a local (raw) AQL @@ -1164,13 +1098,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_rrename</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_rrename</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_rrename</function> will change the name of @@ -1188,14 +1120,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>dbplus_rsecindex</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>mixed <parameter>domlist</parameter></paramdef> - <paramdef>int <parameter>type</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>dbplus_rsecindex</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>mixed</type><parameter>domlist</parameter></methodparam> + <methodparam><type>int</type><parameter>type</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_rsecindex</function> will create a new secondary @@ -1217,12 +1147,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_runlink</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_runlink</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_unlink</function> will close and remove the @@ -1238,12 +1166,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_rzap</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_rzap</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_rzap</function> will remove all tuples from @@ -1259,12 +1185,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_savepos</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_savepos</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Not implemented yet. @@ -1279,13 +1203,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_setindex</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>string <parameter>idx_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_setindex</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>string</type><parameter>idx_name</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Not implemented yet. @@ -1300,15 +1222,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>dbplus_setindexbynumber</function> - </funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>int <parameter>idx_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_setindexbynumber</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>int</type><parameter>idx_number</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Not implemented yet. @@ -1323,14 +1241,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>dbplus_sql</function></funcdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>string <parameter>server</parameter></paramdef> - <paramdef>string <parameter>dbpath</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>dbplus_sql</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam><type>string</type><parameter>server</parameter></methodparam> + <methodparam><type>string</type><parameter>dbpath</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Not implemented yet. @@ -1345,13 +1261,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_tcl</function></funcdef> - <paramdef>int <parameter>sid</parameter></paramdef> - <paramdef>string <parameter>script</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_tcl</methodname> + <methodparam><type>int</type><parameter>sid</parameter></methodparam> + <methodparam><type>string</type><parameter>script</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> A db++ server will prepare a TCL interpreter for each client @@ -1380,16 +1294,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_tremove</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>array <parameter>tuple</parameter></paramdef> - <paramdef>array - <parameter><optional>current</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_tremove</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>array</type><parameter>tuple</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>current</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_tremove</function> removes @@ -1409,12 +1319,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_undo</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_undo</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Not implemented yet. @@ -1429,12 +1337,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_undoprepare</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_undoprepare</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Not implemented yet. @@ -1449,12 +1355,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_unlockrel</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_unlockrel</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_unlockrel</function> will release a write lock @@ -1470,12 +1374,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_unselect</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_unselect</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Calling <function>dbplus_unselect</function> will remove a @@ -1492,14 +1394,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_update</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - <paramdef>array <parameter>old</parameter></paramdef> - <paramdef>array <parameter>new</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_update</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + <methodparam><type>array</type><parameter>old</parameter></methodparam> + <methodparam><type>array</type><parameter>new</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_update</function> replaces the tuple given by @@ -1518,12 +1418,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_xlockrel</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_xlockrel</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_xlockrel</function> will request an exclusive @@ -1543,12 +1441,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbplus_xunlockrel</function></funcdef> - <paramdef>resource <parameter>relation</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbplus_xunlockrel</methodname> + <methodparam><type>resource</type><parameter>relation</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>dbplus_xunlockrel</function> will release an exclusive @@ -1581,3 +1477,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/dbx.xml diff -u phpdoc/en/functions/dbx.xml:1.22 phpdoc/en/functions/dbx.xml:1.23 --- phpdoc/en/functions/dbx.xml:1.22 Wed Dec 12 15:46:44 2001 +++ phpdoc/en/functions/dbx.xml Sat Feb 2 10:35:57 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.22 $ --> +<!-- $Revision: 1.23 $ --> <reference id="ref.dbx"> <title>dbx functions</title> <titleabbrev>dbx</titleabbrev> @@ -37,14 +37,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>dbx_close</function></funcdef> - <paramdef>dbx_link_object - <parameter>link_identifier</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>dbx_close</methodname> + <methodparam><type>dbx_link_object</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Returns &true; on success, @@ -81,19 +77,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>dbx_link_object <function>dbx_connect</function></funcdef> - <paramdef>string <parameter>module</parameter></paramdef> - <paramdef>string <parameter>host</parameter></paramdef> - <paramdef>string <parameter>database</parameter></paramdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>int - <parameter><optional>persistent</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>dbx_link_object</type><methodname>dbx_connect</methodname> + <methodparam><type>string</type><parameter>module</parameter></methodparam> + <methodparam><type>string</type><parameter>host</parameter></methodparam> + <methodparam><type>string</type><parameter>database</parameter></methodparam> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>persistent</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Returns: a dbx_link_object on success, &false; @@ -198,13 +190,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>dbx_error</function></funcdef> - <paramdef>dbx_link_object <parameter>link_identifier</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>dbx_error</methodname> + <methodparam><type>dbx_link_object</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Returns a string containing the error-message from the last @@ -250,18 +239,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>dbx_result_object <function>dbx_query</function></funcdef> - <paramdef>dbx_link_object - <parameter>link_identifier</parameter> - </paramdef> - <paramdef>string <parameter>sql_statement</parameter></paramdef> - <paramdef>long - <parameter><optional>flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>dbx_result_object</type><methodname>dbx_query</methodname> + <methodparam><type>dbx_link_object</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>sql_statement</parameter></methodparam> + <methodparam choice="opt"><type>long</type><parameter>flags</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Returns a dbx_result_object or 1 on success (a result object is @@ -407,15 +390,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>dbx_sort</function></funcdef> - <paramdef>dbx_result_object <parameter>result</parameter></paramdef> - <paramdef>string - <parameter>user_compare_function</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>dbx_sort</methodname> + <methodparam><type>dbx_result_object</type><parameter>result</parameter></methodparam> + <methodparam><type>string</type><parameter>user_compare_function</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Returns &true; on success, @@ -456,17 +435,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dbx_compare</function></funcdef> - <paramdef>array <parameter>row_a</parameter></paramdef> - <paramdef>array <parameter>row_b</parameter></paramdef> - <paramdef>string <parameter>columnname_or_index</parameter></paramdef> - <paramdef>int - <parameter><optional>flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dbx_compare</methodname> + <methodparam><type>array</type><parameter>row_a</parameter></methodparam> + <methodparam><type>array</type><parameter>row_b</parameter></methodparam> + <methodparam><type>string</type><parameter>columnname_or_index</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Returns 0 if row_a[$columnname_or_index] is equal to @@ -536,3 +511,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/dio.xml diff -u phpdoc/en/functions/dio.xml:1.9 phpdoc/en/functions/dio.xml:1.10 --- phpdoc/en/functions/dio.xml:1.9 Sun Jan 13 23:04:12 2002 +++ phpdoc/en/functions/dio.xml Sat Feb 2 10:35:57 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <reference id="ref.dio"> <title>Direct IO functions</title> <titleabbrev>DIO functions</titleabbrev> @@ -32,14 +32,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>dio_open</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>int <parameter>flags</parameter></paramdef> - <paramdef>int <parameter><optional>mode</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>dio_open</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>int</type><parameter>flags</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> <function>dio_open</function> opens a file and returns a new file descriptor for it, or -1 if any error occurred. If @@ -103,13 +101,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>dio_read</function></funcdef> - <paramdef>resource <parameter>fd</parameter></paramdef> - <paramdef>int <parameter><optional>n</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>dio_read</methodname> + <methodparam><type>resource</type><parameter>fd</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>n</parameter></methodparam> + </methodsynopsis> <para> The function <function>dio_read</function> reads and returns <parameter>n</parameter> bytes from file with descriptor @@ -129,15 +125,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dio_write</function></funcdef> - <paramdef>resource <parameter>fd</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>int <parameter><optional>len</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dio_write</methodname> + <methodparam><type>resource</type><parameter>fd</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>len</parameter></methodparam> + </methodsynopsis> <para> The function <function>dio_write</function> writes up to <parameter>len</parameter> bytes from <parameter>data</parameter> @@ -159,13 +152,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>dio_truncate</function></funcdef> - <paramdef>resource <parameter>fd</parameter></paramdef> - <paramdef>int <parameter>offset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>dio_truncate</methodname> + <methodparam><type>resource</type><parameter>fd</parameter></methodparam> + <methodparam><type>int</type><parameter>offset</parameter></methodparam> + </methodsynopsis> <para> Function <function>dio_truncate</function> causes the file referenced by <parameter>fd</parameter> to be truncated to at @@ -188,12 +179,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>dio_stat</function></funcdef> - <paramdef>resource <parameter>fd</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>dio_stat</methodname> + <methodparam><type>resource</type><parameter>fd</parameter></methodparam> + </methodsynopsis> <para> Function <function>dio_stat</function> returns information about the file with file descriptor @@ -230,14 +219,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dio_seek</function></funcdef> - <paramdef>resource <parameter>fd</parameter></paramdef> - <paramdef>int <parameter>pos</parameter></paramdef> - <paramdef>int <parameter>whence</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dio_seek</methodname> + <methodparam><type>resource</type><parameter>fd</parameter></methodparam> + <methodparam><type>int</type><parameter>pos</parameter></methodparam> + <methodparam><type>int</type><parameter>whence</parameter></methodparam> + </methodsynopsis> <para> The function <function>dio_seek</function> is used to change the file position of the file with descriptor @@ -281,14 +268,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>dio_fcntl</function></funcdef> - <paramdef>resource <parameter>fd</parameter></paramdef> - <paramdef>int <parameter>cmd</parameter></paramdef> - <paramdef>mixed <parameter><optional>arg</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>dio_fcntl</methodname> + <methodparam><type>resource</type><parameter>fd</parameter></methodparam> + <methodparam><type>int</type><parameter>cmd</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <para> The <function>dio_fcntl</function> function performs the operation specified by <parameter>cmd</parameter> on the file @@ -369,12 +354,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>dio_close</function></funcdef> - <paramdef>resource <parameter>fd</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>dio_close</methodname> + <methodparam><type>resource</type><parameter>fd</parameter></methodparam> + </methodsynopsis> <para> The function <function>dio_close</function> closes the file descriptor <parameter>resource</parameter>. @@ -401,4 +384,5 @@ sgml-local-ecat-files:nil End: --> + Index: phpdoc/en/functions/dir.xml diff -u phpdoc/en/functions/dir.xml:1.28 phpdoc/en/functions/dir.xml:1.29 --- phpdoc/en/functions/dir.xml:1.28 Wed Dec 12 15:46:44 2001 +++ phpdoc/en/functions/dir.xml Sat Feb 2 10:35:57 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.28 $ --> +<!-- $Revision: 1.29 $ --> <reference id="ref.dir"> <title>Directory functions</title> <titleabbrev>Directories</titleabbrev> @@ -22,12 +22,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>chroot</function></funcdef> - <paramdef>string <parameter>directory</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>chroot</methodname> + <methodparam><type>string</type><parameter>directory</parameter></methodparam> + </methodsynopsis> <para> Changes the root directory of the current process to <parameter>directory</parameter>. Returns &false; if unable to @@ -51,12 +49,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>chdir</function></funcdef> - <paramdef>string <parameter>directory</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>chdir</methodname> + <methodparam><type>string</type><parameter>directory</parameter></methodparam> + </methodsynopsis> <para> Changes PHP's current directory to <parameter>directory</parameter>. Returns &false; if unable to @@ -72,12 +68,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>dir</function></funcdef> - <paramdef>string <parameter>directory</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>dir</methodname> + <methodparam><type>string</type><parameter>directory</parameter></methodparam> + </methodsynopsis> <para> A pseudo-object oriented mechanism for reading a directory. The given <parameter>directory</parameter> is opened. Two properties @@ -118,12 +112,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>closedir</function></funcdef> - <paramdef>resource <parameter>dir_handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>closedir</methodname> + <methodparam><type>resource</type><parameter>dir_handle</parameter></methodparam> + </methodsynopsis> <para> Closes the directory stream indicated by <parameter>dir_handle</parameter>. The stream must have previously @@ -139,12 +131,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>getcwd</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>getcwd</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns the current working directory. </para> @@ -158,12 +148,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>opendir</function></funcdef> - <paramdef>string <parameter>path</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>opendir</methodname> + <methodparam><type>string</type><parameter>path</parameter></methodparam> + </methodsynopsis> <para> Returns a directory handle to be used in subsequent <function>closedir</function>, <function>readdir</function>, and @@ -206,12 +194,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>readdir</function></funcdef> - <paramdef>resource <parameter>dir_handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>readdir</methodname> + <methodparam><type>resource</type><parameter>dir_handle</parameter></methodparam> + </methodsynopsis> <para> Returns the filename of the next file from the directory. The filenames are not returned in any particular order. @@ -268,12 +254,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>rewinddir</function></funcdef> - <paramdef>resource <parameter>dir_handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>rewinddir</methodname> + <methodparam><type>resource</type><parameter>dir_handle</parameter></methodparam> + </methodsynopsis> <para> Resets the directory stream indicated by <parameter>dir_handle</parameter> to the beginning of the @@ -305,3 +289,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/domxml.xml diff -u phpdoc/en/functions/domxml.xml:1.31 phpdoc/en/functions/domxml.xml:1.32 --- phpdoc/en/functions/domxml.xml:1.31 Sat Jan 5 19:10:43 2002 +++ phpdoc/en/functions/domxml.xml Sat Feb 2 10:35:57 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.31 $ --> +<!-- $Revision: 1.32 $ --> <reference id="ref.domxml"> <title>DOM XML functions</title> <titleabbrev>DOM XML</titleabbrev> @@ -423,12 +423,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>xmldoc</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>xmldoc</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> The function parses the XML document in @@ -448,12 +446,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>xmldocfile</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>xmldocfile</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> The function parses the XML document in the file named @@ -476,12 +472,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>xmltree</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>xmltree</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> The function parses the XML document in @@ -505,12 +499,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>domxml_root</function></funcdef> - <paramdef>object <parameter>doc</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>domxml_root</methodname> + <methodparam><type>object</type><parameter>doc</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>domxml_root</function> takes one argument, an object of class @@ -572,13 +564,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>domxml_add_root</function></funcdef> - <paramdef>resource <parameter>doc</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>domxml_add_root</methodname> + <methodparam><type>resource</type><parameter>doc</parameter></methodparam> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Adds a root element node to a dom document and returns the new node. @@ -612,12 +602,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>domxml_dumpmem</function></funcdef> - <paramdef>resource <parameter>doc</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>domxml_dumpmem</methodname> + <methodparam><type>resource</type><parameter>doc</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Creates an XML document from the dom representation. This function @@ -639,12 +627,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>domxml_attributes</function></funcdef> - <paramdef>resource <parameter>node</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>domxml_attributes</methodname> + <methodparam><type>resource</type><parameter>node</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Returns all attributes of a node as array of objects of type @@ -662,13 +648,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>domxml_get_attribute</function></funcdef> - <paramdef>resource <parameter>node</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>domxml_get_attribute</methodname> + <methodparam><type>resource</type><parameter>node</parameter></methodparam> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Returns the attribute with name <parameter>name</parameter> of the given @@ -688,14 +672,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>domxml_set_attribute</function></funcdef> - <paramdef>resource <parameter>node</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>domxml_set_attribute</methodname> + <methodparam><type>resource</type><parameter>node</parameter></methodparam> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Sets an attribute with name <parameter>name</parameter> of the given @@ -733,12 +715,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>domxml_children</function></funcdef> - <paramdef>object <parameter>doc|node</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>domxml_children</methodname> + <methodparam><type>object</type><parameter>doc|node</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Returns all children of a node as an array of nodes. @@ -775,13 +755,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>domxml_new_child</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>string <parameter>content</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>domxml_new_child</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>string</type><parameter>content</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Adds a new child of type element to a node and returns it. @@ -798,12 +776,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>domxml_new_xmldoc</function></funcdef> - <paramdef>string <parameter>version</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>domxml_new_xmldoc</methodname> + <methodparam><type>string</type><parameter>version</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Creates a new dom document from scratch and returns it. @@ -823,12 +799,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>xpath_new_context</function></funcdef> - <paramdef>object <parameter>dom document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>xpath_new_context</methodname> + <methodparam><type>object</type><parameter>dom document</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> </para> @@ -847,12 +821,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>xpath_eval</function></funcdef> - <paramdef>object <parameter>xpath context</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>xpath_eval</methodname> + <methodparam><type>object</type><parameter>xpath context</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> </para> @@ -871,12 +843,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>domxml_node</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>domxml_node</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -892,12 +862,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>domxml_node_set_content</function></funcdef> - <paramdef>string <parameter>content</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>domxml_node_set_content</methodname> + <methodparam><type>string</type><parameter>content</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -913,12 +881,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>domxml_node_unlink_node</function></funcdef> + <methodsynopsis> + <type>object</type><methodname>domxml_node_unlink_node</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -934,12 +900,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>xpath_eval</function></funcdef> - <paramdef>object <parameter>xpath_context</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>xpath_eval</methodname> + <methodparam><type>object</type><parameter>xpath_context</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> </para> @@ -958,12 +922,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>domxml_version</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>domxml_version</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This function returns the version of the XML library version currently used. </para> @@ -979,12 +941,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>xptr_new_context</function></funcdef> - <paramdef>object <parameter><optional>doc_handle</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>xptr_new_context</methodname> + <methodparam choice="opt"><type>object</type><parameter>doc_handle</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1000,13 +960,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>xptr_eval</function></funcdef> - <paramdef>object <parameter><optional>xpath_context</optional></parameter></paramdef> - <paramdef>string <parameter>eval_str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xptr_eval</methodname> + <methodparam choice="opt"><type>object</type><parameter>xpath_context</parameter></methodparam> + <methodparam><type>string</type><parameter>eval_str</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1035,3 +993,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/dotnet.xml diff -u phpdoc/en/functions/dotnet.xml:1.1 phpdoc/en/functions/dotnet.xml:1.2 --- phpdoc/en/functions/dotnet.xml:1.1 Sat Dec 15 09:54:58 2001 +++ phpdoc/en/functions/dotnet.xml Sat Feb 2 10:35:57 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <reference id="ref.dotnet"> <title>.NET functions</title> <titleabbrev>.NET functions</titleabbrev> @@ -17,18 +17,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dotnet_load</function></funcdef> - <paramdef>string <parameter>assembly_name</parameter></paramdef> - <paramdef>string - <parameter><optional>datatype_name</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>codepage</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dotnet_load</methodname> + <methodparam><type>string</type><parameter>assembly_name</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>datatype_name</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>codepage</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -58,4 +52,5 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/errorfunc.xml diff -u phpdoc/en/functions/errorfunc.xml:1.22 phpdoc/en/functions/errorfunc.xml:1.23 --- phpdoc/en/functions/errorfunc.xml:1.22 Sat Jan 12 11:13:51 2002 +++ phpdoc/en/functions/errorfunc.xml Sat Feb 2 10:35:57 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.22 $ --> +<!-- $Revision: 1.23 $ --> <reference id="ref.errorfunc"> <title>Error Handling and Logging Functions</title> <titleabbrev>Errors and Logging</titleabbrev> @@ -31,19 +31,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>error_log</function></funcdef> - <paramdef>string <parameter>message</parameter></paramdef> - <paramdef>int <parameter>message_type</parameter></paramdef> - <paramdef>string - <parameter><optional>destination</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>extra_headers</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>error_log</methodname> + <methodparam><type>string</type><parameter>message</parameter></methodparam> + <methodparam><type>int</type><parameter>message_type</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>destination</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>extra_headers</parameter></methodparam> + </methodsynopsis> <para> Sends an error message to the web server's error log, a <acronym>TCP</acronym> port or to a file. The first parameter, @@ -140,14 +134,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>error_reporting</function></funcdef> - <paramdef>int - <parameter><optional>level</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>error_reporting</methodname> + <methodparam choice="opt"><type>int</type><parameter>level</parameter></methodparam> + </methodsynopsis> <para> Sets PHP's error reporting level and returns the old level. The error reporting level is either a bitmask, or named constant. Using @@ -286,12 +276,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>restore_error_handler</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>restore_error_handler</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Used after changing the error handler function using <function>set_error_handler</function>, to revert to the previous error @@ -314,12 +302,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>set_error_handler</function></funcdef> - <paramdef>string <parameter>error_handler</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>set_error_handler</methodname> + <methodparam><type>string</type><parameter>error_handler</parameter></methodparam> + </methodsynopsis> <para> Sets a user function (<parameter>error_handler</parameter>) to handle errors in a script. Returns the previously defined error handler (if @@ -495,15 +481,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>trigger_error</function></funcdef> - <paramdef>string <parameter>error_msg</parameter></paramdef> - <paramdef>int - <parameter><optional>error_type</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>trigger_error</methodname> + <methodparam><type>string</type><parameter>error_msg</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>error_type</parameter></methodparam> + </methodsynopsis> <para> Used to trigger a user error condition, it can be used by in conjunction with the built-in error handler, or with a user defined function that has @@ -547,15 +529,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>user_error</function></funcdef> - <paramdef>string <parameter>error_msg</parameter></paramdef> - <paramdef>int - <parameter><optional>error_type</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>user_error</methodname> + <methodparam><type>string</type><parameter>error_msg</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>error_type</parameter></methodparam> + </methodsynopsis> <para> This is an alias for the function <function>trigger_error</function>. </para> @@ -590,3 +568,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/exec.xml diff -u phpdoc/en/functions/exec.xml:1.26 phpdoc/en/functions/exec.xml:1.27 --- phpdoc/en/functions/exec.xml:1.26 Wed Jan 2 06:39:45 2002 +++ phpdoc/en/functions/exec.xml Sat Feb 2 10:35:57 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.26 $ --> +<!-- $Revision: 1.27 $ --> <reference id="ref.exec"> <title>Program Execution functions</title> <titleabbrev>Program Execution</titleabbrev> @@ -20,12 +20,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>escapeshellarg</function></funcdef> - <paramdef>string <parameter>arg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>escapeshellarg</methodname> + <methodparam><type>string</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <para> <function>escapeshellarg</function> adds single quotes around a string and quotes/escapes any existing single quotes allowing you to pass a @@ -60,12 +58,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>escapeshellcmd</function></funcdef> - <paramdef>string <parameter>command</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>escapeshellcmd</methodname> + <methodparam><type>string</type><parameter>command</parameter></methodparam> + </methodsynopsis> <para> <function>escapeshellcmd</function> escapes any characters in a string that might be used to trick a shell command into executing @@ -103,19 +99,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>exec</function></funcdef> - <paramdef>string <parameter>command</parameter></paramdef> - <paramdef>string - <parameter><optional>array</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter><optional>return_var</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>exec</methodname> + <methodparam><type>string</type><parameter>command</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>array + </parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>return_var</parameter></methodparam> + </methodsynopsis> <para> <function>exec</function> executes the given <parameter>command</parameter>, however it does not output @@ -174,15 +164,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>passthru</function></funcdef> - <paramdef>string <parameter>command</parameter></paramdef> - <paramdef>int - <parameter><optional>return_var</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>passthru</methodname> + <methodparam><type>string</type><parameter>command</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>return_var</parameter></methodparam> + </methodsynopsis> <para> The <function>passthru</function> function is similar to the <function>exec</function> function in that it executes a @@ -231,15 +217,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>system</function></funcdef> - <paramdef>string <parameter>command</parameter></paramdef> - <paramdef>int - <parameter><optional>return_var</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>system</methodname> + <methodparam><type>string</type><parameter>command</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>return_var</parameter></methodparam> + </methodsynopsis> <para> <function>system</function> is just like the C version of the function in that it executes the given @@ -297,12 +279,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>shell_exec</function></funcdef> - <paramdef>string <parameter>cmd</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>shell_exec</methodname> + <methodparam><type>string</type><parameter>cmd</parameter></methodparam> + </methodsynopsis> <para> This function is identical to the <link linkend="language.operators.execution">backtick operator</link>. @@ -332,3 +312,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/fbsql.xml diff -u phpdoc/en/functions/fbsql.xml:1.37 phpdoc/en/functions/fbsql.xml:1.38 --- phpdoc/en/functions/fbsql.xml:1.37 Tue Jan 29 13:12:02 2002 +++ phpdoc/en/functions/fbsql.xml Sat Feb 2 10:35:58 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.37 $ --> +<!-- $Revision: 1.38 $ --> <reference id="ref.fbsql"> <title>FrontBase Functions</title> <titleabbrev>FrontBase</titleabbrev> @@ -39,16 +39,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fbsql_affected_rows</function></funcdef> - <paramdef>int - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>fbsql_affected_rows</methodname> + <methodparam choice="opt"><type>int</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> <function>fbsql_affected_rows</function> returns the number of rows affected by the last INSERT, UPDATE or DELETE query @@ -93,19 +89,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fbsql_autocommit</function></funcdef> - <paramdef>resource - <parameter>link_identifier</parameter> - </paramdef> - <paramdef>bool - <parameter> - <optional>OnOff</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fbsql_autocommit</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter> + OnOff + </parameter></methodparam> + </methodsynopsis> <para> <function>fbsql_autocommit</function> returns the current autocommit status. if the optional OnOff parameter is @@ -132,23 +122,17 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>fbsql_change_user</function></funcdef> - <paramdef>string <parameter>user</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>string - <parameter> - <optional>database</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>fbsql_change_user</methodname> + <methodparam><type>string</type><parameter>user</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + database + </parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> <function>fbsql_change_user</function> changes the logged in user of the current active connection, or the connection given by the @@ -167,16 +151,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>fbsql_close</function></funcdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>fbsql_close</methodname> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> Returns: &true; on success, &false; on error. </para> @@ -218,16 +198,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fbsql_commit</function></funcdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fbsql_commit</methodname> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> Returns: &true; on success, &false; on failure. </para> @@ -251,27 +227,19 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>fbsql_connect</function></funcdef> - <paramdef>string - <parameter> - <optional>hostname - </optional> - </parameter> - </paramdef> - <paramdef>string - <parameter> - <optional>username</optional> - </parameter> - </paramdef> - <paramdef>string - <parameter> - <optional>password</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>fbsql_connect</methodname> + <methodparam choice="opt"><type>string</type><parameter> + hostname + + </parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + username + </parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + password + </parameter></methodparam> + </methodsynopsis> <para> Returns a positive FrontBase link identifier on success, or an error message on failure. @@ -324,17 +292,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fbsql_create_db</function></funcdef> - <paramdef>string <parameter>database name</parameter></paramdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fbsql_create_db</methodname> + <methodparam><type>string</type><parameter>database name</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> <function>fbsql_create_db</function> attempts to create a new database on the server associated with the specified link @@ -369,17 +333,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fbsql_create_blob</function></funcdef> - <paramdef>string <parameter>blob_data</parameter></paramdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fbsql_create_blob</methodname> + <methodparam><type>string</type><parameter>blob_data</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> Returns: A resource handle to the newly created blob. </para> @@ -424,17 +384,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fbsql_create_clob</function></funcdef> - <paramdef>string <parameter>clob_data</parameter></paramdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fbsql_create_clob</methodname> + <methodparam><type>string</type><parameter>clob_data</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> Returns: A resource handle to the newly created CLOB. </para> @@ -481,20 +437,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string - <function>fbsql_database_password</function> - </funcdef> - <paramdef>resource - <parameter>link_identifier</parameter></paramdef> - <paramdef>string - <parameter> - <optional>database_password</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fbsql_database_password</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + database_password + </parameter></methodparam> + </methodsynopsis> <para> Returns: The database password associated with the link identifier. </para> @@ -541,15 +490,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fbsql_data_seek</function></funcdef> - <paramdef>resource - <parameter>result_identifier</parameter> - </paramdef> - <paramdef>int <parameter>row_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fbsql_data_seek</methodname> + <methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>row_number</parameter></methodparam> + </methodsynopsis> <para> Returns: &true; on success, &false; on failure. </para> @@ -607,18 +552,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>fbsql_db_query</function></funcdef> - <paramdef>string <parameter>database</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>fbsql_db_query</methodname> + <methodparam><type>string</type><parameter>database</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> Returns: A positive FrontBase result identifier to the query result, or &false; on error. @@ -644,17 +585,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fbsql_db_status</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>fbsql_db_status</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> Returns: An integer value with the current status. </para> @@ -725,17 +662,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fbsql_drop_db</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fbsql_drop_db</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> Returns: &true; on success, &false; on failure. </para> @@ -757,16 +690,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fbsql_errno</function></funcdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>fbsql_errno</methodname> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> Returns the error number from the last fbsql function, or <literal>0</literal> (zero) if no error occurred. @@ -811,16 +740,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fbsql_error</function></funcdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fbsql_error</methodname> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> Returns the error text from the last fbsql function, or <literal>''</literal> (the empty string) if no error occurred. @@ -865,17 +790,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>fbsql_fetch_array</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int - <parameter> - <optional>result_type</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>fbsql_fetch_array</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + result_type + </parameter></methodparam> + </methodsynopsis> <para> Returns an array that corresponds to the fetched row, or &false; if there are no more rows. @@ -946,12 +867,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>fbsql_fetch_assoc</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>fbsql_fetch_assoc</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> Returns an associative array that corresponds to the fetched row, or &false; if there are no more rows.</para> @@ -1008,17 +927,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>fbsql_fetch_field</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int - <parameter> - <optional>field_offset</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>fbsql_fetch_field</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + field_offset + </parameter></methodparam> + </methodsynopsis> <para> Returns an object containing field information. </para> @@ -1104,14 +1019,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>fbsql_fetch_lengths</function></funcdef> - <paramdef>resource - <parameter><optional>result</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>fbsql_fetch_lengths</methodname> + <methodparam choice="opt"><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> Returns: An array that corresponds to the lengths of each field in the last row fetched by <function>fbsql_fetch_row</function>, @@ -1138,17 +1049,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>fbsql_fetch_object</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int - <parameter> - <optional>result_type</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>fbsql_fetch_object</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + result_type + </parameter></methodparam> + </methodsynopsis> <para> Returns an object with properties that correspond to the fetched row, or &false; if there are no more rows. @@ -1201,12 +1108,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>fbsql_fetch_row</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>fbsql_fetch_row</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> Returns: An array that corresponds to the fetched row, or &false; if there are no more rows. @@ -1241,13 +1146,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fbsql_field_flags</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>field_offset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fbsql_field_flags</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> <para> <function>fbsql_field_flags</function> returns the field flags of the specified field. The flags are reported as a single word @@ -1266,13 +1169,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fbsql_field_name</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>field_index</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fbsql_field_name</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_index</parameter></methodparam> + </methodsynopsis> <para> <function>fbsql_field_name</function> returns the name of the specified field index. <parameter>result</parameter> must be a @@ -1329,13 +1230,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fbsql_field_len</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>field_offset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>fbsql_field_len</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> <para> <function>fbsql_field_len</function> returns the length of the specified field. @@ -1352,13 +1251,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fbsql_field_seek</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>field_offset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fbsql_field_seek</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> <para> Seeks to the specified field offset. If the next call to <function>fbsql_fetch_field</function> doesn't include a field @@ -1380,13 +1277,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fbsql_field_table</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>field_offset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fbsql_field_table</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> <para> Returns the name of the table that the specified field is in. @@ -1403,13 +1298,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fbsql_field_type</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>field_offset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fbsql_field_type</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> <para> <function>fbsql_field_type</function> is similar to the <function>fbsql_field_name</function> function. The arguments are @@ -1457,12 +1350,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fbsql_free_result</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fbsql_free_result</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> <function>fbsql_free_result</function> will free all memory associated with the result identifier <parameter>result</parameter>. @@ -1485,16 +1376,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fbsql_insert_id</function></funcdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>fbsql_insert_id</methodname> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> <function>fbsql_insert_id</function> returns the ID generated for an column defined as DEFAULT UNIQUE by the previous INSERT query @@ -1528,16 +1415,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>fbsql_list_dbs</function></funcdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>fbsql_list_dbs</methodname> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> <function>fbsql_list_dbs</function> will return a result pointer containing the databases available from the current fbsql @@ -1588,18 +1471,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>fbsql_list_fields</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - <paramdef>string <parameter>table_name</parameter></paramdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>fbsql_list_fields</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam><type>string</type><parameter>table_name</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> <function>fbsql_list_fields</function> retrieves information about the given tablename. Arguments are the database name and @@ -1656,17 +1535,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>fbsql_list_tables</function></funcdef> - <paramdef>string <parameter>database</parameter></paramdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>fbsql_list_tables</methodname> + <methodparam><type>string</type><parameter>database</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> <function>fbsql_list_tables</function> takes a database name and returns a result pointer much like the @@ -1686,14 +1561,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool - <function>fbsql_next_result</function> - </funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fbsql_next_result</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> When sending more than one SQL statement to the server or executing a stored procedure with multiple results will cause the @@ -1733,12 +1604,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fbsql_num_fields</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>fbsql_num_fields</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> <function>fbsql_num_fields</function> returns the number of fields in a result set. @@ -1760,12 +1629,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fbsql_num_rows</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>fbsql_num_rows</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> <function>fbsql_num_rows</function> returns the number of rows in a result set. This command is only valid for SELECT statements. @@ -1808,20 +1675,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>fbsql_pconnect</function></funcdef> - <paramdef>string - <parameter><optional>hostname</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>username</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>password</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>fbsql_pconnect</methodname> + <methodparam choice="opt"><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> + </methodsynopsis> <para> Returns: A positive FrontBase persistent link identifier on success, or &false; on error. @@ -1865,15 +1724,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>fbsql_query</function></funcdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>resource - <parameter><optional>link_identifier</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>fbsql_query</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> <function>fbsql_query</function> sends a query to the currently active database on the server that's associated with the @@ -1968,17 +1823,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fbsql_read_blob</function></funcdef> - <paramdef>string <parameter>blob_handle</parameter></paramdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fbsql_read_blob</methodname> + <methodparam><type>string</type><parameter>blob_handle</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> Returns: A string containing the BLOB specified by blob_handle. </para> @@ -2032,17 +1883,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fbsql_read_clob</function></funcdef> - <paramdef>string <parameter>clob_handle</parameter></paramdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fbsql_read_clob</methodname> + <methodparam><type>string</type><parameter>clob_handle</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> Returns: A string containing the CLOB specified by clob_handle. </para> @@ -2096,18 +1943,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>fbsql_result</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>row</parameter></paramdef> - <paramdef>mixed - <parameter> - <optional>field</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>fbsql_result</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>row</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter> + field + </parameter></methodparam> + </methodsynopsis> <para> <function>fbsql_result</function> returns the contents of one cell from a FrontBase result set. The field argument can be the @@ -2145,16 +1988,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fbsql_rollback</function></funcdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fbsql_rollback</methodname> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> Returns: &true; on success, &false; on failure. </para> @@ -2179,13 +2018,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fbsql_set_lob_mode</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fbsql_set_lob_mode</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + </methodsynopsis> <para> Returns: &true; on success, &false; on error. </para> @@ -2236,17 +2073,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fbsql_select_db</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fbsql_select_db</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> Returns: &true; on success, &false; on error. </para> @@ -2291,17 +2124,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fbsql_start_db</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fbsql_start_db</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> Returns: &true; on success, &false; on failure. </para> @@ -2322,17 +2151,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fbsql_stop_db</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fbsql_stop_db</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> Returns: &true; on success, &false; on failure. </para> @@ -2353,13 +2178,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fbsql_tablename</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>i</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fbsql_tablename</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>i</parameter></methodparam> + </methodsynopsis> <para> <function>fbsql_tablename</function> takes a result pointer returned by the <function>fbsql_list_tables</function> function @@ -2394,16 +2217,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fbsql_warnings</function></funcdef> - <paramdef>bool - <parameter> - <optional>OnOff</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fbsql_warnings</methodname> + <methodparam choice="opt"><type>bool</type><parameter> + OnOff + </parameter></methodparam> + </methodsynopsis> <para> Returns &true; if warnings is turned on otherwise &false;. </para> @@ -2421,13 +2240,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fbsql_database</function></funcdef> - <paramdef>resource <parameter>link_identifier</parameter></paramdef> - <paramdef>string <parameter><optional>database</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fbsql_database</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2441,12 +2258,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>fbsql_get_autostart_info</function></funcdef> - <paramdef>resource <parameter><optional>link_identifier</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>fbsql_get_autostart_info</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2462,13 +2277,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fbsql_hostname</function></funcdef> - <paramdef>resource <parameter>link_identifier</parameter></paramdef> - <paramdef>string <parameter><optional>host_name</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fbsql_hostname</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>host_name</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2484,13 +2297,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fbsql_password</function></funcdef> - <paramdef>resource <parameter>link_identifier</parameter></paramdef> - <paramdef>string <parameter><optional>password</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fbsql_password</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2508,14 +2319,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>fbsql_set_transaction</function></funcdef> - <paramdef>resource <parameter>link_identifier</parameter></paramdef> - <paramdef>int <parameter>Locking</parameter></paramdef> - <paramdef>int <parameter>Isolation</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>fbsql_set_transaction</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>Locking</parameter></methodparam> + <methodparam><type>int</type><parameter>Isolation</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2531,13 +2340,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fbsql_username</function></funcdef> - <paramdef>resource <parameter>link_identifier</parameter></paramdef> - <paramdef>string <parameter><optional>username</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fbsql_username</methodname> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2567,3 +2374,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/fdf.xml diff -u phpdoc/en/functions/fdf.xml:1.28 phpdoc/en/functions/fdf.xml:1.29 --- phpdoc/en/functions/fdf.xml:1.28 Sat Jan 12 11:28:50 2002 +++ phpdoc/en/functions/fdf.xml Sat Feb 2 10:35:58 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.28 $ --> +<!-- $Revision: 1.29 $ --> <reference id="ref.fdf"> <title>Forms Data Format functions</title> <titleabbrev>FDF</titleabbrev> @@ -105,12 +105,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fdf_open</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>fdf_open</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> The <function>fdf_open</function> function opens a file with form data. This file must contain the data as returned @@ -153,12 +151,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fdf_close</function></funcdef> - <paramdef>int <parameter>fdf_document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fdf_close</methodname> + <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam> + </methodsynopsis> <para> The <function>fdf_close</function> function closes the FDF document.</para> @@ -175,12 +171,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fdf_create</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>fdf_create</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> The <function>fdf_create</function> creates a new FDF document. This function is needed if one would like to @@ -221,12 +215,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fdf_save</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>fdf_save</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> The <function>fdf_save</function> function saves a FDF document. @@ -250,13 +242,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fdf_get_value</function></funcdef> - <paramdef>int <parameter>fdf_document</parameter></paramdef> - <paramdef>string <parameter>fieldname</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fdf_get_value</methodname> + <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam> + <methodparam><type>string</type><parameter>fieldname</parameter></methodparam> + </methodsynopsis> <para> The <function>fdf_get_value</function> function returns the value of a field.</para> @@ -274,15 +264,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fdf_set_value</function></funcdef> - <paramdef>int <parameter>fdf_document</parameter></paramdef> - <paramdef>string <parameter>fieldname</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - <paramdef>int <parameter>isName</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fdf_set_value</methodname> + <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam> + <methodparam><type>string</type><parameter>fieldname</parameter></methodparam> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + <methodparam><type>int</type><parameter>isName</parameter></methodparam> + </methodsynopsis> <para> The <function>fdf_set_value</function> function sets the value of a field. The last parameter determines if the field value @@ -302,15 +290,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fdf_next_field_name</function></funcdef> - <paramdef>int <parameter>fdf_document</parameter></paramdef> - <paramdef>string - <parameter><optional>fieldname</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fdf_next_field_name</methodname> + <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>fieldname</parameter></methodparam> + </methodsynopsis> <para> The <function>fdf_next_field_name</function> function returns the name of the field after the field in @@ -331,16 +315,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fdf_set_ap</function></funcdef> - <paramdef>int <parameter>fdf_document</parameter></paramdef> - <paramdef>string <parameter>field_name</parameter></paramdef> - <paramdef>int <parameter>face</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>int <parameter>page_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fdf_set_ap</methodname> + <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam> + <methodparam><type>string</type><parameter>field_name</parameter></methodparam> + <methodparam><type>int</type><parameter>face</parameter></methodparam> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>int</type><parameter>page_number</parameter></methodparam> + </methodsynopsis> <para> The <function>fdf_set_ap</function> function sets the appearance of a field (i.e. the value of the /AP key). @@ -357,13 +339,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fdf_set_status</function></funcdef> - <paramdef>int <parameter>fdf_document</parameter></paramdef> - <paramdef>string <parameter>status</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fdf_set_status</methodname> + <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam> + <methodparam><type>string</type><parameter>status</parameter></methodparam> + </methodsynopsis> <para> The <function>fdf_set_status</function> sets the value of the /STATUS key.</para> @@ -381,12 +361,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fdf_get_status</function></funcdef> - <paramdef>int <parameter>fdf_document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fdf_get_status</methodname> + <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam> + </methodsynopsis> <para> The <function>fdf_get_status</function> returns the value of the /STATUS key.</para> @@ -404,13 +382,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fdf_set_file</function></funcdef> - <paramdef>int <parameter>fdf_document</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fdf_set_file</methodname> + <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> The <function>fdf_set_file</function> sets the value of the /F key. The /F key is just a reference to a PDF form @@ -431,12 +407,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fdf_get_file</function></funcdef> - <paramdef>int <parameter>fdf_document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fdf_get_file</methodname> + <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam> + </methodsynopsis> <para> The <function>fdf_set_file</function> returns the value of the /F key.</para> @@ -454,15 +428,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fdf_set_flags</function></funcdef> - <paramdef>int <parameter>fdf_document</parameter></paramdef> - <paramdef>string <parameter>fieldname</parameter></paramdef> - <paramdef>int <parameter>whichFlags</parameter></paramdef> - <paramdef>int <parameter>newFlags</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fdf_set_flags</methodname> + <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam> + <methodparam><type>string</type><parameter>fieldname</parameter></methodparam> + <methodparam><type>int</type><parameter>whichFlags</parameter></methodparam> + <methodparam><type>int</type><parameter>newFlags</parameter></methodparam> + </methodsynopsis> <para> The <function>fdf_set_flags</function> sets certain flags of the given field <parameter>fieldname</parameter>. @@ -480,16 +452,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fdf_set_opt</function></funcdef> - <paramdef>int <parameter>fdf_document</parameter></paramdef> - <paramdef>string <parameter>fieldname</parameter></paramdef> - <paramdef>int <parameter>element</parameter></paramdef> - <paramdef>string <parameter>str1</parameter></paramdef> - <paramdef>string <parameter>str2</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fdf_set_opt</methodname> + <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam> + <methodparam><type>string</type><parameter>fieldname</parameter></methodparam> + <methodparam><type>int</type><parameter>element</parameter></methodparam> + <methodparam><type>string</type><parameter>str1</parameter></methodparam> + <methodparam><type>string</type><parameter>str2</parameter></methodparam> + </methodsynopsis> <para> The <function>fdf_set_opt</function> sets options of the given field <parameter>fieldname</parameter>. @@ -507,16 +477,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fdf_set_submit_form_action</function></funcdef> - <paramdef>int <parameter>fdf_document</parameter></paramdef> - <paramdef>string <parameter>fieldname</parameter></paramdef> - <paramdef>int <parameter>trigger</parameter></paramdef> - <paramdef>string <parameter>script</parameter></paramdef> - <paramdef>int <parameter>flags</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fdf_set_submit_form_action</methodname> + <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam> + <methodparam><type>string</type><parameter>fieldname</parameter></methodparam> + <methodparam><type>int</type><parameter>trigger</parameter></methodparam> + <methodparam><type>string</type><parameter>script</parameter></methodparam> + <methodparam><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> The <function>fdf_set_submit_form_action</function> sets a submit form action for the given field <parameter>fieldname</parameter>. @@ -534,15 +502,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fdf_set_javascript_action</function></funcdef> - <paramdef>int <parameter>fdf_document</parameter></paramdef> - <paramdef>string <parameter>fieldname</parameter></paramdef> - <paramdef>int <parameter>trigger</parameter></paramdef> - <paramdef>string <parameter>script</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fdf_set_javascript_action</methodname> + <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam> + <methodparam><type>string</type><parameter>fieldname</parameter></methodparam> + <methodparam><type>int</type><parameter>trigger</parameter></methodparam> + <methodparam><type>string</type><parameter>script</parameter></methodparam> + </methodsynopsis> <para> <function>fdf_set_javascript_action</function> sets a javascript action for the given field <parameter>fieldname</parameter>. @@ -560,13 +526,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fdf_set_encoding</function></funcdef> - <paramdef>int <parameter>fdf_document</parameter></paramdef> - <paramdef>string <parameter>encoding</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fdf_set_encoding</methodname> + <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam> + <methodparam><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> <para> <function>fdf_set_encoding</function> sets the character encoding in FDF document <parameter>fdf_document</parameter>. @@ -589,16 +553,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fdf_add_template</function></funcdef> - <paramdef>int <parameter>fdfdoc</parameter></paramdef> - <paramdef>int <parameter>newpage</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>string <parameter>template</parameter></paramdef> - <paramdef>int <parameter>rename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fdf_add_template</methodname> + <methodparam><type>int</type><parameter>fdfdoc</parameter></methodparam> + <methodparam><type>int</type><parameter>newpage</parameter></methodparam> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>string</type><parameter>template</parameter></methodparam> + <methodparam><type>int</type><parameter>rename</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -627,3 +589,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/filepro.xml diff -u phpdoc/en/functions/filepro.xml:1.13 phpdoc/en/functions/filepro.xml:1.14 --- phpdoc/en/functions/filepro.xml:1.13 Wed Dec 12 15:46:47 2001 +++ phpdoc/en/functions/filepro.xml Sat Feb 2 10:35:58 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.13 $ --> +<!-- $Revision: 1.14 $ --> <reference id="ref.filepro"> <title>filePro functions</title> <titleabbrev>filePro</titleabbrev> @@ -19,12 +19,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>filepro</function></funcdef> - <paramdef>string <parameter>directory</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>filepro</methodname> + <methodparam><type>string</type><parameter>directory</parameter></methodparam> + </methodsynopsis> <para> This reads and verifies the map file, storing the field count and info.</para> @@ -42,12 +40,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>filepro_fieldname</function></funcdef> - <paramdef>int <parameter>field_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>filepro_fieldname</methodname> + <methodparam><type>int</type><parameter>field_number</parameter></methodparam> + </methodsynopsis> <para> Returns the name of the field corresponding to <parameter>field_number</parameter>.</para> </refsect1> @@ -60,12 +56,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>filepro_fieldtype</function></funcdef> - <paramdef>int <parameter>field_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>filepro_fieldtype</methodname> + <methodparam><type>int</type><parameter>field_number</parameter></methodparam> + </methodsynopsis> <para> Returns the edit type of the field corresponding to <parameter>field_number</parameter>.</para> </refsect1> @@ -78,12 +72,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>filepro_fieldwidth</function></funcdef> - <paramdef>int <parameter>field_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>filepro_fieldwidth</methodname> + <methodparam><type>int</type><parameter>field_number</parameter></methodparam> + </methodsynopsis> <para> Returns the width of the field corresponding to <parameter>field_number</parameter>.</para> </refsect1> @@ -96,13 +88,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>filepro_retrieve</function></funcdef> - <paramdef>int <parameter>row_number</parameter></paramdef> - <paramdef>int <parameter>field_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>filepro_retrieve</methodname> + <methodparam><type>int</type><parameter>row_number</parameter></methodparam> + <methodparam><type>int</type><parameter>field_number</parameter></methodparam> + </methodsynopsis> <para> Returns the data from the specified location in the database.</para> &note.sm.uidcheck; @@ -116,12 +106,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>filepro_fieldcount</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>filepro_fieldcount</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns the number of fields (columns) in the opened filePro database. @@ -138,12 +126,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>filepro_rowcount</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>filepro_rowcount</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns the number of rows in the opened filePro database.</para> &note.sm.uidcheck; @@ -174,3 +160,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/filesystem.xml diff -u phpdoc/en/functions/filesystem.xml:1.114 phpdoc/en/functions/filesystem.xml:1.115 --- phpdoc/en/functions/filesystem.xml:1.114 Sun Jan 20 09:39:11 2002 +++ phpdoc/en/functions/filesystem.xml Sat Feb 2 10:35:58 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.114 $ --> +<!-- $Revision: 1.115 $ --> <reference id="ref.filesystem"> <title>Filesystem functions</title> <titleabbrev>Filesystem</titleabbrev> @@ -13,13 +13,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>basename</function></funcdef> - <paramdef>string <parameter>path</parameter></paramdef> - <paramdef>string <parameter><optional>suffix</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>basename</methodname> + <methodparam><type>string</type><parameter>path</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>suffix</parameter></methodparam> + </methodsynopsis> <para> Given a string containing a path to a file, this function will return the base name of the file. @@ -62,13 +60,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>chgrp</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>mixed <parameter>group</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>chgrp</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>mixed</type><parameter>group</parameter></methodparam> + </methodsynopsis> <para> Attempts to change the group of the file <parameter>filename</parameter> to <parameter>group</parameter> (specified by name or number). Only the @@ -93,13 +89,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>chmod</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>chmod</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> Attempts to change the mode of the file specified by <parameter>filename</parameter> to that given in @@ -138,13 +132,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>chown</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>mixed <parameter>user</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>chown</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>mixed</type><parameter>user</parameter></methodparam> + </methodsynopsis> <para> Attempts to change the owner of the file <parameter>filename</parameter> to user <parameter>user</parameter> (specified by name or number). Only @@ -168,12 +160,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>clearstatcache</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>clearstatcache</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Invoking the <systemitem>stat</systemitem> or <systemitem>lstat</systemitem> system call on most systems is @@ -217,13 +207,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>copy</function></funcdef> - <paramdef>string <parameter>source</parameter></paramdef> - <paramdef>string <parameter>dest</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>copy</methodname> + <methodparam><type>string</type><parameter>source</parameter></methodparam> + <methodparam><type>string</type><parameter>dest</parameter></methodparam> + </methodsynopsis> <para> Makes a copy of a file. Returns &true; if the copy succeeded, &false; otherwise. @@ -259,12 +247,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>delete</function></funcdef> - <paramdef>string <parameter>file</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>delete</methodname> + <methodparam><type>string</type><parameter>file</parameter></methodparam> + </methodsynopsis> <para> This is a dummy manual entry to satisfy those people who are looking for <function>unlink</function> or @@ -284,12 +270,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>dirname</function></funcdef> - <paramdef>string <parameter>path</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>dirname</methodname> + <methodparam><type>string</type><parameter>path</parameter></methodparam> + </methodsynopsis> <para> Given a string containing a path to a file, this function will return the name of the directory.</para> @@ -322,12 +306,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>disk_free_space</function></funcdef> - <paramdef>string <parameter>directory</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>disk_free_space</methodname> + <methodparam><type>string</type><parameter>directory</parameter></methodparam> + </methodsynopsis> <para> Given a string containing a directory, this function will return the number of bytes available on the corresponding filesystem or @@ -354,12 +336,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>diskfreespace</function></funcdef> - <paramdef>string <parameter>directory</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>diskfreespace</methodname> + <methodparam><type>string</type><parameter>directory</parameter></methodparam> + </methodsynopsis> <para> This is a deprecated alias of <function>disk_free_space</function>. @@ -375,12 +355,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>disk_total_space</function></funcdef> - <paramdef>string <parameter>directory</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>disk_total_space</methodname> + <methodparam><type>string</type><parameter>directory</parameter></methodparam> + </methodsynopsis> <para> Given a string containing a directory, this function will return the total number of bytes on the corresponding filesystem or disk @@ -407,12 +385,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>fclose</function></funcdef> - <paramdef>int <parameter>fp</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>fclose</methodname> + <methodparam><type>int</type><parameter>fp</parameter></methodparam> + </methodsynopsis> <para> The file pointed to by <parameter>fp</parameter> is closed. </para> @@ -435,12 +411,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>feof</function></funcdef> - <paramdef>int <parameter>fp</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>feof</methodname> + <methodparam><type>int</type><parameter>fp</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if the file pointer is at EOF or an error occurs; otherwise returns &false;. @@ -460,12 +434,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fflush</function></funcdef> - <paramdef>int <parameter>fp</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>fflush</methodname> + <methodparam><type>int</type><parameter>fp</parameter></methodparam> + </methodsynopsis> <para> This function forces a write of all buffered output to the to the resource pointed to by the file handle @@ -487,12 +459,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fgetc</function></funcdef> - <paramdef>int <parameter>fp</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fgetc</methodname> + <methodparam><type>int</type><parameter>fp</parameter></methodparam> + </methodsynopsis> <para> Returns a string containing a single character read from the file pointed to by fp. Returns &false; on EOF. @@ -519,18 +489,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>fgetcsv</function></funcdef> - <paramdef>int <parameter>fp</parameter></paramdef> - <paramdef>int <parameter>length</parameter></paramdef> - <paramdef>string - <parameter> - <optional>delimiter</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>fgetcsv</methodname> + <methodparam><type>int</type><parameter>fp</parameter></methodparam> + <methodparam><type>int</type><parameter>length</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + delimiter + </parameter></methodparam> + </methodsynopsis> <simpara> Similar to <function>fgets</function> except that <function>fgetcsv</function> parses the line it reads for fields @@ -587,13 +553,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fgets</function></funcdef> - <paramdef>int <parameter>fp</parameter></paramdef> - <paramdef>int <parameter><optional>length</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fgets</methodname> + <methodparam><type>int</type><parameter>fp</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> <para> Returns a string of up to length - 1 bytes read from the file pointed to by fp. Reading ends when length - 1 bytes have been @@ -656,18 +620,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fgetss</function></funcdef> - <paramdef>int <parameter>fp</parameter></paramdef> - <paramdef>int <parameter>length</parameter></paramdef> - <paramdef>string - <parameter> - <optional>allowable_tags</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fgetss</methodname> + <methodparam><type>int</type><parameter>fp</parameter></methodparam> + <methodparam><type>int</type><parameter>length</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + allowable_tags + </parameter></methodparam> + </methodsynopsis> <para> Identical to <function>fgets</function>, except that fgetss attempts to strip any HTML and PHP tags from the text it @@ -698,15 +658,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>file</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>int - <parameter><optional>use_include_path</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>file</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>use_include_path</parameter></methodparam> + </methodsynopsis> <para> Identical to <function>readfile</function>, except that <function>file</function> returns the file in an array. Each @@ -761,12 +717,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>file_exists</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>file_exists</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <simpara> Returns &true; if the file specified by <parameter>filename</parameter> exists; &false; otherwise. @@ -791,12 +745,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fileatime</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>fileatime</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <simpara> Returns the time the file was last accessed, or &false; in case of an error. The time is returned as a Unix timestamp. @@ -830,12 +782,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>filectime</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>filectime</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Returns the time the file was last changed, or &false; in case of an error. The time is returned as a Unix timestamp. @@ -872,12 +822,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>filegroup</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>filegroup</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Returns the group ID of the owner of the file, or &false; in case of an error. The group ID is returned in numerical format, use @@ -905,12 +853,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fileinode</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>fileinode</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Returns the inode number of the file, or &false; in case of an error.</para> @@ -934,12 +880,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>filemtime</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>filemtime</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Returns the time the file was last modified, or &false; in case of an error. The time is returned as a Unix timestamp. @@ -969,12 +913,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fileowner</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>fileowner</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Returns the user ID of the owner of the file, or &false; in case of an error. The user ID is returned in numerical format, use @@ -1000,12 +942,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fileperms</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>fileperms</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Returns the permissions on the file, or &false; in case of an error. </para> @@ -1028,12 +968,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>filesize</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>filesize</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Returns the size of the file in bytes, or &false; in case of an error. </para> @@ -1056,12 +994,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>filetype</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>filetype</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Returns the type of the file. Possible values are fifo, char, dir, block, link, file, and unknown.</para> <para> Returns &false; @@ -1086,18 +1022,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>flock</function></funcdef> - <paramdef>int <parameter>fp</parameter></paramdef> - <paramdef>int <parameter>operation</parameter></paramdef> - <paramdef>int - <parameter> - <optional>wouldblock</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>flock</methodname> + <methodparam><type>int</type><parameter>fp</parameter></methodparam> + <methodparam><type>int</type><parameter>operation</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + wouldblock + </parameter></methodparam> + </methodsynopsis> <simpara> PHP supports a portable way of locking complete files in an advisory way (which means all accessing programs have to use the @@ -1184,16 +1116,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fopen</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>string <parameter>mode</parameter></paramdef> - <paramdef>int - <parameter><optional>use_include_path</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>fopen</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>string</type><parameter>mode</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>use_include_path</parameter></methodparam> + </methodsynopsis> <simpara> If <parameter>filename</parameter> begins with "http://" (not case sensitive), an HTTP 1.0 connection is opened to the @@ -1341,12 +1269,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fpassthru</function></funcdef> - <paramdef>int <parameter>fp</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>fpassthru</methodname> + <methodparam><type>int</type><parameter>fp</parameter></methodparam> + </methodsynopsis> <simpara> Reads to EOF on the given file pointer from the current position and writes the results to standard output. @@ -1392,18 +1318,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fputs</function></funcdef> - <paramdef>int <parameter>fp</parameter></paramdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>int - <parameter> - <optional>length</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>fputs</methodname> + <methodparam><type>int</type><parameter>fp</parameter></methodparam> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + length + </parameter></methodparam> + </methodsynopsis> <para> <function>fputs</function> is an alias to <function>fwrite</function>, and is identical in every way. Note @@ -1420,13 +1342,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fread</function></funcdef> - <paramdef>int <parameter>fp</parameter></paramdef> - <paramdef>int <parameter>length</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fread</methodname> + <methodparam><type>int</type><parameter>fp</parameter></methodparam> + <methodparam><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> <simpara> <function>fread</function> reads up to <parameter>length</parameter> bytes from the file pointer @@ -1483,16 +1403,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>fscanf</function></funcdef> - <paramdef>int <parameter>handle</parameter></paramdef> - <paramdef>string <parameter>format</parameter></paramdef> - <paramdef>string - <parameter><optional>var1</optional></parameter>... - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>fscanf</methodname> + <methodparam><type>int</type><parameter>handle</parameter></methodparam> + <methodparam><type>string</type><parameter>format</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>var1</parameter></methodparam> + </methodsynopsis> <para> The function <function>fscanf</function> is similar to <function>sscanf</function>, but it takes its input from a file @@ -1543,16 +1459,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fseek</function></funcdef> - <paramdef>int <parameter>fp</parameter></paramdef> - <paramdef>int <parameter>offset</parameter></paramdef> - <paramdef>int - <parameter><optional>whence</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>fseek</methodname> + <methodparam><type>int</type><parameter>fp</parameter></methodparam> + <methodparam><type>int</type><parameter>offset</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>whence</parameter></methodparam> + </methodsynopsis> <para> Sets the file position indicator for the file referenced by <parameter>fp</parameter>.The new position, measured in bytes @@ -1604,12 +1516,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>fstat</function></funcdef> - <paramdef>int <parameter>fp</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>fstat</methodname> + <methodparam><type>int</type><parameter>fp</parameter></methodparam> + </methodsynopsis> <para> Gathers the statistics of the file opened by the file pointer fp. This function is similar to the @@ -1649,12 +1559,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ftell</function></funcdef> - <paramdef>int <parameter>fp</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ftell</methodname> + <methodparam><type>int</type><parameter>fp</parameter></methodparam> + </methodsynopsis> <para> Returns the position of the file pointer referenced by fp; i.e., its offset into the file stream. @@ -1683,13 +1591,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ftruncate</function></funcdef> - <paramdef>int <parameter>fp</parameter></paramdef> - <paramdef>int <parameter>size</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ftruncate</methodname> + <methodparam><type>int</type><parameter>fp</parameter></methodparam> + <methodparam><type>int</type><parameter>size</parameter></methodparam> + </methodsynopsis> <para> Takes the filepointer, fp, and truncates the file to length, size. This function returns &true; on success and &false; on failure. @@ -1704,18 +1610,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fwrite</function></funcdef> - <paramdef>int <parameter>fp</parameter></paramdef> - <paramdef>string <parameter>string</parameter></paramdef> - <paramdef>int - <parameter> - <optional>length</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>fwrite</methodname> + <methodparam><type>int</type><parameter>fp</parameter></methodparam> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + length + </parameter></methodparam> + </methodsynopsis> <simpara> <function>fwrite</function> writes the contents of <parameter>string</parameter> to the file stream pointed to by @@ -1760,13 +1662,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>set_file_buffer</function></funcdef> - <paramdef>int <parameter>fp</parameter></paramdef> - <paramdef>int <parameter>buffer</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>set_file_buffer</methodname> + <methodparam><type>int</type><parameter>fp</parameter></methodparam> + <methodparam><type>int</type><parameter>buffer</parameter></methodparam> + </methodsynopsis> <simpara> Output using <function>fwrite</function> is normally buffered at 8K. This means that if there are two processes wanting to write @@ -1814,12 +1714,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>is_dir</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_dir</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if the filename exists and is a directory. </para> @@ -1846,12 +1744,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>is_executable</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_executable</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if the filename exists and is executable. </para> @@ -1880,12 +1776,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>is_file</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_file</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if the filename exists and is a regular file. </para> @@ -1909,12 +1803,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>is_link</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_link</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if the filename exists and is a symbolic link. </para> @@ -1944,12 +1836,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>is_readable</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_readable</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if the filename exists and is readable. </para> @@ -1980,12 +1870,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>is_writable</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_writable</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if the filename exists and is writable. The filename argument may be a directory name allowing you to check @@ -2018,12 +1906,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>is_writeable</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_writeable</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> This is an alias for <function>is_writable</function> </para> @@ -2037,12 +1923,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>is_uploaded_file</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_uploaded_file</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> This function is available only in versions of PHP 3 after PHP @@ -2079,13 +1963,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>link</function></funcdef> - <paramdef>string <parameter>target</parameter></paramdef> - <paramdef>string <parameter>link</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>link</methodname> + <methodparam><type>string</type><parameter>target</parameter></methodparam> + <methodparam><type>string</type><parameter>link</parameter></methodparam> + </methodsynopsis> <para> <function>link</function> creates a hard link.</para> <para> @@ -2104,12 +1986,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>linkinfo</function></funcdef> - <paramdef>string <parameter>path</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>linkinfo</methodname> + <methodparam><type>string</type><parameter>path</parameter></methodparam> + </methodsynopsis> <para> <function>linkinfo</function> returns the st_dev field of the UNIX C stat structure returned by the lstat system call. This @@ -2133,13 +2013,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mkdir</function></funcdef> - <paramdef>string <parameter>pathname</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mkdir</methodname> + <methodparam><type>string</type><parameter>pathname</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> Attempts to create the directory specified by pathname. </para> @@ -2172,13 +2050,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>move_uploaded_file</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>string <parameter>destination</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>move_uploaded_file</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>string</type><parameter>destination</parameter></methodparam> + </methodsynopsis> <para> This function checks to ensure that the file designated by @@ -2232,17 +2108,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>parse_ini_file</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>bool - <parameter> - <optional>process_sections</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>parse_ini_file</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter> + process_sections + </parameter></methodparam> + </methodsynopsis> <para> <function>parse_ini_file</function> loads in the ini file specified in <parameter>filename</parameter>, @@ -2341,12 +2213,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>pathinfo</function></funcdef> - <paramdef>string <parameter>path</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>pathinfo</methodname> + <methodparam><type>string</type><parameter>path</parameter></methodparam> + </methodsynopsis> <para> <function>pathinfo</function> returns an associative array containing information about <parameter>path</parameter>. The @@ -2399,12 +2269,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pclose</function></funcdef> - <paramdef>int <parameter>fp</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pclose</methodname> + <methodparam><type>int</type><parameter>fp</parameter></methodparam> + </methodsynopsis> <para> Closes a file pointer to a pipe opened by <function>popen</function>. @@ -2430,13 +2298,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>popen</function></funcdef> - <paramdef>string <parameter>command</parameter></paramdef> - <paramdef>string <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>popen</methodname> + <methodparam><type>string</type><parameter>command</parameter></methodparam> + <methodparam><type>string</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> Opens a pipe to a process executed by forking the command given by command. @@ -2474,17 +2340,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>readfile</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>int - <parameter> - <optional>use_include_path</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>readfile</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + use_include_path + </parameter></methodparam> + </methodsynopsis> <para> Reads a file and writes it to standard output. </para> @@ -2535,12 +2397,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>readlink</function></funcdef> - <paramdef>string <parameter>path</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>readlink</methodname> + <methodparam><type>string</type><parameter>path</parameter></methodparam> + </methodsynopsis> <para> <function>readlink</function> does the same as the readlink C function and returns the contents of the symbolic link path or 0 @@ -2562,13 +2422,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>rename</function></funcdef> - <paramdef>string <parameter>oldname</parameter></paramdef> - <paramdef>string <parameter>newname</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>rename</methodname> + <methodparam><type>string</type><parameter>oldname</parameter></methodparam> + <methodparam><type>string</type><parameter>newname</parameter></methodparam> + </methodsynopsis> <para> Attempts to rename <parameter>oldname</parameter> to <parameter>newname</parameter>. @@ -2586,12 +2444,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>rewind</function></funcdef> - <paramdef>int <parameter>fp</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>rewind</methodname> + <methodparam><type>int</type><parameter>fp</parameter></methodparam> + </methodsynopsis> <para> Sets the file position indicator for fp to the beginning of the file stream.</para> <para> If an error occurs, returns 0.</para> @@ -2619,12 +2475,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>rmdir</function></funcdef> - <paramdef>string <parameter>dirname</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>rmdir</methodname> + <methodparam><type>string</type><parameter>dirname</parameter></methodparam> + </methodsynopsis> <para> Attempts to remove the directory named by pathname. The directory must be empty, and the relevant permissions must permit. @@ -2646,12 +2500,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>stat</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>stat</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Gathers the statistics of the file named by filename. </para> @@ -2698,12 +2550,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>lstat</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>lstat</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Gathers the statistics of the file or symbolic link named by filename. This function is identical to the @@ -2746,12 +2596,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>realpath</function></funcdef> - <paramdef>string <parameter>path</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>realpath</methodname> + <methodparam><type>string</type><parameter>path</parameter></methodparam> + </methodsynopsis> <para> <function>realpath</function> expands all symbolic links and resolves references to '/./', '/../' and extra '/' characters in @@ -2779,13 +2627,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>symlink</function></funcdef> - <paramdef>string <parameter>target</parameter></paramdef> - <paramdef>string <parameter>link</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>symlink</methodname> + <methodparam><type>string</type><parameter>target</parameter></methodparam> + <methodparam><type>string</type><parameter>link</parameter></methodparam> + </methodsynopsis> <para> <function>symlink</function> creates a symbolic link from the existing <parameter>target</parameter> with @@ -2807,13 +2653,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>tempnam</function></funcdef> - <paramdef>string <parameter>dir</parameter></paramdef> - <paramdef>string <parameter>prefix</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>tempnam</methodname> + <methodparam><type>string</type><parameter>dir</parameter></methodparam> + <methodparam><type>string</type><parameter>prefix</parameter></methodparam> + </methodsynopsis> <para> Creates a file with a unique filename in the specified directory. If the directory does not exist, <function>tempnam</function> may @@ -2873,12 +2717,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>tmpfile</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>tmpfile</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Creates a temporary file with an unique name in write mode, returning a file handle similar to the one returned by @@ -2917,17 +2759,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>touch</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>int - <parameter> - <optional>time</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>touch</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + time + </parameter></methodparam> + </methodsynopsis> <para> Attempts to set the access and modification time of the file named by filename to the value given by time. If the option time is not @@ -2963,12 +2801,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>umask</function></funcdef> - <paramdef>int <parameter>mask</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>umask</methodname> + <methodparam><type>int</type><parameter>mask</parameter></methodparam> + </methodsynopsis> <para> <function>umask</function> sets PHP's umask to mask &amp; 0777 and returns the old umask. When PHP is being used as a server module, @@ -2989,12 +2825,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>unlink</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>unlink</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Deletes <parameter>filename</parameter>. Similar to the Unix C unlink() function. @@ -3030,3 +2864,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/fribidi.xml diff -u phpdoc/en/functions/fribidi.xml:1.1 phpdoc/en/functions/fribidi.xml:1.2 --- phpdoc/en/functions/fribidi.xml:1.1 Sat Dec 15 09:54:58 2001 +++ phpdoc/en/functions/fribidi.xml Sat Feb 2 10:35:59 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <reference id="ref.fribidi"> <title>FriBiDi functions</title> <titleabbrev>FriBiDi functions</titleabbrev> @@ -17,14 +17,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>fribidi_log2vis</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>string <parameter>direction</parameter></paramdef> - <paramdef>int <parameter>charset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>fribidi_log2vis</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam><type>string</type><parameter>direction</parameter></methodparam> + <methodparam><type>int</type><parameter>charset</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -54,4 +52,5 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/ftp.xml diff -u phpdoc/en/functions/ftp.xml:1.37 phpdoc/en/functions/ftp.xml:1.38 --- phpdoc/en/functions/ftp.xml:1.37 Wed Jan 16 11:44:59 2002 +++ phpdoc/en/functions/ftp.xml Sat Feb 2 10:35:59 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.37 $ --> +<!-- $Revision: 1.38 $ --> <reference id="ref.ftp"> <title>FTP functions</title> <titleabbrev>FTP</titleabbrev> @@ -69,18 +69,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>ftp_connect</function></funcdef> - <paramdef>string <parameter>host</parameter></paramdef> - <paramdef>int - <parameter><optional>port</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>timeout</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>ftp_connect</methodname> + <methodparam><type>string</type><parameter>host</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + </methodsynopsis> <para> Returns a FTP stream on success, &false; on error. </para> @@ -113,14 +107,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ftp_login</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ftp_login</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + </methodsynopsis> <para> Logs in the given FTP stream. </para> @@ -137,12 +129,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ftp_pwd</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ftp_pwd</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + </methodsynopsis> <para> Returns the current directory, or &false; on error. </para> @@ -156,12 +146,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ftp_cdup</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ftp_cdup</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + </methodsynopsis> <para> Changes to the parent directory. </para> @@ -178,13 +166,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ftp_chdir</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - <paramdef>string <parameter>directory</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ftp_chdir</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>directory</parameter></methodparam> + </methodsynopsis> <para> Changes to the specified <parameter>directory</parameter>. </para> @@ -200,13 +186,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ftp_mkdir</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - <paramdef>string <parameter>directory</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ftp_mkdir</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>directory</parameter></methodparam> + </methodsynopsis> <para> Creates the specified <parameter>directory</parameter>. </para> @@ -223,13 +207,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ftp_rmdir</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - <paramdef>string <parameter>directory</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ftp_rmdir</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>directory</parameter></methodparam> + </methodsynopsis> <para> Removes the specified <parameter>directory</parameter>. </para> @@ -245,13 +227,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>ftp_nlist</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - <paramdef>string <parameter>directory</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>ftp_nlist</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>directory</parameter></methodparam> + </methodsynopsis> <para> Returns an array of filenames from the specified directory on success, &false; on error. @@ -268,13 +248,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>ftp_rawlist</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - <paramdef>string <parameter>directory</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>ftp_rawlist</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>directory</parameter></methodparam> + </methodsynopsis> <para> <function>ftp_rawlist</function> executes the FTP LIST command, and returns the result as an array. Each array element corresponds @@ -294,12 +272,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ftp_systype</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ftp_systype</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + </methodsynopsis> <para> Returns the remote system type, or &false; on error. </para> @@ -313,13 +289,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ftp_pasv</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - <paramdef>bool <parameter>pasv</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ftp_pasv</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + <methodparam><type>bool</type><parameter>pasv</parameter></methodparam> + </methodsynopsis> <para> <function>ftp_pasv</function> turns on passive mode if the <parameter>pasv</parameter> parameter is &true; (it turns off @@ -340,15 +314,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ftp_get</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - <paramdef>string <parameter>local_file</parameter></paramdef> - <paramdef>string <parameter>remote_file</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ftp_get</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>local_file</parameter></methodparam> + <methodparam><type>string</type><parameter>remote_file</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> <function>ftp_get</function> retrieves <parameter>remote_file</parameter> from the FTP server, and saves it to <parameter>local_file</parameter> @@ -373,15 +345,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ftp_fget</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - <paramdef>resource <parameter>fp</parameter></paramdef> - <paramdef>string <parameter>remote_file</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ftp_fget</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + <methodparam><type>resource</type><parameter>fp</parameter></methodparam> + <methodparam><type>string</type><parameter>remote_file</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> <function>ftp_fget</function> retrieves <parameter>remote_file</parameter> from the FTP server, and writes it to the given file pointer, @@ -402,15 +372,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ftp_put</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - <paramdef>string <parameter>remote_file</parameter></paramdef> - <paramdef>string <parameter>local_file</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ftp_put</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>remote_file</parameter></methodparam> + <methodparam><type>string</type><parameter>local_file</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> <function>ftp_put</function> stores <parameter>local_file</parameter> on the FTP server, as <parameter>remote_file</parameter>. The transfer @@ -440,15 +408,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ftp_fput</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - <paramdef>string <parameter>remote_file</parameter></paramdef> - <paramdef>resource <parameter>fp</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ftp_fput</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>remote_file</parameter></methodparam> + <methodparam><type>resource</type><parameter>fp</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> <function>ftp_fput</function> uploads the data from the file pointer <parameter>fp</parameter> until end of file. The results are stored @@ -469,13 +435,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ftp_size</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - <paramdef>string <parameter>remote_file</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ftp_size</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>remote_file</parameter></methodparam> + </methodsynopsis> <para> <function>ftp_size</function> returns the size of a file in bytes. If an error occurs, of if the file does not exist, -1 is returned. Not @@ -494,13 +458,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ftp_mdtm</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - <paramdef>string <parameter>remote_file</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ftp_mdtm</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>remote_file</parameter></methodparam> + </methodsynopsis> <para> <function>ftp_mdtm</function> checks the last-modified time for a file, and returns it as a UNIX timestamp. If an error occurs, or @@ -525,14 +487,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ftp_rename</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - <paramdef>string <parameter>from</parameter></paramdef> - <paramdef>string <parameter>to</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ftp_rename</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>from</parameter></methodparam> + <methodparam><type>string</type><parameter>to</parameter></methodparam> + </methodsynopsis> <para> <function>ftp_rename</function> renames the file or directory currently named <parameter>from</parameter> to the new name @@ -552,13 +512,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ftp_delete</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - <paramdef>string <parameter>path</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ftp_delete</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>path</parameter></methodparam> + </methodsynopsis> <para> <function>ftp_delete</function> deletes the file specified by <parameter>path</parameter> from the FTP server. @@ -576,13 +534,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ftp_site</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - <paramdef>string <parameter>cmd</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ftp_site</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>cmd</parameter></methodparam> + </methodsynopsis> <para> <function>ftp_site</function> sends the command specified by <parameter>cmd</parameter> to the FTP server. SITE commands @@ -603,12 +559,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>ftp_close</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>ftp_close</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + </methodsynopsis> <note> <para> This function is only available in CVS. @@ -629,12 +583,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>ftp_quit</function></funcdef> - <paramdef>resource <parameter>ftp_stream</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>ftp_quit</methodname> + <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam> + </methodsynopsis> <para> <function>ftp_quit</function> is an alias for <function>ftp_close</function>. @@ -651,13 +603,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ftp_exec</function></funcdef> - <paramdef>resource <parameter>stream</parameter></paramdef> - <paramdef>string <parameter>command</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ftp_exec</methodname> + <methodparam><type>resource</type><parameter>stream</parameter></methodparam> + <methodparam><type>string</type><parameter>command</parameter></methodparam> + </methodsynopsis> <para> Sends a SITE EXEC <parameter>command</parameter> request to the ftp server. Returns &false; if the request fails, returns the output of the @@ -675,14 +625,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ftp_set_option</function></funcdef> - <paramdef>resource <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>option</parameter></paramdef> - <paramdef>mixed <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ftp_set_option</methodname> + <methodparam><type>resource</type><parameter>stream</parameter></methodparam> + <methodparam><type>int</type><parameter>option</parameter></methodparam> + <methodparam><type>mixed</type><parameter>value</parameter></methodparam> + </methodsynopsis> <note> <para> This function is only available in CVS. @@ -737,13 +685,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ftp_get_option</function></funcdef> - <paramdef>resource <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>option</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ftp_get_option</methodname> + <methodparam><type>resource</type><parameter>stream</parameter></methodparam> + <methodparam><type>int</type><parameter>option</parameter></methodparam> + </methodsynopsis> <note> <para> This function is only available in CVS. @@ -806,3 +752,4 @@ vim: et tw=78 syn=xml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/funchand.xml diff -u phpdoc/en/functions/funchand.xml:1.26 phpdoc/en/functions/funchand.xml:1.27 --- phpdoc/en/functions/funchand.xml:1.26 Sat Jan 12 11:28:50 2002 +++ phpdoc/en/functions/funchand.xml Sat Feb 2 10:35:59 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.26 $ --> +<!-- $Revision: 1.27 $ --> <reference id="ref.funchand"> <title>Function Handling functions</title> <titleabbrev>Functions</titleabbrev> @@ -20,19 +20,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed - <function>call_user_func_array</function> - </funcdef> - <paramdef>string - <parameter>function_name</parameter> - </paramdef> - <paramdef>array - <parameter><optional>paramarr</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>call_user_func_array</methodname> + <methodparam><type>string</type><parameter>function_name</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>paramarr</parameter></methodparam> + </methodsynopsis> <para> Call a user defined function given by <parameter>function_name</parameter>, with @@ -83,22 +75,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed - <function>call_user_func</function> - </funcdef> - <paramdef>string - <parameter>function_name</parameter> - </paramdef> - <paramdef>mixed - <parameter><optional>parameter</optional></parameter> - </paramdef> - <paramdef>mixed - <parameter><optional>...</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>call_user_func</methodname> + <methodparam><type>string</type><parameter>function_name</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>parameter</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam> + </methodsynopsis> <para> Call a user defined function given by the <parameter>function_name</parameter> parameter. Take the @@ -131,13 +113,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>create_function</function></funcdef> - <paramdef>string <parameter>args</parameter></paramdef> - <paramdef>string <parameter>code</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>create_function</methodname> + <methodparam><type>string</type><parameter>args</parameter></methodparam> + <methodparam><type>string</type><parameter>code</parameter></methodparam> + </methodsynopsis> <para> Creates an anonymous function from the parameters passed, and returns a unique name for it. Usually the @@ -285,12 +265,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>func_get_arg</function></funcdef> - <paramdef>int <parameter>arg_num</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>func_get_arg</methodname> + <methodparam><type>int</type><parameter>arg_num</parameter></methodparam> + </methodsynopsis> <simpara> Returns the argument which is at the <parameter>arg_num</parameter>'th offset into a user-defined @@ -345,12 +323,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>func_get_args</function></funcdef> + <methodsynopsis> + <type>array</type><methodname>func_get_args</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <simpara> Returns an array in which each element is the corresponding member of the current user-defined function's argument @@ -403,12 +379,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>func_num_args</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>func_num_args</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <simpara> Returns the number of arguments passed into the current user-defined function. <function>func_num_args</function> will @@ -448,12 +422,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>function_exists</function></funcdef> - <paramdef>string <parameter>function_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>function_exists</methodname> + <methodparam><type>string</type><parameter>function_name</parameter></methodparam> + </methodsynopsis> <para> Checks the list of defined functions for <parameter>function_name</parameter>. Returns &true; if the given @@ -487,12 +459,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>get_defined_functions</function></funcdef> + <methodsynopsis> + <type>array</type><methodname>get_defined_functions</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This function returns an multidimensional array containing a list of all defined functions, both built-in (internal) and user-defined. The @@ -559,14 +529,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>register_shutdown_function</function> - </funcdef> - <paramdef>string <parameter>func</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>register_shutdown_function</methodname> + <methodparam><type>string</type><parameter>func</parameter></methodparam> + </methodsynopsis> <simpara> Registers the function named by <parameter>func</parameter> to be executed when script processing is complete. @@ -598,15 +564,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>register_tick_function</function> - </funcdef> - <paramdef>string <parameter>func</parameter></paramdef> - <paramdef>mixed <parameter><optional>arg</optional></parameter>...</paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>register_tick_function</methodname> + <methodparam><type>string</type><parameter>func</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <simpara> Registers the function named by <parameter>func</parameter> to be executed when a <link @@ -624,15 +586,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>unregister_tick_function</function> - </funcdef> - <paramdef>string <parameter>func</parameter></paramdef> - <paramdef>mixed <parameter><optional>arg</optional></parameter>...</paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>unregister_tick_function</methodname> + <methodparam><type>string</type><parameter>func</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <simpara> De-registers the function named by <parameter>func</parameter> so it is no longer executed when a <link @@ -663,3 +621,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/gettext.xml diff -u phpdoc/en/functions/gettext.xml:1.18 phpdoc/en/functions/gettext.xml:1.19 --- phpdoc/en/functions/gettext.xml:1.18 Sun Dec 16 05:26:37 2001 +++ phpdoc/en/functions/gettext.xml Sat Feb 2 10:35:59 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.18 $ --> +<!-- $Revision: 1.19 $ --> <reference id="ref.gettext"> <title>Gettext</title> <titleabbrev>gettext</titleabbrev> @@ -20,13 +20,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>bindtextdomain</function></funcdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>directory</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>bindtextdomain</methodname> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>directory</parameter></methodparam> + </methodsynopsis> <para> The <function>bindtextdomain</function> function sets the path for a domain. @@ -44,13 +42,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>bind_textdomain_codeset</function></funcdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>codeset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>bind_textdomain_codeset</methodname> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>codeset</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -64,14 +60,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>dcgettext</function></funcdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>message</parameter></paramdef> - <paramdef>int <parameter>category</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>dcgettext</methodname> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>message</parameter></methodparam> + <methodparam><type>int</type><parameter>category</parameter></methodparam> + </methodsynopsis> <para> This function allows you to override the current domain for a single message lookup. It also allows you to specify a category. @@ -86,16 +80,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>dcngettext</function></funcdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>msgid1</parameter></paramdef> - <paramdef>string <parameter>msgid2</parameter></paramdef> - <paramdef>int <parameter>n</parameter></paramdef> - <paramdef>int <parameter>category</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>dcngettext</methodname> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>msgid1</parameter></methodparam> + <methodparam><type>string</type><parameter>msgid2</parameter></methodparam> + <methodparam><type>int</type><parameter>n</parameter></methodparam> + <methodparam><type>int</type><parameter>category</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -109,13 +101,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>dgettext</function></funcdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>message</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>dgettext</methodname> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>message</parameter></methodparam> + </methodsynopsis> <para> The <function>dgettext</function> function allows you to override the current domain for a single message lookup. @@ -130,15 +120,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>dcngettext</function></funcdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>msgid1</parameter></paramdef> - <paramdef>string <parameter>msgid2</parameter></paramdef> - <paramdef>int <parameter>n</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>dcngettext</methodname> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>msgid1</parameter></methodparam> + <methodparam><type>string</type><parameter>msgid2</parameter></methodparam> + <methodparam><type>int</type><parameter>n</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -152,12 +140,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>gettext</function></funcdef> - <paramdef>string <parameter>message</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>gettext</methodname> + <methodparam><type>string</type><parameter>message</parameter></methodparam> + </methodsynopsis> <para> This function returns a translated string if one is found in the translation table, or the submitted message if not found. You may @@ -193,14 +179,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ngettext</function></funcdef> - <paramdef>string <parameter>msgid1</parameter></paramdef> - <paramdef>string <parameter>msgid2</parameter></paramdef> - <paramdef>int <parameter>n</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ngettext</methodname> + <methodparam><type>string</type><parameter>msgid1</parameter></methodparam> + <methodparam><type>string</type><parameter>msgid2</parameter></methodparam> + <methodparam><type>int</type><parameter>n</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -214,12 +198,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>textdomain</function></funcdef> - <paramdef>string <parameter>text_domain</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>textdomain</methodname> + <methodparam><type>string</type><parameter>text_domain</parameter></methodparam> + </methodsynopsis> <para> This function sets the domain to search within when calls are made to <function>gettext</function>, usually the named after an @@ -251,3 +233,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/gmp.xml diff -u phpdoc/en/functions/gmp.xml:1.22 phpdoc/en/functions/gmp.xml:1.23 --- phpdoc/en/functions/gmp.xml:1.22 Sun Jan 20 09:39:11 2002 +++ phpdoc/en/functions/gmp.xml Sat Feb 2 10:35:59 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.22 $ --> +<!-- $Revision: 1.23 $ --> <reference id="ref.gmp"> <title>GMP functions</title> <titleabbrev>GMP</titleabbrev> @@ -79,12 +79,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_init</function></funcdef> - <paramdef>mixed <parameter>number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_init</methodname> + <methodparam><type>mixed</type><parameter>number</parameter></methodparam> + </methodsynopsis> <para> Creates a GMP number from an integer or string. String representation can be decimal or hexadecimal. In the latter case, @@ -124,12 +122,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gmp_intval</function></funcdef> - <paramdef>resource <parameter>gmpnumber</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gmp_intval</methodname> + <methodparam><type>resource</type><parameter>gmpnumber</parameter></methodparam> + </methodsynopsis> <para> This function allows to convert GMP number to integer. <warning> @@ -150,15 +146,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>gmp_strval</function></funcdef> - <paramdef>resource <parameter>gmpnumber</parameter></paramdef> - <paramdef>int - <parameter><optional>base</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>gmp_strval</methodname> + <methodparam><type>resource</type><parameter>gmpnumber</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>base</parameter></methodparam> + </methodsynopsis> <para> Convert GMP number to string representation in base <parameter>base</parameter>. The default base is 10. Allowed @@ -187,13 +179,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_add</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - <paramdef>resource <parameter>b</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_add</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + <methodparam><type>resource</type><parameter>b</parameter></methodparam> + </methodsynopsis> <para> Add two GMP numbers. The result will be a GMP number representing the sum of the arguments. @@ -208,13 +198,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_sub</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - <paramdef>resource <parameter>b</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_sub</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + <methodparam><type>resource</type><parameter>b</parameter></methodparam> + </methodsynopsis> <para> Subtracts <parameter>b</parameter> from <parameter>a</parameter> and returns the result. @@ -229,13 +217,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_mul</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - <paramdef>resource <parameter>b</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_mul</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + <methodparam><type>resource</type><parameter>b</parameter></methodparam> + </methodsynopsis> <para> Multiplies <parameter>a</parameter> by <parameter>b</parameter> and returns the result. @@ -250,16 +236,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_div_q</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - <paramdef>resource <parameter>b</parameter></paramdef> - <paramdef>int - <parameter><optional>round</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_div_q</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + <methodparam><type>resource</type><parameter>b</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>round</parameter></methodparam> + </methodsynopsis> <para> Divides <parameter>a</parameter> by <parameter>b</parameter> and returns the integer result. The result rounding is defined by the @@ -303,16 +285,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_div_r</function></funcdef> - <paramdef>resource <parameter>n</parameter></paramdef> - <paramdef>resource <parameter>d</parameter></paramdef> - <paramdef>int - <parameter><optional>round</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_div_r</methodname> + <methodparam><type>resource</type><parameter>n</parameter></methodparam> + <methodparam><type>resource</type><parameter>d</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>round</parameter></methodparam> + </methodsynopsis> <para> Calculates remainder of the integer division of <parameter>n</parameter> by <parameter>d</parameter>. The @@ -337,16 +315,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>gmp_div_qr</function></funcdef> - <paramdef>resource <parameter>n</parameter></paramdef> - <paramdef>resource <parameter>d</parameter></paramdef> - <paramdef>int - <parameter><optional>round</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>gmp_div_qr</methodname> + <methodparam><type>resource</type><parameter>n</parameter></methodparam> + <methodparam><type>resource</type><parameter>d</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>round</parameter></methodparam> + </methodsynopsis> <para> The function divides <parameter>n</parameter> by <parameter>d</parameter> and returns array, with the first @@ -387,13 +361,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_div</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - <paramdef>resource <parameter>b</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_div</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + <methodparam><type>resource</type><parameter>b</parameter></methodparam> + </methodsynopsis> <para> This function is an alias to <function>gmp_div_q</function>. </para> @@ -407,13 +379,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_mod</function></funcdef> - <paramdef>resource <parameter>n</parameter></paramdef> - <paramdef>resource <parameter>d</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_mod</methodname> + <methodparam><type>resource</type><parameter>n</parameter></methodparam> + <methodparam><type>resource</type><parameter>d</parameter></methodparam> + </methodsynopsis> <para> Calculates <parameter>n</parameter> modulo <parameter>d</parameter>. The result is always non-negative, the @@ -429,13 +399,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_divexact</function></funcdef> - <paramdef>resource <parameter>n</parameter></paramdef> - <paramdef>resource <parameter>d</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_divexact</methodname> + <methodparam><type>resource</type><parameter>n</parameter></methodparam> + <methodparam><type>resource</type><parameter>d</parameter></methodparam> + </methodsynopsis> <para> Divides <parameter>n</parameter> by <parameter>d</parameter>, using fast "exact division" algorithm. This function produces @@ -452,13 +420,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gmp_cmp</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - <paramdef>resource <parameter>b</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gmp_cmp</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + <methodparam><type>resource</type><parameter>b</parameter></methodparam> + </methodsynopsis> <para> Returns a positive value if <literal>a > b</literal>, zero if <literal>a = b</literal> and negative value if <literal>a &lt; @@ -474,12 +440,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_neg</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_neg</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + </methodsynopsis> <para> Returns -<parameter>a</parameter>. </para> @@ -495,12 +459,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_com</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_com</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -514,12 +476,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_abs</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_abs</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + </methodsynopsis> <para> Returns absolute value of <parameter>a</parameter>. </para> @@ -533,12 +493,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gmp_sign</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gmp_sign</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + </methodsynopsis> <para> Return sign of <parameter>a</parameter> - 1 if <parameter>a</parameter> is positive and -1 if it's negative. @@ -553,12 +511,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_fact</function></funcdef> - <paramdef>int <parameter>a</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_fact</methodname> + <methodparam><type>int</type><parameter>a</parameter></methodparam> + </methodsynopsis> <para> Calculates factorial (<literal>a!</literal>) of <parameter>a</parameter>. </para> @@ -572,12 +528,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_sqrt</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_sqrt</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + </methodsynopsis> <para> Calculates square root of <parameter>a</parameter>. </para> @@ -591,12 +545,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>gmp_sqrtrm</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>gmp_sqrtrm</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + </methodsynopsis> <para> Returns array where first element is the integer square root of <parameter>a</parameter> (see also @@ -614,12 +566,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>gmp_perfect_square</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>gmp_perfect_square</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if <parameter>a</parameter> is a perfect square, &false; otherwise. @@ -638,13 +588,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_pow</function></funcdef> - <paramdef>resource <parameter>base</parameter></paramdef> - <paramdef>int <parameter>exp</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_pow</methodname> + <methodparam><type>resource</type><parameter>base</parameter></methodparam> + <methodparam><type>int</type><parameter>exp</parameter></methodparam> + </methodsynopsis> <para> Raise <parameter>base</parameter> into power <parameter>exp</parameter>. The case of 0^0 yields @@ -660,14 +608,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_powm</function></funcdef> - <paramdef>resource <parameter>base</parameter></paramdef> - <paramdef>resource <parameter>exp</parameter></paramdef> - <paramdef>resource <parameter>mod</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_powm</methodname> + <methodparam><type>resource</type><parameter>base</parameter></methodparam> + <methodparam><type>resource</type><parameter>exp</parameter></methodparam> + <methodparam><type>resource</type><parameter>mod</parameter></methodparam> + </methodsynopsis> <para> Calculate (<parameter>base</parameter> raised into power <parameter>exp</parameter>) modulo <parameter>mod</parameter>. If @@ -683,13 +629,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gmp_prob_prime</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - <paramdef>int <parameter><optional>reps</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gmp_prob_prime</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>reps</parameter></methodparam> + </methodsynopsis> <para> If this function returns 0, <parameter>a</parameter> is definitely not prime. If it returns 1, then @@ -712,13 +656,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_gcd</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - <paramdef>resource <parameter>b</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_gcd</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + <methodparam><type>resource</type><parameter>b</parameter></methodparam> + </methodsynopsis> <para> Calculate greatest common divisor of <parameter>a</parameter> and <parameter>b</parameter>. The result is always positive even if @@ -734,13 +676,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>gmp_gcdext</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - <paramdef>resource <parameter>b</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>gmp_gcdext</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + <methodparam><type>resource</type><parameter>b</parameter></methodparam> + </methodsynopsis> <para> Calculates g, s, and t, such that <literal>a*s + b*t = g = gcd(a,b)</literal>, where gcd is the greatest common divisor. Returns @@ -756,13 +696,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_invert</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - <paramdef>resource <parameter>b</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_invert</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + <methodparam><type>resource</type><parameter>b</parameter></methodparam> + </methodsynopsis> <para> Computes the inverse of <parameter>a</parameter> modulo <parameter>b</parameter>. Returns &false; if an inverse does not @@ -778,13 +716,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gmp_legendre</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - <paramdef>resource <parameter>p</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gmp_legendre</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> + </methodsynopsis> <para> Compute the <ulink url="&url.symbole-legendre;"> @@ -802,13 +738,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gmp_jacobi</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - <paramdef>resource <parameter>p</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gmp_jacobi</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + <methodparam><type>resource</type><parameter>p</parameter></methodparam> + </methodsynopsis> <para> Computes <ulink url="http://www.utm.edu/research/primes/glossary/JacobiSymbol.html"> @@ -826,12 +760,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_random</function></funcdef> - <paramdef>int <parameter>limiter</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_random</methodname> + <methodparam><type>int</type><parameter>limiter</parameter></methodparam> + </methodsynopsis> <para> Generate a random number. The number will be up to <parameter>limiter</parameter> words long. If @@ -848,13 +780,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_and</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - <paramdef>resource <parameter>b</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_and</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + <methodparam><type>resource</type><parameter>b</parameter></methodparam> + </methodsynopsis> <para> Calculates logical AND of two GMP numbers. </para> @@ -868,13 +798,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_or</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - <paramdef>resource <parameter>b</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_or</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + <methodparam><type>resource</type><parameter>b</parameter></methodparam> + </methodsynopsis> <para> Calculates logical inclusive OR of two GMP numbers. </para> @@ -888,13 +816,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_xor</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - <paramdef>resource <parameter>b</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_xor</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + <methodparam><type>resource</type><parameter>b</parameter></methodparam> + </methodsynopsis> <para> Calculates logical exclusive OR (XOR) of two GMP numbers. </para> @@ -908,16 +834,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_setbit</function></funcdef> - <paramdef>resource <parameter>&amp;a</parameter></paramdef> - <paramdef>int <parameter>index</parameter></paramdef> - <paramdef>bool - <parameter><optional>set_clear</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_setbit</methodname> + <methodparam><type>resource</type><parameter>&amp;a</parameter></methodparam> + <methodparam><type>int</type><parameter>index</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>set_clear</parameter></methodparam> + </methodsynopsis> <para> Sets bit <parameter>index</parameter> in <parameter>a</parameter>. <parameter>set_clear</parameter> @@ -934,13 +856,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>gmp_clrbit</function></funcdef> - <paramdef>resource <parameter>&amp;a</parameter></paramdef> - <paramdef>int <parameter>index</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>gmp_clrbit</methodname> + <methodparam><type>resource</type><parameter>&amp;a</parameter></methodparam> + <methodparam><type>int</type><parameter>index</parameter></methodparam> + </methodsynopsis> <para> Clears (sets to 0) bit <parameter>index</parameter> in <parameter>a</parameter>. @@ -955,13 +875,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gmp_scan0</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - <paramdef>int <parameter>start</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gmp_scan0</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + <methodparam><type>int</type><parameter>start</parameter></methodparam> + </methodsynopsis> <para> Scans <parameter>a</parameter>, starting with bit <parameter>start</parameter>, towards more significant bits, @@ -978,13 +896,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gmp_scan1</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - <paramdef>int <parameter>start</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gmp_scan1</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + <methodparam><type>int</type><parameter>start</parameter></methodparam> + </methodsynopsis> <para> Scans <parameter>a</parameter>, starting with bit <parameter>start</parameter>, towards more significant bits, @@ -1001,12 +917,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gmp_popcount</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gmp_popcount</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + </methodsynopsis> <para> Return the population count of <parameter>a</parameter>. </para> @@ -1020,13 +934,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gmp_hamdist</function></funcdef> - <paramdef>resource <parameter>a</parameter></paramdef> - <paramdef>resource <parameter>b</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gmp_hamdist</methodname> + <methodparam><type>resource</type><parameter>a</parameter></methodparam> + <methodparam><type>resource</type><parameter>b</parameter></methodparam> + </methodsynopsis> <para> Returns the hamming distance between <parameter>a</parameter> and <parameter>b</parameter>. Both operands should be non-negative. @@ -1056,3 +968,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/http.xml diff -u phpdoc/en/functions/http.xml:1.34 phpdoc/en/functions/http.xml:1.35 --- phpdoc/en/functions/http.xml:1.34 Wed Dec 12 15:46:50 2001 +++ phpdoc/en/functions/http.xml Sat Feb 2 10:35:59 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.34 $ --> +<!-- $Revision: 1.35 $ --> <reference id="ref.http"> <title>HTTP functions</title> <titleabbrev>HTTP</titleabbrev> @@ -18,13 +18,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>header</function></funcdef> - <paramdef>string <parameter>string</parameter></paramdef> - <paramdef>bool <parameter><optional>replace</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>header</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>replace</parameter></methodparam> + </methodsynopsis> <para> <function>header</function> is used to send raw <acronym>HTTP</acronym> headers. See the <ulink @@ -219,12 +217,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>headers_sent</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>headers_sent</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This function returns &true; if the HTTP headers have already been sent, &false; otherwise. @@ -242,27 +238,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>setcookie</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>string - <parameter><optional>value</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>expire</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>path</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>domain</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>secure</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>setcookie</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>value</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>expire</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>path</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>domain</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>secure</parameter></methodparam> + </methodsynopsis> <para> <function>setcookie</function> defines a cookie to be sent along with the rest of the header information. Cookies must be sent @@ -415,3 +399,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/hw.xml diff -u phpdoc/en/functions/hw.xml:1.24 phpdoc/en/functions/hw.xml:1.25 --- phpdoc/en/functions/hw.xml:1.24 Fri Jan 18 08:16:29 2002 +++ phpdoc/en/functions/hw.xml Sat Feb 2 10:35:59 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.24 $ --> +<!-- $Revision: 1.25 $ --> <reference id="ref.hyperwave"> <title>Hyperwave functions</title> <titleabbrev>Hyperwave</titleabbrev> @@ -386,12 +386,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>strin <function>hw_array2objrec</function></funcdef> - <paramdef>array <parameter>object_array</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>strin</type><methodname>hw_array2objrec</methodname> + <methodparam><type>array</type><parameter>object_array</parameter></methodparam> + </methodsynopsis> <para> Converts an <parameter>object_array</parameter> into an object record. Multiple attributes like 'Title' in different languages are treated @@ -410,13 +408,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>hw_children</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>hw_children</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>objectID</parameter></methodparam> + </methodsynopsis> <para> Returns an array of object ids. Each id belongs to a child of the collection with ID @@ -432,13 +428,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>hw_childrenobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>hw_childrenobj</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>objectID</parameter></methodparam> + </methodsynopsis> <para> Returns an array of object records. Each object record belongs to a child of the collection with ID @@ -454,12 +448,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_close</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_close</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> Returns &false; if connection is not a valid connection index, otherwise &true;. Closes down the connection to a Hyperwave server @@ -475,15 +467,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_connect</function></funcdef> - <paramdef>string <parameter>host</parameter></paramdef> - <paramdef>int <parameter>port</parameter></paramdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_connect</methodname> + <methodparam><type>string</type><parameter>host</parameter></methodparam> + <methodparam><type>int</type><parameter>port</parameter></methodparam> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + </methodsynopsis> <para> Opens a connection to a Hyperwave server and returns a connection index on success, or &false; if the connection @@ -510,14 +500,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_cp</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>array <parameter>object_id_array</parameter></paramdef> - <paramdef>int <parameter>destination id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_cp</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>array</type><parameter>object_id_array</parameter></methodparam> + <methodparam><type>int</type><parameter>destination id</parameter></methodparam> + </methodsynopsis> <para> Copies the objects with object ids as specified in the second parameter to the collection @@ -539,13 +527,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_deleteobject</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>object_to_delete</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_deleteobject</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>object_to_delete</parameter></methodparam> + </methodsynopsis> <para> Deletes the object with the given object id in the second parameter. It will delete all instances of the object. @@ -566,13 +552,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_docbyanchor</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>anchorID</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_docbyanchor</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>anchorID</parameter></methodparam> + </methodsynopsis> <para> Returns an th object id of the document to which <parameter>anchorID</parameter> belongs. @@ -587,13 +571,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>hw_docbyanchorobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>anchorID</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>hw_docbyanchorobj</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>anchorID</parameter></methodparam> + </methodsynopsis> <para> Returns an th object record of the document to which <parameter>anchorID</parameter> belongs. @@ -608,12 +590,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>hw_document_attributes</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>hw_document_attributes</methodname> + <methodparam><type>int</type><parameter>hw_document</parameter></methodparam> + </methodsynopsis> <para> Returns the object record of the document. </para> @@ -635,12 +615,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>hw_document_bodytag</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>hw_document_bodytag</methodname> + <methodparam><type>int</type><parameter>hw_document</parameter></methodparam> + </methodsynopsis> <para> Returns the BODY tag of the document. If the document is an HTML document the BODY tag should be printed before the document. @@ -663,12 +641,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>hw_document_content</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>hw_document_content</methodname> + <methodparam><type>int</type><parameter>hw_document</parameter></methodparam> + </methodsynopsis> <para> Returns the content of the document. If the document is an HTML document the content is everything after the BODY tag. Information @@ -689,13 +665,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>hw_document_setcontent</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - <paramdef>string <parameter>content</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>hw_document_setcontent</methodname> + <methodparam><type>int</type><parameter>hw_document</parameter></methodparam> + <methodparam><type>string</type><parameter>content</parameter></methodparam> + </methodsynopsis> <para> Sets or replaces the content of the document. If the document is an HTML document the content is everything after the BODY tag. Information @@ -720,12 +694,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_document_size</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_document_size</methodname> + <methodparam><type>int</type><parameter>hw_document</parameter></methodparam> + </methodsynopsis> <para> Returns the size in bytes of the document.</para> <para> @@ -746,12 +718,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>hw_errormsg</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>hw_errormsg</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> Returns a string containing the last error message or 'No Error'. If &false; is returned, this function failed. @@ -767,13 +737,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_edittext</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_edittext</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>hw_document</parameter></methodparam> + </methodsynopsis> <para> Uploads the text document to the server. The object record of the document may not be modified while the document @@ -800,12 +768,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_error</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_error</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> Returns the last error number. If the return value is 0 no error has occurred. The error relates to the last command. @@ -820,12 +786,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_free_document</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_free_document</methodname> + <methodparam><type>int</type><parameter>hw_document</parameter></methodparam> + </methodsynopsis> <para> Frees the memory occupied by the Hyperwave document. </para> @@ -839,13 +803,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>hw_getparents</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>hw_getparents</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>objectID</parameter></methodparam> + </methodsynopsis> <para> Returns an indexed array of object ids. Each object id belongs to a parent of the object with ID <parameter>objectID</parameter>. @@ -860,13 +822,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>hw_getparentsobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>hw_getparentsobj</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>objectID</parameter></methodparam> + </methodsynopsis> <para> Returns an indexed array of object records plus an associated array with statistical information about the object records. The associated array is the @@ -883,13 +843,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>hw_getchildcoll</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>hw_getchildcoll</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>objectID</parameter></methodparam> + </methodsynopsis> <para> Returns an array of object ids. Each object ID belongs to a child collection of the collection with ID @@ -909,13 +867,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>hw_getchildcollobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>hw_getchildcollobj</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>objectID</parameter></methodparam> + </methodsynopsis> <para> Returns an array of object records. Each object records belongs to a child collection of the collection with ID @@ -936,13 +892,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_getremote</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_getremote</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>objectID</parameter></methodparam> + </methodsynopsis> <para> Returns a remote document. Remote documents in Hyperwave notation are documents retrieved from an external source. Common remote @@ -970,13 +924,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_getremotechildren</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>object record</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_getremotechildren</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>object record</parameter></methodparam> + </methodsynopsis> <para> Returns the children of a remote document. Children of a remote document are remote documents itself. @@ -1010,13 +962,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>hw_getsrcbydestobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>hw_getsrcbydestobj</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>objectID</parameter></methodparam> + </methodsynopsis> <para> Returns the object records of all anchors pointing to the object with ID <parameter>objectID</parameter>. The object can either be a document @@ -1034,14 +984,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>hw_getobject</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>[int|array] <parameter>objectID</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>hw_getobject</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>[int|array]</type><parameter>objectID</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> <para> Returns the object record for the object with ID <parameter>objectID</parameter> if the second parameter is an integer. @@ -1085,13 +1033,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>hw_getandlock</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>hw_getandlock</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>objectID</parameter></methodparam> + </methodsynopsis> <para> Returns the object record for the object with ID <parameter>objectID</parameter>. @@ -1112,18 +1058,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_gettext</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - <paramdef>mixed - <parameter> - <optional>rootID/prefix</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_gettext</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>objectID</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter> + rootID/prefix + </parameter></methodparam> + </methodsynopsis> <para> Returns the document with object ID <parameter>objectID</parameter>. If the document @@ -1180,14 +1122,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>hw_getobjectbyquery</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>int <parameter>max_hits</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>hw_getobjectbyquery</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam><type>int</type><parameter>max_hits</parameter></methodparam> + </methodsynopsis> <para> Searches for objects on the whole server and returns an array of object ids. The maximum number of matches is limited to @@ -1210,14 +1150,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>hw_getobjectbyqueryobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>int <parameter>max_hits</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>hw_getobjectbyqueryobj</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam><type>int</type><parameter>max_hits</parameter></methodparam> + </methodsynopsis> <para> Searches for objects on the whole server and returns an array of object records. The maximum number of matches is limited to @@ -1240,15 +1178,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>hw_getobjectbyquerycoll</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>int <parameter>max_hits</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>hw_getobjectbyquerycoll</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>objectID</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam><type>int</type><parameter>max_hits</parameter></methodparam> + </methodsynopsis> <para> Searches for objects in collection with ID <parameter>objectID</parameter> and returns an array of @@ -1272,15 +1208,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>hw_getobjectbyquerycollobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>int <parameter>max_hits</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>hw_getobjectbyquerycollobj</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>objectID</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam><type>int</type><parameter>max_hits</parameter></methodparam> + </methodsynopsis> <para> Searches for objects in collection with ID <parameter>objectID</parameter> and returns an array of @@ -1305,13 +1239,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>hw_getchilddoccoll</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>hw_getchilddoccoll</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>objectID</parameter></methodparam> + </methodsynopsis> <para> Returns array of object ids for child documents of a collection. </para> @@ -1329,13 +1261,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>hw_getchilddoccollobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>hw_getchilddoccollobj</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>objectID</parameter></methodparam> + </methodsynopsis> <para> Returns an array of object records for child documents of a collection.</para> <para> @@ -1352,13 +1282,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>hw_getanchors</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>hw_getanchors</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>objectID</parameter></methodparam> + </methodsynopsis> <para> Returns an array of object ids with anchors of the document with object ID <parameter>objectID</parameter>. @@ -1373,13 +1301,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>hw_getanchorsobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>hw_getanchorsobj</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>objectID</parameter></methodparam> + </methodsynopsis> <para> Returns an array of object records with anchors of the document with object ID <parameter>objectID</parameter>. @@ -1394,15 +1320,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_mv</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>array <parameter>object id array</parameter></paramdef> - <paramdef>int <parameter>source id</parameter></paramdef> - <paramdef>int <parameter>destination id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_mv</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>array</type><parameter>object id array</parameter></methodparam> + <methodparam><type>int</type><parameter>source id</parameter></methodparam> + <methodparam><type>int</type><parameter>destination id</parameter></methodparam> + </methodsynopsis> <para> Moves the objects with object ids as specified in the second parameter from the collection with id <parameter>source id</parameter> @@ -1429,13 +1353,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_identify</function></funcdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_identify</methodname> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + </methodsynopsis> <para> Identifies as user with <parameter>username</parameter> and <parameter>password</parameter>. Identification @@ -1456,15 +1378,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>hw_incollections</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>array <parameter>object_id_array</parameter></paramdef> - <paramdef>array <parameter>collection_id_array</parameter></paramdef> - <paramdef>int <parameter>return_collections</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>hw_incollections</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>array</type><parameter>object_id_array</parameter></methodparam> + <methodparam><type>array</type><parameter>collection_id_array</parameter></methodparam> + <methodparam><type>int</type><parameter>return_collections</parameter></methodparam> + </methodsynopsis> <para> Checks whether a set of objects (documents or collections) specified by the <parameter>object_id_array</parameter> is part of @@ -1489,12 +1409,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>hw_info</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>hw_info</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> Returns information about the current connection. The returned string has the following format: &lt;Serverstring&gt;, &lt;Host&gt;, @@ -1511,14 +1429,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_inscoll</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - <paramdef>array <parameter>object_array</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_inscoll</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>objectID</parameter></methodparam> + <methodparam><type>array</type><parameter>object_array</parameter></methodparam> + </methodsynopsis> <para> Inserts a new collection with attributes as in <parameter>object_array</parameter> into @@ -1534,15 +1450,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_insdoc</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>parentID</parameter></paramdef> - <paramdef>string <parameter>object_record</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_insdoc</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>parentID</parameter></methodparam> + <methodparam><type>string</type><parameter>object_record</parameter></methodparam> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + </methodsynopsis> <para> Inserts a new document with attributes as in <parameter>object_record</parameter> into collection with object ID @@ -1566,14 +1480,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_insertdocument</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>parent_id</parameter></paramdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_insertdocument</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>parent_id</parameter></methodparam> + <methodparam><type>int</type><parameter>hw_document</parameter></methodparam> + </methodsynopsis> <para> Uploads a document into the collection with <parameter>parent_id</parameter>. @@ -1597,14 +1509,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_insertobject</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>object rec</parameter></paramdef> - <paramdef>string <parameter>parameter</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_insertobject</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>object rec</parameter></methodparam> + <methodparam><type>string</type><parameter>parameter</parameter></methodparam> + </methodsynopsis> <para> Inserts an object into the server. The object can be any valid hyperwave object. See the HG-CSP documentation @@ -1632,14 +1542,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_mapid</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>server id</parameter></paramdef> - <paramdef>int <parameter>object id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_mapid</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>server id</parameter></methodparam> + <methodparam><type>int</type><parameter>object id</parameter></methodparam> + </methodsynopsis> <para> Maps a global object id on any hyperwave server, even those you did not connect to with <function>hw_connect</function>, @@ -1666,16 +1574,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_modifyobject</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>object_to_change</parameter></paramdef> - <paramdef>array <parameter>remove</parameter></paramdef> - <paramdef>array <parameter>add</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_modifyobject</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>object_to_change</parameter></methodparam> + <methodparam><type>array</type><parameter>remove</parameter></methodparam> + <methodparam><type>array</type><parameter>add</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> This command allows to remove, add, or modify individual attributes of an object record. The object is specified by the Object ID @@ -1837,14 +1743,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_new_document</function></funcdef> - <paramdef>string <parameter>object_record</parameter></paramdef> - <paramdef>string <parameter>document_data</parameter></paramdef> - <paramdef>int <parameter>document_size</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_new_document</methodname> + <methodparam><type>string</type><parameter>object_record</parameter></methodparam> + <methodparam><type>string</type><parameter>document_data</parameter></methodparam> + <methodparam><type>int</type><parameter>document_size</parameter></methodparam> + </methodsynopsis> <para> Returns a new Hyperwave document with document data set to <parameter>document_data</parameter> and object record set to @@ -1870,17 +1774,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>hw_objrec2array</function></funcdef> - <paramdef>string <parameter>object_record</parameter></paramdef> - <paramdef>array - <parameter> - <optional>format</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>hw_objrec2array</methodname> + <methodparam><type>string</type><parameter>object_record</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter> + format + </parameter></methodparam> + </methodsynopsis> <para> Converts an <parameter>object_record</parameter> into an object array. The keys of the resulting array are the attributes names. @@ -1910,12 +1810,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_output_document</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_output_document</methodname> + <methodparam><type>int</type><parameter>hw_document</parameter></methodparam> + </methodsynopsis> <para> Prints the document without the BODY tag. </para> @@ -1933,15 +1831,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_pconnect</function></funcdef> - <paramdef>string <parameter>host</parameter></paramdef> - <paramdef>int <parameter>port</parameter></paramdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_pconnect</methodname> + <methodparam><type>string</type><parameter>host</parameter></methodparam> + <methodparam><type>int</type><parameter>port</parameter></methodparam> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + </methodsynopsis> <para> Returns a connection index on success, or &false; if the connection could not be made. Opens a persistent connection to a Hyperwave @@ -1966,13 +1862,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_pipedocument</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_pipedocument</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>objectID</parameter></methodparam> + </methodsynopsis> <para> Returns the Hyperwave document with object ID <parameter>objectID</parameter>. If the document @@ -1996,12 +1890,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_root</function></funcdef> - <paramdef><parameter></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_root</methodname> + <methodparam><parameter/></methodparam> + </methodsynopsis> <para> Returns the object ID of the hyperroot collection. Currently this is always 0. The child collection of the hyperroot is the root @@ -2017,13 +1909,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_unlock</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_unlock</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>objectID</parameter></methodparam> + </methodsynopsis> <para> Unlocks a document, so other users regain access. </para> @@ -2040,12 +1930,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hw_who</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hw_who</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> Returns an array of users currently logged into the Hyperwave server. Each entry in this array is an array itself containing the elements id, @@ -2062,12 +1950,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>hw_getusername</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>hw_getusername</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> Returns the username of the connection. </para> @@ -2083,12 +1969,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>hw_stat</function></funcdef> - <paramdef>int <parameter>link</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>hw_stat</methodname> + <methodparam><type>int</type><parameter>link</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2104,13 +1988,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>hw_setlinkroot</function></funcdef> - <paramdef>int <parameter>link</parameter></paramdef> - <paramdef>int <parameter>rootid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>hw_setlinkroot</methodname> + <methodparam><type>int</type><parameter>link</parameter></methodparam> + <methodparam><type>int</type><parameter>rootid</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2126,12 +2008,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>hw_connection_info</function></funcdef> - <paramdef>int <parameter>link</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>hw_connection_info</methodname> + <methodparam><type>int</type><parameter>link</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2147,14 +2027,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>hw_dummy</function></funcdef> - <paramdef>int <parameter>link</parameter></paramdef> - <paramdef>int <parameter>id</parameter></paramdef> - <paramdef>int <parameter>msgid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>hw_dummy</methodname> + <methodparam><type>int</type><parameter>link</parameter></methodparam> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>int</type><parameter>msgid</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2170,15 +2048,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>hw_insertanchors</function></funcdef> - <paramdef>int <parameter>hwdoc</parameter></paramdef> - <paramdef>array <parameter>anchorecs</parameter></paramdef> - <paramdef>array <parameter>dest</parameter></paramdef> - <paramdef>array <parameter><optional>urlprefixes</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>hw_insertanchors</methodname> + <methodparam><type>int</type><parameter>hwdoc</parameter></methodparam> + <methodparam><type>array</type><parameter>anchorecs</parameter></methodparam> + <methodparam><type>array</type><parameter>dest</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>urlprefixes</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2194,15 +2070,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>hw_getrellink</function></funcdef> - <paramdef>int <parameter>link</parameter></paramdef> - <paramdef>int <parameter>rootid</parameter></paramdef> - <paramdef>int <parameter>sourceid</parameter></paramdef> - <paramdef>int <parameter>destid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>hw_getrellink</methodname> + <methodparam><type>int</type><parameter>link</parameter></methodparam> + <methodparam><type>int</type><parameter>rootid</parameter></methodparam> + <methodparam><type>int</type><parameter>sourceid</parameter></methodparam> + <methodparam><type>int</type><parameter>destid</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2218,14 +2092,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>hw_changeobject</function></funcdef> - <paramdef>int <parameter>link</parameter></paramdef> - <paramdef>int <parameter>objid</parameter></paramdef> - <paramdef>array <parameter>attributes</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>hw_changeobject</methodname> + <methodparam><type>int</type><parameter>link</parameter></methodparam> + <methodparam><type>int</type><parameter>objid</parameter></methodparam> + <methodparam><type>array</type><parameter>attributes</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2254,3 +2126,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/ibase.xml diff -u phpdoc/en/functions/ibase.xml:1.44 phpdoc/en/functions/ibase.xml:1.45 --- phpdoc/en/functions/ibase.xml:1.44 Mon Jan 21 13:59:53 2002 +++ phpdoc/en/functions/ibase.xml Sat Feb 2 10:35:59 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.44 $ --> +<!-- $Revision: 1.45 $ --> <reference id="ref.ibase"> <title>InterBase functions</title> <titleabbrev>InterBase</titleabbrev> @@ -39,30 +39,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ibase_connect</function></funcdef> - <paramdef>string <parameter>database</parameter></paramdef> - <paramdef>string - <parameter><optional>username</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>password</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>charset</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>buffers</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>dialect</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>role</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ibase_connect</methodname> + <methodparam><type>string</type><parameter>database</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>buffers</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>dialect</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>role</parameter></methodparam> + </methodsynopsis> <para> Establishes a connection to an InterBase server. The <parameter>database</parameter> argument @@ -136,30 +122,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ibase_pconnect</function></funcdef> - <paramdef>string <parameter>database</parameter></paramdef> - <paramdef>string - <parameter><optional>username</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>password</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>charset</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>buffers</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>dialect</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>role</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ibase_pconnect</methodname> + <methodparam><type>string</type><parameter>database</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>buffers</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>dialect</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>role</parameter></methodparam> + </methodsynopsis> <para> <function>ibase_pconnect</function> acts very much like <function>ibase_connect</function> with two major differences. @@ -206,14 +178,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ibase_close</function></funcdef> - <paramdef>int - <parameter><optional>connection_id</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ibase_close</methodname> + <methodparam choice="opt"><type>int</type><parameter>connection_id</parameter></methodparam> + </methodsynopsis> <para> Closes the link to an InterBase database that's associated with a connection id returned from <function>ibase_connect</function>. @@ -231,20 +199,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ibase_query</function></funcdef> - <paramdef>int - <parameter><optional>link_identifier</optional></parameter> - </paramdef> - <paramdef>string - <parameter>query</parameter> - </paramdef> - <paramdef>int - <parameter><optional>bind_args</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ibase_query</methodname> + <methodparam choice="opt"><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>bind_args</parameter></methodparam> + </methodsynopsis> <simpara> Performs a query on an InterBase database. If the query is not successful, returns &false;. If it is successful and there are resulting @@ -270,12 +230,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ibase_errmsg</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>ibase_errmsg</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <simpara> Returns a string containing an error message. </simpara> @@ -289,14 +247,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>ibase_fetch_row</function></funcdef> - <paramdef>int - <parameter>result_identifier</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>ibase_fetch_row</methodname> + <methodparam><type>int</type><parameter>result_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns an array that corresponds to the fetched row, or &false; if there are no more rows. @@ -323,14 +277,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>ibase_fetch_object</function></funcdef> - <paramdef>int - <parameter>result_id</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>ibase_fetch_object</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> Fetches a row as a pseudo-object from a <parameter>result_id</parameter> obtained either by @@ -372,13 +322,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>ibase_field_info</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - <paramdef>int <parameter>field number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>ibase_field_info</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field number</parameter></methodparam> + </methodsynopsis> <para> Returns an array with information about a field after a select query has been run. The array is in the form of name, alias, @@ -412,14 +360,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ibase_free_query</function></funcdef> - <paramdef>int - <parameter>query</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ibase_free_query</methodname> + <methodparam><type>int</type><parameter>query</parameter></methodparam> + </methodsynopsis> <simpara> Free a query prepared by <function>ibase_prepare</function>. </simpara> @@ -433,14 +377,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ibase_free_result</function></funcdef> - <paramdef>int - <parameter>result_identifier</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ibase_free_result</methodname> + <methodparam><type>int</type><parameter>result_identifier</parameter></methodparam> + </methodsynopsis> <simpara> Free's a result set the has been created by <function>ibase_query</function>. @@ -458,15 +398,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ibase_prepare</function></funcdef> - <paramdef>int - <parameter><optional>link_identifier</optional></parameter> - </paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ibase_prepare</methodname> + <methodparam choice="opt"><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> <simpara> Prepare a query for later binding of parameter placeholders and execution (via <function>ibase_execute</function>). @@ -481,17 +417,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ibase_execute</function></funcdef> - <paramdef>int - <parameter>query</parameter> - </paramdef> - <paramdef>int - <parameter><optional>bind_args</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ibase_execute</methodname> + <methodparam><type>int</type><parameter>query</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>bind_args</parameter></methodparam> + </methodsynopsis> <para> Execute a query prepared by <function>ibase_prepare</function>. This is a lot more effective than using <function>ibase_query</function> @@ -527,17 +457,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ibase_trans</function></funcdef> - <paramdef>int - <parameter><optional>trans_args</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>link_identifier</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ibase_trans</methodname> + <methodparam choice="opt"><type>int</type><parameter>trans_args</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> Begins a transaction. </para> @@ -551,16 +475,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ibase_commit</function></funcdef> - <paramdef>int - <parameter><optional>link_identifier</optional></parameter> - </paramdef> - <paramdef>int <parameter>trans_number</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ibase_commit</methodname> + <methodparam choice="opt"><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>trans_number</parameter></methodparam> + </methodsynopsis> <para> Commits transaction <parameter>trans_number</parameter> which was created with <function>ibase_trans</function>. @@ -575,16 +494,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ibase_rollback</function></funcdef> - <paramdef>int - <parameter><optional>link_identifier</optional></parameter> - </paramdef> - <paramdef>int <parameter>trans_number</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ibase_rollback</methodname> + <methodparam choice="opt"><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>trans_number</parameter></methodparam> + </methodsynopsis> <para> Rolls back transaction <parameter>trans_number</parameter> which was created with <function>ibase_trans</function>. @@ -601,17 +515,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ibase_timefmt</function></funcdef> - <paramdef>string - <parameter>format</parameter> - </paramdef> - <paramdef>int - <parameter><optional>columntype</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ibase_timefmt</methodname> + <methodparam><type>string</type><parameter>format</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>columntype</parameter></methodparam> + </methodsynopsis> <para> Sets the format of timestamp, date or time type columns returned from queries. Internally, the columns are formatted by c-function @@ -662,12 +570,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ibase_num_fields</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ibase_num_fields</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> Returns an integer containing the number of fields in a result set. @@ -708,13 +614,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ibase_blob_add</function></funcdef> - <paramdef>int <parameter>blob_id</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ibase_blob_add</methodname> + <methodparam><type>int</type><parameter>blob_id</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -732,12 +636,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ibase_blob_cancel</function></funcdef> - <paramdef>int <parameter>blob_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ibase_blob_cancel</methodname> + <methodparam><type>int</type><parameter>blob_id</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -755,12 +657,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ibase_blob_close</function></funcdef> - <paramdef>int <parameter>blob_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ibase_blob_close</methodname> + <methodparam><type>int</type><parameter>blob_id</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -778,12 +678,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ibase_blob_create</function></funcdef> - <paramdef>int <parameter><optional>link_identifier</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ibase_blob_create</methodname> + <methodparam choice="opt"><type>int</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -801,12 +699,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ibase_blob_echo</function></funcdef> - <paramdef>string <parameter>blob_id_str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ibase_blob_echo</methodname> + <methodparam><type>string</type><parameter>blob_id_str</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -824,13 +720,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ibase_blob_get</function></funcdef> - <paramdef>int <parameter>blob_id</parameter></paramdef> - <paramdef>int <parameter>len</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ibase_blob_get</methodname> + <methodparam><type>int</type><parameter>blob_id</parameter></methodparam> + <methodparam><type>int</type><parameter>len</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -848,15 +742,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ibase_blob_import</function></funcdef> - <paramdef>int - <parameter><optional>link_identifier</optional></parameter> - </paramdef> - <paramdef>int <parameter>file_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ibase_blob_import</methodname> + <methodparam choice="opt"><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>file_id</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -874,12 +764,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>ibase_blob_info</function></funcdef> - <paramdef>string <parameter>blob_id_str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>ibase_blob_info</methodname> + <methodparam><type>string</type><parameter>blob_id_str</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -897,12 +785,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ibase_blob_open</function></funcdef> - <paramdef>string <parameter>blob_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ibase_blob_open</methodname> + <methodparam><type>string</type><parameter>blob_id</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -932,3 +818,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/icap.xml diff -u phpdoc/en/functions/icap.xml:1.18 phpdoc/en/functions/icap.xml:1.19 --- phpdoc/en/functions/icap.xml:1.18 Thu Jan 17 22:32:23 2002 +++ phpdoc/en/functions/icap.xml Sat Feb 2 10:35:59 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.18 $ --> +<!-- $Revision: 1.19 $ --> <reference id="ref.icap"> <title>ICAP Functions [deprecated]</title> <titleabbrev>ICAP</titleabbrev> @@ -26,15 +26,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>stream <function>icap_open</function></funcdef> - <paramdef>string <parameter>calendar</parameter></paramdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>string <parameter>options</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>stream</type><methodname>icap_open</methodname> + <methodparam><type>string</type><parameter>calendar</parameter></methodparam> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam><type>string</type><parameter>options</parameter></methodparam> + </methodsynopsis> <para> Returns an ICAP stream on success, &false; on error.</para> <para> @@ -53,15 +51,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>icap_close</function></funcdef> - <paramdef>int <parameter>icap_stream</parameter></paramdef> - <paramdef>int - <parameter><optional>flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>icap_close</methodname> + <methodparam><type>int</type><parameter>icap_stream</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> Closes the given icap stream. </para> @@ -75,16 +69,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>icap_fetch_event</function></funcdef> - <paramdef>int <parameter>stream_id</parameter></paramdef> - <paramdef>int <parameter>event_id</parameter></paramdef> - <paramdef>int - <parameter><optional>options</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>icap_fetch_event</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>int</type><parameter>event_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> <para> <function>icap_fetch_event</function> fetches an event from the calendar stream specified by <parameter>event_id</parameter>. @@ -179,16 +169,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>icap_list_events</function></funcdef> - <paramdef>int <parameter>stream_id</parameter></paramdef> - <paramdef>int <parameter>begin_date</parameter></paramdef> - <paramdef>int - <parameter><optional>end_date</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>icap_list_events</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>int</type><parameter>begin_date</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>end_date</parameter></methodparam> + </methodsynopsis> <para> Returns an array of event ID's that are between the two given datetimes. @@ -244,13 +230,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>icap_store_event</function></funcdef> - <paramdef>int <parameter>stream_id</parameter></paramdef> - <paramdef>object <parameter>event</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>icap_store_event</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>object</type><parameter>event</parameter></methodparam> + </methodsynopsis> <para> <function>icap_store_event</function> Stores an event into an ICAP calendar. An event object consists of: @@ -340,13 +324,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>icap_delete_event</function></funcdef> - <paramdef>int <parameter>stream_id</parameter></paramdef> - <paramdef>int <parameter>uid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>icap_delete_event</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>int</type><parameter>uid</parameter></methodparam> + </methodsynopsis> <para> <function>icap_delete_event</function> deletes the calendar event specified by the <parameter>uid</parameter>. @@ -364,13 +346,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>icap_snooze</function></funcdef> - <paramdef>int <parameter>stream_id</parameter></paramdef> - <paramdef>int <parameter>uid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>icap_snooze</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>int</type><parameter>uid</parameter></methodparam> + </methodsynopsis> <para> <function>icap_snooze</function> turns on an alarm for a calendar event specified by the <parameter>uid</parameter>. @@ -391,14 +371,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>icap_list_alarms</function></funcdef> - <paramdef>int <parameter>stream_id</parameter></paramdef> - <paramdef>array <parameter>date</parameter></paramdef> - <paramdef>array <parameter>time</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>icap_list_alarms</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>array</type><parameter>date</parameter></methodparam> + <methodparam><type>array</type><parameter>time</parameter></methodparam> + </methodsynopsis> <para> Returns an array of event ID's that has an alarm going off at the given datetime. @@ -455,13 +433,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>icap_create_calendar</function></funcdef> - <paramdef>int <parameter>stream_id</parameter></paramdef> - <paramdef>string <parameter>calendar</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>icap_create_calendar</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>string</type><parameter>calendar</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -477,14 +453,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>icap_rename_calendar</function></funcdef> - <paramdef>int <parameter>stream_id</parameter></paramdef> - <paramdef>string <parameter>old_name</parameter></paramdef> - <paramdef>string <parameter>new_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>icap_rename_calendar</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>string</type><parameter>old_name</parameter></methodparam> + <methodparam><type>string</type><parameter>new_name</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -500,13 +474,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>icap_delete_calendar</function></funcdef> - <paramdef>int <parameter>stream_id</parameter></paramdef> - <paramdef>string <parameter>calendar</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>icap_delete_calendar</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>string</type><parameter>calendar</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -522,14 +494,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>icap_reopen</function></funcdef> - <paramdef>int <parameter>stream_id</parameter></paramdef> - <paramdef>string <parameter>calendar</parameter></paramdef> - <paramdef>int <parameter><optional>options</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>icap_reopen</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>string</type><parameter>calendar</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -558,3 +528,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/iconv.xml diff -u phpdoc/en/functions/iconv.xml:1.10 phpdoc/en/functions/iconv.xml:1.11 --- phpdoc/en/functions/iconv.xml:1.10 Wed Dec 12 15:46:52 2001 +++ phpdoc/en/functions/iconv.xml Sat Feb 2 10:35:59 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <reference id="ref.iconv"> <title>iconv functions</title> <titleabbrev>iconv</titleabbrev> @@ -31,14 +31,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>iconv</function></funcdef> - <paramdef>string <parameter>in_charset</parameter></paramdef> - <paramdef>string <parameter>out_charset</parameter></paramdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>iconv</methodname> + <methodparam><type>string</type><parameter>in_charset</parameter></methodparam> + <methodparam><type>string</type><parameter>out_charset</parameter></methodparam> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> It converts the string <parameter>string</parameter> encoded in <parameter>in_charset</parameter> to the string encoded in @@ -67,14 +65,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>iconv_get_encoding</function></funcdef> - <paramdef>string - <parameter><optional>type</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>iconv_get_encoding</methodname> + <methodparam choice="opt"><type>string</type><parameter>type</parameter></methodparam> + </methodsynopsis> <para> It returns the current settings of <function>ob_iconv_handler</function> as array or @@ -97,13 +91,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>iconv_set_encoding</function></funcdef> - <paramdef>string <parameter>type</parameter></paramdef> - <paramdef>string <parameter>charset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>iconv_set_encoding</methodname> + <methodparam><type>string</type><parameter>type</parameter></methodparam> + <methodparam><type>string</type><parameter>charset</parameter></methodparam> + </methodsynopsis> <para> It changes the value of <parameter>type</parameter> to <parameter>charset</parameter> and returns &true; in success or @@ -137,17 +129,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>ob_iconv_handler</function></funcdef> - <paramdef>string - <parameter>contents</parameter> - </paramdef> - <paramdef>int - <parameter>status</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>ob_iconv_handler</methodname> + <methodparam><type>string</type><parameter>contents</parameter></methodparam> + <methodparam><type>int</type><parameter>status</parameter></methodparam> + </methodsynopsis> <para> It converts the string encoded in <parameter>internal_encoding</parameter> to @@ -199,3 +185,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/ifx.xml diff -u phpdoc/en/functions/ifx.xml:1.25 phpdoc/en/functions/ifx.xml:1.26 --- phpdoc/en/functions/ifx.xml:1.25 Thu Jan 17 22:32:23 2002 +++ phpdoc/en/functions/ifx.xml Sat Feb 2 10:35:59 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.25 $ --> +<!-- $Revision: 1.26 $ --> <reference id="ref.ifx"> <title>Informix functions</title> <titleabbrev>Informix</titleabbrev> @@ -171,17 +171,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifx_connect</function></funcdef> - <paramdef>string <parameter><optional>database</optional> - </parameter></paramdef> - <paramdef>string <parameter><optional>userid</optional> - </parameter></paramdef> - <paramdef>string <parameter><optional>password</optional> - </parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifx_connect</methodname> + <methodparam choice="opt"><type>string</type><parameter>database + </parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>userid + </parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password + </parameter></methodparam> + </methodsynopsis> <para> Returns a connection identifier on success, or &false; on error. @@ -229,20 +227,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifx_pconnect</function></funcdef> - <paramdef>string - <parameter><optional>database</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>userid</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>password</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifx_pconnect</methodname> + <methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>userid</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> + </methodsynopsis> <para> Returns: A positive Informix persistent link identifier on success, or &false; on error @@ -281,14 +271,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifx_close</function></funcdef> - <paramdef>int - <parameter><optional>link_identifier</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifx_close</methodname> + <methodparam choice="opt"><type>int</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns: always &true;. </para> @@ -331,23 +317,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifx_query</function></funcdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>int - <parameter><optional>link_identifier</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>cursor_type</optional></parameter> - </paramdef> - <paramdef>mixed - <parameter> - <optional>blobidarray</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifx_query</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>cursor_type</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter> + blobidarray + </parameter></methodparam> + </methodsynopsis> <para> Returns: A positive Informix result identifier on success, or &false; on error. @@ -452,17 +430,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifx_prepare</function></funcdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>int <parameter>conn_id</parameter></paramdef> - <paramdef>int - <parameter><optional>cursor_def</optional></parameter> - </paramdef> - <paramdef>mixed <parameter>blobidarray</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifx_prepare</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam><type>int</type><parameter>conn_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>cursor_def</parameter></methodparam> + <methodparam><type>mixed</type><parameter>blobidarray</parameter></methodparam> + </methodsynopsis> <para> Returns a integer <parameter>result_id</parameter> for use by <function>ifx_do</function>. Sets @@ -515,12 +489,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifx_do</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifx_do</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> Returns &true; on success, &false; on error. </para> @@ -548,12 +520,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ifx_error</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>ifx_error</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> The Informix error codes (SQLSTATE &amp; SQLCODE) formatted as follows : @@ -608,14 +578,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ifx_errormsg</function></funcdef> - <paramdef>int - <parameter><optional>errorcode</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ifx_errormsg</methodname> + <methodparam choice="opt"><type>int</type><parameter>errorcode</parameter></methodparam> + </methodsynopsis> <para> Returns the Informix error message associated with the most recent Informix error, or, when the optional @@ -642,12 +608,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifx_affected_rows</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifx_affected_rows</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> <parameter>result_id</parameter> is a valid result id returned by <function>ifx_query</function> or @@ -702,12 +666,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>ifx_getsqlca</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>ifx_getsqlca</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> <parameter>result_id</parameter> is a valid result id returned by <function>ifx_query</function> or @@ -755,15 +717,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>ifx_fetch_row</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>mixed - <parameter><optional>position</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>ifx_fetch_row</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>position</parameter></methodparam> + </methodsynopsis> <para> Returns an associative array that corresponds to the fetched row, or &false; if there are no more rows. @@ -839,15 +797,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifx_htmltbl_result</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>string - <parameter><optional>html_table_options</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifx_htmltbl_result</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>html_table_options</parameter></methodparam> + </methodsynopsis> <para> Returns the number of rows fetched or &false; on error. </para> @@ -890,12 +844,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>ifx_fieldtypes</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>ifx_fieldtypes</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> Returns an associative array with fieldnames as key and the SQL fieldtypes as data for query with @@ -927,12 +879,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>ifx_fieldproperties</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>ifx_fieldproperties</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> Returns an associative array with fieldnames as key and the SQL fieldproperties as data for a query with @@ -970,12 +920,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifx_num_fields</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifx_num_fields</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> Returns the number of columns in query for <parameter>result_id</parameter> or &false; on error @@ -994,12 +942,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifx_num_rows</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifx_num_rows</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> Gives the number of rows fetched so far for a query with <parameter>result_id</parameter> after a @@ -1016,12 +962,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifx_free_result</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifx_free_result</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> Releases resources for the query associated with <parameter>result_id</parameter>. Returns &false; on error. @@ -1036,12 +980,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifx_create_char</function></funcdef> - <paramdef>string <parameter>param</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifx_create_char</methodname> + <methodparam><type>string</type><parameter>param</parameter></methodparam> + </methodsynopsis> <para> Creates an char object. <parameter>param</parameter> should be the char content. @@ -1056,12 +998,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifx_free_char</function></funcdef> - <paramdef>int <parameter>bid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifx_free_char</methodname> + <methodparam><type>int</type><parameter>bid</parameter></methodparam> + </methodsynopsis> <para> Deletes the charobject for the given char object-id <parameter>bid</parameter>. Returns &false; on error otherwise @@ -1077,13 +1017,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifx_update_char</function></funcdef> - <paramdef>int <parameter>bid</parameter></paramdef> - <paramdef>string <parameter>content</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifx_update_char</methodname> + <methodparam><type>int</type><parameter>bid</parameter></methodparam> + <methodparam><type>string</type><parameter>content</parameter></methodparam> + </methodsynopsis> <para> Updates the content of the char object for the given char object <parameter>bid</parameter>. <parameter>content</parameter> is a @@ -1099,12 +1037,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifx_get_char</function></funcdef> - <paramdef>int <parameter>bid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifx_get_char</methodname> + <methodparam><type>int</type><parameter>bid</parameter></methodparam> + </methodsynopsis> <para> Returns the content of the char object for the given char object-id <parameter>bid</parameter>. @@ -1119,14 +1055,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifx_create_blob</function></funcdef> - <paramdef>int <parameter>type</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - <paramdef>string <parameter>param</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifx_create_blob</methodname> + <methodparam><type>int</type><parameter>type</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + <methodparam><type>string</type><parameter>param</parameter></methodparam> + </methodsynopsis> <para> Creates an blob object. </para> @@ -1154,12 +1088,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifx_copy_blob</function></funcdef> - <paramdef>int <parameter>bid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifx_copy_blob</methodname> + <methodparam><type>int</type><parameter>bid</parameter></methodparam> + </methodsynopsis> <para> Duplicates the given blob object. <parameter>bid</parameter> is the ID of the blob object. @@ -1177,12 +1109,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifx_free_blob</function></funcdef> - <paramdef>int <parameter>bid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifx_free_blob</methodname> + <methodparam><type>int</type><parameter>bid</parameter></methodparam> + </methodsynopsis> <para> Deletes the blobobject for the given blob object-id <parameter>bid</parameter>. Returns &false; on error otherwise @@ -1198,12 +1128,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifx_get_blob</function></funcdef> - <paramdef>int <parameter>bid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifx_get_blob</methodname> + <methodparam><type>int</type><parameter>bid</parameter></methodparam> + </methodsynopsis> <para> Returns the content of the blob object for the given blob object-id <parameter>bid</parameter>. @@ -1218,13 +1146,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef><function>ifx_update_blob</function></funcdef> - <paramdef>int <parameter>bid</parameter></paramdef> - <paramdef>string <parameter>content</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <methodname>ifx_update_blob</methodname> + <methodparam><type>int</type><parameter>bid</parameter></methodparam> + <methodparam><type>string</type><parameter>content</parameter></methodparam> + </methodsynopsis> <para> Updates the content of the blob object for the given blob object <parameter>bid</parameter>. <parameter>content</parameter> is a @@ -1240,12 +1166,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>ifx_blobinfile_mode</function></funcdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>ifx_blobinfile_mode</methodname> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> Set the default blob mode for all select queries. Mode "0" means save Byte-Blobs in memory, and mode "1" means save Byte-Blobs in @@ -1261,12 +1185,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>ifx_textasvarchar</function></funcdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>ifx_textasvarchar</methodname> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> Sets the default text mode for all select-queries. Mode "0" will return a blob id, and mode "1" will return a varchar with text @@ -1282,12 +1204,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>ifx_byteasvarchar</function></funcdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>ifx_byteasvarchar</methodname> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> Sets the default byte mode for all select-queries. Mode "0" will return a blob id, and mode "1" will return a varchar with text @@ -1305,12 +1225,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>ifx_nullformat</function></funcdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>ifx_nullformat</methodname> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> Sets the default return value of a NULL-value on a fetch row. Mode "0" returns "", and mode "1" returns "&null;". @@ -1325,12 +1243,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifxus_create_slob</function></funcdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifxus_create_slob</methodname> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> Creates an slob object and opens it. Modes: 1 = LO_RDONLY, 2 = LO_WRONLY, 4 = LO_APPEND, 8 = LO_RDWR, 16 = LO_BUFFER, 32 = @@ -1348,12 +1264,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifxus_free_slob</function></funcdef> - <paramdef>int <parameter>bid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifxus_free_slob</methodname> + <methodparam><type>int</type><parameter>bid</parameter></methodparam> + </methodsynopsis> <para> Deletes the slob object. <parameter>bid</parameter> is the Id of the slob object. Returns &false; on error otherwise &true;. @@ -1368,12 +1282,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifxus_close_slob</function></funcdef> - <paramdef>int <parameter>bid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifxus_close_slob</methodname> + <methodparam><type>int</type><parameter>bid</parameter></methodparam> + </methodsynopsis> <para> Deletes the slob object on the given slob object-id <parameter>bid</parameter>. Return &false; on error otherwise @@ -1389,13 +1301,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifxus_open_slob</function></funcdef> - <paramdef>long <parameter>bid</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifxus_open_slob</methodname> + <methodparam><type>long</type><parameter>bid</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> Opens an slob object. <parameter>bid</parameter> should be an existing slob id. Modes: 1 = LO_RDONLY, 2 = LO_WRONLY, 4 = @@ -1413,12 +1323,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifxus_tell_slob</function></funcdef> - <paramdef>long <parameter>bid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifxus_tell_slob</methodname> + <methodparam><type>long</type><parameter>bid</parameter></methodparam> + </methodsynopsis> <para> Returns the current file or seek position of an open slob object <parameter>bid</parameter> should be an existing slob id. Return @@ -1434,14 +1342,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifxus_seek_slob</function></funcdef> - <paramdef>long <parameter>bid</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - <paramdef>long <parameter>offset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifxus_seek_slob</methodname> + <methodparam><type>long</type><parameter>bid</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + <methodparam><type>long</type><parameter>offset</parameter></methodparam> + </methodsynopsis> <para> Sets the current file or seek position of an open slob object. <parameter>bid</parameter> should be an existing slob id. Modes: @@ -1459,13 +1365,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifxus_read_slob</function></funcdef> - <paramdef>long <parameter>bid</parameter></paramdef> - <paramdef>long <parameter>nbytes</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifxus_read_slob</methodname> + <methodparam><type>long</type><parameter>bid</parameter></methodparam> + <methodparam><type>long</type><parameter>nbytes</parameter></methodparam> + </methodsynopsis> <para> Reads nbytes of the slob object. <parameter>bid</parameter> is a existing slob id and <parameter>nbytes</parameter> is the number @@ -1481,13 +1385,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ifxus_write_slob</function></funcdef> - <paramdef>long <parameter>bid</parameter></paramdef> - <paramdef>string <parameter>content</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ifxus_write_slob</methodname> + <methodparam><type>long</type><parameter>bid</parameter></methodparam> + <methodparam><type>string</type><parameter>content</parameter></methodparam> + </methodsynopsis> <para> Writes a string into the slob object. <parameter>bid</parameter> is a existing slob id and <parameter>content</parameter> the @@ -1518,3 +1420,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/iisfunc.xml diff -u phpdoc/en/functions/iisfunc.xml:1.5 phpdoc/en/functions/iisfunc.xml:1.6 --- phpdoc/en/functions/iisfunc.xml:1.5 Sun Jan 13 23:04:12 2002 +++ phpdoc/en/functions/iisfunc.xml Sat Feb 2 10:36:00 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <reference id="ref.iisfunc"> <title>IIS Administration functions</title> <titleabbrev>IIS Functions</titleabbrev> @@ -21,12 +21,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>iis_get_server_by_path</function></funcdef> - <paramdef>string <parameter>path</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>iis_get_server_by_path</methodname> + <methodparam><type>string</type><parameter>path</parameter></methodparam> + </methodsynopsis> <para> Each vertual server in IIS is associated with an instance number. <function>iis_get_server_by_path</function> Finds the instance number @@ -42,12 +40,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>iis_get_server_by_comment</function></funcdef> - <paramdef>string <parameter>comment</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>iis_get_server_by_comment</methodname> + <methodparam><type>string</type><parameter>comment</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -60,18 +56,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>iis_add_server</function></funcdef> - <paramdef>string <parameter>path</parameter></paramdef> - <paramdef>string <parameter>comment</parameter></paramdef> - <paramdef>string <parameter>server_ip</parameter></paramdef> - <paramdef>int <parameter>port</parameter></paramdef> - <paramdef>string <parameter>host_name</parameter></paramdef> - <paramdef>int <parameter>rights</parameter></paramdef> - <paramdef>int <parameter>start_server</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>iis_add_server</methodname> + <methodparam><type>string</type><parameter>path</parameter></methodparam> + <methodparam><type>string</type><parameter>comment</parameter></methodparam> + <methodparam><type>string</type><parameter>server_ip</parameter></methodparam> + <methodparam><type>int</type><parameter>port</parameter></methodparam> + <methodparam><type>string</type><parameter>host_name</parameter></methodparam> + <methodparam><type>int</type><parameter>rights</parameter></methodparam> + <methodparam><type>int</type><parameter>start_server</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -84,12 +78,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>iis_remove_server</function></funcdef> - <paramdef>int <parameter>server_instance</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>iis_remove_server</methodname> + <methodparam><type>int</type><parameter>server_instance</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -102,14 +94,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>iis_set_dir_security</function></funcdef> - <paramdef>int <parameter>server_instance</parameter></paramdef> - <paramdef>string <parameter>virtual_path</parameter></paramdef> - <paramdef>int <parameter>directory_flags</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>iis_set_dir_security</methodname> + <methodparam><type>int</type><parameter>server_instance</parameter></methodparam> + <methodparam><type>string</type><parameter>virtual_path</parameter></methodparam> + <methodparam><type>int</type><parameter>directory_flags</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -122,13 +112,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>iis_get_dir_security</function></funcdef> - <paramdef>int <parameter>server_instance</parameter></paramdef> - <paramdef>string <parameter>virtual_path</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>iis_get_dir_security</methodname> + <methodparam><type>int</type><parameter>server_instance</parameter></methodparam> + <methodparam><type>string</type><parameter>virtual_path</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -141,14 +129,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>iis_set_server_rights</function></funcdef> - <paramdef>int <parameter>server_instance</parameter></paramdef> - <paramdef>string <parameter>virtual_path</parameter></paramdef> - <paramdef>int <parameter>directory_flags</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>iis_set_server_rights</methodname> + <methodparam><type>int</type><parameter>server_instance</parameter></methodparam> + <methodparam><type>string</type><parameter>virtual_path</parameter></methodparam> + <methodparam><type>int</type><parameter>directory_flags</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -161,13 +147,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>iis_get_server_rights</function></funcdef> - <paramdef>int <parameter>server_instance</parameter></paramdef> - <paramdef>string <parameter>virtual_path</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>iis_get_server_rights</methodname> + <methodparam><type>int</type><parameter>server_instance</parameter></methodparam> + <methodparam><type>string</type><parameter>virtual_path</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -180,16 +164,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>iis_set_script_map</function></funcdef> - <paramdef>int <parameter>server_instance</parameter></paramdef> - <paramdef>string <parameter>virtual_path</parameter></paramdef> - <paramdef>string <parameter>script_extension</parameter></paramdef> - <paramdef>string <parameter>engine_path</parameter></paramdef> - <paramdef>int <parameter>allow_scripting</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>iis_set_script_map</methodname> + <methodparam><type>int</type><parameter>server_instance</parameter></methodparam> + <methodparam><type>string</type><parameter>virtual_path</parameter></methodparam> + <methodparam><type>string</type><parameter>script_extension</parameter></methodparam> + <methodparam><type>string</type><parameter>engine_path</parameter></methodparam> + <methodparam><type>int</type><parameter>allow_scripting</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -202,14 +184,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>iis_get_script_map</function></funcdef> - <paramdef>int <parameter>server_instance</parameter></paramdef> - <paramdef>string <parameter>virtual_path</parameter></paramdef> - <paramdef>string <parameter>script_extension</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>iis_get_script_map</methodname> + <methodparam><type>int</type><parameter>server_instance</parameter></methodparam> + <methodparam><type>string</type><parameter>virtual_path</parameter></methodparam> + <methodparam><type>string</type><parameter>script_extension</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -222,14 +202,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>iis_set_app_settings</function></funcdef> - <paramdef>int <parameter>server_instance</parameter></paramdef> - <paramdef>string <parameter>virtual_path</parameter></paramdef> - <paramdef>string <parameter>application_scope</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>iis_set_app_settings</methodname> + <methodparam><type>int</type><parameter>server_instance</parameter></methodparam> + <methodparam><type>string</type><parameter>virtual_path</parameter></methodparam> + <methodparam><type>string</type><parameter>application_scope</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -242,12 +220,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>iis_start_server</function></funcdef> - <paramdef>int <parameter>server_instance</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>iis_start_server</methodname> + <methodparam><type>int</type><parameter>server_instance</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -260,12 +236,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>iis_stop_server</function></funcdef> - <paramdef>int <parameter>server_instance</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>iis_stop_server</methodname> + <methodparam><type>int</type><parameter>server_instance</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -278,12 +252,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>iis_stop_service</function></funcdef> - <paramdef>string <parameter>service_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>iis_stop_service</methodname> + <methodparam><type>string</type><parameter>service_id</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -296,12 +268,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>iis_start_service</function></funcdef> - <paramdef>string <parameter>service_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>iis_start_service</methodname> + <methodparam><type>string</type><parameter>service_id</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -314,12 +284,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>iis_get_service_state</function></funcdef> - <paramdef>string <parameter>service_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>iis_get_service_state</methodname> + <methodparam><type>string</type><parameter>service_id</parameter></methodparam> + </methodsynopsis> <para> </para> </refsect1> @@ -344,3 +312,4 @@ sgml-local-ecat-files:nil End: --> + Index: phpdoc/en/functions/image.xml diff -u phpdoc/en/functions/image.xml:1.74 phpdoc/en/functions/image.xml:1.75 --- phpdoc/en/functions/image.xml:1.74 Tue Jan 1 20:13:10 2002 +++ phpdoc/en/functions/image.xml Sat Feb 2 10:36:00 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.74 $ --> +<!-- $Revision: 1.75 $ --> <reference id="ref.image"> <title>Image functions</title> <titleabbrev>Image</titleabbrev> @@ -41,15 +41,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>getimagesize</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>array - <parameter><optional>imageinfo</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>getimagesize</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>imageinfo</parameter></methodparam> + </methodsynopsis> <para> The <function>GetImageSize</function> function will determine the size of any <acronym>GIF</acronym>, <acronym>JPG</acronym>, @@ -143,18 +139,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>image2WBMP</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>string - <parameter><optional>filename</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>threshold</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>image2WBMP</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>threshold</parameter></methodparam> + </methodsynopsis> <para> <function>Image2WBMP</function> creates the <acronym>WBMP</acronym> file in filename from the image @@ -187,13 +177,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagealphablending</function></funcdef> - <paramdef>resource <parameter>im</parameter></paramdef> - <paramdef>bool <parameter>blendmode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagealphablending</methodname> + <methodparam><type>resource</type><parameter>im</parameter></methodparam> + <methodparam><type>bool</type><parameter>blendmode</parameter></methodparam> + </methodsynopsis> <para> <function>ImageAlphaBlending</function> allows for two different modes of drawing on truecolor images. In blending mode, the @@ -220,19 +208,17 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagearc</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>cx</parameter></paramdef> - <paramdef>int <parameter>cy</parameter></paramdef> - <paramdef>int <parameter>w</parameter></paramdef> - <paramdef>int <parameter>h</parameter></paramdef> - <paramdef>int <parameter>s</parameter></paramdef> - <paramdef>int <parameter>e</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagearc</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>cx</parameter></methodparam> + <methodparam><type>int</type><parameter>cy</parameter></methodparam> + <methodparam><type>int</type><parameter>w</parameter></methodparam> + <methodparam><type>int</type><parameter>h</parameter></methodparam> + <methodparam><type>int</type><parameter>s</parameter></methodparam> + <methodparam><type>int</type><parameter>e</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <para> <function>ImageArc</function> draws a partial ellipse centered at <parameter>cx</parameter>, <parameter>cy</parameter> (top left is @@ -259,20 +245,18 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagefilledarc</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>cx</parameter></paramdef> - <paramdef>int <parameter>cy</parameter></paramdef> - <paramdef>int <parameter>w</parameter></paramdef> - <paramdef>int <parameter>h</parameter></paramdef> - <paramdef>int <parameter>s</parameter></paramdef> - <paramdef>int <parameter>e</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - <paramdef>int <parameter>style</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagefilledarc</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>cx</parameter></methodparam> + <methodparam><type>int</type><parameter>cy</parameter></methodparam> + <methodparam><type>int</type><parameter>w</parameter></methodparam> + <methodparam><type>int</type><parameter>h</parameter></methodparam> + <methodparam><type>int</type><parameter>s</parameter></methodparam> + <methodparam><type>int</type><parameter>e</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + <methodparam><type>int</type><parameter>style</parameter></methodparam> + </methodsynopsis> <para> <function>ImageFilledArc</function> draws a partial ellipse centered at <parameter>cx</parameter>, <parameter>cy</parameter> (top left is @@ -310,17 +294,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imageellipse</function></funcdef> - <paramdef>resource <parameter>im</parameter></paramdef> - <paramdef>int <parameter>cx</parameter></paramdef> - <paramdef>int <parameter>cy</parameter></paramdef> - <paramdef>int <parameter>w</parameter></paramdef> - <paramdef>int <parameter>h</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imageellipse</methodname> + <methodparam><type>resource</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>cx</parameter></methodparam> + <methodparam><type>int</type><parameter>cy</parameter></methodparam> + <methodparam><type>int</type><parameter>w</parameter></methodparam> + <methodparam><type>int</type><parameter>h</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <para> <function>ImageEllipse</function> draws an ellipse centered at <parameter>cx</parameter>, <parameter>cy</parameter> (top left is @@ -344,17 +326,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagefilledellipse</function></funcdef> - <paramdef>resource <parameter>im</parameter></paramdef> - <paramdef>int <parameter>cx</parameter></paramdef> - <paramdef>int <parameter>cy</parameter></paramdef> - <paramdef>int <parameter>w</parameter></paramdef> - <paramdef>int <parameter>h</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagefilledellipse</methodname> + <methodparam><type>resource</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>cx</parameter></methodparam> + <methodparam><type>int</type><parameter>cy</parameter></methodparam> + <methodparam><type>int</type><parameter>w</parameter></methodparam> + <methodparam><type>int</type><parameter>h</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <para> <function>ImageFilledEllipse</function> draws an ellipse centered at <parameter>cx</parameter>, <parameter>cy</parameter> (top left is @@ -377,17 +357,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagechar</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>font</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>string <parameter>c</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagechar</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>font</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>string</type><parameter>c</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <para> <function>ImageChar</function> draws the first character of <parameter>c</parameter> in the image identified by @@ -410,17 +388,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecharup</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>font</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>string <parameter>c</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecharup</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>font</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>string</type><parameter>c</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <para> <function>ImageCharUp</function> draws the character <parameter>c</parameter> vertically in the image identified by @@ -443,15 +419,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecolorallocate</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>red</parameter></paramdef> - <paramdef>int <parameter>green</parameter></paramdef> - <paramdef>int <parameter>blue</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecolorallocate</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>red</parameter></methodparam> + <methodparam><type>int</type><parameter>green</parameter></methodparam> + <methodparam><type>int</type><parameter>blue</parameter></methodparam> + </methodsynopsis> <para> <function>ImageColorAllocate</function> returns a color identifier representing the color composed of the given @@ -487,19 +461,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>imagecolordeallocate</function> - </funcdef> - <paramdef>int - <parameter>im</parameter> - </paramdef> - <paramdef>int - <parameter>index</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecolordeallocate</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>index</parameter></methodparam> + </methodsynopsis> <para> The <function>ImageColorDeAllocate</function> function de-allocates a color previously allocated with the @@ -523,14 +489,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecolorat</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecolorat</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + </methodsynopsis> <para> Returns the index of the color of the pixel at the specified location in the image. @@ -551,15 +515,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecolorclosest</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>red</parameter></paramdef> - <paramdef>int <parameter>green</parameter></paramdef> - <paramdef>int <parameter>blue</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecolorclosest</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>red</parameter></methodparam> + <methodparam><type>int</type><parameter>green</parameter></methodparam> + <methodparam><type>int</type><parameter>blue</parameter></methodparam> + </methodsynopsis> <para> Returns the index of the color in the palette of the image which is "closest" to the specified <acronym>RGB</acronym> value. @@ -584,16 +546,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecolorclosestalpha</function></funcdef> - <paramdef>resource <parameter>im</parameter></paramdef> - <paramdef>int <parameter>red</parameter></paramdef> - <paramdef>int <parameter>green</parameter></paramdef> - <paramdef>int <parameter>blue</parameter></paramdef> - <paramdef>int <parameter>alpha</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecolorclosestalpha</methodname> + <methodparam><type>resource</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>red</parameter></methodparam> + <methodparam><type>int</type><parameter>green</parameter></methodparam> + <methodparam><type>int</type><parameter>blue</parameter></methodparam> + <methodparam><type>int</type><parameter>alpha</parameter></methodparam> + </methodsynopsis> <para> Returns the index of the color in the palette of the image which is "closest" to the specified <acronym>RGB</acronym> value and <parameter>alpha</parameter> level. @@ -614,15 +574,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecolorclosesthwb</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>red</parameter></paramdef> - <paramdef>int <parameter>green</parameter></paramdef> - <paramdef>int <parameter>blue</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecolorclosesthwb</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>red</parameter></methodparam> + <methodparam><type>int</type><parameter>green</parameter></methodparam> + <methodparam><type>int</type><parameter>blue</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -636,15 +594,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecolorexact</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>red</parameter></paramdef> - <paramdef>int <parameter>green</parameter></paramdef> - <paramdef>int <parameter>blue</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecolorexact</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>red</parameter></methodparam> + <methodparam><type>int</type><parameter>green</parameter></methodparam> + <methodparam><type>int</type><parameter>blue</parameter></methodparam> + </methodsynopsis> <para> Returns the index of the specified color in the palette of the image. @@ -666,16 +622,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecolorexactalpha</function></funcdef> - <paramdef>resource <parameter>im</parameter></paramdef> - <paramdef>int <parameter>red</parameter></paramdef> - <paramdef>int <parameter>green</parameter></paramdef> - <paramdef>int <parameter>blue</parameter></paramdef> - <paramdef>int <parameter>alpha</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecolorexactalpha</methodname> + <methodparam><type>resource</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>red</parameter></methodparam> + <methodparam><type>int</type><parameter>green</parameter></methodparam> + <methodparam><type>int</type><parameter>blue</parameter></methodparam> + <methodparam><type>int</type><parameter>alpha</parameter></methodparam> + </methodsynopsis> <para> Returns the index of the specified color+alpha in the palette of the image. @@ -702,15 +656,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecolorresolve</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>red</parameter></paramdef> - <paramdef>int <parameter>green</parameter></paramdef> - <paramdef>int <parameter>blue</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecolorresolve</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>red</parameter></methodparam> + <methodparam><type>int</type><parameter>green</parameter></methodparam> + <methodparam><type>int</type><parameter>blue</parameter></methodparam> + </methodsynopsis> <para> This function is guaranteed to return a color index for a requested color, either the exact color or the closest possible @@ -732,16 +684,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecolorresolvealpha</function></funcdef> - <paramdef>resource <parameter>im</parameter></paramdef> - <paramdef>int <parameter>red</parameter></paramdef> - <paramdef>int <parameter>green</parameter></paramdef> - <paramdef>int <parameter>blue</parameter></paramdef> - <paramdef>int <parameter>alpha</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecolorresolvealpha</methodname> + <methodparam><type>resource</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>red</parameter></methodparam> + <methodparam><type>int</type><parameter>green</parameter></methodparam> + <methodparam><type>int</type><parameter>blue</parameter></methodparam> + <methodparam><type>int</type><parameter>alpha</parameter></methodparam> + </methodsynopsis> <para> This function is guaranteed to return a color index for a requested color, either the exact color or the closest possible @@ -765,22 +715,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>imagegammacorrect</function> - </funcdef> - <paramdef>int - <parameter>im</parameter> - </paramdef> - <paramdef>float - <parameter>inputgamma</parameter> - </paramdef> - <paramdef>float - <parameter>outputgamma</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagegammacorrect</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>float</type><parameter>inputgamma</parameter></methodparam> + <methodparam><type>float</type><parameter>outputgamma</parameter></methodparam> + </methodsynopsis> <para> The <function>ImageGammaCorrect</function> function applies gamma correction to a gd image stream (<parameter>im</parameter>) given @@ -800,16 +740,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>imagecolorset</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>index</parameter></paramdef> - <paramdef>int <parameter>red</parameter></paramdef> - <paramdef>int <parameter>green</parameter></paramdef> - <paramdef>int <parameter>blue</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>imagecolorset</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>index</parameter></methodparam> + <methodparam><type>int</type><parameter>red</parameter></methodparam> + <methodparam><type>int</type><parameter>green</parameter></methodparam> + <methodparam><type>int</type><parameter>blue</parameter></methodparam> + </methodsynopsis> <para> This sets the specified index in the palette to the specified color. This is useful for creating flood-fill-like effects in @@ -829,13 +767,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>imagecolorsforindex</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>index</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>imagecolorsforindex</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>index</parameter></methodparam> + </methodsynopsis> <para> This returns an associative array with red, green, and blue keys that contain the appropriate values for the specified color @@ -857,12 +793,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecolorstotal</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecolorstotal</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + </methodsynopsis> <para> This returns the number of colors in the specified image's palette. @@ -881,15 +815,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecolortransparent</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int - <parameter><optional>col</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecolortransparent</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <para> <function>ImageColorTransparent</function> sets the transparent color in the <parameter>im</parameter> image to @@ -922,37 +852,17 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>ImageCopy</function> - </funcdef> - <paramdef>resource - <parameter>dst_im</parameter> - </paramdef> - <paramdef>resource - <parameter>src_im</parameter> - </paramdef> - <paramdef>int - <parameter>dst_x</parameter> - </paramdef> - <paramdef>int - <parameter>dst_y</parameter> - </paramdef> - <paramdef>int - <parameter>src_x</parameter> - </paramdef> - <paramdef>int - <parameter>src_y</parameter> - </paramdef> - <paramdef>int - <parameter>src_w</parameter> - </paramdef> - <paramdef>int - <parameter>src_h</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ImageCopy</methodname> + <methodparam><type>resource</type><parameter>dst_im</parameter></methodparam> + <methodparam><type>resource</type><parameter>src_im</parameter></methodparam> + <methodparam><type>int</type><parameter>dst_x</parameter></methodparam> + <methodparam><type>int</type><parameter>dst_y</parameter></methodparam> + <methodparam><type>int</type><parameter>src_x</parameter></methodparam> + <methodparam><type>int</type><parameter>src_y</parameter></methodparam> + <methodparam><type>int</type><parameter>src_w</parameter></methodparam> + <methodparam><type>int</type><parameter>src_h</parameter></methodparam> + </methodsynopsis> <para> Copy a part of <parameter>src_im</parameter> onto <parameter>dst_im</parameter> starting at the x,y coordinates @@ -974,20 +884,18 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ImageCopyMerge</function> </funcdef> - <paramdef>resource <parameter>dst_im</parameter> </paramdef> - <paramdef>resource <parameter>src_im</parameter> </paramdef> - <paramdef>int <parameter>dst_x</parameter> </paramdef> - <paramdef>int <parameter>dst_y</parameter> </paramdef> - <paramdef>int <parameter>src_x</parameter> </paramdef> - <paramdef>int <parameter>src_y</parameter> </paramdef> - <paramdef>int <parameter>src_w</parameter> </paramdef> - <paramdef>int <parameter>src_h</parameter> </paramdef> - <paramdef>int <parameter>pct</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ImageCopyMerge</methodname> + <methodparam><type>resource</type><parameter>dst_im</parameter></methodparam> + <methodparam><type>resource</type><parameter>src_im</parameter></methodparam> + <methodparam><type>int</type><parameter>dst_x</parameter></methodparam> + <methodparam><type>int</type><parameter>dst_y</parameter></methodparam> + <methodparam><type>int</type><parameter>src_x</parameter></methodparam> + <methodparam><type>int</type><parameter>src_y</parameter></methodparam> + <methodparam><type>int</type><parameter>src_w</parameter></methodparam> + <methodparam><type>int</type><parameter>src_h</parameter></methodparam> + <methodparam><type>int</type><parameter>pct</parameter></methodparam> + </methodsynopsis> <para> Copy a part of <parameter>src_im</parameter> onto <parameter>dst_im</parameter> starting at the x,y coordinates @@ -1014,20 +922,18 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ImageCopyMergeGray</function> </funcdef> - <paramdef>resource <parameter>dst_im</parameter> </paramdef> - <paramdef>resource <parameter>src_im</parameter> </paramdef> - <paramdef>int <parameter>dst_x</parameter> </paramdef> - <paramdef>int <parameter>dst_y</parameter> </paramdef> - <paramdef>int <parameter>src_x</parameter> </paramdef> - <paramdef>int <parameter>src_y</parameter> </paramdef> - <paramdef>int <parameter>src_w</parameter> </paramdef> - <paramdef>int <parameter>src_h</parameter> </paramdef> - <paramdef>int <parameter>pct</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ImageCopyMergeGray</methodname> + <methodparam><type>resource</type><parameter>dst_im</parameter></methodparam> + <methodparam><type>resource</type><parameter>src_im</parameter></methodparam> + <methodparam><type>int</type><parameter>dst_x</parameter></methodparam> + <methodparam><type>int</type><parameter>dst_y</parameter></methodparam> + <methodparam><type>int</type><parameter>src_x</parameter></methodparam> + <methodparam><type>int</type><parameter>src_y</parameter></methodparam> + <methodparam><type>int</type><parameter>src_w</parameter></methodparam> + <methodparam><type>int</type><parameter>src_h</parameter></methodparam> + <methodparam><type>int</type><parameter>pct</parameter></methodparam> + </methodsynopsis> <para> <function>ImageCopyMergeGray</function> copy a part of <parameter>src_im</parameter> onto <parameter>dst_im</parameter> starting at the x,y coordinates @@ -1057,21 +963,19 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecopyresized</function></funcdef> - <paramdef>resource <parameter>dst_im</parameter></paramdef> - <paramdef>resource <parameter>src_im</parameter></paramdef> - <paramdef>int <parameter>dstX</parameter></paramdef> - <paramdef>int <parameter>dstY</parameter></paramdef> - <paramdef>int <parameter>srcX</parameter></paramdef> - <paramdef>int <parameter>srcY</parameter></paramdef> - <paramdef>int <parameter>dstW</parameter></paramdef> - <paramdef>int <parameter>dstH</parameter></paramdef> - <paramdef>int <parameter>srcW</parameter></paramdef> - <paramdef>int <parameter>srcH</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecopyresized</methodname> + <methodparam><type>resource</type><parameter>dst_im</parameter></methodparam> + <methodparam><type>resource</type><parameter>src_im</parameter></methodparam> + <methodparam><type>int</type><parameter>dstX</parameter></methodparam> + <methodparam><type>int</type><parameter>dstY</parameter></methodparam> + <methodparam><type>int</type><parameter>srcX</parameter></methodparam> + <methodparam><type>int</type><parameter>srcY</parameter></methodparam> + <methodparam><type>int</type><parameter>dstW</parameter></methodparam> + <methodparam><type>int</type><parameter>dstH</parameter></methodparam> + <methodparam><type>int</type><parameter>srcW</parameter></methodparam> + <methodparam><type>int</type><parameter>srcH</parameter></methodparam> + </methodsynopsis> <para> <function>ImageCopyResized</function> copies a rectangular portion of one image to another image. @@ -1098,21 +1002,19 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecopyresampled</function></funcdef> - <paramdef>resource <parameter>dst_im</parameter></paramdef> - <paramdef>resource <parameter>src_im</parameter></paramdef> - <paramdef>int <parameter>dstX</parameter></paramdef> - <paramdef>int <parameter>dstY</parameter></paramdef> - <paramdef>int <parameter>srcX</parameter></paramdef> - <paramdef>int <parameter>srcY</parameter></paramdef> - <paramdef>int <parameter>dstW</parameter></paramdef> - <paramdef>int <parameter>dstH</parameter></paramdef> - <paramdef>int <parameter>srcW</parameter></paramdef> - <paramdef>int <parameter>srcH</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecopyresampled</methodname> + <methodparam><type>resource</type><parameter>dst_im</parameter></methodparam> + <methodparam><type>resource</type><parameter>src_im</parameter></methodparam> + <methodparam><type>int</type><parameter>dstX</parameter></methodparam> + <methodparam><type>int</type><parameter>dstY</parameter></methodparam> + <methodparam><type>int</type><parameter>srcX</parameter></methodparam> + <methodparam><type>int</type><parameter>srcY</parameter></methodparam> + <methodparam><type>int</type><parameter>dstW</parameter></methodparam> + <methodparam><type>int</type><parameter>dstH</parameter></methodparam> + <methodparam><type>int</type><parameter>srcW</parameter></methodparam> + <methodparam><type>int</type><parameter>srcH</parameter></methodparam> + </methodsynopsis> <para> <function>ImageCopyResampled</function> copies a rectangular portion of one image to another image, smoothly interpolating pixel @@ -1142,13 +1044,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecreate</function></funcdef> - <paramdef>int <parameter>x_size</parameter></paramdef> - <paramdef>int <parameter>y_size</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecreate</methodname> + <methodparam><type>int</type><parameter>x_size</parameter></methodparam> + <methodparam><type>int</type><parameter>y_size</parameter></methodparam> + </methodsynopsis> <para> <function>ImageCreate</function> returns an image identifier representing a blank image of size <parameter>x_size</parameter> @@ -1182,13 +1082,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>imagecreatetruecolor</function></funcdef> - <paramdef>int <parameter>x_size</parameter></paramdef> - <paramdef>int <parameter>y_size</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>imagecreatetruecolor</methodname> + <methodparam><type>int</type><parameter>x_size</parameter></methodparam> + <methodparam><type>int</type><parameter>y_size</parameter></methodparam> + </methodsynopsis> <para> <function>ImageCreateTrueColor</function> returns an image identifier representing a black image of size <parameter>x_size</parameter> @@ -1204,14 +1102,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>imagetruecolortopalette</function></funcdef> - <paramdef>resource <parameter>im</parameter></paramdef> - <paramdef>bool <parameter>dither</parameter></paramdef> - <paramdef>int <parameter>ncolors</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>imagetruecolortopalette</methodname> + <methodparam><type>resource</type><parameter>im</parameter></methodparam> + <methodparam><type>bool</type><parameter>dither</parameter></methodparam> + <methodparam><type>int</type><parameter>ncolors</parameter></methodparam> + </methodsynopsis> <para> <function>ImageTrueColorToPalette</function> converts a truecolor image to a palette image. The code for this function was originally drawn from @@ -1248,12 +1144,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecreatefromgd</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecreatefromgd</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1269,12 +1163,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecreatefromgd2</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecreatefromgd2</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1290,16 +1182,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecreatefromgd2part</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>int <parameter>srcX</parameter></paramdef> - <paramdef>int <parameter>srcY</parameter></paramdef> - <paramdef>int <parameter>width</parameter></paramdef> - <paramdef>int <parameter>height</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecreatefromgd2part</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>int</type><parameter>srcX</parameter></methodparam> + <methodparam><type>int</type><parameter>srcY</parameter></methodparam> + <methodparam><type>int</type><parameter>width</parameter></methodparam> + <methodparam><type>int</type><parameter>height</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1313,12 +1203,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecreatefromgif</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecreatefromgif</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> <function>ImageCreateFromGif</function> returns an image identifier representing the image obtained from the given filename. @@ -1368,12 +1256,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecreatefromjpeg</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecreatefromjpeg</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> <function>ImageCreateFromJPEG</function> returns an image identifier representing the image obtained from the given filename. @@ -1416,12 +1302,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecreatefrompng</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecreatefrompng</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> <function>ImageCreateFromPNG</function> returns an image identifier representing the image obtained from the given filename. @@ -1464,12 +1348,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecreatefromwbmp</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecreatefromwbmp</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> <function>ImageCreateFromWBMP</function> returns an image identifier representing the image obtained from the given filename. @@ -1518,12 +1400,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecreatefromstring</function></funcdef> - <paramdef>string <parameter>image</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecreatefromstring</methodname> + <methodparam><type>string</type><parameter>image</parameter></methodparam> + </methodsynopsis> <para> <function>ImageCreateFromString</function> returns an image identifier representing the image obtained from the given string. @@ -1538,12 +1418,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecreatefromxbm</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecreatefromxbm</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> <function>ImageCreateFromXBM</function> returns an image identifier representing the image obtained from the given filename. @@ -1558,12 +1436,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagecreatefromxpm</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagecreatefromxpm</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> <function>ImageCreateFromXPM</function> returns an image identifier representing the image obtained from the given filename. @@ -1578,17 +1454,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagedashedline</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>x1</parameter></paramdef> - <paramdef>int <parameter>y1</parameter></paramdef> - <paramdef>int <parameter>x2</parameter></paramdef> - <paramdef>int <parameter>y2</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagedashedline</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>x1</parameter></methodparam> + <methodparam><type>int</type><parameter>y1</parameter></methodparam> + <methodparam><type>int</type><parameter>x2</parameter></methodparam> + <methodparam><type>int</type><parameter>y2</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <para> This function is deprecated. Use combination of <function>ImageSetStyle</function> and <function>ImageLine</function> @@ -1604,12 +1478,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagedestroy</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagedestroy</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + </methodsynopsis> <para> <function>ImageDestroy</function> frees any memory associated with image <parameter>im</parameter>. <parameter>Im</parameter> @@ -1626,15 +1498,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagefill</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagefill</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <para> <function>ImageFill</function> performs a flood fill starting at coordinate <parameter>x</parameter>, <parameter>y</parameter> @@ -1651,15 +1521,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagefilledpolygon</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>array <parameter>points</parameter></paramdef> - <paramdef>int <parameter>num_points</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagefilledpolygon</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>array</type><parameter>points</parameter></methodparam> + <methodparam><type>int</type><parameter>num_points</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <para> <function>ImageFilledPolygon</function> creates a filled polygon in image <parameter>im</parameter>. @@ -1678,17 +1546,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagefilledrectangle</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>x1</parameter></paramdef> - <paramdef>int <parameter>y1</parameter></paramdef> - <paramdef>int <parameter>x2</parameter></paramdef> - <paramdef>int <parameter>y2</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagefilledrectangle</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>x1</parameter></methodparam> + <methodparam><type>int</type><parameter>y1</parameter></methodparam> + <methodparam><type>int</type><parameter>x2</parameter></methodparam> + <methodparam><type>int</type><parameter>y2</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <para> <function>ImageFilledRectangle</function> creates a filled rectangle of color <parameter>col</parameter> in image @@ -1708,16 +1574,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagefilltoborder</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>int <parameter>border</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagefilltoborder</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>int</type><parameter>border</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <para> <function>ImageFillToBorder</function> performs a flood fill whose border color is defined by <parameter>border</parameter>. @@ -1735,12 +1599,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagefontheight</function></funcdef> - <paramdef>int <parameter>font</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagefontheight</methodname> + <methodparam><type>int</type><parameter>font</parameter></methodparam> + </methodsynopsis> <para> Returns the pixel height of a character in the specified font. </para> @@ -1758,12 +1620,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagefontwidth</function></funcdef> - <paramdef>int <parameter>font</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagefontwidth</methodname> + <methodparam><type>int</type><parameter>font</parameter></methodparam> + </methodsynopsis> <para> Returns the pixel width of a character in font. </para> @@ -1783,13 +1643,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagegd</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>string <parameter><optional>filename</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagegd</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1805,13 +1663,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagegd2</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>string <parameter><optional>filename</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagegd2</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1825,15 +1681,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagegif</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>string - <parameter><optional>filename</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagegif</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> <function>ImageGIF</function> creates the <acronym>GIF</acronym> file in filename from the image <parameter>im</parameter>. The @@ -1928,15 +1780,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>imagepng</function> - </funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>string <parameter><optional>filename</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagepng</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> The <function>ImagePNG</function> outputs a GD image stream (<parameter>im</parameter>) in PNG format to standard output @@ -1967,18 +1815,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagejpeg</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>string - <parameter><optional>filename</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>quality</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagejpeg</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>quality</parameter></methodparam> + </methodsynopsis> <para> <function>ImageJPEG</function> creates the <acronym>JPEG</acronym> file in filename from the image @@ -2026,18 +1868,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imageWBMP</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>string - <parameter><optional>filename</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>foreground</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imageWBMP</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>foreground</parameter></methodparam> + </methodsynopsis> <para> <function>ImageWBMP</function> creates the <acronym>WBMP</acronym> file in filename from the image @@ -2078,15 +1914,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imageinterlace</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int - <parameter><optional>interlace</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imageinterlace</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>interlace</parameter></methodparam> + </methodsynopsis> <para> <function>ImageInterlace</function> turns the interlace bit on or off. If interlace is 1 the im image will be interlaced, and if interlace @@ -2110,17 +1942,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imageline</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>x1</parameter></paramdef> - <paramdef>int <parameter>y1</parameter></paramdef> - <paramdef>int <parameter>x2</parameter></paramdef> - <paramdef>int <parameter>y2</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imageline</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>x1</parameter></methodparam> + <methodparam><type>int</type><parameter>y1</parameter></methodparam> + <methodparam><type>int</type><parameter>x2</parameter></methodparam> + <methodparam><type>int</type><parameter>y2</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <para> <function>ImageLine</function> draws a line from <parameter>x1</parameter>, <parameter>y1</parameter> to @@ -2141,12 +1971,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imageloadfont</function></funcdef> - <paramdef>string <parameter>file</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imageloadfont</methodname> + <methodparam><type>string</type><parameter>file</parameter></methodparam> + </methodsynopsis> <para> <function>ImageLoadFont</function> loads a user-defined bitmap font and returns an identifier for the font (that is always @@ -2217,13 +2045,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagepalettecopy</function></funcdef> - <paramdef>resource <parameter>destination</parameter></paramdef> - <paramdef>resource <parameter>source</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagepalettecopy</methodname> + <methodparam><type>resource</type><parameter>destination</parameter></methodparam> + <methodparam><type>resource</type><parameter>source</parameter></methodparam> + </methodsynopsis> <para> <function>imagepalettecopy</function> copies the palette from the <parameter>source</parameter> image @@ -2239,15 +2065,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagepolygon</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>array <parameter>points</parameter></paramdef> - <paramdef>int <parameter>num_points</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagepolygon</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>array</type><parameter>points</parameter></methodparam> + <methodparam><type>int</type><parameter>num_points</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <para> <function>ImagePolygon</function> creates a polygon in image id. <parameter>Points</parameter> is a PHP array containing the @@ -2271,17 +2095,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>imagepsbbox</function></funcdef> - <paramdef>string <parameter>text</parameter></paramdef> - <paramdef>int <parameter>font</parameter></paramdef> - <paramdef>int <parameter>size</parameter></paramdef> - <paramdef>int <parameter><optional>space</optional></parameter></paramdef> - <paramdef>int <parameter><optional>tightness</optional></parameter></paramdef> - <paramdef>float <parameter><optional>angle</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>imagepsbbox</methodname> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + <methodparam><type>int</type><parameter>font</parameter></methodparam> + <methodparam><type>int</type><parameter>size</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>space</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>tightness</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>angle</parameter></methodparam> + </methodsynopsis> <para> <parameter>Size</parameter> is expressed in pixels. </para> @@ -2359,12 +2181,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagepscopyfont</function></funcdef> - <paramdef>int <parameter>fontindex</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagepscopyfont</methodname> + <methodparam><type>int</type><parameter>fontindex</parameter></methodparam> + </methodsynopsis> <para> Use this function if you need make further modifications to the font, for example extending/condensing, slanting it or changing @@ -2401,13 +2221,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagepsencodefont</function></funcdef> - <paramdef>int <parameter>font_index</parameter></paramdef> - <paramdef>string <parameter>encodingfile</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagepsencodefont</methodname> + <methodparam><type>int</type><parameter>font_index</parameter></methodparam> + <methodparam><type>string</type><parameter>encodingfile</parameter></methodparam> + </methodsynopsis> <para> Loads a character encoding vector from from a file and changes the fonts encoding vector to it. As a PostScript fonts default @@ -2434,12 +2252,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>imagepsfreefont</function></funcdef> - <paramdef>int <parameter>fontindex</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>imagepsfreefont</methodname> + <methodparam><type>int</type><parameter>fontindex</parameter></methodparam> + </methodsynopsis> <para> See also <function>ImagePSLoadFont</function>. </para> @@ -2453,12 +2269,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagepsloadfont</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagepsloadfont</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> In the case everything went right, a valid font index will be returned and can be used for further purposes. Otherwise the @@ -2499,19 +2313,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool - <function>imagepsextendfont</function> - </funcdef> - <paramdef>int - <parameter>font_index</parameter> - </paramdef> - <paramdef>float - <parameter>extend</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>imagepsextendfont</methodname> + <methodparam><type>int</type><parameter>font_index</parameter></methodparam> + <methodparam><type>float</type><parameter>extend</parameter></methodparam> + </methodsynopsis> <para> Extend or condense a font (<parameter>font_index</parameter>), if the value of the <parameter>extend</parameter> parameter is less @@ -2529,19 +2335,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool - <function>imagepsslantfont</function> - </funcdef> - <paramdef>int - <parameter>font_index</parameter> - </paramdef> - <paramdef>float - <parameter>slant</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>imagepsslantfont</methodname> + <methodparam><type>int</type><parameter>font_index</parameter></methodparam> + <methodparam><type>float</type><parameter>slant</parameter></methodparam> + </methodsynopsis> <para> Slant a font given by the <parameter>font_index</parameter> parameter with a slant of the value of the @@ -2559,39 +2357,29 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>imagepstext</function></funcdef> - <paramdef>int <parameter>image</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - <paramdef>int <parameter>font</parameter></paramdef> - <paramdef>int <parameter>size</parameter></paramdef> - <paramdef>int <parameter>foreground</parameter></paramdef> - <paramdef>int <parameter>background</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>int - <parameter> - <optional>space</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>tightness</optional> - </parameter> - </paramdef> - <paramdef>float - <parameter> - <optional>angle</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>antialias_steps</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>imagepstext</methodname> + <methodparam><type>int</type><parameter>image</parameter></methodparam> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + <methodparam><type>int</type><parameter>font</parameter></methodparam> + <methodparam><type>int</type><parameter>size</parameter></methodparam> + <methodparam><type>int</type><parameter>foreground</parameter></methodparam> + <methodparam><type>int</type><parameter>background</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + space + </parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + tightness + </parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter> + angle + </parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + antialias_steps + </parameter></methodparam> + </methodsynopsis> <para> <parameter>Size</parameter> is expressed in pixels. </para> @@ -2681,17 +2469,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagerectangle</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>x1</parameter></paramdef> - <paramdef>int <parameter>y1</parameter></paramdef> - <paramdef>int <parameter>x2</parameter></paramdef> - <paramdef>int <parameter>y2</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagerectangle</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>x1</parameter></methodparam> + <methodparam><type>int</type><parameter>y1</parameter></methodparam> + <methodparam><type>int</type><parameter>x2</parameter></methodparam> + <methodparam><type>int</type><parameter>y2</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <para> <function>ImageRectangle</function> creates a rectangle of color col in image im starting at upper left coordinate x1, y1 and @@ -2708,15 +2494,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagesetpixel</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagesetpixel</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <para> <function>ImageSetPixel</function> draws a pixel at <parameter>x</parameter>, <parameter>y</parameter> (top left is @@ -2737,13 +2521,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagesetbrush</function></funcdef> - <paramdef>resource <parameter>im</parameter></paramdef> - <paramdef>resource <parameter>brush</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagesetbrush</methodname> + <methodparam><type>resource</type><parameter>im</parameter></methodparam> + <methodparam><type>resource</type><parameter>brush</parameter></methodparam> + </methodsynopsis> <para> <function>ImageSetBrush</function> sets the brush image to be used by all line drawing functions (such as <function>ImageLine</function> @@ -2767,13 +2549,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagesetstyle</function></funcdef> - <paramdef>resource <parameter>im</parameter></paramdef> - <paramdef>array <parameter>style</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagesetstyle</methodname> + <methodparam><type>resource</type><parameter>im</parameter></methodparam> + <methodparam><type>array</type><parameter>style</parameter></methodparam> + </methodsynopsis> <para> <function>ImageSetStyle</function> sets the style to be used by all line drawing functions (such as <function>ImageLine</function> @@ -2830,13 +2610,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagesettile</function></funcdef> - <paramdef>resource <parameter>im</parameter></paramdef> - <paramdef>resource <parameter>tile</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagesettile</methodname> + <methodparam><type>resource</type><parameter>im</parameter></methodparam> + <methodparam><type>resource</type><parameter>tile</parameter></methodparam> + </methodsynopsis> <para> <function>ImageSetTile</function> sets the tile image to be used by all region filling functions (such as <function>ImageFill</function> @@ -2865,13 +2643,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>imagesetthickness</function></funcdef> - <paramdef>resource <parameter>im</parameter></paramdef> - <paramdef>int <parameter>thickness</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>imagesetthickness</methodname> + <methodparam><type>resource</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>thickness</parameter></methodparam> + </methodsynopsis> <para> <function>ImageSetThickness</function> sets the thickness of the lines drawn when drawing rectangles, polygons, ellipses etc. etc. to @@ -2888,17 +2664,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagestring</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>font</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>string <parameter>s</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagestring</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>font</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>string</type><parameter>s</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <para> <function>ImageString</function> draws the string <parameter>s</parameter> in the image identified by @@ -2920,17 +2694,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagestringup</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>font</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>string <parameter>s</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagestringup</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>font</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>string</type><parameter>s</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <para> <function>ImageStringUp</function> draws the string <parameter>s</parameter> vertically in the image identified by @@ -2952,12 +2724,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagesx</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagesx</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + </methodsynopsis> <para> <function>ImageSX</function> returns the width of the image identified by <parameter>im</parameter>. @@ -2976,12 +2746,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagesy</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imagesy</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + </methodsynopsis> <para> <function>ImageSY</function> returns the height of the image identified by <parameter>im</parameter>. @@ -3002,15 +2770,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>imagettfbbox</function></funcdef> - <paramdef>int <parameter>size</parameter></paramdef> - <paramdef>int <parameter>angle</parameter></paramdef> - <paramdef>string <parameter>fontfile</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>imagettfbbox</methodname> + <methodparam><type>int</type><parameter>size</parameter></methodparam> + <methodparam><type>int</type><parameter>angle</parameter></methodparam> + <methodparam><type>string</type><parameter>fontfile</parameter></methodparam> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + </methodsynopsis> <para> This function calculates and returns the bounding box in pixels for a TrueType text. @@ -3120,16 +2886,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>imageftbbox</function></funcdef> - <paramdef>int <parameter>size</parameter></paramdef> - <paramdef>int <parameter>angle</parameter></paramdef> - <paramdef>string <parameter>font_file</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - <paramdef>array <parameter><optional>extrainfo</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>imageftbbox</methodname> + <methodparam><type>int</type><parameter>size</parameter></methodparam> + <methodparam><type>int</type><parameter>angle</parameter></methodparam> + <methodparam><type>string</type><parameter>font_file</parameter></methodparam> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>extrainfo</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -3145,19 +2909,17 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>imagettftext</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>size</parameter></paramdef> - <paramdef>int <parameter>angle</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - <paramdef>string <parameter>fontfile</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>imagettftext</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>size</parameter></methodparam> + <methodparam><type>int</type><parameter>angle</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + <methodparam><type>string</type><parameter>fontfile</parameter></methodparam> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + </methodsynopsis> <para> <function>ImageTTFText</function> draws the string <parameter>text</parameter> in the image identified by @@ -3246,20 +3008,18 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>imagefttext</function></funcdef> - <paramdef>int <parameter>im</parameter></paramdef> - <paramdef>int <parameter>size</parameter></paramdef> - <paramdef>int <parameter>angle</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - <paramdef>string <parameter>font_file</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - <paramdef>array <parameter><optional>extrainfo</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>imagefttext</methodname> + <methodparam><type>int</type><parameter>im</parameter></methodparam> + <methodparam><type>int</type><parameter>size</parameter></methodparam> + <methodparam><type>int</type><parameter>angle</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + <methodparam><type>string</type><parameter>font_file</parameter></methodparam> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>extrainfo</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -3275,12 +3035,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imagetypes</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>imagetypes</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This function returns a bit-field corresponding to the image formats supported by the version of GD linked into PHP. The @@ -3311,16 +3069,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>jpeg2wbmp</function></funcdef> - <paramdef>string <parameter>jpegname</parameter></paramdef> - <paramdef>string <parameter>wbmpname</parameter></paramdef> - <paramdef>int <parameter>d_height</parameter></paramdef> - <paramdef>int <parameter>d_width</parameter></paramdef> - <paramdef>int <parameter>threshold</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>jpeg2wbmp</methodname> + <methodparam><type>string</type><parameter>jpegname</parameter></methodparam> + <methodparam><type>string</type><parameter>wbmpname</parameter></methodparam> + <methodparam><type>int</type><parameter>d_height</parameter></methodparam> + <methodparam><type>int</type><parameter>d_width</parameter></methodparam> + <methodparam><type>int</type><parameter>threshold</parameter></methodparam> + </methodsynopsis> <para> Converts the <parameter>jpegname</parameter> JPEG file to WBMP format, and saves it as <parameter>wbmpname</parameter>. @@ -3351,16 +3107,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>png2wbmp</function></funcdef> - <paramdef>string <parameter>pngname</parameter></paramdef> - <paramdef>string <parameter>wbmpname</parameter></paramdef> - <paramdef>int <parameter>d_height</parameter></paramdef> - <paramdef>int <parameter>d_width</parameter></paramdef> - <paramdef>int <parameter>threshold</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>png2wbmp</methodname> + <methodparam><type>string</type><parameter>pngname</parameter></methodparam> + <methodparam><type>string</type><parameter>wbmpname</parameter></methodparam> + <methodparam><type>int</type><parameter>d_height</parameter></methodparam> + <methodparam><type>int</type><parameter>d_width</parameter></methodparam> + <methodparam><type>int</type><parameter>threshold</parameter></methodparam> + </methodsynopsis> <para> Converts the <parameter>pngname</parameter> PNG file to WBMP format, and saves it as <parameter>wbmpname</parameter>. @@ -3389,12 +3143,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>read_exif_data</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>read_exif_data</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> The <function>read_exif_data</function> function reads the EXIF headers from a JPEG image file. It returns an associative @@ -3462,14 +3214,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>iptcembed</function></funcdef> - <paramdef>string <parameter>iptcdata</parameter></paramdef> - <paramdef>string <parameter>jpeg_file_name</parameter></paramdef> - <paramdef>int <parameter><optional>spool</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>iptcembed</methodname> + <methodparam><type>string</type><parameter>iptcdata</parameter></methodparam> + <methodparam><type>string</type><parameter>jpeg_file_name</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>spool</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -3499,3 +3249,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/imap.xml diff -u phpdoc/en/functions/imap.xml:1.60 phpdoc/en/functions/imap.xml:1.61 --- phpdoc/en/functions/imap.xml:1.60 Sun Jan 20 09:39:11 2002 +++ phpdoc/en/functions/imap.xml Sat Feb 2 10:36:00 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.60 $ --> +<!-- $Revision: 1.61 $ --> <reference id='ref.imap'> <title>IMAP, POP3 and NNTP functions</title> <titleabbrev>IMAP</titleabbrev> @@ -94,12 +94,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>imap_8bit</function></funcdef> - <paramdef>string <parameter>string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>imap_8bit</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> <para> Convert an 8bit string to a quoted-printable string (according to <ulink url="&url.rfc;rfc2045.html">RFC2045</ulink>, section @@ -125,12 +123,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>imap_alerts</function></funcdef> + <methodsynopsis> + <type>array</type><methodname>imap_alerts</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This function returns an array of all of the IMAP alert messages generated since the last <function>imap_alerts</function> call, @@ -151,17 +147,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_append</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>string <parameter>mbox</parameter></paramdef> - <paramdef>string <parameter>message</parameter></paramdef> - <paramdef>string - <parameter><optional>flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_append</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>mbox</parameter></methodparam> + <methodparam><type>string</type><parameter>message</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> Returns &true; on sucess, &false; on error. </para> @@ -212,12 +204,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>imap_base64</function></funcdef> - <paramdef>string <parameter>text</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>imap_base64</methodname> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + </methodsynopsis> <para> <function>imap_base64</function> function decodes BASE-64 encoded text (see <ulink url="&url.rfc;rfc2045.html">RFC2045</ulink>, @@ -238,12 +228,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>imap_binary</function></funcdef> - <paramdef>string <parameter>string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>imap_binary</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> <para> Convert an 8bit string to a base64 string (according to <ulink url="&url.rfc;rfc2045.html">RFC2045</ulink>, Section 6.8). @@ -264,14 +252,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>imap_body</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>int <parameter>msg_number</parameter></paramdef> - <paramdef>int <parameter><optional>flags</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>imap_body</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> <function>imap_body</function> returns the body of the message, numbered <parameter> msg_number</parameter> in the current @@ -315,14 +301,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>imap_bodystruct</function></funcdef> - <paramdef>int <parameter>stream_id</parameter></paramdef> - <paramdef>int <parameter>msg_no</parameter></paramdef> - <paramdef>int <parameter>section</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>imap_bodystruct</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>int</type><parameter>msg_no</parameter></methodparam> + <methodparam><type>int</type><parameter>section</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -336,12 +320,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>imap_check</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>imap_check</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + </methodsynopsis> <para> Returns information about the current mailbox. Returns &false; on failure. @@ -391,17 +373,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string - <function>imap_clearflag_full</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>string <parameter>sequence</parameter></paramdef> - <paramdef>string <parameter>flag</parameter></paramdef> - <paramdef>string <parameter>options</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>imap_clearflag_full</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>string</type><parameter>sequence</parameter></methodparam> + <methodparam><type>string</type><parameter>flag</parameter></methodparam> + <methodparam><type>string</type><parameter>options</parameter></methodparam> + </methodsynopsis> <para> This function causes a store to delete the specified flag to the flags set for the messages in the specified sequence. @@ -429,15 +407,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_close</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>int - <parameter><optional>flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_close</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> Close the imap stream. Takes an optional <parameter>flag</parameter> CL_EXPUNGE, which will silently @@ -454,13 +428,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_createmailbox</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>string <parameter>mbox</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_createmailbox</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>mbox</parameter></methodparam> + </methodsynopsis> <para> <function>imap_createmailbox</function> creates a new mailbox specified by <parameter>mbox</parameter>. Names containing @@ -539,16 +511,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_delete</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>int <parameter>msg_number</parameter></paramdef> - <paramdef>int - <parameter><optional>flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_delete</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> Returns &true;. </para> @@ -603,13 +571,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_deletemailbox</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>string <parameter>mbox</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_deletemailbox</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>mbox</parameter></methodparam> + </methodsynopsis> <para> <function>imap_deletemailbox</function> deletes the specified mailbox (see <function>imap_open</function> for the format @@ -638,12 +604,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>imap_errors</function></funcdef> + <methodsynopsis> + <type>array</type><methodname>imap_errors</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This function returns an array of all of the IMAP error messages generated since the last <function>imap_errors</function> call, @@ -662,12 +626,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_expunge</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_expunge</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + </methodsynopsis> <para> <function>imap_expunge</function> deletes all the messages marked for deletion by <function>imap_delete</function>, @@ -689,14 +651,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>imap_fetch_overview</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>string <parameter>sequence</parameter></paramdef> - <paramdef>int <parameter><optional>flags</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>imap_fetch_overview</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>sequence</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> This function fetches mail headers for the given <parameter>sequence</parameter> and returns an overview of their @@ -815,17 +775,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>imap_fetchbody</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>int <parameter>msg_number</parameter></paramdef> - <paramdef>string <parameter>part_number</parameter></paramdef> - <paramdef>flags - <parameter><optional>flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>imap_fetchbody</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> + <methodparam><type>string</type><parameter>part_number</parameter></methodparam> + <methodparam choice="opt"><type>flags</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> This function causes a fetch of a particular section of the body of the specified messages as a text string and returns that text @@ -868,14 +824,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>imap_fetchheader</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>int <parameter>msgno</parameter></paramdef> - <paramdef>int <parameter>flags</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>imap_fetchheader</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>msgno</parameter></methodparam> + <methodparam><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> This function causes a fetch of the complete, unfiltered <ulink url="&url.rfc;rfc2822.html">RFC2822</ulink> @@ -911,18 +865,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object - <function>imap_fetchstructure</function> - </funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>int <parameter>msg_number</parameter></paramdef> - <paramdef>int - <parameter><optional>flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>imap_fetchstructure</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> This function fetches all the structured information for a given message. The optional <parameter>flags</parameter> parameter only @@ -1064,13 +1012,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>imap_get_quota</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>string <parameter>quota_root</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>imap_get_quota</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>quota_root</parameter></methodparam> + </methodsynopsis> <para> Returns an array with integer values limit and usage for the given mailbox. The value of limit represents the total amount of space @@ -1124,14 +1070,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>imap_getmailboxes</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>string <parameter>ref</parameter></paramdef> - <paramdef>string <parameter>pattern</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>imap_getmailboxes</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>ref</parameter></methodparam> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + </methodsynopsis> <para> Returns an array of objects containing mailbox information. Each object has the attributes <parameter>name</parameter>, specifying @@ -1228,14 +1172,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>imap_getsubscribed</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>string <parameter>ref</parameter></paramdef> - <paramdef>string <parameter>pattern</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>imap_getsubscribed</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>ref</parameter></methodparam> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + </methodsynopsis> <para> This function is identical to <function>imap_getmailboxes</function>, except that it only @@ -1252,22 +1194,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>imap_header</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>int <parameter>msg_number</parameter></paramdef> - <paramdef>int - <parameter><optional>fromlength</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>subjectlength</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>defaulthost</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>imap_header</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>fromlength</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>subjectlength</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>defaulthost</parameter></methodparam> + </methodsynopsis> <para> This is an alias to <function>imap_headerinfo</function> and is identical to this in any way. @@ -1282,22 +1216,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>imap_headerinfo</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>int <parameter>msg_number</parameter></paramdef> - <paramdef>int - <parameter><optional>fromlength</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>subjectlength</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>defaulthost</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>imap_headerinfo</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>fromlength</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>subjectlength</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>defaulthost</parameter></methodparam> + </methodsynopsis> <para> This function returns an object of various header elements. </para> @@ -1402,12 +1328,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>imap_headers</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>imap_headers</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + </methodsynopsis> <para> Returns an array of string formatted with header info. One element per mail message. @@ -1426,12 +1350,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>imap_last_error</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>imap_last_error</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This function returns the full text of the last IMAP error message that occurred on the current page. The error stack is @@ -1450,14 +1372,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>imap_listmailbox</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>string <parameter>ref</parameter></paramdef> - <paramdef>string <parameter>pattern</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>imap_listmailbox</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>ref</parameter></methodparam> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + </methodsynopsis> <para> Returns an array containing the names of the mailboxes. See <function>imap_getmailboxes</function> for a description @@ -1495,14 +1415,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>imap_listsubscribed</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>string <parameter>ref</parameter></paramdef> - <paramdef>string <parameter>pattern</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>imap_listsubscribed</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>ref</parameter></methodparam> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + </methodsynopsis> <para> Returns an array of all the mailboxes that you have subscribed. This is almost identical to @@ -1522,26 +1440,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>imap_mail</function></funcdef> - <paramdef>string <parameter>to</parameter></paramdef> - <paramdef>string <parameter>subject</parameter></paramdef> - <paramdef>string <parameter>message</parameter></paramdef> - <paramdef>string - <parameter><optional>additional_headers</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>cc</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>bcc</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>rpath</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>imap_mail</methodname> + <methodparam><type>string</type><parameter>to</parameter></methodparam> + <methodparam><type>string</type><parameter>subject</parameter></methodparam> + <methodparam><type>string</type><parameter>message</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>additional_headers</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>cc</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>bcc</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>rpath</parameter></methodparam> + </methodsynopsis> <para> This function allows sending of emails with correct handling of Cc and Bcc receivers. The parameters to, cc and bcc are all strings and are all parsed as rfc822 address lists. @@ -1562,13 +1470,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>imap_mail_compose</function></funcdef> - <paramdef>array <parameter>envelope</parameter></paramdef> - <paramdef>array <parameter>body</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>imap_mail_compose</methodname> + <methodparam><type>array</type><parameter>envelope</parameter></methodparam> + <methodparam><type>array</type><parameter>body</parameter></methodparam> + </methodsynopsis> <para> </para> <para> @@ -1622,17 +1528,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_mail_copy</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>string <parameter>msglist</parameter></paramdef> - <paramdef>string <parameter>mbox</parameter></paramdef> - <paramdef>int - <parameter><optional>flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_mail_copy</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>msglist</parameter></methodparam> + <methodparam><type>string</type><parameter>mbox</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> Returns &true; on success and &false; on error. </para> @@ -1668,17 +1570,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_mail_move</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>string <parameter>msglist</parameter></paramdef> - <paramdef>string <parameter>mbox</parameter></paramdef> - <paramdef>int - <parameter><optional>flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_mail_move</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>msglist</parameter></methodparam> + <methodparam><type>string</type><parameter>mbox</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> Moves mail messages specified by <parameter>msglist</parameter> to specified mailbox. <parameter>msglist</parameter> is a range @@ -1708,12 +1606,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>imap_mailboxmsginfo</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>imap_mailboxmsginfo</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + </methodsynopsis> <para> Returns information about the current mailbox. Returns &false; on failure. @@ -1809,12 +1705,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>imap_mime_header_decode</function></funcdef> - <paramdef>string <parameter>text</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>imap_mime_header_decode</methodname> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + </methodsynopsis> <para> <function>imap_mime_header_decode</function> function decodes MIME message header extensions that are non ASCII text @@ -1859,13 +1753,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_msgno</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>int <parameter>uid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_msgno</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>uid</parameter></methodparam> + </methodsynopsis> <para> This function returns the message sequence number for the given UID. It is the inverse of <function>imap_uid</function>. @@ -1883,12 +1775,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_num_msg</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_num_msg</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + </methodsynopsis> <para> Return the number of messages in the current mailbox. </para> @@ -1907,12 +1797,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_num_recent</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_num_recent</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + </methodsynopsis> <para> Returns the number of recent messages in the current mailbox. </para> @@ -1930,17 +1818,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_open</function></funcdef> - <paramdef>string <parameter>mailbox</parameter></paramdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>int - <parameter><optional>flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_open</methodname> + <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> Returns an IMAP stream on success and &false; on error. This function can also be used to open streams to POP3 and NNTP @@ -2076,12 +1960,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_ping</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_ping</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if the stream is still alive, &false; otherwise. </para> @@ -2105,15 +1987,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_popen</function></funcdef> - <paramdef>string <parameter>mailbox</parameter></paramdef> - <paramdef>string <parameter>user</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>int <parameter><optional>options</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_popen</methodname> + <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> + <methodparam><type>string</type><parameter>user</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2128,12 +2008,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>imap_qprint</function></funcdef> - <paramdef>string <parameter>string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>imap_qprint</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> <para> Convert a quoted-printable string to an 8 bit string (according to <ulink url="&url.rfc;rfc2045.html">RFC2045</ulink>, section @@ -2156,14 +2034,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_renamemailbox</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>string <parameter>old_mbox</parameter></paramdef> - <paramdef>string <parameter>new_mbox</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_renamemailbox</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>old_mbox</parameter></methodparam> + <methodparam><type>string</type><parameter>new_mbox</parameter></methodparam> + </methodsynopsis> <para> This function renames on old mailbox to new mailbox (see <function>imap_open</function> for the format of @@ -2188,16 +2064,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_reopen</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>string <parameter>mailbox</parameter></paramdef> - <paramdef>string - <parameter><optional>flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_reopen</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> This function reopens the specified stream to a new mailbox on an IMAP or NNTP server. @@ -2244,15 +2116,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array - <function>imap_rfc822_parse_adrlist</function> - </funcdef> - <paramdef>string <parameter>address</parameter></paramdef> - <paramdef>string <parameter>default_host</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>imap_rfc822_parse_adrlist</methodname> + <methodparam><type>string</type><parameter>address</parameter></methodparam> + <methodparam><type>string</type><parameter>default_host</parameter></methodparam> + </methodsynopsis> <para> This function parses the address string as defined in <ulink url="&url.rfc;rfc2822.html">RFC2822</ulink> and @@ -2313,15 +2181,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>imap_rfc822_parse_headers</function></funcdef> - <paramdef>string <parameter>headers</parameter></paramdef> - <paramdef>string - <parameter><optional>defaulthost</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>imap_rfc822_parse_headers</methodname> + <methodparam><type>string</type><parameter>headers</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>defaulthost</parameter></methodparam> + </methodsynopsis> <para> This function returns an object of various header elements, similar to <function>imap_header</function>, except without the @@ -2340,16 +2204,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string - <function>imap_rfc822_write_address</function> - </funcdef> - <paramdef>string <parameter>mailbox</parameter></paramdef> - <paramdef>string <parameter>host</parameter></paramdef> - <paramdef>string <parameter>personal</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>imap_rfc822_write_address</methodname> + <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> + <methodparam><type>string</type><parameter>host</parameter></methodparam> + <methodparam><type>string</type><parameter>personal</parameter></methodparam> + </methodsynopsis> <para> Returns a properly formatted email address as defined in <ulink url="&url.rfc;rfc2822.html">RFC2822</ulink> @@ -2378,15 +2238,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>imap_scanmailbox</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>string <parameter>ref</parameter></paramdef> - <paramdef>string <parameter>pattern</parameter></paramdef> - <paramdef>string <parameter>content</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>imap_scanmailbox</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>ref</parameter></methodparam> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + <methodparam><type>string</type><parameter>content</parameter></methodparam> + </methodsynopsis> <para> Returns an array containing the names of the mailboxes that have <parameter>content</parameter> in the text of the mailbox. @@ -2409,14 +2267,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>imap_search</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>string <parameter>criteria</parameter></paramdef> - <paramdef>int <parameter>flags</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>imap_search</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>criteria</parameter></methodparam> + <methodparam><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> This function performs a search on the mailbox currently opened in the given imap stream. <parameter>criteria</parameter> is a @@ -2571,15 +2427,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_setacl</function></funcdef> - <paramdef>int <parameter>stream_id</parameter></paramdef> - <paramdef>string <parameter>mailbox</parameter></paramdef> - <paramdef>string <parameter>id</parameter></paramdef> - <paramdef>string <parameter>rights</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_setacl</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> + <methodparam><type>string</type><parameter>id</parameter></methodparam> + <methodparam><type>string</type><parameter>rights</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2593,14 +2447,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_set_quota</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>string <parameter>quota_root</parameter></paramdef> - <paramdef>int <parameter>quota_limit</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_set_quota</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>quota_root</parameter></methodparam> + <methodparam><type>int</type><parameter>quota_limit</parameter></methodparam> + </methodsynopsis> <para> Sets an upper limit quota on a per mailbox basis. This function requires the <parameter>imap_stream</parameter> to have been opened @@ -2654,15 +2506,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>imap_setflag_full</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>string <parameter>sequence</parameter></paramdef> - <paramdef>string <parameter>flag</parameter></paramdef> - <paramdef>string <parameter>options</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>imap_setflag_full</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>string</type><parameter>sequence</parameter></methodparam> + <methodparam><type>string</type><parameter>flag</parameter></methodparam> + <methodparam><type>string</type><parameter>options</parameter></methodparam> + </methodsynopsis> <para> This function causes a store to add the specified flag to the flags set for the messages in the specified sequence. @@ -2709,15 +2559,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>imap_sort</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>criteria</parameter></paramdef> - <paramdef>int <parameter>reverse</parameter></paramdef> - <paramdef>int <parameter>options</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>imap_sort</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>int</type><parameter>criteria</parameter></methodparam> + <methodparam><type>int</type><parameter>reverse</parameter></methodparam> + <methodparam><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> <para> Returns an array of message numbers sorted by the given parameters. @@ -2761,14 +2609,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>imap_status</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>string <parameter>mailbox</parameter></paramdef> - <paramdef>int <parameter>options</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>imap_status</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> + <methodparam><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> <para> This function returns an object containing status information. Valid flags are: @@ -2848,13 +2694,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_subscribe</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>string <parameter>mbox</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_subscribe</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>mbox</parameter></methodparam> + </methodsynopsis> <para> Subscribe to a new mailbox. </para> @@ -2874,13 +2718,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_uid</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>int <parameter>msgno</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_uid</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>msgno</parameter></methodparam> + </methodsynopsis> <para> This function returns the UID for the given message sequence number. An UID is an unique identifier that will not change over @@ -2905,13 +2747,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_undelete</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>int <parameter>msg_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_undelete</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> + </methodsynopsis> <para> This function removes the deletion flag for a specified message, which is set by <function>imap_delete</function> or @@ -2930,13 +2770,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_unsubscribe</function></funcdef> - <paramdef>int <parameter>imap_stream</parameter></paramdef> - <paramdef>string <parameter>mbox</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_unsubscribe</methodname> + <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> + <methodparam><type>string</type><parameter>mbox</parameter></methodparam> + </methodsynopsis> <para> Unsubscribe from a specified mailbox. </para> @@ -2955,12 +2793,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>imap_utf7_decode</function></funcdef> - <paramdef>string <parameter>text</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>imap_utf7_decode</methodname> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + </methodsynopsis> <para> Decodes modified UTF-7 <parameter>text</parameter> into 8bit data. </para> @@ -2985,12 +2821,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>imap_utf7_encode</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>imap_utf7_encode</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> <para> Converts 8bit <parameter>data</parameter> to modified UTF-7 text. This is needed to encode mailbox names that contain @@ -3015,12 +2849,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>imap_utf8</function></funcdef> - <paramdef>string <parameter>text</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>imap_utf8</methodname> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + </methodsynopsis> <para> Converts the given <parameter>text</parameter> to UTF8 (as defined in @@ -3038,13 +2870,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>imap_thread</function></funcdef> - <paramdef>int <parameter>stream_id</parameter></paramdef> - <paramdef>int <parameter><optional>flags</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>imap_thread</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -3074,3 +2904,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/info.xml diff -u phpdoc/en/functions/info.xml:1.89 phpdoc/en/functions/info.xml:1.90 --- phpdoc/en/functions/info.xml:1.89 Wed Jan 23 02:32:57 2002 +++ phpdoc/en/functions/info.xml Sat Feb 2 10:36:01 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.89 $ --> +<!-- $Revision: 1.90 $ --> <reference id="ref.info"> <title>PHP Options&amp;Information</title> <titleabbrev>PHP Options/Info</titleabbrev> @@ -11,12 +11,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>assert</function></funcdef> - <paramdef>string|bool <parameter>assertion</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>assert</methodname> + <methodparam><type>string|bool</type><parameter>assertion</parameter></methodparam> + </methodsynopsis> <para> <function>assert</function> will check the given <parameter>assertion</parameter> and take appropriate action if @@ -108,14 +106,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>assert_options</function></funcdef> - <paramdef>int <parameter>what</parameter></paramdef> - <paramdef>mixed <parameter><optional>value</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>assert_options</methodname> + <methodparam><type>int</type><parameter>what</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> Using <function>assert_options</function> you may set the various <function>assert</function> control options or just query their @@ -183,12 +178,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>extension_loaded</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>extension_loaded</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> <simpara> Returns &true; if the extension identified by <parameter>name</parameter> is loaded. You can see the names of @@ -212,12 +205,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>dl</function></funcdef> - <paramdef>string <parameter>library</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>dl</methodname> + <methodparam><type>string</type><parameter>library</parameter></methodparam> + </methodsynopsis> <para> Loads the PHP extension defined in <parameter>library</parameter>. See also the <link @@ -233,12 +224,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>getenv</function></funcdef> - <paramdef>string <parameter>varname</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>getenv</methodname> + <methodparam><type>string</type><parameter>varname</parameter></methodparam> + </methodsynopsis> <para> Returns the value of the environment variable <parameter>varname</parameter>, or &false; on an error. @@ -277,12 +266,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>get_cfg_var</function></funcdef> - <paramdef>string <parameter>varname</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>get_cfg_var</methodname> + <methodparam><type>string</type><parameter>varname</parameter></methodparam> + </methodsynopsis> <simpara> Returns the current value of the PHP configuration variable specified by <parameter>varname</parameter>, or &false; if an @@ -315,12 +302,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>get_current_user</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>get_current_user</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <simpara> Returns the name of the owner of the current PHP script. </simpara> @@ -343,12 +328,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>get_defined_constants</function></funcdef> + <methodsynopsis> + <type>array</type><methodname>get_defined_constants</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This function returns the names and values of all the constants currently defined. This includes those created by extensions as @@ -403,12 +386,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>get_extension_funcs</function></funcdef> - <paramdef>string <parameter>module_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>get_extension_funcs</methodname> + <methodparam><type>string</type><parameter>module_name</parameter></methodparam> + </methodsynopsis> <para> This function returns the names of all the functions defined in the module indicated by <parameter>module_name</parameter>. @@ -439,12 +420,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>getmygid</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>getmygid</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <simpara> Returns the group ID of the current script, or &false; on error. </simpara> @@ -467,12 +446,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>get_included_files</function></funcdef> + <methodsynopsis> + <type>array</type><methodname>get_included_files</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns an array of the names of all files that have been included using <function>include</function>, @@ -553,12 +530,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>get_loaded_extensions</function></funcdef> + <methodsynopsis> + <type>array</type><methodname>get_loaded_extensions</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This function returns the names of all the modules compiled and loaded in the PHP interpreter. @@ -610,12 +585,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>long <function>get_magic_quotes_gpc</function></funcdef> + <methodsynopsis> + <type>long</type><methodname>get_magic_quotes_gpc</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <simpara> Returns the current active configuration setting of <link linkend="ini.magic-quotes-gpc">magic_quotes_gpc</link> (0 for @@ -638,14 +611,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>long - <function>get_magic_quotes_runtime</function> - </funcdef> + <methodsynopsis> + <type>long</type><methodname>get_magic_quotes_runtime</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <simpara> Returns the current active configuration setting of <link linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link> @@ -665,12 +634,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>getlastmod</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>getlastmod</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns the time of the last modification of the current page. The value returned is a Unix timestamp, suitable for @@ -702,12 +669,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>getmyinode</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>getmyinode</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns the current script's inode, or &false; on error. </para> @@ -729,12 +694,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>getmypid</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>getmypid</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns the current PHP process ID, or &false; on error. </para> @@ -762,12 +725,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>getmyuid</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>getmyuid</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <simpara> Returns the user ID of the current script, or &false; on error. </simpara> @@ -790,12 +751,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>get_required_files</function></funcdef> + <methodsynopsis> + <type>array</type><methodname>get_required_files</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> As of PHP 4.0.4, this function is an alias for <function>get_included_files</function> @@ -825,14 +784,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>getrusage</function></funcdef> - <paramdef>int - <parameter><optional>who</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>getrusage</methodname> + <methodparam choice="opt"><type>int</type><parameter>who</parameter></methodparam> + </methodsynopsis> <para> This is an interface to getrusage(2). It returns an associative array containing the data returned from the system call. If who @@ -866,13 +821,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ini_alter</function></funcdef> - <paramdef>string <parameter>varname</parameter></paramdef> - <paramdef>string <parameter>newvalue</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ini_alter</methodname> + <methodparam><type>string</type><parameter>varname</parameter></methodparam> + <methodparam><type>string</type><parameter>newvalue</parameter></methodparam> + </methodsynopsis> <para> Changes the value of a configuration option, returns &false; on failure, and the previous value of the configuration option on @@ -899,12 +852,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ini_get</function></funcdef> - <paramdef>string <parameter>varname</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ini_get</methodname> + <methodparam><type>string</type><parameter>varname</parameter></methodparam> + </methodsynopsis> <para> Returns the value of the configuration option on success, an empty string on failure. @@ -926,14 +877,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>ini_get_all</function></funcdef> - <paramdef>string - <parameter><optional>extension</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>ini_get_all</methodname> + <methodparam choice="opt"><type>string</type><parameter>extension</parameter></methodparam> + </methodsynopsis> <para> Returns all the registered configuration options as an associative array. If optional <parameter>extension</parameter> @@ -955,12 +902,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ini_restore</function></funcdef> - <paramdef>string <parameter>varname</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ini_restore</methodname> + <methodparam><type>string</type><parameter>varname</parameter></methodparam> + </methodsynopsis> <para> Restores a given configuration option to its original value. </para> @@ -979,13 +924,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ini_set</function></funcdef> - <paramdef>string <parameter>varname</parameter></paramdef> - <paramdef>string <parameter>newvalue</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ini_set</methodname> + <methodparam><type>string</type><parameter>varname</parameter></methodparam> + <methodparam><type>string</type><parameter>newvalue</parameter></methodparam> + </methodsynopsis> <para> Sets the value of the given configuration option. Returns the old value on success, &false; on failure. The configuration option @@ -1363,12 +1306,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>phpcredits</function></funcdef> - <paramdef>int <parameter>flag</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>phpcredits</methodname> + <methodparam><type>int</type><parameter>flag</parameter></methodparam> + </methodsynopsis> <para> This function prints out the credits listing the PHP developers, modules, etc. It generates the appropriate HTML codes to insert @@ -1494,12 +1435,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>phpinfo</function></funcdef> - <paramdef>int <parameter><optional>what</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>phpinfo</methodname> + <methodparam choice="opt"><type>int</type><parameter>what</parameter></methodparam> + </methodsynopsis> <para> Outputs a large amount of information about the current state of PHP. This includes information about PHP compilation options and @@ -1648,12 +1587,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>phpversion</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>phpversion</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns a string containing the version of the currently running PHP parser. @@ -1693,12 +1630,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>php_logo_guid</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>php_logo_guid</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <note> <para> This functionality was added in PHP 4.0.0. @@ -1721,12 +1656,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>php_sapi_name</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>php_sapi_name</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <simpara> <function>php_sapi_name</function> returns a lowercase string which describes the type of interface between web server and PHP @@ -1759,12 +1692,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>php_uname</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>php_uname</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <simpara> <function>php_uname</function> returns a string with a description of the operating system PHP is built on. @@ -1791,12 +1722,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>putenv</function></funcdef> - <paramdef>string <parameter>setting</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>putenv</methodname> + <methodparam><type>string</type><parameter>setting</parameter></methodparam> + </methodsynopsis> <para> Adds <parameter>setting</parameter> to the server environment. The environment variable will only exist for the duration of the @@ -1854,14 +1783,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>long - <function>set_magic_quotes_runtime</function> - </funcdef> - <paramdef>int <parameter>new_setting</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>long</type><methodname>set_magic_quotes_runtime</methodname> + <methodparam><type>int</type><parameter>new_setting</parameter></methodparam> + </methodsynopsis> <simpara> Set the current active configuration setting of <link linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link> (0 @@ -1881,12 +1806,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>set_time_limit</function></funcdef> - <paramdef>int <parameter>seconds</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>set_time_limit</methodname> + <methodparam><type>int</type><parameter>seconds</parameter></methodparam> + </methodsynopsis> <simpara> Set the number of seconds a script is allowed to run. If this is reached, the script returns a fatal error. The default limit is @@ -1933,18 +1856,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>version_compare</function></funcdef> - <paramdef>string <parameter>version1</parameter></paramdef> - <paramdef>string <parameter>version2</parameter></paramdef> - <paramdef>string - <parameter> - <optional>operator</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>version_compare</methodname> + <methodparam><type>string</type><parameter>version1</parameter></methodparam> + <methodparam><type>string</type><parameter>version2</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + operator + </parameter></methodparam> + </methodsynopsis> <para> <function>version_compare</function> compares two "PHP-standardized" version number strings. This is useful if you @@ -1995,12 +1914,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>zend_logo_guid</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>zend_logo_guid</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <note> <para> This functionality was added in PHP 4.0.0. @@ -2016,12 +1933,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>zend_version</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>zend_version</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns a string containing the version of the currently running PHP parser. @@ -2066,3 +1981,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/ingres_ii.xml diff -u phpdoc/en/functions/ingres_ii.xml:1.15 phpdoc/en/functions/ingres_ii.xml:1.16 --- phpdoc/en/functions/ingres_ii.xml:1.15 Wed Dec 12 15:46:58 2001 +++ phpdoc/en/functions/ingres_ii.xml Sat Feb 2 10:36:01 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.15 $ --> +<!-- $Revision: 1.16 $ --> <reference id="ref.ingres"> <title>Ingres II functions</title> <titleabbrev>Ingres II</titleabbrev> @@ -49,20 +49,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>ingres_connect</function></funcdef> - <paramdef>string - <parameter><optional>database</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>username</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>password</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>ingres_connect</methodname> + <methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Returns a Ingres II link resource on success, or &false; on @@ -134,20 +126,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>ingres_pconnect</function></funcdef> - <paramdef>string - <parameter><optional>database</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>username</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>password</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>ingres_pconnect</methodname> + <methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Returns a Ingres II link resource on success, or &false; on @@ -182,14 +166,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ingres_close</function></funcdef> - <paramdef>resource - <parameter><optional>link</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ingres_close</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Returns &true; on success, or &false; on failure. @@ -219,17 +199,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ingres_query</function></funcdef> - <paramdef>string - <parameter>query</parameter> - </paramdef> - <paramdef>resource - <parameter><optional>link</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ingres_query</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Returns &true; on success, or &false; on failure. @@ -335,14 +309,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ingres_num_rows</function></funcdef> - <paramdef>resource - <parameter><optional>link</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ingres_num_rows</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> For delete, insert or update queries, @@ -387,14 +357,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ingres_num_fields</function></funcdef> - <paramdef>resource - <parameter><optional>link</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ingres_num_fields</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>ingres_num_fields</function> returns the number of @@ -418,17 +384,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ingres_field_name</function></funcdef> - <paramdef>int - <parameter>index</parameter> - </paramdef> - <paramdef>resource - <parameter><optional>link</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ingres_field_name</methodname> + <methodparam><type>int</type><parameter>index</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>ingres_field_name</function> returns the name of a field @@ -458,17 +418,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ingres_field_type</function></funcdef> - <paramdef>int - <parameter>index</parameter> - </paramdef> - <paramdef>resource - <parameter><optional>link</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ingres_field_type</methodname> + <methodparam><type>int</type><parameter>index</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>ingres_field_type</function> returns the type of a @@ -503,17 +457,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ingres_field_nullable</function></funcdef> - <paramdef>int - <parameter>index</parameter> - </paramdef> - <paramdef>resource - <parameter><optional>link</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ingres_field_nullable</methodname> + <methodparam><type>int</type><parameter>index</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>ingres_field_nullable</function> returns &true; if the @@ -541,17 +489,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ingres_field_length</function></funcdef> - <paramdef>int - <parameter>index</parameter> - </paramdef> - <paramdef>resource - <parameter><optional>link</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ingres_field_length</methodname> + <methodparam><type>int</type><parameter>index</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>ingres_field_length</function> returns the length of a @@ -581,18 +523,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>ingres_field_precision</function> - </funcdef> - <paramdef>int <parameter>index</parameter> - </paramdef> - <paramdef>resource - <parameter><optional>link</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ingres_field_precision</methodname> + <methodparam><type>int</type><parameter>index</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>ingres_field_precision</function> returns the precision @@ -622,17 +557,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ingres_field_scale</function></funcdef> - <paramdef>int - <parameter>index</parameter> - </paramdef> - <paramdef>resource - <parameter><optional>link</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ingres_field_scale</methodname> + <methodparam><type>int</type><parameter>index</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>ingres_field_scale</function> returns the scale of a @@ -662,17 +591,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>ingres_fetch_array</function></funcdef> - <paramdef>int - <parameter><optional>result_type</optional></parameter> - </paramdef> - <paramdef>resource - <parameter><optional>link</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>ingres_fetch_array</methodname> + <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>ingres_fetch_array</function> Returns an array that @@ -753,14 +676,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>ingres_fetch_row</function></funcdef> - <paramdef>resource - <parameter><optional>link</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>ingres_fetch_row</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>ingres_fetch_row</function> returns an array that @@ -808,19 +727,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object - <function>ingres_fetch_object</function> - </funcdef> - <paramdef>int - <parameter><optional>result_type</optional></parameter> - </paramdef> - <paramdef>resource - <parameter><optional>link</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>ingres_fetch_object</methodname> + <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>ingres_fetch_object</function> Returns an object that @@ -880,14 +791,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ingres_rollback</function></funcdef> - <paramdef>resource - <parameter><optional>link</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ingres_rollback</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>ingres_rollback</function> rolls back the currently @@ -914,14 +821,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ingres_commit</function></funcdef> - <paramdef>resource - <parameter><optional>link</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ingres_commit</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>ingres_commit</function> commits the currently open @@ -952,14 +855,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ingres_autocommit</function></funcdef> - <paramdef>resource - <parameter><optional>link</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ingres_autocommit</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>ingres_autocommit</function> is called before opening a @@ -1005,3 +904,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/ircg.xml diff -u phpdoc/en/functions/ircg.xml:1.23 phpdoc/en/functions/ircg.xml:1.24 --- phpdoc/en/functions/ircg.xml:1.23 Tue Jan 22 06:13:11 2002 +++ phpdoc/en/functions/ircg.xml Sat Feb 2 10:36:02 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.23 $ --> +<!-- $Revision: 1.24 $ --> <reference id="ref.ircg"> <title>IRC Gateway Functions</title> <titleabbrev>IRC Gateway</titleabbrev> @@ -58,27 +58,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>ircg_pconnect</function></funcdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string - <parameter><optional>server_ip</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>server_port</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>msg_format</optional></parameter> - </paramdef> - <paramdef>array - <parameter><optional>ctcp_messages</optional></parameter> - </paramdef> - <paramdef>array - <parameter><optional>user_settings</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>ircg_pconnect</methodname> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>server_ip</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>server_port</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>msg_format</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>ctcp_messages</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>user_settings</parameter></methodparam> + </methodsynopsis> <para> <function>ircg_pconnect</function> will try to establish a connection to an IRC server and return a connection resource @@ -126,12 +114,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>ircg_fetch_error_msg</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>ircg_fetch_error_msg</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>ircg_fetch_error_msg</function> returns the error from the last called ircg function. @@ -167,13 +153,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>ircg_set_current</function></funcdef> - <paramdef>resource - <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>ircg_set_current</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> Select the current connection for output in this execution context. Every output sent from the server connected to by @@ -198,13 +181,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>ircg_join</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>channel</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>ircg_join</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>channel</parameter></methodparam> + </methodsynopsis> <para> Join the channel <parameter>channel</parameter> on the server connected to by <parameter>connection</parameter>. @@ -221,13 +202,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>ircg_part</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>channel</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>ircg_part</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>channel</parameter></methodparam> + </methodsynopsis> <para> Leave the channel <parameter>channel</parameter> on the server connected to by <parameter>connection</parameter>. @@ -244,17 +223,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>ircg_msg</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>recipient</parameter></paramdef> - <paramdef>string <parameter>message</parameter></paramdef> - <paramdef>boolean - <parameter><optional>suppress</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>ircg_msg</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>recipient</parameter></methodparam> + <methodparam><type>string</type><parameter>message</parameter></methodparam> + <methodparam choice="opt"><type>boolean</type><parameter>suppress</parameter></methodparam> + </methodsynopsis> <para> <function>ircg_msg</function> will send the message to a channel or user on the server connected to by @@ -281,14 +256,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>ircg_notice</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - <paramdef>string <parameter></parameter></paramdef> - <paramdef>string <parameter>message</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>ircg_notice</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter/></methodparam> + <methodparam><type>string</type><parameter>message</parameter></methodparam> + </methodsynopsis> <para> This function will send the <parameter>message</parameter> text to the user <parameter>nick</parameter> on the server connected @@ -308,13 +281,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>ircg_nick</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>nick</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>ircg_nick</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>nick</parameter></methodparam> + </methodsynopsis> <para> Change your nickname on the given <parameter>connection</parameter> to the one given in @@ -335,14 +306,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>ircg_topic</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>channel</parameter></paramdef> - <paramdef>string <parameter>new_topic</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>ircg_topic</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>channel</parameter></methodparam> + <methodparam><type>string</type><parameter>new_topic</parameter></methodparam> + </methodsynopsis> <para> Change the topic for channel <parameter>channel</parameter> on the server connected to by <parameter>connection</parameter> to @@ -360,15 +329,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>ircg_channel_mode</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>channel</parameter></paramdef> - <paramdef>string <parameter>mode_spec</parameter></paramdef> - <paramdef>string <parameter>nick</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>ircg_channel_mode</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>channel</parameter></methodparam> + <methodparam><type>string</type><parameter>mode_spec</parameter></methodparam> + <methodparam><type>string</type><parameter>nick</parameter></methodparam> + </methodsynopsis> <para> Set channel mode flags for <parameter>channel</parameter> on server connected to by <parameter>connection</parameter>. Mode flags @@ -393,12 +360,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>ircg_html_encode</function></funcdef> - <paramdef>string <parameter>html_string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>ircg_html_encode</methodname> + <methodparam><type>string</type><parameter>html_string</parameter></methodparam> + </methodsynopsis> <para> Encodes a HTML string <parameter>html_string</parameter> for output. This feature could be usable, e.g. if someone wants to @@ -416,13 +381,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>ircg_whois</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>nick</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>ircg_whois</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>nick</parameter></methodparam> + </methodsynopsis> <para> Sends a query to the connected server <parameter>connection</parameter> to send information for the @@ -440,15 +403,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>ircg_kick</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>channel</parameter></paramdef> - <paramdef>string <parameter>nick</parameter></paramdef> - <paramdef>string <parameter>reason</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>ircg_kick</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>channel</parameter></methodparam> + <methodparam><type>string</type><parameter>nick</parameter></methodparam> + <methodparam><type>string</type><parameter>reason</parameter></methodparam> + </methodsynopsis> <para> Kick user <parameter>nick</parameter> from <parameter>channel</parameter> on server connected to by @@ -468,13 +429,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>ircg_ignore_add</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>nick</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>ircg_ignore_add</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>nick</parameter></methodparam> + </methodsynopsis> <para> This function will add user <parameter>nick</parameter> to your ignore list on the server connected to by @@ -496,13 +455,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>ircg_ignore_del</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>nick</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>ircg_ignore_del</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>nick</parameter></methodparam> + </methodsynopsis> <para> This function remove user <parameter>nick</parameter> from your ignore list on the server connected to by @@ -523,13 +480,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>ircg_disconnect</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>reason</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>ircg_disconnect</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>reason</parameter></methodparam> + </methodsynopsis> <para> <function>ircg_disconnect</function> will close a <parameter>connection</parameter> to a server previously @@ -550,12 +505,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>ircg_is_conn_alive</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>ircg_is_conn_alive</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>ircg_is_conn_alive</function> returns &true; if <parameter>connection</parameter> is still alive and working or @@ -573,14 +526,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean - <function>ircg_lookup_format_messages</function> - </funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>ircg_lookup_format_messages</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> <para> Select the set of format strings to use for display of IRC messages and events. Sets may be registered with @@ -602,15 +551,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean - <function>ircg_register_format_messages</function> - </funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>array <parameter>messages</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>ircg_register_format_messages</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>array</type><parameter>messages</parameter></methodparam> + </methodsynopsis> <para> With <function>ircg_register_format_messages</function> you can customize the way your IRC output looks like. You can even @@ -681,15 +626,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ircg_set_on_die</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>host</parameter></paramdef> - <paramdef>int <parameter>port</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ircg_set_on_die</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>host</parameter></methodparam> + <methodparam><type>int</type><parameter>port</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> <para> In case of the termination of connection <parameter>connection</parameter> IRCG will connect to <parameter>host</parameter> at @@ -711,13 +654,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ircg_set_file</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>path</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ircg_set_file</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>path</parameter></methodparam> + </methodsynopsis> <para> Function <function>ircg_set_file</function> specifies a logfile <parameter>path</parameter> in which all output from connection @@ -736,12 +677,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ircg_get_username</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ircg_get_username</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> Function <function>ircg_get_username</function> returns the username for specified connection <parameter>connection</parameter>. @@ -760,12 +699,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ircg_nickname_escape</function></funcdef> - <paramdef>string <parameter>nick</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ircg_nickname_escape</methodname> + <methodparam><type>string</type><parameter>nick</parameter></methodparam> + </methodsynopsis> <para> Function <function>ircg_nickname_escape</function> returns a decoded nickname specified by <parameter>nick</parameter> wich is IRC-compliant. @@ -785,12 +722,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ircg_nickname_unescape</function></funcdef> - <paramdef>string <parameter>nick</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ircg_nickname_unescape</methodname> + <methodparam><type>string</type><parameter>nick</parameter></methodparam> + </methodsynopsis> <para> Function <function>ircg_nickname_unescape</function> returns a decoded nickname, which is specified in <parameter>nick</parameter>. @@ -823,3 +758,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/java.xml diff -u phpdoc/en/functions/java.xml:1.15 phpdoc/en/functions/java.xml:1.16 --- phpdoc/en/functions/java.xml:1.15 Wed Dec 12 15:46:59 2001 +++ phpdoc/en/functions/java.xml Sat Feb 2 10:36:02 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.15 $ --> +<!-- $Revision: 1.16 $ --> <reference id="ref.java"> <title>Java</title> <titleabbrev>PHP / Java Integration</titleabbrev> @@ -175,12 +175,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>java_last_exception_clear</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>java_last_exception_clear</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> </refsect1> </refentry> @@ -191,12 +189,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>exception <function>java_last_exception_get</function></funcdef> + <methodsynopsis> + <type>exception</type><methodname>java_last_exception_get</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> The following example demonstrates the usage of Java's exception handler from within PHP: @@ -250,3 +246,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/ldap.xml diff -u phpdoc/en/functions/ldap.xml:1.40 phpdoc/en/functions/ldap.xml:1.41 --- phpdoc/en/functions/ldap.xml:1.40 Fri Jan 18 18:22:23 2002 +++ phpdoc/en/functions/ldap.xml Sat Feb 2 10:36:02 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.40 $ --> +<!-- $Revision: 1.41 $ --> <reference id="ref.ldap"> <title>LDAP functions</title> <titleabbrev>LDAP</titleabbrev> @@ -211,14 +211,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_add</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>string <parameter>dn</parameter></paramdef> - <paramdef>array <parameter>entry</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_add</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>dn</parameter></methodparam> + <methodparam><type>array</type><parameter>entry</parameter></methodparam> + </methodsynopsis> <para> &return.success; </para><para> @@ -276,14 +274,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_bind</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>string <parameter><optional>bind_rdn</optional></parameter></paramdef> - <paramdef>string <parameter><optional>bind_password</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_bind</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>bind_rdn</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>bind_password</parameter></methodparam> + </methodsynopsis> <para> Binds to the LDAP directory with specified RDN and password. &return.success;</para> @@ -304,12 +300,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_close</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_close</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> &return.success; </para> @@ -338,15 +332,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_compare</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>string <parameter>dn</parameter></paramdef> - <paramdef>string <parameter>attribute</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_compare</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>dn</parameter></methodparam> + <methodparam><type>string</type><parameter>attribute</parameter></methodparam> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + </methodsynopsis> <simpara> Returns &true; if <parameter>value</parameter> matches otherwise returns &false;. Returns -1 on error. </simpara> @@ -423,13 +415,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_connect</function></funcdef> - <paramdef>string <parameter><optional>hostname</optional></parameter></paramdef> - <paramdef>int <parameter><optional>port</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_connect</methodname> + <methodparam choice="opt"><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam> + </methodsynopsis> <para> Returns a positive LDAP link identifier on success, or &false; on error.</para> @@ -463,13 +453,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_count_entries</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>int <parameter>result_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_count_entries</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>result_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns number of entries in the result or &false; on error.</para> <para> @@ -488,13 +476,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_delete</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>string <parameter>dn</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_delete</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>dn</parameter></methodparam> + </methodsynopsis> <para> &return.success;</para> <para> @@ -512,12 +498,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ldap_dn2ufn</function></funcdef> - <paramdef>string <parameter>dn</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ldap_dn2ufn</methodname> + <methodparam><type>string</type><parameter>dn</parameter></methodparam> + </methodsynopsis> <para> <function>ldap_dn2ufn</function> function is used to turn a DN, specified by <parameter>dn</parameter>, into a more user-friendly form, @@ -536,12 +520,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ldap_err2str</function></funcdef> - <paramdef>int <parameter>errno</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ldap_err2str</methodname> + <methodparam><type>int</type><parameter>errno</parameter></methodparam> + </methodsynopsis> <para> Returns string error message.</para> <para> @@ -579,12 +561,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_errno</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_errno</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> Return the LDAP error number of the last LDAP command for this link.</para> @@ -637,12 +617,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ldap_error</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ldap_error</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns string error message.</para> <para> @@ -672,13 +650,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>ldap_explode_dn</function></funcdef> - <paramdef>string <parameter>dn</parameter></paramdef> - <paramdef>int <parameter>with_attrib</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>ldap_explode_dn</methodname> + <methodparam><type>string</type><parameter>dn</parameter></methodparam> + <methodparam><type>int</type><parameter>with_attrib</parameter></methodparam> + </methodsynopsis> <para> <function>ldap_explode_dn</function> function is used to split the DN returned by <function>ldap_get_dn</function> and breaks @@ -701,14 +677,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ldap_first_attribute</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>int <parameter>result_entry_identifier</parameter></paramdef> - <paramdef>int <parameter>ber_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ldap_first_attribute</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>result_entry_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>ber_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns the first attribute in the entry on success and &false; on error. @@ -740,13 +714,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_first_entry</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>int <parameter>result_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_first_entry</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>result_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns the result entry identifier for the first entry on success and &false; on error.</para> @@ -772,12 +744,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_free_result</function></funcdef> - <paramdef>int <parameter>result_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_free_result</methodname> + <methodparam><type>int</type><parameter>result_identifier</parameter></methodparam> + </methodsynopsis> <para> &return.success;</para> <para> @@ -802,14 +772,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>ldap_get_attributes</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>int - <parameter>result_entry_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>ldap_get_attributes</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>result_entry_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns a complete entry information in a multi-dimensional array on success and &false; on error.</para> @@ -874,13 +841,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ldap_get_dn</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>int <parameter>result_entry_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ldap_get_dn</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>result_entry_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns the DN of the result entry and &false; on error.</para> <para> @@ -897,13 +862,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>ldap_get_entries</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>int <parameter>result_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>ldap_get_entries</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>result_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns a complete result information in a multi-dimenasional array on success and &false; on error.</para> @@ -950,14 +913,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ldap_get_option</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>int <parameter>option</parameter></paramdef> - <paramdef>mixed <parameter>retval</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ldap_get_option</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>option</parameter></methodparam> + <methodparam><type>mixed</type><parameter>retval</parameter></methodparam> + </methodsynopsis> <para> Sets <parameter>retval</parameter> to the value of the specified option. &return.success;</para> @@ -1002,14 +963,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>ldap_get_values</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>int <parameter>result_entry_identifier</parameter></paramdef> - <paramdef>string <parameter>attribute</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>ldap_get_values</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>result_entry_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>attribute</parameter></methodparam> + </methodsynopsis> <para> Returns an array of values for the attribute on success and &false; on error.</para> @@ -1077,14 +1036,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>ldap_get_values_len</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>int <parameter>result_entry_identifier</parameter></paramdef> - <paramdef>string <parameter>attribute</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>ldap_get_values_len</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>result_entry_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>attribute</parameter></methodparam> + </methodsynopsis> <para> Returns an array of values for the attribute on success and &false; on error.</para> @@ -1116,28 +1073,17 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_list</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>string <parameter>base_dn</parameter></paramdef> - <paramdef>string <parameter>filter</parameter></paramdef> - <paramdef>array - <parameter><optional>attributes</optional></parameter></paramdef> - <paramdef>int - <parameter><optional>attrsonly</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>sizelimit</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>timelimit</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>deref</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_list</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>base_dn</parameter></methodparam> + <methodparam><type>string</type><parameter>filter</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>attributes</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>attrsonly</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>sizelimit</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timelimit</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>deref</parameter></methodparam> + </methodsynopsis> <para> Returns a search result identifier or &false; on error.</para> <para> @@ -1199,14 +1145,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_modify</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>string <parameter>dn</parameter></paramdef> - <paramdef>array <parameter>entry</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_modify</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>dn</parameter></methodparam> + <methodparam><type>array</type><parameter>entry</parameter></methodparam> + </methodsynopsis> <para> &return.success;</para> <para> @@ -1224,14 +1168,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_mod_add</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>string <parameter>dn</parameter></paramdef> - <paramdef>array <parameter>entry</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_mod_add</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>dn</parameter></methodparam> + <methodparam><type>array</type><parameter>entry</parameter></methodparam> + </methodsynopsis> <para> &return.success;</para> <para> @@ -1250,14 +1192,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_mod_del</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>string <parameter>dn</parameter></paramdef> - <paramdef>array <parameter>entry</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_mod_del</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>dn</parameter></methodparam> + <methodparam><type>array</type><parameter>entry</parameter></methodparam> + </methodsynopsis> <para> &return.success;</para> <para> @@ -1276,14 +1216,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_mod_replace</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>string <parameter>dn</parameter></paramdef> - <paramdef>array <parameter>entry</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_mod_replace</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>dn</parameter></methodparam> + <methodparam><type>array</type><parameter>entry</parameter></methodparam> + </methodsynopsis> <para> &return.success;</para> <para> @@ -1302,14 +1240,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ldap_next_attribute</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>int <parameter>result_entry_identifier</parameter></paramdef> - <paramdef>int <parameter>ber_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ldap_next_attribute</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>result_entry_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>ber_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns the next attribute in an entry on success and &false; on error.</para> @@ -1334,13 +1270,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_next_entry</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>int <parameter>result_entry_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_next_entry</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>result_entry_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns entry identifier for the next entry in the result whose entries are being read starting with @@ -1369,28 +1303,17 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_read</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>string <parameter>base_dn</parameter></paramdef> - <paramdef>string <parameter>filter</parameter></paramdef> - <paramdef>array - <parameter><optional>attributes</optional></parameter></paramdef> - <paramdef>int - <parameter><optional>attrsonly</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>sizelimit</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>timelimit</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>deref</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_read</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>base_dn</parameter></methodparam> + <methodparam><type>string</type><parameter>filter</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>attributes</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>attrsonly</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>sizelimit</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timelimit</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>deref</parameter></methodparam> + </methodsynopsis> <para> Returns a search result identifier or &false; on error.</para> <para> @@ -1433,16 +1356,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ldap_rename</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>string <parameter>dn</parameter></paramdef> - <paramdef>string <parameter>newrdn</parameter></paramdef> - <paramdef>string <parameter>newparent</parameter></paramdef> - <paramdef>bool <parameter>deleteoldrdn</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ldap_rename</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>dn</parameter></methodparam> + <methodparam><type>string</type><parameter>newrdn</parameter></methodparam> + <methodparam><type>string</type><parameter>newparent</parameter></methodparam> + <methodparam><type>bool</type><parameter>deleteoldrdn</parameter></methodparam> + </methodsynopsis> <para> The entry specified by <parameter>dn</parameter> is renamed/moved. The new RDN is specified by <parameter>newrdn</parameter> and the @@ -1470,29 +1391,17 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_search</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>string <parameter>base_dn</parameter></paramdef> - <paramdef>string <parameter>filter</parameter></paramdef> - <paramdef>array - <parameter><optional>attributes</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>attrsonly</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>sizelimit</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>timelimit</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>deref</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_search</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>string</type><parameter>base_dn</parameter></methodparam> + <methodparam><type>string</type><parameter>filter</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>attributes</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>attrsonly</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>sizelimit</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timelimit</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>deref</parameter></methodparam> + </methodsynopsis> <para> Returns a search result identifier or &false; on error.</para> <para> @@ -1637,14 +1546,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ldap_set_option</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - <paramdef>int <parameter>option</parameter></paramdef> - <paramdef>mixed <parameter>newval</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ldap_set_option</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>option</parameter></methodparam> + <methodparam><type>mixed</type><parameter>newval</parameter></methodparam> + </methodsynopsis> <para> Sets the value of the specified option to be <parameter>newval</parameter>. &return.success; @@ -1724,12 +1631,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_unbind</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_unbind</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> &return.success;</para> <para> @@ -1747,12 +1652,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ldap_8859_to_t61</function></funcdef> - <paramdef>string <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ldap_8859_to_t61</methodname> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1770,13 +1673,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_first_reference</function></funcdef> - <paramdef>int <parameter>link</parameter></paramdef> - <paramdef>int <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_first_reference</methodname> + <methodparam><type>int</type><parameter>link</parameter></methodparam> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1794,13 +1695,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_next_reference</function></funcdef> - <paramdef>int <parameter>link</parameter></paramdef> - <paramdef>int <parameter>entry</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_next_reference</methodname> + <methodparam><type>int</type><parameter>link</parameter></methodparam> + <methodparam><type>int</type><parameter>entry</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1818,14 +1717,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>ldap_parse_reference</function></funcdef> - <paramdef>int <parameter>link</parameter></paramdef> - <paramdef>int <parameter>entry</parameter></paramdef> - <paramdef>array <parameter>referrals</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>ldap_parse_reference</methodname> + <methodparam><type>int</type><parameter>link</parameter></methodparam> + <methodparam><type>int</type><parameter>entry</parameter></methodparam> + <methodparam><type>array</type><parameter>referrals</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1843,17 +1740,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>ldap_parse_result</function></funcdef> - <paramdef>int <parameter>link</parameter></paramdef> - <paramdef>int <parameter>result</parameter></paramdef> - <paramdef>int <parameter>errcode</parameter></paramdef> - <paramdef>string <parameter>matcheddn</parameter></paramdef> - <paramdef>string <parameter>errmsg</parameter></paramdef> - <paramdef>array <parameter>referrals</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>ldap_parse_result</methodname> + <methodparam><type>int</type><parameter>link</parameter></methodparam> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>errcode</parameter></methodparam> + <methodparam><type>string</type><parameter>matcheddn</parameter></methodparam> + <methodparam><type>string</type><parameter>errmsg</parameter></methodparam> + <methodparam><type>array</type><parameter>referrals</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1871,13 +1766,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_set_rebind_proc</function></funcdef> - <paramdef>int <parameter>link</parameter></paramdef> - <paramdef>string <parameter>callback</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_set_rebind_proc</methodname> + <methodparam><type>int</type><parameter>link</parameter></methodparam> + <methodparam><type>string</type><parameter>callback</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1895,14 +1788,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_sort</function></funcdef> - <paramdef>int <parameter>link</parameter></paramdef> - <paramdef>int <parameter>result</parameter></paramdef> - <paramdef>string <parameter>sortfilter</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_sort</methodname> + <methodparam><type>int</type><parameter>link</parameter></methodparam> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam><type>string</type><parameter>sortfilter</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1920,12 +1811,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ldap_start_tls</function></funcdef> - <paramdef>int <parameter>link</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ldap_start_tls</methodname> + <methodparam><type>int</type><parameter>link</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1943,12 +1832,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ldap_t61_to_8859</function></funcdef> - <paramdef>string <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ldap_t61_to_8859</methodname> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1977,3 +1864,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/mail.xml diff -u phpdoc/en/functions/mail.xml:1.36 phpdoc/en/functions/mail.xml:1.37 --- phpdoc/en/functions/mail.xml:1.36 Sat Jan 12 04:16:11 2002 +++ phpdoc/en/functions/mail.xml Sat Feb 2 10:36:02 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.36 $ --> +<!-- $Revision: 1.37 $ --> <reference id="ref.mail"> <title>Mail functions</title> <titleabbrev>Mail</titleabbrev> @@ -67,21 +67,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>mail</function></funcdef> - <paramdef>string <parameter>to</parameter></paramdef> - <paramdef>string <parameter>subject</parameter></paramdef> - <paramdef>string <parameter>message</parameter></paramdef> - <paramdef>string - <parameter><optional>additional_headers</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>additional_parameters</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>mail</methodname> + <methodparam><type>string</type><parameter>to</parameter></methodparam> + <methodparam><type>string</type><parameter>subject</parameter></methodparam> + <methodparam><type>string</type><parameter>message</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>additional_headers</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>additional_parameters + </parameter></methodparam> + </methodsynopsis> <simpara> <function>mail</function> automatically mails the message specified in <parameter>message</parameter> to the receiver @@ -236,12 +230,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ezmlm_hash</function></funcdef> - <paramdef>string <parameter>addr</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ezmlm_hash</methodname> + <methodparam><type>string</type><parameter>addr</parameter></methodparam> + </methodsynopsis> <simpara> <function>ezmlm_hash</function> calculates the hash value needed when keeping EZMLM mailing lists in a MySQL database. @@ -284,3 +276,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/mailparse.xml diff -u phpdoc/en/functions/mailparse.xml:1.2 phpdoc/en/functions/mailparse.xml:1.3 --- phpdoc/en/functions/mailparse.xml:1.2 Fri Dec 21 08:28:42 2001 +++ phpdoc/en/functions/mailparse.xml Sat Feb 2 10:36:02 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <reference id="ref.mailparse"> <title>mailparse functions</title> <titleabbrev>mailparse functions</titleabbrev> @@ -20,12 +20,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>mailparse_uudecode_all</function></funcdef> - <paramdef>resource <parameter>fp</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>mailparse_uudecode_all</methodname> + <methodparam><type>resource</type><parameter>fp</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -42,12 +40,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>mailparse_rfc822_parse_addresses</function></funcdef> - <paramdef>string <parameter>addresses</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>mailparse_rfc822_parse_addresses</methodname> + <methodparam><type>string</type><parameter>addresses</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -65,12 +61,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mailparse_determine_best_xfer_encoding</function></funcdef> - <paramdef>resource <parameter>fp</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mailparse_determine_best_xfer_encoding</methodname> + <methodparam><type>resource</type><parameter>fp</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -88,14 +82,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>mailparse_stream_encode</function></funcdef> - <paramdef>resource <parameter>sourcefp</parameter></paramdef> - <paramdef>resource <parameter>destfp</parameter></paramdef> - <paramdef>string <parameter>encoding</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>mailparse_stream_encode</methodname> + <methodparam><type>resource</type><parameter>sourcefp</parameter></methodparam> + <methodparam><type>resource</type><parameter>destfp</parameter></methodparam> + <methodparam><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -110,13 +102,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>mailparse_msg_parse</function></funcdef> - <paramdef>resource <parameter>rfc2045buf</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>mailparse_msg_parse</methodname> + <methodparam><type>resource</type><parameter>rfc2045buf</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -131,12 +121,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>mailparse_msg_parse_file</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>mailparse_msg_parse_file</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -151,12 +139,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>mailparse_msg_free</function></funcdef> - <paramdef>resource <parameter>rfc2045buf</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>mailparse_msg_free</methodname> + <methodparam><type>resource</type><parameter>rfc2045buf</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -171,12 +157,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mailparse_msg_create</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>mailparse_msg_create</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -191,12 +175,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>mailparse_msg_get_structure</function></funcdef> - <paramdef>resource <parameter>rfc2045</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>mailparse_msg_get_structure</methodname> + <methodparam><type>resource</type><parameter>rfc2045</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -214,16 +196,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>mailparse_msg_extract_part</function></funcdef> - <paramdef>resource <parameter>rfc2045</parameter></paramdef> - <paramdef>string <parameter>msgbody</parameter></paramdef> - <paramdef>string - <parameter><optional>callbackfunc</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>mailparse_msg_extract_part</methodname> + <methodparam><type>resource</type><parameter>rfc2045</parameter></methodparam> + <methodparam><type>string</type><parameter>msgbody</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>callbackfunc</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -238,16 +216,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mailparse_msg_extract_part_file</function></funcdef> - <paramdef>resource <parameter>rfc2045</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>string - <parameter><optional>callbackfunc</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mailparse_msg_extract_part_file</methodname> + <methodparam><type>resource</type><parameter>rfc2045</parameter></methodparam> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>callbackfunc</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -262,12 +236,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>mailparse_msg_get_part_data</function></funcdef> - <paramdef>resource <parameter>rfc2045</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>mailparse_msg_get_part_data</methodname> + <methodparam><type>resource</type><parameter>rfc2045</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -282,13 +254,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mailparse_msg_get_part</function></funcdef> - <paramdef>resource <parameter>rfc2045</parameter></paramdef> - <paramdef>string <parameter>mimesection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mailparse_msg_get_part</methodname> + <methodparam><type>resource</type><parameter>rfc2045</parameter></methodparam> + <methodparam><type>string</type><parameter>mimesection</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -318,4 +288,5 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/math.xml diff -u phpdoc/en/functions/math.xml:1.70 phpdoc/en/functions/math.xml:1.71 --- phpdoc/en/functions/math.xml:1.70 Tue Jan 29 17:07:49 2002 +++ phpdoc/en/functions/math.xml Sat Feb 2 10:36:02 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.70 $ --> +<!-- $Revision: 1.71 $ --> <reference id="ref.math"> <title>Mathematical Functions</title> <titleabbrev>Math</titleabbrev> @@ -133,12 +133,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>abs</function></funcdef> - <paramdef>mixed <parameter>number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>abs</methodname> + <methodparam><type>mixed</type><parameter>number</parameter></methodparam> + </methodsynopsis> <para> Returns the absolute value of number. If the argument number is of type <type>float</type>, the return type is also <type>float</type>, @@ -165,12 +163,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>acos</function></funcdef> - <paramdef>float <parameter>arg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>acos</methodname> + <methodparam><type>float</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <para> Returns the arc cosine of <parameter>arg</parameter> in radians. </para> @@ -188,12 +184,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>acosh</function></funcdef> - <paramdef>float <parameter>arg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>acosh</methodname> + <methodparam><type>float</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <para> Returns the inverse hyperbolic cosine of <parameter>arg</parameter>, i.e. the value whose @@ -214,12 +208,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>asin</function></funcdef> - <paramdef>float <parameter>arg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>asin</methodname> + <methodparam><type>float</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <para> Returns the arc sine of arg in radians. </para> @@ -237,12 +229,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>asinh</function></funcdef> - <paramdef>float <parameter>arg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>asinh</methodname> + <methodparam><type>float</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <para> Returns the inverse hyperbolic sine of <parameter>arg</parameter>, i.e. the value whose @@ -263,12 +253,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>atan</function></funcdef> - <paramdef>float <parameter>arg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>atan</methodname> + <methodparam><type>float</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <para> Returns the arc tangent of arg in radians. </para> @@ -286,12 +274,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>atanh</function></funcdef> - <paramdef>float <parameter>arg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>atanh</methodname> + <methodparam><type>float</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <para> Returns the inverse hyperbolic tangent of <parameter>arg</parameter>, i.e. the value whose @@ -312,13 +298,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>atan2</function></funcdef> - <paramdef>float <parameter>y</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>atan2</methodname> + <methodparam><type>float</type><parameter>y</parameter></methodparam> + <methodparam><type>float</type><parameter>x</parameter></methodparam> + </methodsynopsis> <simpara> This function calculates the arc tangent of the two variables <parameter>x</parameter> and <parameter>y</parameter>. It is @@ -344,14 +328,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>base_convert</function></funcdef> - <paramdef>string <parameter>number</parameter></paramdef> - <paramdef>int <parameter>frombase</parameter></paramdef> - <paramdef>int <parameter>tobase</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>base_convert</methodname> + <methodparam><type>string</type><parameter>number</parameter></methodparam> + <methodparam><type>int</type><parameter>frombase</parameter></methodparam> + <methodparam><type>int</type><parameter>tobase</parameter></methodparam> + </methodsynopsis> <para> Returns a string containing <parameter>number</parameter> represented in base <parameter>tobase</parameter>. The base in @@ -381,12 +363,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>bindec</function></funcdef> - <paramdef>string <parameter>binary_string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>bindec</methodname> + <methodparam><type>string</type><parameter>binary_string</parameter></methodparam> + </methodsynopsis> <para> Returns the decimal equivalent of the binary number represented by the binary_string argument. @@ -410,12 +390,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>ceil</function></funcdef> - <paramdef>float <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>ceil</methodname> + <methodparam><type>float</type><parameter>value</parameter></methodparam> + </methodsynopsis> <simpara> Returns the next highest integer value by rounding up <parameter>value</parameter> if necessary. @@ -446,12 +424,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>cos</function></funcdef> - <paramdef>float <parameter>arg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>cos</methodname> + <methodparam><type>float</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <para> Returns the cosine of arg in radians. </para> @@ -468,12 +444,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>cosh</function></funcdef> - <paramdef>float <parameter>arg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>cosh</methodname> + <methodparam><type>float</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <para> Returns the hyperbolic cosine of <parameter>arg</parameter>, defined as <literal>(exp(arg) + exp(-arg))/2</literal>. @@ -492,12 +466,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>decbin</function></funcdef> - <paramdef>int <parameter>number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>decbin</methodname> + <methodparam><type>int</type><parameter>number</parameter></methodparam> + </methodsynopsis> <para> Returns a string containing a binary representation of the given number argument. The largest number that can be converted is @@ -516,12 +488,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>dechex</function></funcdef> - <paramdef>int <parameter>number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>dechex</methodname> + <methodparam><type>int</type><parameter>number</parameter></methodparam> + </methodsynopsis> <para> Returns a string containing a hexadecimal representation of the given number argument. The largest number that can @@ -540,12 +510,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>decoct</function></funcdef> - <paramdef>int <parameter>number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>decoct</methodname> + <methodparam><type>int</type><parameter>number</parameter></methodparam> + </methodsynopsis> <para> Returns a string containing an octal representation of the given number argument. The largest number that can be converted is @@ -566,12 +534,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>deg2rad</function></funcdef> - <paramdef>float <parameter>number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>deg2rad</methodname> + <methodparam><type>float</type><parameter>number</parameter></methodparam> + </methodsynopsis> <para> This function converts <parameter>number</parameter> from degrees to the radian equivalent. @@ -589,12 +555,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>exp</function></funcdef> - <paramdef>float <parameter>arg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>exp</methodname> + <methodparam><type>float</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <para> Returns e raised to the power of <parameter>arg</parameter>. </para> @@ -614,12 +578,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>expm1</function></funcdef> - <paramdef>float <parameter>number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>expm1</methodname> + <methodparam><type>float</type><parameter>number</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -634,12 +596,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>floor</function></funcdef> - <paramdef>float <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>floor</methodname> + <methodparam><type>float</type><parameter>value</parameter></methodparam> + </methodsynopsis> <simpara> Returns the next lowest integer value by rounding down <parameter>value</parameter> if necessary. @@ -670,12 +630,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>getrandmax</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>getrandmax</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <simpara> Returns the maximum value that can be returned by a call to <function>rand</function>. @@ -695,12 +653,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>hexdec</function></funcdef> - <paramdef>string <parameter>hex_string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>hexdec</methodname> + <methodparam><type>string</type><parameter>hex_string</parameter></methodparam> + </methodsynopsis> <para> Returns the decimal equivalent of the hexadecimal number represented by the hex_string argument. <function>hexdec</function> converts a @@ -741,13 +697,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>hypot</function></funcdef> - <paramdef>float <parameter>num1</parameter></paramdef> - <paramdef>float <parameter>num2</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>hypot</methodname> + <methodparam><type>float</type><parameter>num1</parameter></methodparam> + <methodparam><type>float</type><parameter>num2</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -762,12 +716,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>lcg_value</function></funcdef> + <methodsynopsis> + <type>float</type><methodname>lcg_value</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> <function>lcg_value</function> returns a pseudo random number in the range of (0, 1). The function combines two CGs with periods @@ -784,12 +736,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>log</function></funcdef> - <paramdef>float <parameter>arg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>log</methodname> + <methodparam><type>float</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <para> Returns the natural logarithm of arg. </para> @@ -803,12 +753,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>log10</function></funcdef> - <paramdef>float <parameter>arg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>log10</methodname> + <methodparam><type>float</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <para> Returns the base-10 logarithm of <parameter>arg</parameter>. </para> @@ -825,12 +773,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>log1p</function></funcdef> - <paramdef>float <parameter>number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>log1p</methodname> + <methodparam><type>float</type><parameter>number</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -845,14 +791,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>max</function></funcdef> - <paramdef>mixed <parameter>arg1</parameter></paramdef> - <paramdef>mixed <parameter>arg2</parameter></paramdef> - <paramdef>mixed <parameter>argn</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>max</methodname> + <methodparam><type>mixed</type><parameter>arg1</parameter></methodparam> + <methodparam><type>mixed</type><parameter>arg2</parameter></methodparam> + <methodparam><type>mixed</type><parameter>argn</parameter></methodparam> + </methodsynopsis> <para> <function>max</function> returns the numerically highest of the parameter values. @@ -880,18 +824,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>number <function>min</function></funcdef> - <paramdef>number <parameter>arg1</parameter></paramdef> - <paramdef>number <parameter>arg2</parameter></paramdef> - <paramdef><parameter><optional>...</optional></parameter></paramdef> - </funcprototype> - <funcprototype> - <funcdef>number <function>min</function></funcdef> - <paramdef>array <parameter>numbers</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>number</type><methodname>min</methodname> + <methodparam><type>number</type><parameter>arg1</parameter></methodparam> + <methodparam><type>number</type><parameter>arg2</parameter></methodparam> + <methodparam choice="opt"><parameter>...</parameter></methodparam> + </methodsynopsis> + <methodsynopsis> + <type>number</type><methodname>min</methodname> + <methodparam><type>array</type><parameter>numbers</parameter></methodparam> + </methodsynopsis> <para> <function>min</function> returns the numerically lowest of the parameter values. @@ -922,21 +864,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mt_rand</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>mt_rand</methodname> <void/> - </funcprototype> - <funcprototype> - <funcdef>int <function>mt_rand</function></funcdef> - <paramdef>int - <parameter>min</parameter> - </paramdef> - <paramdef>int - <parameter>max</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + </methodsynopsis> + <methodsynopsis> + <type>int</type><methodname>mt_rand</methodname> + <methodparam><type>int</type><parameter>min</parameter></methodparam> + <methodparam><type>int</type><parameter>max</parameter></methodparam> + </methodsynopsis> <simpara> Many random number generators of older libcs have dubious or unknown characteristics and are slow. By default, PHP uses the @@ -989,12 +925,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>mt_srand</function></funcdef> - <paramdef>int <parameter>seed</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>mt_srand</methodname> + <methodparam><type>int</type><parameter>seed</parameter></methodparam> + </methodsynopsis> <para> Seeds the random number generator with <parameter>seed</parameter>. @@ -1028,12 +962,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mt_getrandmax</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>mt_getrandmax</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <simpara> Returns the maximum value that can be returned by a call to <function>mt_rand</function>. @@ -1054,15 +986,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>number_format</function></funcdef> - <paramdef>float <parameter>number</parameter></paramdef> - <paramdef>int <parameter><optional>decimals</optional></parameter></paramdef> - <paramdef>string <parameter><optional>dec_point</optional></parameter></paramdef> - <paramdef>string <parameter><optional>thousands_sep</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>number_format</methodname> + <methodparam><type>float</type><parameter>number</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>decimals</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>dec_point</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>thousands_sep</parameter></methodparam> + </methodsynopsis> <para> <function>number_format</function> returns a formatted version of <parameter>number</parameter>. This function accepts either one, @@ -1144,12 +1074,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>octdec</function></funcdef> - <paramdef>string <parameter>octal_string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>octdec</methodname> + <methodparam><type>string</type><parameter>octal_string</parameter></methodparam> + </methodsynopsis> <para> Returns the decimal equivalent of the octal number represented by the <parameter>octal_string</parameter> argument. @@ -1169,12 +1097,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>pi</function></funcdef> + <methodsynopsis> + <type>float</type><methodname>pi</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <simpara> Returns an approximation of pi. The returned <type>float</type> has a precision based on the @@ -1203,13 +1129,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>number <function>pow</function></funcdef> - <paramdef>number <parameter>base</parameter></paramdef> - <paramdef>number <parameter>exp</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>number</type><methodname>pow</methodname> + <methodparam><type>number</type><parameter>base</parameter></methodparam> + <methodparam><type>number</type><parameter>exp</parameter></methodparam> + </methodsynopsis> <para> Returns <parameter>base</parameter> raised to the power of <parameter>exp</parameter>. If possible, this function will @@ -1256,12 +1180,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>rad2deg</function></funcdef> - <paramdef>float <parameter>number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>rad2deg</methodname> + <methodparam><type>float</type><parameter>number</parameter></methodparam> + </methodsynopsis> <para> This function converts <parameter>number</parameter> from radian to degrees. @@ -1279,21 +1201,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>rand</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>rand</methodname> <void/> - </funcprototype> - <funcprototype> - <funcdef>int <function>rand</function></funcdef> - <paramdef>int - <parameter>min</parameter> - </paramdef> - <paramdef>int - <parameter>max</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + </methodsynopsis> + <methodsynopsis> + <type>int</type><methodname>rand</methodname> + <methodparam><type>int</type><parameter>min</parameter></methodparam> + <methodparam><type>int</type><parameter>max</parameter></methodparam> + </methodsynopsis> <simpara> If called without the optional <parameter>min</parameter>, <parameter>max</parameter> arguments <function>rand</function> @@ -1331,15 +1247,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>round</function></funcdef> - <paramdef>float <parameter>val</parameter></paramdef> - <paramdef>int - <parameter><optional>precision</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>round</methodname> + <methodparam><type>float</type><parameter>val</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>precision</parameter></methodparam> + </methodsynopsis> <para> Returns the rounded value of <parameter>val</parameter> to specified <parameter>precision</parameter> @@ -1391,12 +1303,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>sin</function></funcdef> - <paramdef>float <parameter>arg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>sin</methodname> + <methodparam><type>float</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <para> Returns the sine of arg in radians. </para> @@ -1413,12 +1323,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>sinh</function></funcdef> - <paramdef>float <parameter>arg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>sinh</methodname> + <methodparam><type>float</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <para> Returns the hyperbolic sine of <parameter>arg</parameter>, defined as <literal>(exp(arg) - exp(-arg))/2</literal>. @@ -1437,12 +1345,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>sqrt</function></funcdef> - <paramdef>float <parameter>arg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>sqrt</methodname> + <methodparam><type>float</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <para> Returns the square root of <parameter>arg</parameter>. </para> @@ -1459,12 +1365,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>srand</function></funcdef> - <paramdef>int <parameter>seed</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>srand</methodname> + <methodparam><type>int</type><parameter>seed</parameter></methodparam> + </methodsynopsis> <para> Seeds the random number generator with <parameter>seed</parameter>. @@ -1498,12 +1402,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>tan</function></funcdef> - <paramdef>float <parameter>arg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>tan</methodname> + <methodparam><type>float</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <para> Returns the tangent of arg in radians. </para> @@ -1520,12 +1422,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>tanh</function></funcdef> - <paramdef>float <parameter>arg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>tanh</methodname> + <methodparam><type>float</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <para> Returns the hyperbolic tangent of <parameter>arg</parameter>, defined as <literal>sinh(arg)/cosh(arg)</literal>. @@ -1559,3 +1459,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/mbstring.xml diff -u phpdoc/en/functions/mbstring.xml:1.20 phpdoc/en/functions/mbstring.xml:1.21 --- phpdoc/en/functions/mbstring.xml:1.20 Sun Jan 6 22:23:06 2002 +++ phpdoc/en/functions/mbstring.xml Sat Feb 2 10:36:02 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.20 $ --> +<!-- $Revision: 1.21 $ --> <reference id="ref.mbstring"> <title>Multi-Byte String Functions</title> <titleabbrev> @@ -532,14 +532,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string - <function>mb_language</function></funcdef> - <paramdef>string - <parameter><optional>language</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mb_language</methodname> + <methodparam choice="opt"><type>string</type><parameter>language</parameter></methodparam> + </methodsynopsis> <para> <function>mb_language</function> sets language. If <parameter>language</parameter> is omitted, it returns current @@ -579,19 +575,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean - <function>mb_parse_str</function> - </funcdef> - <paramdef>string - <parameter>encoded_string</parameter> - </paramdef> - <paramdef>array - <parameter><optional>result</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>mb_parse_str</methodname> + <methodparam><type>string</type><parameter>encoded_string</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> <function>mb_parse_str</function> parses GET/POST/COOKIE data and sets global variables. Since PHP does not provide raw POST/COOKIE @@ -626,14 +614,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string - <function>mb_internal_encoding</function></funcdef> - <paramdef>string - <parameter><optional>encoding</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mb_internal_encoding</methodname> + <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> <para> <function>mb_internal_encoding</function> sets internal character encoding to <parameter>encoding</parameter> If parameter is @@ -684,14 +668,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mb_http_input</function></funcdef> - <paramdef>string - <parameter><optional>type</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mb_http_input</methodname> + <methodparam choice="opt"><type>string</type><parameter>type</parameter></methodparam> + </methodsynopsis> <simpara> <function>mb_http_input</function> returns result of HTTP input character encoding detection. @@ -722,14 +702,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mb_http_output</function></funcdef> - <paramdef>string - <parameter><optional>encoding</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mb_http_output</methodname> + <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> <para> If <parameter>encoding</parameter> is set, <function>mb_http_output</function> sets HTTP output character @@ -761,14 +737,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>mb_detect_order</function></funcdef> - <paramdef>mixed - <parameter><optional>encoding-list</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>mb_detect_order</methodname> + <methodparam choice="opt"><type>mixed</type><parameter>encoding-list</parameter></methodparam> + </methodsynopsis> <para> <function>mb_detect_order</function> sets automatic character encoding detection order to <parameter>encoding-list</parameter>. @@ -862,14 +834,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>mb_substitute_character</function></funcdef> - <paramdef>mixed - <parameter><optional>substrchar</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>mb_substitute_character</methodname> + <methodparam choice="opt"><type>mixed</type><parameter>substrchar</parameter></methodparam> + </methodsynopsis> <para> <function>mb_substitute_character</function> specifies substitution character when input character encoding is invalid @@ -934,13 +902,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mb_output_handler</function></funcdef> - <paramdef>string <parameter>contents</parameter></paramdef> - <paramdef>int <parameter>status</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mb_output_handler</methodname> + <methodparam><type>string</type><parameter>contents</parameter></methodparam> + <methodparam><type>int</type><parameter>status</parameter></methodparam> + </methodsynopsis> <para> <function>mb_output_handler</function> is <function>ob_start</function> callback @@ -1008,12 +974,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mb_preferred_mime_name</function></funcdef> - <paramdef>string <parameter>encoding</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mb_preferred_mime_name</methodname> + <methodparam><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> <para> <function>mb_preferred_mime_name</function> returns MIME <literal>charset</literal> string for character encoding @@ -1043,15 +1007,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mb_strlen</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>string - <parameter><optional>encoding</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mb_strlen</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> <para> <function>mb_strlen</function> returns number of characters in string <parameter>str</parameter> having character encoding @@ -1079,19 +1039,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mb_strpos</function></funcdef> - <paramdef>string <parameter>haystack</parameter></paramdef> - <paramdef>string <parameter>needle</parameter></paramdef> - <paramdef>int - <parameter><optional>offset</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>encoding</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mb_strpos</methodname> + <methodparam><type>string</type><parameter>haystack</parameter></methodparam> + <methodparam><type>string</type><parameter>needle</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> <para> <function>mb_strpos</function> returns the numeric position of the first occurrence of <parameter>needle</parameter> in the @@ -1138,16 +1092,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mb_strrpos</function></funcdef> - <paramdef>string <parameter>haystack</parameter></paramdef> - <paramdef>string <parameter>needle</parameter></paramdef> - <paramdef>string - <parameter><optional>encoding</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mb_strrpos</methodname> + <methodparam><type>string</type><parameter>haystack</parameter></methodparam> + <methodparam><type>string</type><parameter>needle</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> <para> <function>mb_strrpos</function> returns the numeric position of the last occurrence of <parameter>needle</parameter> in the @@ -1187,19 +1137,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mb_substr</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>int <parameter>start</parameter></paramdef> - <paramdef>int - <parameter><optional>length</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>encoding</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mb_substr</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam><type>int</type><parameter>start</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> <para> <function>mb_substr</function> returns the portion of <parameter>str</parameter> specified by the @@ -1236,19 +1180,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mb_strcut</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>int <parameter>start</parameter></paramdef> - <paramdef>int - <parameter><optional>length</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>encoding</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mb_strcut</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam><type>int</type><parameter>start</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> <para> <function>mb_strcut</function> returns the portion of <parameter>str</parameter> specified by the @@ -1286,15 +1224,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mb_strwidth</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>string - <parameter><optional>encoding</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mb_strwidth</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> <para> <function>mb_strwidth</function> returns width of string <parameter>str</parameter>. @@ -1336,18 +1270,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mb_strimwidth</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>int <parameter>start</parameter></paramdef> - <paramdef>int <parameter>width</parameter></paramdef> - <paramdef>string <parameter>trimmarker</parameter></paramdef> - <paramdef>string - <parameter><optional>encoding</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mb_strimwidth</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam><type>int</type><parameter>start</parameter></methodparam> + <methodparam><type>int</type><parameter>width</parameter></methodparam> + <methodparam><type>string</type><parameter>trimmarker</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> <para> <function>mb_strimwidth</function> truncates string <parameter>str</parameter> to specified @@ -1393,16 +1323,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mb_convert_encoding</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>string <parameter>to-encoding</parameter></paramdef> - <paramdef>mixed - <parameter><optional>from-encoding</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mb_convert_encoding</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam><type>string</type><parameter>to-encoding</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>from-encoding</parameter></methodparam> + </methodsynopsis> <para> <function>mb_convert_encoding</function> converts character encoding of string <parameter>str</parameter> from @@ -1450,15 +1376,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mb_detect_encoding</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>mixed - <parameter><optional>encoding-list</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mb_detect_encoding</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>encoding-list</parameter></methodparam> + </methodsynopsis> <para> <function>mb_detect_encoding</function> detects character encoding in string <parameter>str</parameter>. It returns @@ -1511,16 +1433,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mb_convert_kana</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>string <parameter>option</parameter></paramdef> - <paramdef>mixed - <parameter><optional>encoding</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mb_convert_kana</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam><type>string</type><parameter>option</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> <para> <function>mb_convert_kana</function> performs "han-kaku" - "zen-kaku" conversion for string <parameter>str</parameter>. It @@ -1588,21 +1506,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mb_encode_mimeheader</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>string - <parameter><optional>charset</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>transfer-encoding</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>linefeed</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mb_encode_mimeheader</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>transfer-encoding</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>linefeed</parameter></methodparam> + </methodsynopsis> <para> <function>mb_encode_mimeheader</function> converts string <parameter>str</parameter> to encoded-word for header field. @@ -1649,12 +1559,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mb_decode_mimeheader</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mb_decode_mimeheader</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> <function>mb_decode_mimeheader</function> decodes encoded-word string <parameter>str</parameter> in MIME header. @@ -1675,14 +1583,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mb_convert_variables</function></funcdef> - <paramdef>string <parameter>to-encoding</parameter></paramdef> - <paramdef>mixed <parameter>from-encoding</parameter></paramdef> - <paramdef>mixed <parameter>vars</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mb_convert_variables</methodname> + <methodparam><type>string</type><parameter>to-encoding</parameter></methodparam> + <methodparam><type>mixed</type><parameter>from-encoding</parameter></methodparam> + <methodparam><type>mixed</type><parameter>vars</parameter></methodparam> + </methodsynopsis> <para> <function>mb_convert_variables</function> convert character encoding of variables <parameter>vars</parameter> in @@ -1733,16 +1639,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mb_encode_numericentity</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>array <parameter>convmap</parameter></paramdef> - <paramdef>string - <parameter><optional>encoding</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mb_encode_numericentity</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam><type>array</type><parameter>convmap</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> <para> <function>mb_encode_numericentity</function> converts specified character codes in string <parameter>str</parameter> @@ -1817,16 +1719,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mb_decode_numericentity</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>array <parameter>convmap</parameter></paramdef> - <paramdef>string - <parameter><optional>encoding</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mb_decode_numericentity</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam><type>array</type><parameter>convmap</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> <para> Convert numeric string reference of string <parameter>str</parameter> in specified block to character. It @@ -1872,20 +1770,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>mb_send_mail</function></funcdef> - <paramdef>string <parameter>to</parameter></paramdef> - <paramdef>string <parameter>subject</parameter></paramdef> - <paramdef>string <parameter>message</parameter></paramdef> - <paramdef>string - <parameter><optional>additional_headers</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>additional_parameter</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>mb_send_mail</methodname> + <methodparam><type>string</type><parameter>to</parameter></methodparam> + <methodparam><type>string</type><parameter>subject</parameter></methodparam> + <methodparam><type>string</type><parameter>message</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>additional_headers</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>additional_parameter</parameter></methodparam> + </methodsynopsis> <para> <function>mb_send_mail</function> sends email. Headers and message are converted and encoded according to @@ -1934,14 +1826,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mb_get_info</function></funcdef> - <paramdef>string - <parameter><optional>type</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mb_get_info</methodname> + <methodparam choice="opt"><type>string</type><parameter>type</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <simpara> <function>mb_get_info</function> returns internal setting @@ -1986,3 +1874,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/mcal.xml diff -u phpdoc/en/functions/mcal.xml:1.28 phpdoc/en/functions/mcal.xml:1.29 --- phpdoc/en/functions/mcal.xml:1.28 Sat Dec 15 09:45:44 2001 +++ phpdoc/en/functions/mcal.xml Sat Feb 2 10:36:02 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.28 $ --> +<!-- $Revision: 1.29 $ --> <reference id="ref.mcal"> <title>MCAL functions</title> <titleabbrev>MCAL</titleabbrev> @@ -136,15 +136,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_open</function></funcdef> - <paramdef>string <parameter>calendar</parameter></paramdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>int <parameter><optional>options</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_open</methodname> + <methodparam><type>string</type><parameter>calendar</parameter></methodparam> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> <para> Returns an MCAL stream on success, &false; on error. </para> @@ -165,15 +163,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_popen</function></funcdef> - <paramdef>string <parameter>calendar</parameter></paramdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>int <parameter><optional>options</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_popen</methodname> + <methodparam><type>string</type><parameter>calendar</parameter></methodparam> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> <para> Returns an MCAL stream on success, &false; on error. </para> @@ -194,13 +190,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_reopen</function></funcdef> - <paramdef>string <parameter>calendar</parameter></paramdef> - <paramdef>int <parameter><optional>options</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_reopen</methodname> + <methodparam><type>string</type><parameter>calendar</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> <para> Reopens an MCAL stream to a new calendar. </para> @@ -220,13 +214,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_close</function></funcdef> - <paramdef>int <parameter>mcal_stream</parameter></paramdef> - <paramdef>int <parameter>flags</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_close</methodname> + <methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> Closes the given mcal stream. </para> @@ -240,13 +232,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mcal_create_calendar</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>string <parameter>calendar</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mcal_create_calendar</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>string</type><parameter>calendar</parameter></methodparam> + </methodsynopsis> <para> Creates a new calendar named <parameter>calendar</parameter>. </para> @@ -260,14 +250,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mcal_rename_calendar</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>string <parameter>old_name</parameter></paramdef> - <paramdef>string <parameter>new_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mcal_rename_calendar</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>string</type><parameter>old_name</parameter></methodparam> + <methodparam><type>string</type><parameter>new_name</parameter></methodparam> + </methodsynopsis> <para> Renames the calendar <parameter>old_name</parameter> to <parameter>new_name</parameter>. @@ -282,13 +270,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mcal_delete_calendar</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>string <parameter>calendar</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mcal_delete_calendar</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>string</type><parameter>calendar</parameter></methodparam> + </methodsynopsis> <para> Deletes the calendar named <parameter>calendar</parameter>. </para> @@ -304,14 +290,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>mcal_fetch_event</function></funcdef> - <paramdef>int <parameter>mcal_stream</parameter></paramdef> - <paramdef>int <parameter>event_id</parameter></paramdef> - <paramdef>int <parameter><optional>options</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>mcal_fetch_event</methodname> + <methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam> + <methodparam><type>int</type><parameter>event_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_fetch_event</function> fetches an event from the calendar stream specified by <parameter>id</parameter>. @@ -395,16 +379,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>mcal_list_events</function></funcdef> - <paramdef>int <parameter>mcal_stream</parameter></paramdef> - <paramdef>object<parameter>begin_date</parameter></paramdef> - <paramdef>object - <parameter><optional>end_date</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>mcal_list_events</methodname> + <methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam> + <methodparam><type>object</type><parameter>begin_date</parameter></methodparam> + <methodparam choice="opt"><type>object</type><parameter>end_date</parameter></methodparam> + </methodsynopsis> <para> Returns an array of ID's that are between the start and end dates, or if just a stream is given, uses the start and end dates @@ -427,12 +407,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_append_event</function></funcdef> - <paramdef>int <parameter>mcal_stream</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_append_event</methodname> + <methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_append_event</function> Stores the global event into an MCAL calendar for the given stream. @@ -451,12 +429,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_store_event</function></funcdef> - <paramdef>int <parameter>mcal_stream</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_store_event</methodname> + <methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_store_event</function> Stores the modifications to the current global event for the given stream. @@ -475,13 +451,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_delete_event</function></funcdef> - <paramdef>int <parameter>mcal_stream</parameter></paramdef> - <paramdef>int <parameter><optional>event_id</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_delete_event</methodname> + <methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>event_id</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_delete_event</function> deletes the calendar event specified by the event_id.</para> @@ -498,12 +472,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_snooze</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_snooze</methodname> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_snooze</function> turns off an alarm for a calendar event specified by the id. @@ -524,30 +496,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>mcal_list_alarms</function></funcdef> - <paramdef>int <parameter>mcal_stream</parameter></paramdef> - <paramdef>int - <parameter><optional>begin_year</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>begin_month</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>begin_day</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>end_year</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>end_month</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>end_day</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>mcal_list_alarms</methodname> + <methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>begin_year</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>begin_month</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>begin_day</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>end_year</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>end_month</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>end_day</parameter></methodparam> + </methodsynopsis> <para> Returns an array of event ID's that has an alarm going off between the start and end dates, or if just a stream is given, @@ -571,12 +529,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_event_init</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_event_init</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_event_init</function> initializes a streams global event structure. this effectively sets all elements of the @@ -597,13 +553,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_event_set_category</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>string <parameter>category</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_event_set_category</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>string</type><parameter>category</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_event_set_category</function> sets the streams global event structure's category to the given string. @@ -623,13 +577,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_event_set_title</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>string <parameter>title</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_event_set_title</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>string</type><parameter>title</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_event_set_title</function> sets the streams global event structure's title to the given string. @@ -649,15 +601,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>mcal_event_set_description</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>string <parameter>description</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_event_set_description</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>string</type><parameter>description</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_event_set_description</function> sets the streams global event structure's description to the given string. @@ -678,33 +626,23 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_event_set_start</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int - <parameter> - <optional>day</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>hour</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>min</optional></parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>sec</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_event_set_start</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + day + </parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + hour + </parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + min</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + sec + </parameter></methodparam> + </methodsynopsis> <para> <function>mcal_event_set_start</function> sets the streams global event structure's start date and time to the given values. @@ -724,34 +662,24 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_event_set_end</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int - <parameter> - <optional>day</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>hour</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>min</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>sec</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_event_set_end</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + day + </parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + hour + </parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + min + </parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + sec + </parameter></methodparam> + </methodsynopsis> <para> <function>mcal_event_set_end</function> sets the streams global event structure's end date and time to the given values. @@ -771,13 +699,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_event_set_alarm</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>alarm</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_event_set_alarm</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>int</type><parameter>alarm</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_event_set_alarm</function> sets the streams global event structure's alarm to the given minutes before the event. @@ -797,13 +723,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_event_set_class</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>class</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_event_set_class</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>int</type><parameter>class</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_event_set_class</function> sets the streams global event structure's class to the given value. The class is either 1 @@ -825,12 +749,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_is_leap_year</function></funcdef> - <paramdef>int <parameter>year</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_is_leap_year</methodname> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_is_leap_year</function> returns 1 if the given year is a leap year, 0 if not. @@ -847,13 +769,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_days_in_month</function></funcdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>leap year</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_days_in_month</methodname> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam><type>int</type><parameter>leap year</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_days_in_month</function> Returns the number of days in the given month, taking into account if the given year is @@ -871,14 +791,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_date_valid</function></funcdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_date_valid</methodname> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam><type>int</type><parameter>day</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_date_valid</function> Returns &true; if the given year, month and day is a valid date, &false; if not. @@ -895,14 +813,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_time_valid</function></funcdef> - <paramdef>int <parameter>hour</parameter></paramdef> - <paramdef>int <parameter>minutes</parameter></paramdef> - <paramdef>int <parameter>seconds</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_time_valid</methodname> + <methodparam><type>int</type><parameter>hour</parameter></methodparam> + <methodparam><type>int</type><parameter>minutes</parameter></methodparam> + <methodparam><type>int</type><parameter>seconds</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_time_valid</function> Returns &true; if the given hour, minutes and seconds is a valid time, &false; if not. @@ -919,14 +835,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_day_of_week</function></funcdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_day_of_week</methodname> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam><type>int</type><parameter>day</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_day_of_week</function> returns the day of the week of the given date. @@ -945,14 +859,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_</function></funcdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_</methodname> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam><type>int</type><parameter>day</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_day_of_year</function> returns the day of the year of the given date. @@ -967,17 +879,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_date_compare</function></funcdef> - <paramdef>int <parameter>a_year</parameter></paramdef> - <paramdef>int <parameter>a_month</parameter></paramdef> - <paramdef>int <parameter>a_day</parameter></paramdef> - <paramdef>int <parameter>b_year</parameter></paramdef> - <paramdef>int <parameter>b_month</parameter></paramdef> - <paramdef>int <parameter>b_day</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_date_compare</methodname> + <methodparam><type>int</type><parameter>a_year</parameter></methodparam> + <methodparam><type>int</type><parameter>a_month</parameter></methodparam> + <methodparam><type>int</type><parameter>a_day</parameter></methodparam> + <methodparam><type>int</type><parameter>b_year</parameter></methodparam> + <methodparam><type>int</type><parameter>b_month</parameter></methodparam> + <methodparam><type>int</type><parameter>b_day</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_date_compare</function> Compares the two given dates, returns &lt;0, 0, >0 if a&lt;b, a==b, a>b respectively. @@ -992,14 +902,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_next_recurrence</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>weekstart</parameter></paramdef> - <paramdef>array <parameter>next</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_next_recurrence</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>int</type><parameter>weekstart</parameter></methodparam> + <methodparam><type>array</type><parameter>next</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_next_recurrence</function> returns an object filled with the next date the event occurs, on or after the @@ -1019,14 +927,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>mcal_event_set_recur_none</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_event_set_recur_none</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_event_set_recur_none</function> sets the streams global event structure to not recur (event->recur_type is set to @@ -1044,18 +948,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>mcal_event_set_recur_daily</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>interval</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_event_set_recur_daily</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam><type>int</type><parameter>day</parameter></methodparam> + <methodparam><type>int</type><parameter>interval</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_event_set_recur_daily</function> sets the streams global event structure's recurrence to the given value to be @@ -1073,19 +973,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>mcal_event_set_recur_weekly</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>interval</parameter></paramdef> - <paramdef>int <parameter>weekdays</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_event_set_recur_weekly</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam><type>int</type><parameter>day</parameter></methodparam> + <methodparam><type>int</type><parameter>interval</parameter></methodparam> + <methodparam><type>int</type><parameter>weekdays</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_event_set_recur_weekly</function> sets the streams global event structure's recurrence to the given value to be @@ -1103,18 +999,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>mcal_event_set_recur_monthly_mday</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>interval</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_event_set_recur_monthly_mday</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam><type>int</type><parameter>day</parameter></methodparam> + <methodparam><type>int</type><parameter>interval</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_event_set_recur_monthly_mday</function> sets the streams global event structure's recurrence to the given value to @@ -1133,18 +1025,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>mcal_event_set_recur_monthly_wday</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>interval</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_event_set_recur_monthly_wday</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam><type>int</type><parameter>day</parameter></methodparam> + <methodparam><type>int</type><parameter>interval</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_event_set_recur_monthly_wday</function> sets the streams global event structure's recurrence to the given value to @@ -1163,18 +1051,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>mcal_event_set_recur_yearly</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>interval</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_event_set_recur_yearly</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam><type>int</type><parameter>day</parameter></methodparam> + <methodparam><type>int</type><parameter>interval</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_event_set_recur_yearly</function> sets the streams global event structure's recurrence to the given value to be @@ -1192,14 +1076,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object - <function>mcal_fetch_current_stream_event</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>mcal_fetch_current_stream_event</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_fetch_current_stream_event</function> returns the current stream's event structure as an object @@ -1265,16 +1145,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>mcal_event_add_attribute</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>string <parameter>attribute</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>mcal_event_add_attribute</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + <methodparam><type>string</type><parameter>attribute</parameter></methodparam> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_event_add_attribute</function> adds an attribute to the stream's global event structure with the value given by @@ -1292,14 +1168,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>mcal_expunge</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_expunge</methodname> + <methodparam><type>int</type><parameter>stream</parameter></methodparam> + </methodsynopsis> <para> <function>mcal_expunge</function> Deletes all events which have been previously marked for deletion. @@ -1316,14 +1188,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcal_week_of_year</function></funcdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcal_week_of_year</methodname> + <methodparam><type>int</type><parameter>day</parameter></methodparam> + <methodparam><type>int</type><parameter>month</parameter></methodparam> + <methodparam><type>int</type><parameter>year</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1352,3 +1222,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/mcrypt.xml diff -u phpdoc/en/functions/mcrypt.xml:1.27 phpdoc/en/functions/mcrypt.xml:1.28 --- phpdoc/en/functions/mcrypt.xml:1.27 Sun Dec 16 04:10:54 2001 +++ phpdoc/en/functions/mcrypt.xml Sat Feb 2 10:36:02 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.27 $ --> +<!-- $Revision: 1.28 $ --> <reference id="ref.mcrypt"> <title>Mcrypt Encryption Functions</title> <titleabbrev>mcrypt</titleabbrev> @@ -375,18 +375,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mcrypt_get_cipher_name</function></funcdef> - <paramdef>int <parameter>cipher</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mcrypt_get_cipher_name</function></funcdef> - <paramdef>string <parameter>cipher</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mcrypt_get_cipher_name</methodname> + <methodparam><type>int</type><parameter>cipher</parameter></methodparam> + </methodsynopsis> + <methodsynopsis> + <type>string</type><methodname>mcrypt_get_cipher_name</methodname> + <methodparam><type>string</type><parameter>cipher</parameter></methodparam> + </methodsynopsis> <para> <function>mcrypt_get_cipher_name</function> is used to get the name of the specified cipher. @@ -429,17 +425,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcrypt_get_block_size</function></funcdef> - <paramdef>int <parameter>cipher</parameter></paramdef> - </funcprototype> - <funcprototype> - <funcdef>int <function>mcrypt_get_block_size</function></funcdef> - <paramdef>string <parameter>cipher</parameter></paramdef> - <paramdef>string <parameter>module</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcrypt_get_block_size</methodname> + <methodparam><type>int</type><parameter>cipher</parameter></methodparam> + </methodsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcrypt_get_block_size</methodname> + <methodparam><type>string</type><parameter>cipher</parameter></methodparam> + <methodparam><type>string</type><parameter>module</parameter></methodparam> + </methodsynopsis> <para> The first prototype is when linked against libmcrypt 2.2.x, the second when linked against libmcrypt 2.4.x. @@ -466,17 +460,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcrypt_get_key_size</function></funcdef> - <paramdef>int <parameter>cipher</parameter></paramdef> - </funcprototype> - <funcprototype> - <funcdef>int <function>mcrypt_get_key_size</function></funcdef> - <paramdef>string <parameter>cipher</parameter></paramdef> - <paramdef>string <parameter>module</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcrypt_get_key_size</methodname> + <methodparam><type>int</type><parameter>cipher</parameter></methodparam> + </methodsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcrypt_get_key_size</methodname> + <methodparam><type>string</type><parameter>cipher</parameter></methodparam> + <methodparam><type>string</type><parameter>module</parameter></methodparam> + </methodsynopsis> <para> The first prototype is when linked against libmcrypt 2.2.x, the second when linked against libmcrypt 2.4.x. @@ -505,14 +497,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string - <function>mcrypt_create_iv</function></funcdef> - <paramdef>int <parameter>size</parameter></paramdef> - <paramdef>int <parameter>source</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mcrypt_create_iv</methodname> + <methodparam><type>int</type><parameter>size</parameter></methodparam> + <methodparam><type>int</type><parameter>source</parameter></methodparam> + </methodsynopsis> <para> <function>mcrypt_create_iv</function> is used to create an IV. </para> @@ -552,30 +541,22 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mcrypt_cbc</function></funcdef> - <paramdef>int <parameter>cipher</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - <paramdef>string - <parameter><optional>iv</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mcrypt_cbc</function></funcdef> - <paramdef>string <parameter>cipher</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - <paramdef>string - <parameter><optional>iv</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mcrypt_cbc</methodname> + <methodparam><type>int</type><parameter>cipher</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>iv</parameter></methodparam> + </methodsynopsis> + <methodsynopsis> + <type>string</type><methodname>mcrypt_cbc</methodname> + <methodparam><type>string</type><parameter>cipher</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>iv</parameter></methodparam> + </methodsynopsis> <para> The first prototype is when linked against libmcrypt 2.2.x, the second when linked against libmcrypt 2.4.x. @@ -619,28 +600,22 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mcrypt_cfb</function></funcdef> - <paramdef>int <parameter>cipher</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - <paramdef>string <parameter>iv</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mcrypt_cfb</function></funcdef> - <paramdef>string <parameter>cipher</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - <paramdef>string - <parameter><optional>iv</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mcrypt_cfb</methodname> + <methodparam><type>int</type><parameter>cipher</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + <methodparam><type>string</type><parameter>iv</parameter></methodparam> + </methodsynopsis> + <methodsynopsis> + <type>string</type><methodname>mcrypt_cfb</methodname> + <methodparam><type>string</type><parameter>cipher</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>iv</parameter></methodparam> + </methodsynopsis> <para> The first prototype is when linked against libmcrypt 2.2.x, the second when linked against libmcrypt 2.4.x. @@ -684,27 +659,21 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mcrypt_ecb</function></funcdef> - <paramdef>int <parameter>cipher</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mcrypt_ecb</function></funcdef> - <paramdef>string <parameter>cipher</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - <paramdef>string - <parameter><optional>iv</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mcrypt_ecb</methodname> + <methodparam><type>int</type><parameter>cipher</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> + <methodsynopsis> + <type>string</type><methodname>mcrypt_ecb</methodname> + <methodparam><type>string</type><parameter>cipher</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>iv</parameter></methodparam> + </methodsynopsis> <para> The first prototype is when linked against libmcrypt 2.2.x, the second when linked against libmcrypt 2.4.x. @@ -745,28 +714,22 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mcrypt_ofb</function></funcdef> - <paramdef>int <parameter>cipher</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - <paramdef>string <parameter>iv</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mcrypt_ofb</function></funcdef> - <paramdef>string <parameter>cipher</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - <paramdef>string - <parameter><optional>iv</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mcrypt_ofb</methodname> + <methodparam><type>int</type><parameter>cipher</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + <methodparam><type>string</type><parameter>iv</parameter></methodparam> + </methodsynopsis> + <methodsynopsis> + <type>string</type><methodname>mcrypt_ofb</methodname> + <methodparam><type>string</type><parameter>cipher</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>iv</parameter></methodparam> + </methodsynopsis> <para> The first prototype is when linked against libmcrypt 2.2.x, the second when linked against libmcrypt 2.4.x. @@ -810,16 +773,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>mcrypt_list_algorithms</function></funcdef> - <paramdef>string - <parameter> - <optional>lib_dir</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>mcrypt_list_algorithms</methodname> + <methodparam choice="opt"><type>string</type><parameter> + lib_dir + </parameter></methodparam> + </methodsynopsis> <para> <function>mcrypt_list_algorithms</function> is used to get an array of all supported algorithms in the @@ -861,16 +820,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>mcrypt_list_modes</function></funcdef> - <paramdef>string - <parameter> - <optional>lib_dir</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>mcrypt_list_modes</methodname> + <methodparam choice="opt"><type>string</type><parameter> + lib_dir + </parameter></methodparam> + </methodsynopsis> <para> <function>mcrypt_list_modes</function> is used to get an array of all supported modes in the @@ -914,17 +869,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcrypt_get_iv_size</function></funcdef> - <paramdef>string <parameter>cipher</parameter></paramdef> - <paramdef>string <parameter>mode</parameter></paramdef> - </funcprototype> - <funcprototype> - <funcdef>int <function>mcrypt_get_iv_size</function></funcdef> - <paramdef>resource <parameter>td</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcrypt_get_iv_size</methodname> + <methodparam><type>string</type><parameter>cipher</parameter></methodparam> + <methodparam><type>string</type><parameter>mode</parameter></methodparam> + </methodsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcrypt_get_iv_size</methodname> + <methodparam><type>resource</type><parameter>td</parameter></methodparam> + </methodsynopsis> <para> The first prototype is when linked against libmcrypt 2.2.x, the second when linked against libmcrypt 2.4.x. @@ -957,20 +910,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mcrypt_encrypt</function></funcdef> - <paramdef>string <parameter>cipher</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>string <parameter>mode</parameter></paramdef> - <paramdef>string - <parameter> - <optional>iv</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mcrypt_encrypt</methodname> + <methodparam><type>string</type><parameter>cipher</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>string</type><parameter>mode</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + iv + </parameter></methodparam> + </methodsynopsis> <para> <function>mcrypt_encrypt</function> encrypts the data and returns the encrypted data. @@ -1042,20 +991,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mcrypt_decrypt</function></funcdef> - <paramdef>string <parameter>cipher</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>string <parameter>mode</parameter></paramdef> - <paramdef>string - <parameter> - <optional>iv</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mcrypt_decrypt</methodname> + <methodparam><type>string</type><parameter>cipher</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>string</type><parameter>mode</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + iv + </parameter></methodparam> + </methodsynopsis> <para> <function>mcrypt_decrypt</function> decrypts the data and returns the unencrypted data. @@ -1096,15 +1041,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>mcrypt_module_open</function></funcdef> - <paramdef>string <parameter>algorithm</parameter></paramdef> - <paramdef>string <parameter>algorithm_directory</parameter></paramdef> - <paramdef>string <parameter>mode</parameter></paramdef> - <paramdef>string <parameter>mode_directory</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>mcrypt_module_open</methodname> + <methodparam><type>string</type><parameter>algorithm</parameter></methodparam> + <methodparam><type>string</type><parameter>algorithm_directory</parameter></methodparam> + <methodparam><type>string</type><parameter>mode</parameter></methodparam> + <methodparam><type>string</type><parameter>mode_directory</parameter></methodparam> + </methodsynopsis> <para> This function opens the module of the algorithm and the mode to be used. The name of the algorithm is specified in algorithm, @@ -1154,12 +1097,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>mcrypt_module_close</function></funcdef> - <paramdef>resource <parameter>td</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>mcrypt_module_close</methodname> + <methodparam><type>resource</type><parameter>td</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1175,12 +1116,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>mcrypt_generic_deinit</function></funcdef> - <paramdef>resource <parameter>td</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>mcrypt_generic_deinit</methodname> + <methodparam><type>resource</type><parameter>td</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1194,14 +1133,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcrypt_generic_init</function></funcdef> - <paramdef>resource <parameter>td</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>string <parameter>iv</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcrypt_generic_init</methodname> + <methodparam><type>resource</type><parameter>td</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>iv</parameter></methodparam> + </methodsynopsis> <para> The maximum length of the key should be the one obtained by calling <function>mcrypt_enc_get_key_size</function> and every @@ -1229,13 +1166,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mcrypt_generic</function></funcdef> - <paramdef>resource <parameter>td</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mcrypt_generic</methodname> + <methodparam><type>resource</type><parameter>td</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> <para> This function encrypts data. The data is padded with "<literal>\0</literal>" to make sure the length of the data is n * blocksize. This @@ -1253,13 +1188,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mdecrypt_generic</function></funcdef> - <paramdef>resource <parameter>td</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mdecrypt_generic</methodname> + <methodparam><type>resource</type><parameter>td</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> <para> This function decrypts data. Note that the length of the returned string can in fact be longer then the unencrypted @@ -1303,12 +1236,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>mcrypt_generic_end</function></funcdef> - <paramdef>resource <parameter>td</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>mcrypt_generic_end</methodname> + <methodparam><type>resource</type><parameter>td</parameter></methodparam> + </methodsynopsis> <para> This function terminates encryption specified by the encryption descriptor (td). Actually it clears all buffers, and closes @@ -1324,12 +1255,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcrypt_enc_self_test</function></funcdef> - <paramdef>resource <parameter>td</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcrypt_enc_self_test</methodname> + <methodparam><type>resource</type><parameter>td</parameter></methodparam> + </methodsynopsis> <para> This function runs the self test on the algorithm specified by the descriptor td. If the self test succeeds it returns zero. In case @@ -1345,12 +1274,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcrypt_enc_is_block_algorithm_mode</function></funcdef> - <paramdef>resource <parameter>td</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcrypt_enc_is_block_algorithm_mode</methodname> + <methodparam><type>resource</type><parameter>td</parameter></methodparam> + </methodsynopsis> <para> This function returns 1 if the mode is for use with block algorithms, otherwise it returns 0. (eg. 0 for stream, and 1 for cbc, cfb, ofb). @@ -1365,12 +1292,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcrypt_enc_is_block_algorithm</function></funcdef> - <paramdef>resource <parameter>td</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcrypt_enc_is_block_algorithm</methodname> + <methodparam><type>resource</type><parameter>td</parameter></methodparam> + </methodsynopsis> <para> This function returns 1 if the algorithm is a block algorithm, or 0 if it is a stream algorithm. @@ -1385,12 +1310,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcrypt_enc_is_block_mode</function></funcdef> - <paramdef>resource <parameter>td</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcrypt_enc_is_block_mode</methodname> + <methodparam><type>resource</type><parameter>td</parameter></methodparam> + </methodsynopsis> <para> This function returns 1 if the mode outputs blocks of bytes or 0 if it outputs bytes. (eg. 1 for cbc and ecb, and 0 for cfb and @@ -1406,12 +1329,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcrypt_enc_get_block_size</function></funcdef> - <paramdef>resource <parameter>td</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcrypt_enc_get_block_size</methodname> + <methodparam><type>resource</type><parameter>td</parameter></methodparam> + </methodsynopsis> <para> This function returns the block size of the algorithm specified by the encryption descriptor td in bytes. @@ -1426,12 +1347,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcrypt_enc_get_key_size</function></funcdef> - <paramdef>resource <parameter>td</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcrypt_enc_get_key_size</methodname> + <methodparam><type>resource</type><parameter>td</parameter></methodparam> + </methodsynopsis> <para> This function returns the maximum supported key size of the algorithm specified by the encryption descriptor td in bytes. @@ -1446,12 +1365,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>mcrypt_enc_get_supported_key_sizes</function></funcdef> - <paramdef>resource <parameter>td</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>mcrypt_enc_get_supported_key_sizes</methodname> + <methodparam><type>resource</type><parameter>td</parameter></methodparam> + </methodsynopsis> <para> Returns an array with the key sizes supported by the algorithm specified by the encryption descriptor. If it returns an empty @@ -1469,12 +1386,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcrypt_enc_get_iv_size</function></funcdef> - <paramdef>resource <parameter>td</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcrypt_enc_get_iv_size</methodname> + <methodparam><type>resource</type><parameter>td</parameter></methodparam> + </methodsynopsis> <para> This function returns the size of the iv of the algorithm specified by the encryption descriptor in bytes. If it returns @@ -1491,12 +1406,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mcrypt_enc_get_algorithms_name</function></funcdef> - <paramdef>resource <parameter>td</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mcrypt_enc_get_algorithms_name</methodname> + <methodparam><type>resource</type><parameter>td</parameter></methodparam> + </methodsynopsis> <para> This function returns the name of the algorithm. </para> @@ -1510,12 +1423,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mcrypt_enc_get_modes_name</function></funcdef> - <paramdef>resource <parameter>td</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mcrypt_enc_get_modes_name</methodname> + <methodparam><type>resource</type><parameter>td</parameter></methodparam> + </methodsynopsis> <para> This function returns the name of the mode. </para> @@ -1529,13 +1440,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>mcrypt_module_self_test</function></funcdef> - <paramdef>string <parameter>algorithm</parameter></paramdef> - <paramdef>string <parameter><optional>lib_dir</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>mcrypt_module_self_test</methodname> + <methodparam><type>string</type><parameter>algorithm</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam> + </methodsynopsis> <para> This function runs the self test on the algorithm specified. The optional <parameter>lib_dir</parameter> parameter can contain @@ -1555,13 +1464,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>mcrypt_module_is_block_algorithm_mode</function></funcdef> - <paramdef>string <parameter>mode</parameter></paramdef> - <paramdef>string <parameter><optional>lib_dir</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>mcrypt_module_is_block_algorithm_mode</methodname> + <methodparam><type>string</type><parameter>mode</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam> + </methodsynopsis> <para> This function returns &true; if the mode is for use with block algorithms, otherwise it returns 0. (eg. 0 for stream, and 1 for cbc, cfb, ofb). @@ -1578,13 +1485,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>mcrypt_module_is_block_algorithm</function></funcdef> - <paramdef>string <parameter>algorithm</parameter></paramdef> - <paramdef>string <parameter><optional>lib_dir</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>mcrypt_module_is_block_algorithm</methodname> + <methodparam><type>string</type><parameter>algorithm</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam> + </methodsynopsis> <para> This function returns &true; if the specified algorithm is a block algorithm, or &false; is it is a stream algorithm. @@ -1601,13 +1506,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>mcrypt_module_is_block_mode</function></funcdef> - <paramdef>string <parameter>mode</parameter></paramdef> - <paramdef>string <parameter><optional>lib_dir</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>mcrypt_module_is_block_mode</methodname> + <methodparam><type>string</type><parameter>mode</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam> + </methodsynopsis> <para> This function returns &true; if the mode outputs blocks of bytes or &false; if it outputs just bytes. (eg. 1 for cbc and ecb, and 0 for cfb @@ -1624,13 +1527,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcrypt_module_get_algo_block_size</function></funcdef> - <paramdef>string <parameter>algorithm</parameter></paramdef> - <paramdef>string <parameter><optional>lib_dir</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcrypt_module_get_algo_block_size</methodname> + <methodparam><type>string</type><parameter>algorithm</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam> + </methodsynopsis> <para> This function returns the block size of the algorithm specified in bytes. The optional <parameter>lib_dir</parameter> parameter @@ -1646,13 +1547,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mcrypt_module_get_algo_key_size</function></funcdef> - <paramdef>string <parameter>algorithm</parameter></paramdef> - <paramdef>string <parameter><optional>lib_dir</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mcrypt_module_get_algo_key_size</methodname> + <methodparam><type>string</type><parameter>algorithm</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam> + </methodsynopsis> <para> This function returns the maximum supported key size of the algorithm specified in bytes. The optional @@ -1669,13 +1568,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>mcrypt_module_get_supported_key_sizes</function></funcdef> - <paramdef>string <parameter>algorithm</parameter></paramdef> - <paramdef>string <parameter><optional>lib_dir</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>mcrypt_module_get_supported_key_sizes</methodname> + <methodparam><type>string</type><parameter>algorithm</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam> + </methodsynopsis> <para> Returns an array with the key sizes supported by the specified algorithm. If it returns an empty array then all key sizes @@ -1709,3 +1606,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/mhash.xml diff -u phpdoc/en/functions/mhash.xml:1.21 phpdoc/en/functions/mhash.xml:1.22 --- phpdoc/en/functions/mhash.xml:1.21 Wed Dec 12 15:47:03 2001 +++ phpdoc/en/functions/mhash.xml Sat Feb 2 10:36:03 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.21 $ --> +<!-- $Revision: 1.22 $ --> <reference id="ref.mhash"> <title>Mhash Functions</title> <titleabbrev>mhash</titleabbrev> @@ -124,12 +124,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mhash_get_hash_name</function></funcdef> - <paramdef>int <parameter>hash</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mhash_get_hash_name</methodname> + <methodparam><type>int</type><parameter>hash</parameter></methodparam> + </methodsynopsis> <para> <function>mhash_get_hash_name</function> is used to get the name of the specified hash. @@ -171,12 +169,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mhash_get_block_size</function></funcdef> - <paramdef>int <parameter>hash</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mhash_get_block_size</methodname> + <methodparam><type>int</type><parameter>hash</parameter></methodparam> + </methodsynopsis> <para> <function>mhash_get_block_size</function> is used to get the size of a block of the specified <parameter>hash</parameter>. @@ -196,12 +192,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mhash_count</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>mhash_count</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> <function>mhash_count</function> returns the highest available hash id. Hashes are numbered from 0 to this hash id. @@ -235,14 +229,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mhash</function></funcdef> - <paramdef>int <parameter>hash</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>string <parameter>[ key ]</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mhash</methodname> + <methodparam><type>int</type><parameter>hash</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>string</type><parameter>[ key ]</parameter></methodparam> + </methodsynopsis> <para> <function>mhash</function> applies a hash function specified by <parameter>hash</parameter> to the <parameter>data</parameter> and @@ -262,15 +254,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mhash_keygen_s2k</function></funcdef> - <paramdef>int <parameter>hash</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>string <parameter>salt</parameter></paramdef> - <paramdef>int <parameter>bytes</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mhash_keygen_s2k</methodname> + <methodparam><type>int</type><parameter>hash</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam><type>string</type><parameter>salt</parameter></methodparam> + <methodparam><type>int</type><parameter>bytes</parameter></methodparam> + </methodsynopsis> <para> <function>mhash_keygen_s2k</function> generates a key that is <parameter>bytes</parameter> long, from a user given password. @@ -314,3 +304,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/ming.xml diff -u phpdoc/en/functions/ming.xml:1.33 phpdoc/en/functions/ming.xml:1.34 --- phpdoc/en/functions/ming.xml:1.33 Sat Jan 26 03:56:25 2002 +++ phpdoc/en/functions/ming.xml Sat Feb 2 10:36:03 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.33 $ --> +<!-- $Revision: 1.34 $ --> <reference id="ref.ming"> <title>Ming functions for Flash</title> <titleabbrev>Ming (flash)</titleabbrev> @@ -176,12 +176,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>ming_setcubicthreshold</function></funcdef> - <paramdef>int <parameter>threshold</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>ming_setcubicthreshold</methodname> + <methodparam><type>int</type><parameter>threshold</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -197,12 +195,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>ming_setscale</function></funcdef> - <paramdef>int <parameter>scale</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>ming_setscale</methodname> + <methodparam><type>int</type><parameter>scale</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -218,12 +214,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>ming_useswfversion</function></funcdef> - <paramdef>int <parameter>version</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>ming_useswfversion</methodname> + <methodparam><type>int</type><parameter>version</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -239,12 +233,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>swfbutton_keypress</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>swfbutton_keypress</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -260,12 +252,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>new <function>swfmovie</function></funcdef> + <methodsynopsis> + <type>new</type><methodname>swfmovie</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>swfmovie</function> creates a new movie object, @@ -294,12 +284,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfmovie->output</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>swfmovie->output</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>swfmovie->output</function> dumps your lovingly prepared movie out. @@ -334,12 +322,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfmovie->save</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfmovie->save</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfmovie->save</function> saves your movie to the @@ -359,12 +345,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfmovie->add</function></funcdef> - <paramdef>ressource <parameter>instance</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfmovie->add</methodname> + <methodparam><type>ressource</type><parameter>instance</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfmovie->add</function> adds <parameter>instance</parameter> to @@ -397,12 +381,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfmovie->remove</function></funcdef> - <paramdef>resource <parameter>instance</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfmovie->remove</methodname> + <methodparam><type>resource</type><parameter>instance</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfmovie->remove</function> removes the object instance @@ -422,14 +404,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfmovie->setbackground</function></funcdef> - <paramdef>int <parameter>red</parameter></paramdef> - <paramdef>int <parameter>green</parameter></paramdef> - <paramdef>int <parameter>blue</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfmovie->setbackground</methodname> + <methodparam><type>int</type><parameter>red</parameter></methodparam> + <methodparam><type>int</type><parameter>green</parameter></methodparam> + <methodparam><type>int</type><parameter>blue</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfmovie->setbackground</function> sets the background color. Why is @@ -449,12 +429,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfmovie->setrate</function></funcdef> - <paramdef>int <parameter>rate</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfmovie->setrate</methodname> + <methodparam><type>int</type><parameter>rate</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfmovie->setrate</function> sets the frame rate to @@ -473,13 +451,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfmovie->setdimension</function></funcdef> - <paramdef>int <parameter>width</parameter></paramdef> - <paramdef>int <parameter>height</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfmovie->setdimension</methodname> + <methodparam><type>int</type><parameter>width</parameter></methodparam> + <methodparam><type>int</type><parameter>height</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfmovie->setdimension</function> sets the movie's width @@ -495,12 +471,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfmovie->setframes</function></funcdef> - <paramdef>string <parameter>numberofframes</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfmovie->setframes</methodname> + <methodparam><type>string</type><parameter>numberofframes</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfmovie->setframes</function> sets the total number of frames @@ -516,12 +490,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfmovie->nextframe</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>swfmovie->nextframe</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>swfmovie->setframes</function> moves to the next frame of @@ -538,12 +510,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfmovie->streammp3</function></funcdef> - <paramdef>string <parameter>mp3FileName</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfmovie->streammp3</methodname> + <methodparam><type>string</type><parameter>mp3FileName</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfmovie->streammp3</function> streams the mp3 file @@ -592,12 +562,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>new <function>swfdisplayitem</function></funcdef> + <methodsynopsis> + <type>new</type><methodname>swfdisplayitem</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>swfdisplayitem</function> creates a new swfdisplayitem object. @@ -628,13 +596,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfdisplayitem->moveto</function></funcdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfdisplayitem->moveto</methodname> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfdisplayitem->moveto</function> moves the current object to @@ -660,13 +626,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfdisplayitem->move</function></funcdef> - <paramdef>int <parameter>dx</parameter></paramdef> - <paramdef>int <parameter>dy</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfdisplayitem->move</methodname> + <methodparam><type>int</type><parameter>dx</parameter></methodparam> + <methodparam><type>int</type><parameter>dy</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfdisplayitem->move</function> moves the current object by @@ -693,13 +657,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfdisplayitem->scaleto</function></funcdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfdisplayitem->scaleto</methodname> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfdisplayitem->scaleto</function> scales the current object to @@ -725,13 +687,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfdisplayitem->scale</function></funcdef> - <paramdef>int <parameter>dx</parameter></paramdef> - <paramdef>int <parameter>dy</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfdisplayitem->scale</methodname> + <methodparam><type>int</type><parameter>dx</parameter></methodparam> + <methodparam><type>int</type><parameter>dy</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfdisplayitem->scale</function> scales the current object by @@ -758,12 +718,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfdisplayitem->rotateto</function></funcdef> - <paramdef>float <parameter>degrees</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfdisplayitem->rotateto</methodname> + <methodparam><type>float</type><parameter>degrees</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfdisplayitem->rotateto</function> set the current object @@ -875,12 +833,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfdisplayitem->rotate</function></funcdef> - <paramdef>float <parameter>ddegrees</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfdisplayitem->rotate</methodname> + <methodparam><type>float</type><parameter>ddegrees</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfdisplayitem->rotate</function> rotates the current object @@ -906,12 +862,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfdisplayitem->skewxto</function></funcdef> - <paramdef>float <parameter>degrees</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfdisplayitem->skewxto</methodname> + <methodparam><type>float</type><parameter>degrees</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfdisplayitem->skewxto</function> sets the @@ -941,12 +895,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfdisplayitem->skewx</function></funcdef> - <paramdef>float <parameter>ddegrees</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfdisplayitem->skewx</methodname> + <methodparam><type>float</type><parameter>ddegrees</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfdisplayitem->skewx</function> adds <parameter>ddegrees</parameter> @@ -974,12 +926,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfdisplayitem->skewyto</function></funcdef> - <paramdef>float <parameter>degrees</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfdisplayitem->skewyto</methodname> + <methodparam><type>float</type><parameter>degrees</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfdisplayitem->skewyto</function> sets the @@ -1009,12 +959,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfdisplayitem->skewy</function></funcdef> - <paramdef>float <parameter>ddegrees</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfdisplayitem->skewy</methodname> + <methodparam><type>float</type><parameter>ddegrees</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfdisplayitem->skewy</function> adds <parameter>ddegrees</parameter> @@ -1042,12 +990,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfdisplayitem->setdepth</function></funcdef> - <paramdef>float <parameter>depth</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfdisplayitem->setdepth</methodname> + <methodparam><type>float</type><parameter>depth</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfdisplayitem->rotate</function> sets the object's @@ -1072,12 +1018,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfdisplayitem->remove</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>swfdisplayitem->remove</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>swfdisplayitem->remove</function> removes this object from @@ -1103,12 +1047,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfdisplayitem->setname</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfdisplayitem->setname</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfdisplayitem->setname</function> sets the object's name to @@ -1131,12 +1073,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfdisplayitem->setratio</function></funcdef> - <paramdef>float <parameter>ratio</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfdisplayitem->setratio</methodname> + <methodparam><type>float</type><parameter>ratio</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfdisplayitem->setratio</function> sets the object's ratio @@ -1225,15 +1165,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfdisplayitem->addcolor</function></funcdef> - <paramdef>int <parameter><optional>red</optional></parameter></paramdef> - <paramdef>int <parameter><optional>green</optional></parameter></paramdef> - <paramdef>int <parameter><optional>blue</optional></parameter></paramdef> - <paramdef>int <parameter><optional>a</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfdisplayitem->addcolor</methodname> + <methodparam choice="opt"><type>int</type><parameter>red</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>green</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>blue</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>a</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfdisplayitem->addcolor</function> adds the color to @@ -1255,15 +1193,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfdisplayitem->multcolor</function></funcdef> - <paramdef>int <parameter><optional>red</optional></parameter></paramdef> - <paramdef>int <parameter><optional>green</optional></parameter></paramdef> - <paramdef>int <parameter><optional>blue</optional></parameter></paramdef> - <paramdef>int <parameter><optional>a</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfdisplayitem->multcolor</methodname> + <methodparam choice="opt"><type>int</type><parameter>red</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>green</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>blue</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>a</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfdisplayitem->multcolor</function> multiplies the item's @@ -1324,12 +1260,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>new <function>swfshape</function></funcdef> + <methodsynopsis> + <type>new</type><methodname>swfshape</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>swfshape</function> creates a new shape object. @@ -1380,16 +1314,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfshape->setline</function></funcdef> - <paramdef>int <parameter>width</parameter></paramdef> - <paramdef>int <parameter><optional>red</optional></parameter></paramdef> - <paramdef>int <parameter><optional>green</optional></parameter></paramdef> - <paramdef>int <parameter><optional>blue</optional></parameter></paramdef> - <paramdef>int <parameter><optional>a</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfshape->setline</methodname> + <methodparam><type>int</type><parameter>width</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>red</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>green</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>blue</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>a</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfshape->setline</function> sets the shape's line style. @@ -1477,31 +1409,25 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfshape->addfill</function></funcdef> - <paramdef>int <parameter>red</parameter></paramdef> - <paramdef>int <parameter>green</parameter></paramdef> - <paramdef>int <parameter>blue</parameter></paramdef> - <paramdef>int <parameter><optional>a</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> - &warn.experimental.func; - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfshape->addfill</function></funcdef> - <paramdef>SWFbitmap <parameter>bitmap</parameter></paramdef> - <paramdef>int <parameter><optional>flags</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> - &warn.experimental.func; - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfshape->addfill</function></funcdef> - <paramdef>SWFGradient <parameter>gradient</parameter></paramdef> - <paramdef>int <parameter><optional>flags</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfshape->addfill</methodname> + <methodparam><type>int</type><parameter>red</parameter></methodparam> + <methodparam><type>int</type><parameter>green</parameter></methodparam> + <methodparam><type>int</type><parameter>blue</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>a</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <methodsynopsis> + <type>void</type><methodname>swfshape->addfill</methodname> + <methodparam><type>SWFbitmap</type><parameter>bitmap</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <methodsynopsis> + <type>void</type><methodname>swfshape->addfill</methodname> + <methodparam><type>SWFGradient</type><parameter>gradient</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfshape->addfill</function> adds a solid fill to the shape's list @@ -1606,22 +1532,18 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfshape->setleftfill</function></funcdef> - <paramdef>swfgradient <parameter>fill</parameter></paramdef> - </funcprototype> - </funcsynopsis> - &warn.experimental.func; - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfshape->setleftfill</function></funcdef> - <paramdef>int <parameter>red</parameter></paramdef> - <paramdef>int <parameter>green</parameter></paramdef> - <paramdef>int <parameter>blue</parameter></paramdef> - <paramdef>int <parameter><optional>a</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfshape->setleftfill</methodname> + <methodparam><type>swfgradient</type><parameter>fill</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <methodsynopsis> + <type>void</type><methodname>swfshape->setleftfill</methodname> + <methodparam><type>int</type><parameter>red</parameter></methodparam> + <methodparam><type>int</type><parameter>green</parameter></methodparam> + <methodparam><type>int</type><parameter>blue</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>a</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> What this nonsense is about is, every edge segment borders at most two fills. @@ -1655,22 +1577,18 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfshape->setrightfill</function></funcdef> - <paramdef>swfgradient <parameter>fill</parameter></paramdef> - </funcprototype> - </funcsynopsis> - &warn.experimental.func; - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfshape->setrightfill</function></funcdef> - <paramdef>int <parameter>red</parameter></paramdef> - <paramdef>int <parameter>green</parameter></paramdef> - <paramdef>int <parameter>blue</parameter></paramdef> - <paramdef>int <parameter><optional>a</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfshape->setrightfill</methodname> + <methodparam><type>swfgradient</type><parameter>fill</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <methodsynopsis> + <type>void</type><methodname>swfshape->setrightfill</methodname> + <methodparam><type>int</type><parameter>red</parameter></methodparam> + <methodparam><type>int</type><parameter>green</parameter></methodparam> + <methodparam><type>int</type><parameter>blue</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>a</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <simpara> See also @@ -1689,13 +1607,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfshape->movepento</function></funcdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfshape->movepento</methodname> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <simpara> <function>swfshape->setrightfill</function> move the shape's pen to @@ -1719,13 +1635,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfshape->movepen</function></funcdef> - <paramdef>int <parameter>dx</parameter></paramdef> - <paramdef>int <parameter>dy</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfshape->movepen</methodname> + <methodparam><type>int</type><parameter>dx</parameter></methodparam> + <methodparam><type>int</type><parameter>dy</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <simpara> <function>swfshape->setrightfill</function> move the shape's pen from @@ -1749,13 +1663,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfshape->drawlineto</function></funcdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfshape->drawlineto</methodname> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <simpara> <function>swfshape->setrightfill</function> draws a line (using the @@ -1780,13 +1692,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfshape->drawline</function></funcdef> - <paramdef>int <parameter>dx</parameter></paramdef> - <paramdef>int <parameter>dy</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfshape->drawline</methodname> + <methodparam><type>int</type><parameter>dx</parameter></methodparam> + <methodparam><type>int</type><parameter>dy</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <simpara> <function>swfshape->drawline</function> draws a line (using the current line style @@ -1810,15 +1720,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfshape->drawcurveto</function></funcdef> - <paramdef>int <parameter>controlx</parameter></paramdef> - <paramdef>int <parameter>controly</parameter></paramdef> - <paramdef>int <parameter>anchorx</parameter></paramdef> - <paramdef>int <parameter>anchory</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfshape->drawcurveto</methodname> + <methodparam><type>int</type><parameter>controlx</parameter></methodparam> + <methodparam><type>int</type><parameter>controly</parameter></methodparam> + <methodparam><type>int</type><parameter>anchorx</parameter></methodparam> + <methodparam><type>int</type><parameter>anchory</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <simpara> <function>swfshape->drawcurveto</function> draws a quadratic curve @@ -1846,15 +1754,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfshape->drawcurve</function></funcdef> - <paramdef>int <parameter>controldx</parameter></paramdef> - <paramdef>int <parameter>controldy</parameter></paramdef> - <paramdef>int <parameter>anchordx</parameter></paramdef> - <paramdef>int <parameter>anchordy</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfshape->drawcurve</methodname> + <methodparam><type>int</type><parameter>controldx</parameter></methodparam> + <methodparam><type>int</type><parameter>controldy</parameter></methodparam> + <methodparam><type>int</type><parameter>anchordx</parameter></methodparam> + <methodparam><type>int</type><parameter>anchordy</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <simpara> <function>swfshape->drawcurve</function> draws a quadratic curve @@ -1885,12 +1791,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>new <function>swfgradient</function></funcdef> + <methodsynopsis> + <type>new</type><methodname>swfgradient</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>swfgradient</function> creates a new SWFGradient object. @@ -1967,16 +1871,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfgradient->addentry</function></funcdef> - <paramdef>float <parameter>ratio</parameter></paramdef> - <paramdef>int <parameter>red</parameter></paramdef> - <paramdef>int <parameter>green</parameter></paramdef> - <paramdef>int <parameter>blue</parameter></paramdef> - <paramdef>int <parameter><optional>a</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfgradient->addentry</methodname> + <methodparam><type>float</type><parameter>ratio</parameter></methodparam> + <methodparam><type>int</type><parameter>red</parameter></methodparam> + <methodparam><type>int</type><parameter>green</parameter></methodparam> + <methodparam><type>int</type><parameter>blue</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>a</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfgradient->addentry</function> adds an entry to the gradient list. @@ -1999,13 +1901,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>new <function>swfbitmap</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>int <parameter><optional>alphafilename</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>new</type><methodname>swfbitmap</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>alphafilename</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfbitmap</function> creates a new SWFBitmap object from @@ -2120,12 +2020,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>swfbitmap->getwidth</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>swfbitmap->getwidth</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>swfbitmap->getwidth</function> returns the bitmap's width in pixels. @@ -2144,12 +2042,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>swfbitmap->getheight</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>swfbitmap->getheight</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>swfbitmap->getheight</function> returns the bitmap's height in pixels. @@ -2190,13 +2086,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swffill->moveto</function></funcdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swffill->moveto</methodname> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swffill->moveto</function> moves fill's origin to @@ -2212,13 +2106,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swffill->scaleto</function></funcdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swffill->scaleto</methodname> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swffill->scaleto</function> sets fill's scale to @@ -2235,12 +2127,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swffill->rotateto</function></funcdef> - <paramdef>float <parameter>degrees</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swffill->rotateto</methodname> + <methodparam><type>float</type><parameter>degrees</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swffill->rotateto</function> sets fill's rotation to @@ -2256,12 +2146,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swffill->skewxto</function></funcdef> - <paramdef>float <parameter>x</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swffill->skewxto</methodname> + <methodparam><type>float</type><parameter>x</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swffill->skewxto</function> sets fill x-skew to <parameter>x</parameter>. @@ -2278,12 +2166,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swffill->skewyto</function></funcdef> - <paramdef>float <parameter>y</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swffill->skewyto</methodname> + <methodparam><type>float</type><parameter>y</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swffill->skewyto</function> sets fill y-skew to <parameter>y</parameter>. @@ -2302,12 +2188,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>new <function>swfmorph</function></funcdef> + <methodsynopsis> + <type>new</type><methodname>swfmorph</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>swfmorph</function> creates a new SWFMorph object. @@ -2390,12 +2274,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>swfmorph->getshape1</function></funcdef> + <methodsynopsis> + <type>mixed</type><methodname>swfmorph->getshape1</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>swfmorph->getshape1</function> gets a handle to the morph's @@ -2412,12 +2294,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>swfmorph->getshape2</function></funcdef> + <methodsynopsis> + <type>mixed</type><methodname>swfmorph->getshape2</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>swfmorph->getshape2</function> gets a handle to the morph's @@ -2436,12 +2316,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>new <function>swftext</function></funcdef> + <methodsynopsis> + <type>new</type><methodname>swftext</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>swftext</function> creates a new SWFText object, @@ -2491,12 +2369,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swftext->setfont</function></funcdef> - <paramdef>string <parameter>font</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swftext->setfont</methodname> + <methodparam><type>string</type><parameter>font</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swftext->setfont</function> sets the current font to @@ -2512,12 +2388,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swftext->setheight</function></funcdef> - <paramdef>int <parameter>height</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swftext->setheight</methodname> + <methodparam><type>int</type><parameter>height</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swftext->setheight</function> sets the current font height to @@ -2533,12 +2407,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swftext->setspacing</function></funcdef> - <paramdef>float <parameter>spacing</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swftext->setspacing</methodname> + <methodparam><type>float</type><parameter>spacing</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swftext->setspacing</function> sets the current font spacing to @@ -2560,15 +2432,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swftext->setcolor</function></funcdef> - <paramdef>int <parameter>red</parameter></paramdef> - <paramdef>int <parameter>green</parameter></paramdef> - <paramdef>int <parameter>blue</parameter></paramdef> - <paramdef>int <parameter><optional>a</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swftext->setcolor</methodname> + <methodparam><type>int</type><parameter>red</parameter></methodparam> + <methodparam><type>int</type><parameter>green</parameter></methodparam> + <methodparam><type>int</type><parameter>blue</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>a</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swftext->setspacing</function> changes the current text color. @@ -2584,13 +2454,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swftext->moveto</function></funcdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swftext->moveto</methodname> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swftext->moveto</function> moves the pen (or cursor, if @@ -2608,12 +2476,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swftext->addstring</function></funcdef> - <paramdef>string <parameter>string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swftext->addstring</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swftext->addstring</function> draws the string <parameter>string</parameter> @@ -2630,12 +2496,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swftext->addstring</function></funcdef> - <paramdef>string <parameter>string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swftext->addstring</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swftext->addstring</function> returns the rendered width of the @@ -2654,12 +2518,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>new <function>swffont</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>new</type><methodname>swffont</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> If <parameter>filename</parameter> is the name of an FDB file @@ -2705,12 +2567,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>swffont->getwidth</function></funcdef> - <paramdef>string <parameter>string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>swffont->getwidth</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swffont->getwidth</function> returns the string @@ -2730,12 +2590,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>new <function>swftextfield</function></funcdef> - <paramdef>int <parameter><optional>flags</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>new</type><methodname>swftextfield</methodname> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swftextfield</function> creates a new text field object. @@ -2808,12 +2666,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swftextfield->setfont</function></funcdef> - <paramdef>string <parameter>font</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swftextfield->setfont</methodname> + <methodparam><type>string</type><parameter>font</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swftextfield->setfont</function> sets the text field font to @@ -2829,13 +2685,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swftextfield->setbounds</function></funcdef> - <paramdef>int <parameter>width</parameter></paramdef> - <paramdef>int <parameter>height</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swftextfield->setbounds</methodname> + <methodparam><type>int</type><parameter>width</parameter></methodparam> + <methodparam><type>int</type><parameter>height</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swftextfield->setbounds</function> sets the text field width @@ -2853,12 +2707,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swftextfield->align</function></funcdef> - <paramdef>int <parameter>alignement</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swftextfield->align</methodname> + <methodparam><type>int</type><parameter>alignement</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swftextfield->align</function> sets the text field alignment @@ -2877,12 +2729,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swftextfield->setheight</function></funcdef> - <paramdef>int <parameter>height</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swftextfield->setheight</methodname> + <methodparam><type>int</type><parameter>height</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swftextfield->setheight</function> sets the font height of this text field @@ -2898,12 +2748,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swftextfield->setleftmargin</function></funcdef> - <paramdef>int <parameter>width</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swftextfield->setleftmargin</methodname> + <methodparam><type>int</type><parameter>width</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swftextfield->setleftmargin</function> sets the left margin width @@ -2919,12 +2767,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swftextfield->setrightmargin</function></funcdef> - <paramdef>int <parameter>width</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swftextfield->setrightmargin</methodname> + <methodparam><type>int</type><parameter>width</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swftextfield->setrightmargin</function> sets the right margin width @@ -2940,13 +2786,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swftextfield->setmargins</function></funcdef> - <paramdef>int <parameter>left</parameter></paramdef> - <paramdef>int <parameter>right</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swftextfield->setmargins</methodname> + <methodparam><type>int</type><parameter>left</parameter></methodparam> + <methodparam><type>int</type><parameter>right</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swftextfield->setmargins</function> set both margins at once, @@ -2962,12 +2806,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swftextfield->setindentation</function></funcdef> - <paramdef>int <parameter>width</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swftextfield->setindentation</methodname> + <methodparam><type>int</type><parameter>width</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swftextfield->setindentation</function> sets the indentation of @@ -2983,12 +2825,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swftextfield->setlinespacing</function></funcdef> - <paramdef>int <parameter>height</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swftextfield->setlinespacing</methodname> + <methodparam><type>int</type><parameter>height</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swftextfield->setlinespacing</function> sets the line spacing @@ -3004,15 +2844,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swftextfield->setcolor</function></funcdef> - <paramdef>int <parameter>red</parameter></paramdef> - <paramdef>int <parameter>green</parameter></paramdef> - <paramdef>int <parameter>blue</parameter></paramdef> - <paramdef>int <parameter><optional>a</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swftextfield->setcolor</methodname> + <methodparam><type>int</type><parameter>red</parameter></methodparam> + <methodparam><type>int</type><parameter>green</parameter></methodparam> + <methodparam><type>int</type><parameter>blue</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>a</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swftextfield->setcolor</function> sets the color of the text field. @@ -3028,12 +2866,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swftextfield->setname</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swftextfield->setname</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swftextfield->setname</function> sets the variable name of this @@ -3050,12 +2886,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swftextfield->addstring</function></funcdef> - <paramdef>string <parameter>string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swftextfield->addstring</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swftextfield->setname</function> concatenates the string @@ -3073,12 +2907,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>new <function>swfsprite</function></funcdef> + <methodsynopsis> + <type>new</type><methodname>swfsprite</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>swfsprite</function> are also known as a "movie clip", @@ -3145,12 +2977,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfsprite->add</function></funcdef> - <paramdef>resource <parameter>object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfsprite->add</methodname> + <methodparam><type>resource</type><parameter>object</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfsprite->add</function> adds a <function>swfshape</function>, a @@ -3173,12 +3003,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfsprite->remove</function></funcdef> - <paramdef>ressource <parameter>object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfsprite->remove</methodname> + <methodparam><type>ressource</type><parameter>object</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfsprite->remove</function> remove a <function>swfshape</function>, a @@ -3196,12 +3024,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfsprite->setframes</function></funcdef> - <paramdef>int <parameter>numberofframes</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfsprite->setframes</methodname> + <methodparam><type>int</type><parameter>numberofframes</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfsprite->setframes</function> sets the total number of frames @@ -3217,12 +3043,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfsprite->nextframe</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>swfsprite->nextframe</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>swfsprite->setframes</function> moves to the next frame of @@ -3240,12 +3064,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>new <function>swfbutton</function></funcdef> + <methodsynopsis> + <type>new</type><methodname>swfbutton</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>swfbutton</function> creates a new Button. @@ -3407,13 +3229,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfbutton->addshape</function></funcdef> - <paramdef>ressource <parameter>shape</parameter></paramdef> - <paramdef>int <parameter>flags</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfbutton->addshape</methodname> + <methodparam><type>ressource</type><parameter>shape</parameter></methodparam> + <methodparam><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfbutton->addshape</function> adds the shape @@ -3434,12 +3254,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfbutton->setup</function></funcdef> - <paramdef>ressource <parameter>shape</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfbutton->setup</methodname> + <methodparam><type>ressource</type><parameter>shape</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfbutton->setup</function> alias for addShape(shape, SWFBUTTON_UP). @@ -3459,12 +3277,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfbutton->setover</function></funcdef> - <paramdef>ressource <parameter>shape</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfbutton->setover</methodname> + <methodparam><type>ressource</type><parameter>shape</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfbutton->setover</function> alias for addShape(shape, SWFBUTTON_OVER). @@ -3484,12 +3300,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfbutton->setdown</function></funcdef> - <paramdef>ressource <parameter>shape</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfbutton->setdown</methodname> + <methodparam><type>ressource</type><parameter>shape</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfbutton->setdown</function> alias for addShape(shape, SWFBUTTON_DOWN). @@ -3509,12 +3323,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfbutton->sethit</function></funcdef> - <paramdef>ressource <parameter>shape</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfbutton->sethit</methodname> + <methodparam><type>ressource</type><parameter>shape</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfbutton->sethit</function> alias for addShape(shape, SWFBUTTON_HIT). @@ -3534,13 +3346,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfbutton->addaction</function></funcdef> - <paramdef>ressource <parameter>action</parameter></paramdef> - <paramdef>int <parameter>flags</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfbutton->addaction</methodname> + <methodparam><type>ressource</type><parameter>action</parameter></methodparam> + <methodparam><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfbutton->addaction</function> adds the action @@ -3565,12 +3375,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>swfbutton->setaction</function></funcdef> - <paramdef>ressource <parameter>action</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swfbutton->setaction</methodname> + <methodparam><type>ressource</type><parameter>action</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfbutton->setaction</function> sets the action to be performed @@ -3594,12 +3402,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>new <function>swfaction</function></funcdef> - <paramdef>string <parameter>script</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>new</type><methodname>swfaction</methodname> + <methodparam><type>string</type><parameter>script</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>swfaction</function> creates a new Action, and @@ -4388,3 +4194,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/misc.xml diff -u phpdoc/en/functions/misc.xml:1.66 phpdoc/en/functions/misc.xml:1.67 --- phpdoc/en/functions/misc.xml:1.66 Sat Jan 26 03:56:25 2002 +++ phpdoc/en/functions/misc.xml Sat Feb 2 10:36:03 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.66 $ --> +<!-- $Revision: 1.67 $ --> <reference id="ref.misc"> <title>Miscellaneous functions</title> <titleabbrev>Misc.</titleabbrev> @@ -18,12 +18,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>connection_aborted</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>connection_aborted</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <simpara> Returns &true; if client disconnected. See the <link linkend="features.connection-handling">Connection Handling</link> @@ -40,12 +38,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>connection_status</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>connection_status</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <simpara> Returns the connection status bitfield. See the <link linkend="features.connection-handling">Connection Handling</link> @@ -62,12 +58,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>connection_timeout</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>connection_timeout</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <simpara> Returns &true; if script timed out. </simpara> @@ -98,12 +92,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>constant</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>constant</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> <simpara> <function>constant</function> will return the value of the constant indicated by <parameter>name</parameter>. @@ -146,16 +138,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>define</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>mixed <parameter>value</parameter></paramdef> - <paramdef>bool - <parameter><optional>case_insensitive</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>define</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>mixed</type><parameter>value</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>case_insensitive</parameter></methodparam> + </methodsynopsis> <para> Defines a named constant. See the <link linkend="language.constants">section on constants</link> @@ -214,12 +202,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>defined</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>defined</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if the named constant given by <parameter>name</parameter> has been defined, @@ -265,12 +251,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>eval</function></funcdef> - <paramdef>string <parameter>code_str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>eval</methodname> + <methodparam><type>string</type><parameter>code_str</parameter></methodparam> + </methodsynopsis> <simpara> <function>eval</function> evaluates the string given in <parameter>code_str</parameter> as PHP code. Among other things, @@ -336,16 +320,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>exit</function></funcdef> - <paramdef>string <parameter><optional>status</optional></parameter></paramdef> - </funcprototype> - <funcprototype> - <funcdef>void <function>exit</function></funcdef> - <paramdef>int <parameter>status</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>exit</methodname> + <methodparam choice="opt"><type>string</type><parameter>status</parameter></methodparam> + </methodsynopsis> + <methodsynopsis> + <type>void</type><methodname>exit</methodname> + <methodparam><type>int</type><parameter>status</parameter></methodparam> + </methodsynopsis> <note> <simpara> This is not a real function, but a language construct. @@ -400,14 +382,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>get_browser</function></funcdef> - <paramdef>string - <parameter><optional>user_agent</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>get_browser</methodname> + <methodparam choice="opt"><type>string</type><parameter>user_agent</parameter></methodparam> + </methodsynopsis> <simpara> <function>get_browser</function> attempts to determine the capabilities of the user's browser. This is done by looking up @@ -501,12 +479,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>highlight_file</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>highlight_file</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <simpara> The <function>highlight_file</function> function prints out a syntax higlighted version of the code contained in <parameter>filename</parameter> @@ -609,12 +585,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>highlight_string</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>highlight_string</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <simpara> The <function>highlight_string</function> function prints out a syntax highlighted version of <parameter>str</parameter> using the colors defined @@ -638,14 +612,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ignore_user_abort</function></funcdef> - <paramdef>int - <parameter><optional>setting</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ignore_user_abort</methodname> + <methodparam choice="opt"><type>int</type><parameter>setting</parameter></methodparam> + </methodsynopsis> <simpara> This function sets whether a client disconnect should cause a script to be aborted. It will return the previous setting and @@ -668,12 +638,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>iptcparse</function></funcdef> - <paramdef>string <parameter>iptcblock</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>iptcparse</methodname> + <methodparam><type>string</type><parameter>iptcblock</parameter></methodparam> + </methodsynopsis> <simpara> This function parses a binary IPTC block into its single tags. It returns an array using the tagmarker as an index and the value as @@ -690,12 +658,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>leak</function></funcdef> - <paramdef>int <parameter>bytes</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>leak</methodname> + <methodparam><type>int</type><parameter>bytes</parameter></methodparam> + </methodsynopsis> <simpara> <function>leak</function> leaks the specified amount of memory. </simpara> @@ -714,15 +680,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pack</function></funcdef> - <paramdef>string <parameter>format</parameter></paramdef> - <paramdef>mixed - <parameter><optional>args</optional></parameter> ... - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pack</methodname> + <methodparam><type>string</type><parameter>format</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>args</parameter></methodparam> + </methodsynopsis> <para> Pack given arguments into binary string according to <parameter>format</parameter>. Returns binary string containing @@ -882,12 +844,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>show_source</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>show_source</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <simpara> The <function>show_source</function> function prints out a syntax higlighted version of the code contained in <parameter>filename</parameter> @@ -922,12 +882,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>sleep</function></funcdef> - <paramdef>int <parameter>seconds</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>sleep</methodname> + <methodparam><type>int</type><parameter>seconds</parameter></methodparam> + </methodsynopsis> <simpara> The sleep function delays program execution for the given number of <parameter>seconds</parameter>. @@ -945,15 +903,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>uniqid</function></funcdef> - <paramdef>string <parameter>prefix</parameter></paramdef> - <paramdef>bool - <parameter><optional>lcg</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>uniqid</methodname> + <methodparam><type>string</type><parameter>prefix</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>lcg</parameter></methodparam> + </methodsynopsis> <simpara> <function>uniqid</function> returns a prefixed unique identifier based on the current time in microseconds. The prefix can be @@ -1006,13 +960,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>unpack</function></funcdef> - <paramdef>string <parameter>format</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>unpack</methodname> + <methodparam><type>string</type><parameter>format</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> <para> <function>unpack</function> from binary string into array according to <parameter>format</parameter>. Returns array @@ -1056,12 +1008,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>usleep</function></funcdef> - <paramdef>int <parameter>micro_seconds</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>usleep</methodname> + <methodparam><type>int</type><parameter>micro_seconds</parameter></methodparam> + </methodsynopsis> <simpara> The <function>usleep</function> function delays program execution for the given number of <parameter>micro_seconds</parameter>. @@ -1099,3 +1049,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/mnogosearch.xml diff -u phpdoc/en/functions/mnogosearch.xml:1.33 phpdoc/en/functions/mnogosearch.xml:1.34 --- phpdoc/en/functions/mnogosearch.xml:1.33 Sat Jan 26 03:56:25 2002 +++ phpdoc/en/functions/mnogosearch.xml Sat Feb 2 10:36:04 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.33 $ --> +<!-- $Revision: 1.34 $ --> <reference id="ref.mnogo"> <title>mnoGoSearch Functions</title> <titleabbrev>mnoGoSearch</titleabbrev> @@ -60,14 +60,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>udm_add_search_limit</function></funcdef> - <paramdef>int <parameter>agent</parameter></paramdef> - <paramdef>int <parameter>var</parameter></paramdef> - <paramdef>string <parameter>val</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>udm_add_search_limit</methodname> + <methodparam><type>int</type><parameter>agent</parameter></methodparam> + <methodparam><type>int</type><parameter>var</parameter></methodparam> + <methodparam><type>string</type><parameter>val</parameter></methodparam> + </methodsynopsis> <para> <function>udm_add_search_limit</function> returns &true; on success, &false; on error. Adds search restrictions. @@ -153,13 +151,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>udm_alloc_agent</function></funcdef> - <paramdef>string <parameter>dbaddr</parameter></paramdef> - <paramdef>string<parameter><optional>dbmode</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>udm_alloc_agent</methodname> + <methodparam><type>string</type><parameter>dbaddr</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>dbmode</parameter></methodparam> + </methodsynopsis> <para><function>udm_alloc_agent</function> returns mnogosearch agent identifier on success, &false; on error. This function creates a session with database parameters. @@ -212,12 +208,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>udm_api_version</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>udm_api_version</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para><function>udm_api_version</function> returns mnoGoSearch API version number. E.g. if mnoGoSearch 3.1.10 API is used, this function will return <literal>30110</literal>.</para> @@ -245,13 +239,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>udm_cat_path</function></funcdef> - <paramdef>int <parameter>agent</parameter></paramdef> - <paramdef>string <parameter>category</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>udm_cat_path</methodname> + <methodparam><type>int</type><parameter>agent</parameter></methodparam> + <methodparam><type>string</type><parameter>category</parameter></methodparam> + </methodsynopsis> <para> <function>udm_cat_path</function> returns array describing path in the categories tree from the tree root to the current category. @@ -319,13 +311,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>udm_cat_list</function></funcdef> - <paramdef>int <parameter>agent</parameter></paramdef> - <paramdef>string <parameter>category</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>udm_cat_list</methodname> + <methodparam><type>int</type><parameter>agent</parameter></methodparam> + <methodparam><type>string</type><parameter>category</parameter></methodparam> + </methodsynopsis> <para> <function>udm_cat_list</function> returns array listing all categories of the same @@ -390,12 +380,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>udm_clear_search_limits</function></funcdef> - <paramdef>int <parameter>agent</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>udm_clear_search_limits</methodname> + <methodparam><type>int</type><parameter>agent</parameter></methodparam> + </methodsynopsis> <para> <function>udm_clear_search_limits</function> resets defined search @@ -412,12 +400,10 @@ <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>udm_errno</function></funcdef> - <paramdef>int <parameter>agent</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>udm_errno</methodname> + <methodparam><type>int</type><parameter>agent</parameter></methodparam> + </methodsynopsis> <para> <function>udm_errno</function> returns mnoGoSearch error number, zero if no error. @@ -441,12 +427,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>udm_error</function></funcdef> - <paramdef>int <parameter>agent</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>udm_error</methodname> + <methodparam><type>int</type><parameter>agent</parameter></methodparam> + </methodsynopsis> <para> <function>udm_error</function> returns mnoGoSearch error message, @@ -473,13 +457,11 @@ <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>udm_find</function></funcdef> - <paramdef>int <parameter>agent</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>udm_find</methodname> + <methodparam><type>int</type><parameter>agent</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> <para> <function>udm_find</function> returns result link identifier on @@ -541,12 +523,10 @@ <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>udm_free_agent</function></funcdef> - <paramdef>int <parameter>agent</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>udm_free_agent</methodname> + <methodparam><type>int</type><parameter>agent</parameter></methodparam> + </methodsynopsis> <para> <function>udm_free_agent</function> returns &true; on success, &false; on error. @@ -571,12 +551,10 @@ <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>udm_free_ispell_data</function></funcdef> - <paramdef>int <parameter>agent</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>udm_free_ispell_data</methodname> + <methodparam><type>int</type><parameter>agent</parameter></methodparam> + </methodsynopsis> <para> <function>udm_free_ispell_data</function> always returns &true;. @@ -605,12 +583,10 @@ <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>udm_free_res</function></funcdef> - <paramdef>int <parameter>res</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>udm_free_res</methodname> + <methodparam><type>int</type><parameter>res</parameter></methodparam> + </methodsynopsis> <para> <function>udm_free_res</function> returns &true; on success, &false; on error. @@ -636,12 +612,10 @@ <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>udm_get_doc_count</function></funcdef> - <paramdef>int <parameter>agent</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>udm_get_doc_count</methodname> + <methodparam><type>int</type><parameter>agent</parameter></methodparam> + </methodsynopsis> <para> <function>udm_get_doc_count</function> returns number of documents in database. @@ -669,14 +643,12 @@ <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>udm_get_res_field</function></funcdef> - <paramdef>int <parameter>res</parameter></paramdef> - <paramdef>int <parameter>row</parameter></paramdef> - <paramdef>int <parameter>field</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>udm_get_res_field</methodname> + <methodparam><type>int</type><parameter>res</parameter></methodparam> + <methodparam><type>int</type><parameter>row</parameter></methodparam> + <methodparam><type>int</type><parameter>field</parameter></methodparam> + </methodsynopsis> <para> <function>udm_get_res_field</function> returns result field value on @@ -781,13 +753,11 @@ <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>udm_get_res_param</function></funcdef> - <paramdef>int <parameter>res</parameter></paramdef> - <paramdef>int <parameter>param</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>udm_get_res_param</methodname> + <methodparam><type>int</type><parameter>res</parameter></methodparam> + <methodparam><type>int</type><parameter>param</parameter></methodparam> + </methodsynopsis> <para> <function>udm_get_res_param</function> returns result parameter value on @@ -849,16 +819,14 @@ <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>udm_load_ispell_data</function></funcdef> - <paramdef>int <parameter>agent</parameter></paramdef> - <paramdef>int <parameter>var</parameter></paramdef> - <paramdef>string <parameter>val1</parameter></paramdef> - <paramdef>string <parameter>val2</parameter></paramdef> - <paramdef>int <parameter>flag</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>udm_load_ispell_data</methodname> + <methodparam><type>int</type><parameter>agent</parameter></methodparam> + <methodparam><type>int</type><parameter>var</parameter></methodparam> + <methodparam><type>string</type><parameter>val1</parameter></methodparam> + <methodparam><type>string</type><parameter>val2</parameter></methodparam> + <methodparam><type>int</type><parameter>flag</parameter></methodparam> + </methodsynopsis> <para> <function>udm_load_ispell_data</function> loads ispell data. Returns &true; @@ -1043,14 +1011,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>udm_set_agent_param</function></funcdef> - <paramdef>int <parameter>agent</parameter></paramdef> - <paramdef>int <parameter>var</parameter></paramdef> - <paramdef>string <parameter>val</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>udm_set_agent_param</methodname> + <methodparam><type>int</type><parameter>agent</parameter></methodparam> + <methodparam><type>int</type><parameter>var</parameter></methodparam> + <methodparam><type>string</type><parameter>val</parameter></methodparam> + </methodsynopsis> <para> <function>udm_set_agent_param</function> returns &true; on success, @@ -1290,13 +1256,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>udm_check_charset</function></funcdef> - <paramdef>int <parameter>agent</parameter></paramdef> - <paramdef>string <parameter>charset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>udm_check_charset</methodname> + <methodparam><type>int</type><parameter>agent</parameter></methodparam> + <methodparam><type>string</type><parameter>charset</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1312,14 +1276,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>udm_check_stored</function></funcdef> - <paramdef>int <parameter>agent</parameter></paramdef> - <paramdef>int <parameter>link</parameter></paramdef> - <paramdef>string <parameter>doc_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>udm_check_stored</methodname> + <methodparam><type>int</type><parameter>agent</parameter></methodparam> + <methodparam><type>int</type><parameter>link</parameter></methodparam> + <methodparam><type>string</type><parameter>doc_id</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1335,13 +1297,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>udm_close_stored</function></funcdef> - <paramdef>int <parameter>agent</parameter></paramdef> - <paramdef>int <parameter>link</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>udm_close_stored</methodname> + <methodparam><type>int</type><parameter>agent</parameter></methodparam> + <methodparam><type>int</type><parameter>link</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1357,13 +1317,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>udm_crc32</function></funcdef> - <paramdef>int <parameter>agent</parameter></paramdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>udm_crc32</methodname> + <methodparam><type>int</type><parameter>agent</parameter></methodparam> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1379,13 +1337,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>udm_open_stored</function></funcdef> - <paramdef>int <parameter>agent</parameter></paramdef> - <paramdef>string <parameter>storedaddr</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>udm_open_stored</methodname> + <methodparam><type>int</type><parameter>agent</parameter></methodparam> + <methodparam><type>string</type><parameter>storedaddr</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1414,3 +1370,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/msession.xml diff -u phpdoc/en/functions/msession.xml:1.5 phpdoc/en/functions/msession.xml:1.6 --- phpdoc/en/functions/msession.xml:1.5 Tue Jan 1 20:45:59 2002 +++ phpdoc/en/functions/msession.xml Sat Feb 2 10:36:04 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <reference id="ref.msession"> <title>Mohawk Software session handler functions</title> <titleabbrev>Msession functions</titleabbrev> @@ -23,13 +23,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>msession_connect</function></funcdef> - <paramdef>string <parameter>host</parameter></paramdef> - <paramdef>string <parameter>port</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>msession_connect</methodname> + <methodparam><type>string</type><parameter>host</parameter></methodparam> + <methodparam><type>string</type><parameter>port</parameter></methodparam> + </methodsynopsis> &warn.undocumented.func; </refsect1> </refentry> @@ -41,12 +39,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>msession_disconnect</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>msession_disconnect</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.undocumented.func; </refsect1> </refentry> @@ -58,12 +54,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msession_count</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>msession_count</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.undocumented.func; </refsect1> </refentry> @@ -75,12 +69,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>msession_create</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>msession_create</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + </methodsynopsis> &warn.undocumented.func; </refsect1> </refentry> @@ -92,12 +84,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>msession_destroy</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>msession_destroy</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> &warn.undocumented.func; </refsect1> </refentry> @@ -109,12 +99,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msession_lock</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msession_lock</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> &warn.undocumented.func; </refsect1> </refentry> @@ -126,13 +114,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msession_unlock</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>int <parameter>key</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msession_unlock</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam><type>int</type><parameter>key</parameter></methodparam> + </methodsynopsis> &warn.undocumented.func; </refsect1> </refentry> @@ -144,14 +130,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>msession_set</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>msession_set</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + </methodsynopsis> &warn.undocumented.func; </refsect1> </refentry> @@ -163,14 +147,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>msession_get</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>msession_get</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + </methodsynopsis> &warn.undocumented.func; </refsect1> </refentry> @@ -182,12 +164,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>msession_uniq</function></funcdef> - <paramdef>int <parameter>param</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>msession_uniq</methodname> + <methodparam><type>int</type><parameter>param</parameter></methodparam> + </methodsynopsis> &warn.undocumented.func; </refsect1> </refentry> @@ -199,12 +179,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>msession_randstr</function></funcdef> - <paramdef>int <parameter>param</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>msession_randstr</methodname> + <methodparam><type>int</type><parameter>param</parameter></methodparam> + </methodsynopsis> &warn.undocumented.func; </refsect1> </refentry> @@ -216,13 +194,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>msession_find</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>msession_find</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + </methodsynopsis> &warn.undocumented.func; </refsect1> </refentry> @@ -234,12 +210,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>msession_list</function></funcdef> + <methodsynopsis> + <type>array</type><methodname>msession_list</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.undocumented.func; </refsect1> </refentry> @@ -251,12 +225,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>msession_get_array</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>msession_get_array</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + </methodsynopsis> &warn.undocumented.func; </refsect1> </refentry> @@ -268,13 +240,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>msession_set_array</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>array <parameter>tuples</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>msession_set_array</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam><type>array</type><parameter>tuples</parameter></methodparam> + </methodsynopsis> &warn.undocumented.func; </refsect1> </refentry> @@ -286,12 +256,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>msession_listvar</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>msession_listvar</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> <para> Returns an associative array of value, session for all sessions with a variable named <parameter>name</parameter>. @@ -309,15 +277,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msession_timeout</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>int - <parameter><optional>param</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msession_timeout</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>param</parameter></methodparam> + </methodsynopsis> &warn.undocumented.func; </refsect1> </refentry> @@ -329,13 +293,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>msession_inc</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>msession_inc</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> &warn.undocumented.func; </refsect1> </refentry> @@ -347,12 +309,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>msession_getdata</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>msession_getdata</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + </methodsynopsis> &warn.undocumented.func; </refsect1> </refentry> @@ -364,13 +324,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>msession_setdata</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>msession_setdata</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + </methodsynopsis> &warn.undocumented.func; </refsect1> </refentry> @@ -382,16 +340,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>msession_plugin</function></funcdef> - <paramdef>string <parameter>session</parameter></paramdef> - <paramdef>string <parameter>val</parameter></paramdef> - <paramdef>string - <parameter><optional>param</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>msession_plugin</methodname> + <methodparam><type>string</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>val</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>param</parameter></methodparam> + </methodsynopsis> &warn.undocumented.func; </refsect1> </refentry> @@ -419,3 +373,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/msql.xml diff -u phpdoc/en/functions/msql.xml:1.23 phpdoc/en/functions/msql.xml:1.24 --- phpdoc/en/functions/msql.xml:1.23 Sat Jan 26 03:56:25 2002 +++ phpdoc/en/functions/msql.xml Sat Feb 2 10:36:04 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.23 $ --> +<!-- $Revision: 1.24 $ --> <reference id="ref.msql"> <title>mSQL functions</title> <titleabbrev>mSQL</titleabbrev> @@ -24,14 +24,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql</function></funcdef> - <paramdef>string <parameter>database</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql</methodname> + <methodparam><type>string</type><parameter>database</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns a positive mSQL query identifier to the query result, or &false; on error. @@ -54,12 +52,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_affected_rows</function></funcdef> - <paramdef>int <parameter>query_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_affected_rows</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns number of affected ("touched") rows by a specific query (i.e. the number of rows returned by a SELECT, the number of rows @@ -79,12 +75,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_close</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_close</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns &true; on success, &false; on error. </para> @@ -117,31 +111,21 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_connect</function></funcdef> - <paramdef>string - <parameter> - <optional>hostname</optional> - </parameter> - </paramdef> - <paramdef>string - <parameter> - <optional>server</optional> - </parameter> - </paramdef> - <paramdef>string - <parameter> - <optional>username</optional> - </parameter> - </paramdef> - <paramdef>string - <parameter> - <optional>password</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_connect</methodname> + <methodparam choice="opt"><type>string</type><parameter> + hostname + </parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + server + </parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + username + </parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + password + </parameter></methodparam> + </methodsynopsis> <para> Returns a positive mSQL link identifier on success, or &false; on error. @@ -177,15 +161,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_create_db</function></funcdef> - <paramdef>string <parameter>database name</parameter></paramdef> - <paramdef>int - <parameter><optional>link_identifier</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_create_db</methodname> + <methodparam><type>string</type><parameter>database name</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> msql_create_db() attempts to create a new database on the server associated with the specified link identifier. @@ -202,15 +182,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_createdb</function></funcdef> - <paramdef>string <parameter>database name</parameter></paramdef> - <paramdef>int - <parameter><optional>link_identifier</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_createdb</methodname> + <methodparam><type>string</type><parameter>database name</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> Identical to <function>msql_create_db</function>. </para> @@ -224,13 +200,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_data_seek</function></funcdef> - <paramdef>int <parameter>query_identifier</parameter></paramdef> - <paramdef>int <parameter>row_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_data_seek</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>row_number</parameter></methodparam> + </methodsynopsis> <para> &return.success; </para> @@ -254,13 +228,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>msql_dbname</function></funcdef> - <paramdef>int <parameter>query_identifier</parameter></paramdef> - <paramdef>int <parameter>i</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>msql_dbname</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>i</parameter></methodparam> + </methodsynopsis> <para> <function>msql_dbname</function> returns the database name stored in position <parameter>i</parameter> of the result pointer @@ -278,13 +250,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_drop_db</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_drop_db</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> &return.success; </para> @@ -319,16 +289,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>msql_error</function></funcdef> - <paramdef>int - <parameter> + <methodsynopsis> + <type>string</type><methodname>msql_error</methodname> + <methodparam><type>int</type><parameter> <replaceable><optional>link_identifier</optional></replaceable> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + </parameter></methodparam> + </methodsynopsis> <para> Errors coming back from the mSQL database backend no longer issue warnings. Instead, use these functions to retrieve the @@ -344,15 +310,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_fetch_array</function></funcdef> - <paramdef>int <parameter>query_identifier</parameter></paramdef> - <paramdef>int - <parameter><optional>result_type</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_fetch_array</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> + </methodsynopsis> <para> Returns an array that corresponds to the fetched row, or &false; if there are no more rows. @@ -393,13 +355,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>msql_fetch_field</function></funcdef> - <paramdef>int <parameter>query_identifier</parameter></paramdef> - <paramdef>int <parameter>field_offset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>msql_fetch_field</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> <para> Returns an object containing field information </para> @@ -457,15 +417,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_fetch_object</function></funcdef> - <paramdef>int <parameter>query_identifier</parameter></paramdef> - <paramdef>int - <parameter><optional>result_type</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_fetch_object</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> + </methodsynopsis> <para> Returns an object with properties that correspond to the fetched row, or &false; if there are no more rows. @@ -502,12 +458,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>msql_fetch_row</function></funcdef> - <paramdef>int <parameter>query_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>msql_fetch_row</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns an array that corresponds to the fetched row, or &false; if there are no more rows. @@ -539,13 +493,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>msql_fieldname</function></funcdef> - <paramdef>int <parameter>query_identifier</parameter></paramdef> - <paramdef>int <parameter>field</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>msql_fieldname</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>field</parameter></methodparam> + </methodsynopsis> <para> <function>msql_fieldname</function> returns the name of the specified field. <parameter>query_identifier</parameter> is the @@ -564,13 +516,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_field_seek</function></funcdef> - <paramdef>int <parameter>query_identifier</parameter></paramdef> - <paramdef>int <parameter>field_offset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_field_seek</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> <para> Seeks to the specified field offset. If the next call to <function>msql_fetch_field</function> won't include a field @@ -589,13 +539,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_fieldtable</function></funcdef> - <paramdef>int <parameter>query_identifier</parameter></paramdef> - <paramdef>int <parameter>field</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_fieldtable</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>field</parameter></methodparam> + </methodsynopsis> <para> Returns the name of the table <parameter>field</parameter> was fetched from. @@ -610,13 +558,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>msql_fieldtype</function></funcdef> - <paramdef>int <parameter>query_identifier</parameter></paramdef> - <paramdef>int <parameter>i</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>msql_fieldtype</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>i</parameter></methodparam> + </methodsynopsis> <para> <function>msql_fieldtype</function> is similar to the <function>msql_fieldname</function> function. The arguments are @@ -633,13 +579,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>msql_fieldflags</function></funcdef> - <paramdef>int <parameter>query_identifier</parameter></paramdef> - <paramdef>int <parameter>i</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>msql_fieldflags</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>i</parameter></methodparam> + </methodsynopsis> <para> <function>msql_fieldflags</function> returns the field flags of the specified field. Currently this is either, "not &null;", @@ -655,13 +599,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_fieldlen</function></funcdef> - <paramdef>int <parameter>query_identifier</parameter></paramdef> - <paramdef>int <parameter>i</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_fieldlen</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>i</parameter></methodparam> + </methodsynopsis> <para> <function>msql_fieldlen</function> returns the length of the specified field. @@ -676,12 +618,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_free_result</function></funcdef> - <paramdef>int <parameter>query_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_free_result</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + </methodsynopsis> <para> <function>msql_free_result</function> frees the memory associated with <parameter>query_identifier</parameter>. When PHP completes a @@ -711,13 +651,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_list_fields</function></funcdef> - <paramdef>string <parameter>database</parameter></paramdef> - <paramdef>string <parameter>tablename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_list_fields</methodname> + <methodparam><type>string</type><parameter>database</parameter></methodparam> + <methodparam><type>string</type><parameter>tablename</parameter></methodparam> + </methodsynopsis> <para> <function>msql_list_fields</function> retrieves information about the given tablename. Arguments are the database name and the @@ -758,12 +696,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_list_dbs</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>msql_list_dbs</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> <function>msql_list_dbs</function> will return a result pointer containing the databases available from the current msql @@ -793,12 +729,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_list_tables</function></funcdef> - <paramdef>string <parameter>database</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_list_tables</methodname> + <methodparam><type>string</type><parameter>database</parameter></methodparam> + </methodsynopsis> <para> <function>msql_list_tables</function> takes a database name and result pointer much like the <function>msql</function> @@ -829,12 +763,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_num_fields</function></funcdef> - <paramdef>int <parameter>query_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_num_fields</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + </methodsynopsis> <para> <function>msql_num_fields</function> returns the number of fields in a result set. @@ -855,12 +787,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_num_rows</function></funcdef> - <paramdef>int <parameter>query_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_num_rows</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + </methodsynopsis> <para> <function>msql_num_rows</function> returns the number of rows in a result set. @@ -880,12 +810,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_numfields</function></funcdef> - <paramdef>int <parameter>query_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_numfields</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + </methodsynopsis> <para> Identical to <function>msql_num_fields</function>. </para> @@ -899,12 +827,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_numrows</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>msql_numrows</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Identical to <function>msql_num_rows</function>. </para> @@ -918,26 +844,18 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_pconnect</function></funcdef> - <paramdef>string - <parameter> - <optional>server</optional> - </parameter> - </paramdef> - <paramdef>string - <parameter> - <optional>username</optional> - </parameter> - </paramdef> - <paramdef>string - <parameter> - <optional>password</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_pconnect</methodname> + <methodparam choice="opt"><type>string</type><parameter> + server + </parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + username + </parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + password + </parameter></methodparam> + </methodsynopsis> <para> Returns a positive mSQL persistent link identifier on success, or &false; on error. @@ -971,13 +889,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_query</function></funcdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_query</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> <function>msql_query</function> sends a query to the currently active database on the server that's associated with the @@ -1041,14 +957,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_result</function></funcdef> - <paramdef>int <parameter>query_identifier</parameter></paramdef> - <paramdef>int <parameter>i</parameter></paramdef> - <paramdef>mixed <parameter>field</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_result</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>i</parameter></methodparam> + <methodparam><type>mixed</type><parameter>field</parameter></methodparam> + </methodsynopsis> <para> Returns the contents of the cell at the row and offset in the specified mSQL result set. @@ -1086,13 +1000,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>msql_select_db</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>msql_select_db</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns &true; on success, &false; on error. </para> @@ -1135,13 +1047,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>msql_tablename</function></funcdef> - <paramdef>int <parameter>query_identifier</parameter></paramdef> - <paramdef>int <parameter>field</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>msql_tablename</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>field</parameter></methodparam> + </methodsynopsis> <para> <function>msql_tablename</function> takes a result pointer returned by the <function>msql_list_tables</function> function as @@ -1191,3 +1101,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/mssql.xml diff -u phpdoc/en/functions/mssql.xml:1.27 phpdoc/en/functions/mssql.xml:1.28 --- phpdoc/en/functions/mssql.xml:1.27 Mon Jan 21 06:58:42 2002 +++ phpdoc/en/functions/mssql.xml Sat Feb 2 10:36:04 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.27 $ --> +<!-- $Revision: 1.28 $ --> <reference id="ref.mssql"> <title>Microsoft SQL Server functions</title> <titleabbrev>MS SQL Server</titleabbrev> @@ -30,14 +30,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mssql_close</function></funcdef> - <paramdef>int - <parameter><optional>link_identifier</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mssql_close</methodname> + <methodparam choice="opt"><type>int</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns: &true; on success, &false; on error. </para> @@ -70,20 +66,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mssql_connect</function></funcdef> - <paramdef>string - <parameter><optional>servername</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>username</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>password</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mssql_connect</methodname> + <methodparam choice="opt"><type>string</type><parameter>servername</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> + </methodsynopsis> <para> Returns: A positive MS SQL link identifier on success, or &false; on error. @@ -118,13 +106,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mssql_data_seek</function></funcdef> - <paramdef>int <parameter>result_identifier</parameter></paramdef> - <paramdef>int <parameter>row_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mssql_data_seek</methodname> + <methodparam><type>int</type><parameter>result_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>row_number</parameter></methodparam> + </methodsynopsis> <para> Returns: &true; on success, &false; on failure. </para> @@ -147,12 +133,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mssql_fetch_array</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mssql_fetch_array</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> Returns: An array that corresponds to the fetched row, or &false; if there are no more rows. @@ -183,15 +167,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>mssql_fetch_field</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - <paramdef>int - <parameter><optional>field_offset</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>mssql_fetch_field</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> <para> Returns an object containing field information. </para> @@ -240,12 +220,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mssql_fetch_object</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mssql_fetch_object</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> Returns: An object with properties that correspond to the fetched row, or &false; if there are no more rows. @@ -277,12 +255,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>mssql_fetch_row</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>mssql_fetch_row</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> Returns: An array that corresponds to the fetched row, or &false; if there are no more rows. @@ -315,15 +291,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mssql_field_length</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - <paramdef>int - <parameter><optional>offset</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mssql_field_length</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -337,15 +309,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mssql_field_name</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - <paramdef>int - <parameter><optional>offset</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mssql_field_name</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam> + </methodsynopsis> </refsect1> </refentry> @@ -356,13 +324,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mssql_field_seek</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - <paramdef>int <parameter>field_offset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mssql_field_seek</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> <para> Seeks to the specified field offset. If the next call to <function>mssql_fetch_field</function> won't include a field @@ -380,15 +346,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mssql_field_type</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - <paramdef>int - <parameter><optional>offset</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mssql_field_type</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam> + </methodsynopsis> </refsect1> </refentry> @@ -399,12 +361,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mssql_free_result</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mssql_free_result</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> <function>mssql_free_result</function> only needs to be called if you are worried about using too much memory while your script @@ -426,14 +386,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string - <function>mssql_get_last_message</function> - </funcdef> + <methodsynopsis> + <type>string</type><methodname>mssql_get_last_message</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> </refsect1> </refentry> @@ -444,14 +400,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>mssql_min_error_severity</function> - </funcdef> - <paramdef>int <parameter>severity</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>mssql_min_error_severity</methodname> + <methodparam><type>int</type><parameter>severity</parameter></methodparam> + </methodsynopsis> </refsect1> </refentry> @@ -462,14 +414,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>mssql_min_message_severity</function> - </funcdef> - <paramdef>int <parameter>severity</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>mssql_min_message_severity</methodname> + <methodparam><type>int</type><parameter>severity</parameter></methodparam> + </methodsynopsis> </refsect1> </refentry> @@ -480,14 +428,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool - <function>mssql_next_result</function> - </funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>mssql_next_result</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> When sending more than one SQL statement to the server or executing a stored procedure with multiple results, it will cause @@ -527,12 +471,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mssql_num_fields</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mssql_num_fields</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> <function>mssql_num_fields</function> returns the number of fields in a result set. @@ -553,12 +495,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mssql_num_rows</function></funcdef> - <paramdef>string <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mssql_num_rows</methodname> + <methodparam><type>string</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> <function>mssql_num_rows</function> returns the number of rows in a result set. @@ -578,20 +518,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mssql_pconnect</function></funcdef> - <paramdef>string - <parameter><optional>servername</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>username</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>password</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mssql_pconnect</methodname> + <methodparam choice="opt"><type>string</type><parameter>servername</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> + </methodsynopsis> <para> Returns: A positive MS SQL persistent link identifier on success, or &false; on error. @@ -625,15 +557,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mssql_query</function></funcdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>int - <parameter><optional>link_identifier</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mssql_query</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns: A positive MS SQL result identifier on success, or &false; on error. @@ -661,14 +589,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mssql_result</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - <paramdef>int <parameter>i</parameter></paramdef> - <paramdef>mixed <parameter>field</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mssql_result</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>i</parameter></methodparam> + <methodparam><type>mixed</type><parameter>field</parameter></methodparam> + </methodsynopsis> <para> <function>mssql_result</function> returns the contents of one cell from a MS SQL result set. The field argument can be the @@ -702,15 +628,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mssql_select_db</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - <paramdef>int - <parameter><optional>link_identifier</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mssql_select_db</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns: &true; on success, &false; on error </para> <para> @@ -742,18 +664,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mssql_bind</function></funcdef> - <paramdef>int <parameter>stmt</parameter></paramdef> - <paramdef>string <parameter>param_name</parameter></paramdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - <paramdef>int <parameter>type</parameter></paramdef> - <paramdef>int <parameter><optional>is_output</optional></parameter></paramdef> - <paramdef>int <parameter><optional>is_null</optional></parameter></paramdef> - <paramdef>int <parameter><optional>maxlen</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mssql_bind</methodname> + <methodparam><type>int</type><parameter>stmt</parameter></methodparam> + <methodparam><type>string</type><parameter>param_name</parameter></methodparam> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + <methodparam><type>int</type><parameter>type</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>is_output</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>is_null</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>maxlen</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -771,12 +691,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mssql_execute</function></funcdef> - <paramdef>int <parameter>stmt</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mssql_execute</methodname> + <methodparam><type>int</type><parameter>stmt</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -794,13 +712,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>mssql_fetch_assoc</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter><optional>result_type</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>mssql_fetch_assoc</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -818,12 +734,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mssql_fetch_batch</function></funcdef> - <paramdef>string <parameter>result_index</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mssql_fetch_batch</methodname> + <methodparam><type>string</type><parameter>result_index</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -841,13 +755,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mssql_guid_string</function></funcdef> - <paramdef>string <parameter>binary</parameter></paramdef> - <paramdef>int <parameter><optional>short_format</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mssql_guid_string</methodname> + <methodparam><type>string</type><parameter>binary</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>short_format</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -865,13 +777,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mssql_init</function></funcdef> - <paramdef>string <parameter>sp_name</parameter></paramdef> - <paramdef>int <parameter><optional>conn_id</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mssql_init</methodname> + <methodparam><type>string</type><parameter>sp_name</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>conn_id</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -889,12 +799,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mssql_rows_affected</function></funcdef> - <paramdef>int <parameter>conn_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mssql_rows_affected</methodname> + <methodparam><type>int</type><parameter>conn_id</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -924,3 +832,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/muscat.xml diff -u phpdoc/en/functions/muscat.xml:1.1 phpdoc/en/functions/muscat.xml:1.2 --- phpdoc/en/functions/muscat.xml:1.1 Sat Dec 15 09:54:58 2001 +++ phpdoc/en/functions/muscat.xml Sat Feb 2 10:36:04 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <reference id="ref.muscat"> <title>muscat functions</title> <titleabbrev>muscat functions</titleabbrev> @@ -17,15 +17,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>muscat_setup</function></funcdef> - <paramdef>int <parameter>size</parameter></paramdef> - <paramdef>string - <parameter><optional>muscat_dir</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>muscat_setup</methodname> + <methodparam><type>int</type><parameter>size</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>muscat_dir</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -40,13 +36,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>muscat_setup_net</function></funcdef> - <paramdef>string <parameter>muscat_host</parameter></paramdef> - <paramdef>int <parameter>port</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>muscat_setup_net</methodname> + <methodparam><type>string</type><parameter>muscat_host</parameter></methodparam> + <methodparam><type>int</type><parameter>port</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -61,13 +55,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>muscat_give</function></funcdef> - <paramdef>resource <parameter>muscat_handle</parameter></paramdef> - <paramdef>string <parameter>string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>muscat_give</methodname> + <methodparam><type>resource</type><parameter>muscat_handle</parameter></methodparam> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -82,12 +74,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>muscat_get</function></funcdef> - <paramdef>resource <parameter>muscat_handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>muscat_get</methodname> + <methodparam><type>resource</type><parameter>muscat_handle</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -102,12 +92,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>muscat_close</function></funcdef> - <paramdef>resource <parameter>muscat_handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>muscat_close</methodname> + <methodparam><type>resource</type><parameter>muscat_handle</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -137,4 +125,5 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/mysql.xml diff -u phpdoc/en/functions/mysql.xml:1.84 phpdoc/en/functions/mysql.xml:1.85 --- phpdoc/en/functions/mysql.xml:1.84 Sat Jan 26 03:56:25 2002 +++ phpdoc/en/functions/mysql.xml Sat Feb 2 10:36:04 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.84 $ --> +<!-- $Revision: 1.85 $ --> <reference id="ref.mysql"> <title>MySQL Functions</title> <titleabbrev>MySQL</titleabbrev> @@ -128,16 +128,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mysql_affected_rows</function></funcdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mysql_affected_rows</methodname> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> <function>mysql_affected_rows</function> returns the number of rows affected by the last INSERT, UPDATE or DELETE query @@ -190,23 +186,17 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mysql_change_user</function></funcdef> - <paramdef>string <parameter>user</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>string - <parameter> - <optional>database</optional> - </parameter> - </paramdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mysql_change_user</methodname> + <methodparam><type>string</type><parameter>user</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + database + </parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> <function>mysql_change_user</function> changes the logged in user of the current active connection, or the connection given by the @@ -235,16 +225,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>mysql_close</function></funcdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>mysql_close</methodname> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> &return.success; </para> @@ -293,26 +279,18 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>mysql_connect</function></funcdef> - <paramdef>string - <parameter> - <optional>server</optional> - </parameter> - </paramdef> - <paramdef>string - <parameter> - <optional>username</optional> - </parameter> - </paramdef> - <paramdef>string - <parameter> - <optional>password</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>mysql_connect</methodname> + <methodparam choice="opt"><type>string</type><parameter> + server + </parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + username + </parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + password + </parameter></methodparam> + </methodsynopsis> <para> Returns a MySQL link identifier on success, or &false; on failure. </para> @@ -380,17 +358,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>mysql_create_db</function></funcdef> - <paramdef>string <parameter>database name</parameter></paramdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>mysql_create_db</methodname> + <methodparam><type>string</type><parameter>database name</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> <function>mysql_create_db</function> attempts to create a new database on the server associated with the specified link @@ -432,13 +406,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>mysql_data_seek</function></funcdef> - <paramdef>resource <parameter>result_identifier</parameter></paramdef> - <paramdef>int <parameter>row_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>mysql_data_seek</methodname> + <methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>row_number</parameter></methodparam> + </methodsynopsis> <para> &return.success; </para> @@ -495,18 +467,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mysql_db_name</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>row</parameter></paramdef> - <paramdef>mixed - <parameter> - <optional>field</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mysql_db_name</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>row</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter> + field + </parameter></methodparam> + </methodsynopsis> <para> <function>mysql_db_name</function> takes as its first parameter the result pointer from a call to @@ -554,18 +522,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>mysql_db_query</function></funcdef> - <paramdef>string <parameter>database</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>mysql_db_query</methodname> + <methodparam><type>string</type><parameter>database</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> Returns a positive MySQL result resource to the query result, or &false; on error. @@ -601,17 +565,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>mysql_drop_db</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>mysql_drop_db</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> &return.success; </para> @@ -640,16 +600,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mysql_errno</function></funcdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mysql_errno</methodname> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> Returns the error number from the last MySQL function, or <literal>0</literal> (zero) if no error occurred. @@ -694,16 +650,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mysql_error</function></funcdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mysql_error</methodname> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> Returns the error text from the last MySQL function, or <literal>''</literal> (the empty string) if no error occurred. @@ -746,12 +698,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mysql_escape_string</function></funcdef> - <paramdef>string <parameter>unescaped_string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mysql_escape_string</methodname> + <methodparam><type>string</type><parameter>unescaped_string</parameter></methodparam> + </methodsynopsis> <para> This function will escape the <parameter>unescaped_string</parameter>, so that it is safe to place it in a <function>mysql_query</function>. @@ -774,17 +724,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>mysql_fetch_array</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int - <parameter> - <optional>result_type</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>mysql_fetch_array</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + result_type + </parameter></methodparam> + </methodsynopsis> <para> Returns an array that corresponds to the fetched row, or &false; if there are no more rows.</para> @@ -866,12 +812,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>mysql_fetch_assoc</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>mysql_fetch_assoc</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> Returns an associative array that corresponds to the fetched row, or &false; if there are no more rows.</para> @@ -934,17 +878,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>mysql_fetch_field</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int - <parameter> - <optional>field_offset</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>mysql_fetch_field</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + field_offset + </parameter></methodparam> + </methodsynopsis> <para> Returns an object containing field information. </para> @@ -1073,12 +1013,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>mysql_fetch_lengths</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>mysql_fetch_lengths</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> Returns an array that corresponds to the lengths of each field in the last row fetched by <function>mysql_fetch_row</function>, @@ -1105,17 +1043,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>mysql_fetch_object</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int - <parameter> - <optional>result_type</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>mysql_fetch_object</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + result_type + </parameter></methodparam> + </methodsynopsis> <para> Returns an object with properties that correspond to the fetched row, or &false; if there are no more rows. @@ -1171,12 +1105,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>mysql_fetch_row</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>mysql_fetch_row</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> Returns an array that corresponds to the fetched row, or &false; if there are no more rows. @@ -1211,13 +1143,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mysql_field_flags</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>field_offset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mysql_field_flags</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> <para> <function>mysql_field_flags</function> returns the field flags of the specified field. The flags are reported as a single word @@ -1245,13 +1175,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mysql_field_name</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>field_index</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mysql_field_name</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_index</parameter></methodparam> + </methodsynopsis> <para> <function>mysql_field_name</function> returns the name of the specified field index. <parameter>result</parameter> must be a @@ -1312,13 +1240,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mysql_field_len</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>field_offset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mysql_field_len</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> <para> <function>mysql_field_len</function> returns the length of the specified field. @@ -1339,13 +1265,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mysql_field_seek</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>field_offset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mysql_field_seek</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> <para> Seeks to the specified field offset. If the next call to <function>mysql_fetch_field</function> doesn't include a field @@ -1367,13 +1291,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mysql_field_table</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>field_offset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mysql_field_table</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> <para> Returns the name of the table that the specifed field is in. @@ -1394,13 +1316,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mysql_field_type</function></funcdef> - <paramdef>iresource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>field_offset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mysql_field_type</methodname> + <methodparam><type>iresource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> <para> <function>mysql_field_type</function> is similar to the <function>mysql_field_name</function> function. The arguments are @@ -1452,12 +1372,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>mysql_free_result</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>mysql_free_result</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> <function>mysql_free_result</function> will free all memory associated with the result identifier <parameter>result</parameter>. @@ -1488,16 +1406,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mysql_insert_id</function></funcdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mysql_insert_id</methodname> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> <function>mysql_insert_id</function> returns the ID generated for an AUTO_INCREMENT column by the previous INSERT query using the @@ -1544,16 +1458,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>mysql_list_dbs</function></funcdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>mysql_list_dbs</methodname> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> <function>mysql_list_dbs</function> will return a result pointer containing the databases available from the current mysql @@ -1611,18 +1521,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>mysql_list_fields</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - <paramdef>string <parameter>table_name</parameter></paramdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>mysql_list_fields</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam><type>string</type><parameter>table_name</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> <function>mysql_list_fields</function> retrieves information about the given tablename. Arguments are the database name and @@ -1679,17 +1585,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>mysql_list_tables</function></funcdef> - <paramdef>string <parameter>database</parameter></paramdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>mysql_list_tables</methodname> + <methodparam><type>string</type><parameter>database</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> <function>mysql_list_tables</function> takes a database name and returns a result pointer much like the @@ -1712,12 +1614,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mysql_num_fields</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mysql_num_fields</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> <function>mysql_num_fields</function> returns the number of fields in a result set. @@ -1742,12 +1642,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mysql_num_rows</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mysql_num_rows</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> <function>mysql_num_rows</function> returns the number of rows in a result set. This command is only valid for SELECT statements. @@ -1795,22 +1693,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>mysql_pconnect</function></funcdef> - <paramdef>string - <parameter> - <optional>server</optional> - </parameter> - </paramdef> - <paramdef>string - <parameter><optional>username</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>password</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>mysql_pconnect</methodname> + <methodparam choice="opt"><type>string</type><parameter> + server + </parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> + </methodsynopsis> <para> Returns a positive MySQL persistent link identifier on success, or &false; on error. @@ -1883,15 +1773,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>mysql_query</function></funcdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>resource - <parameter><optional>link_identifier</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>mysql_query</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> <function>mysql_query</function> sends a query to the currently active database on the server that's associated with the @@ -1997,15 +1883,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>mysql_unbuffered_query</function></funcdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>resource - <parameter><optional>link_identifier</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>mysql_unbuffered_query</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> <function>mysql_unbuffered_query</function> sends a SQL query <parameter>query</parameter> to MySQL, without fetching and @@ -2042,18 +1924,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>mysql_result</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>row</parameter></paramdef> - <paramdef>mixed - <parameter> - <optional>field</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>mysql_result</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>row</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter> + field + </parameter></methodparam> + </methodsynopsis> <para> <function>mysql_result</function> returns the contents of one cell from a MySQL result set. The field argument can be the @@ -2091,17 +1969,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>mysql_select_db</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - <paramdef>resource - <parameter> - <optional>link_identifier</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>mysql_select_db</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter> + link_identifier + </parameter></methodparam> + </methodsynopsis> <para> &return.success; </para> @@ -2136,13 +2010,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mysql_tablename</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>i</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mysql_tablename</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>i</parameter></methodparam> + </methodsynopsis> <para> <function>mysql_tablename</function> takes a result pointer returned by the <function>mysql_list_tables</function> function @@ -2175,12 +2047,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mysql_get_client_info</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>mysql_get_client_info</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> <function>mysql_get_client_info</function> returns a string that represents the client library version. @@ -2198,14 +2068,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>mysql_get_host_info</function></funcdef> - <paramdef>resource - <parameter><optional>link_identifier</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>mysql_get_host_info</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> <function>mysql_get_host_info</function> returns a string describing the type of connection in use for the connection @@ -2226,14 +2092,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mysql_get_proto_info</function></funcdef> - <paramdef>resource - <parameter><optional>link_identifier</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mysql_get_proto_info</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> <function>mysql_get_proto_info</function> returns the protocol version used by connection @@ -2254,14 +2116,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>mysql_get_server_info</function></funcdef> - <paramdef>resource - <parameter><optional>link_identifier</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>mysql_get_server_info</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> <function>mysql_get_server_info</function> returns the server version used by connection @@ -2296,3 +2154,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/ncurses.xml diff -u phpdoc/en/functions/ncurses.xml:1.10 phpdoc/en/functions/ncurses.xml:1.11 --- phpdoc/en/functions/ncurses.xml:1.10 Fri Jan 18 17:52:48 2002 +++ phpdoc/en/functions/ncurses.xml Sat Feb 2 10:36:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <reference id="ref.ncurses"> <title>Ncurses terminal screen control functions</title> <titleabbrev>ncurses functions</titleabbrev> @@ -539,12 +539,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_can_change_color</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_can_change_color</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> The function <function>ncurses_can_change_color</function> returns @@ -560,12 +558,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_cbreak</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_cbreak</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_cbreak</function> disables line buffering and @@ -590,12 +586,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_clear</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_clear</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_clear</function> clears the screen completely @@ -619,12 +613,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_clrtobot</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_clrtobot</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_clrtobot</function> erases all lines from cursor @@ -646,12 +638,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_clrtoeol</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_clrtoeol</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_clrtoeol</function> erases the current line from @@ -673,12 +663,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_def_prog_mode</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_def_prog_mode</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_def_prog_mode</function> saves the current @@ -699,12 +687,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_def_shell_mode</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_def_shell_mode</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_def_shell_mode</function> saves the current @@ -725,12 +711,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_delch</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_delch</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_delch</function> deletes the character under @@ -752,12 +736,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_deleteln</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_deleteln</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_deleteln</function> deletes the current line under @@ -780,12 +762,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_doupdate</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_doupdate</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_doupdate()</function> compares the virtual screen to the @@ -803,12 +783,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_echo</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_echo</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_echo</function> enables echo mode. @@ -829,12 +807,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_erase</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_erase</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_erase</function> fills the terminal screen with @@ -856,12 +832,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ncurses_erasechar</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>ncurses_erasechar</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_erasechar</function> returns the current erase @@ -880,12 +854,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_flash</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_flash</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_flash</function> flashes the screen, and if @@ -905,12 +877,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_flushinp</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_flushinp</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> The <function>ncurses_flushinp</function> throws away any @@ -928,12 +898,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_has_colors</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_has_colors</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_has_colors</function> returns &true; or &false; @@ -952,12 +920,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_has_ic</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_has_ic</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_has_ic</function> checks terminals insert- and @@ -977,12 +943,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_has_il</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_has_il</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_has_il</function> checks terminals insert- and @@ -1002,12 +966,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ncurses_inch</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>ncurses_inch</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_inch</function> returns the character from the @@ -1023,12 +985,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_insertln</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_insertln</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_insertln</function> inserts a new line above @@ -1044,12 +1004,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_isendwin</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_isendwin</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_isendwin</function> returns &true;, if @@ -1071,12 +1029,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_killchar</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_killchar</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_killchar</function> returns the current line @@ -1095,12 +1051,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_nl</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_nl</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1115,12 +1069,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_nocbreak</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_nocbreak</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_nocbreak</function> routine returns terminal to @@ -1143,12 +1095,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_noecho</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_noecho</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_noecho</function> prevents echoing of user @@ -1169,12 +1119,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_nonl</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_nonl</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1189,12 +1137,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_noraw</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_noraw</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_noraw</function> switches the terminal out of raw @@ -1220,12 +1166,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_raw</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_raw</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_raw</function> places the terminal in raw @@ -1251,12 +1195,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_resetty</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_resetty</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> Function <function>ncurses_resetty</function> restores the @@ -1277,12 +1219,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_savetty</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_savetty</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> Function <function>ncurses_savetty</function> saves the current @@ -1303,12 +1243,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_slk_init</function></funcdef> - <paramdef>int <parameter>format</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ncurses_slk_init</methodname> + <methodparam><type>int</type><parameter>format</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Funtion <function>ncurses_slk_init</function> must be called @@ -1333,12 +1271,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_slk_attr</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_slk_attr</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_slk_attr</function> returns the current soft @@ -1354,12 +1290,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_slk_clear</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_slk_clear</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> The function <function>ncurses_slk_clear</function> clears soft @@ -1375,12 +1309,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_slk_noutrefresh</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_slk_noutrefresh</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1395,12 +1327,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_slk_refresh</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_slk_refresh</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_slk_refresh</function> copies soft label keys @@ -1417,12 +1347,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_slk_restore</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_slk_restore</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> The function <function>ncurses_slk_restore</function> restores @@ -1439,12 +1367,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_slk_touch</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_slk_touch</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> The <function>ncurses_slk_touch</function> function forces all the soft @@ -1461,12 +1387,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_termattrs</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_termattrs</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1481,12 +1405,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_use_default_colors</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>ncurses_use_default_colors</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1501,12 +1423,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_addch</function></funcdef> - <paramdef>int <parameter>ch</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_addch</methodname> + <methodparam><type>int</type><parameter>ch</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1521,13 +1441,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_addchnstr</function></funcdef> - <paramdef>string <parameter>s</parameter></paramdef> - <paramdef>int <parameter>n</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_addchnstr</methodname> + <methodparam><type>string</type><parameter>s</parameter></methodparam> + <methodparam><type>int</type><parameter>n</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1542,12 +1460,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_addchstr</function></funcdef> - <paramdef>string <parameter>s</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_addchstr</methodname> + <methodparam><type>string</type><parameter>s</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1562,13 +1478,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_addnstr</function></funcdef> - <paramdef>string <parameter>s</parameter></paramdef> - <paramdef>int <parameter>n</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_addnstr</methodname> + <methodparam><type>string</type><parameter>s</parameter></methodparam> + <methodparam><type>int</type><parameter>n</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1583,12 +1497,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_addstr</function></funcdef> - <paramdef>string <parameter>text</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_addstr</methodname> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1603,13 +1515,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_assume_default_colors</function></funcdef> - <paramdef>int <parameter>fg</parameter></paramdef> - <paramdef>int <parameter>bg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_assume_default_colors</methodname> + <methodparam><type>int</type><parameter>fg</parameter></methodparam> + <methodparam><type>int</type><parameter>bg</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1624,12 +1534,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_attroff</function></funcdef> - <paramdef>int <parameter>attributes</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_attroff</methodname> + <methodparam><type>int</type><parameter>attributes</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1644,12 +1552,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_attron</function></funcdef> - <paramdef>int <parameter>attributes</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_attron</methodname> + <methodparam><type>int</type><parameter>attributes</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1664,12 +1570,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_attrset</function></funcdef> - <paramdef>int <parameter>attributes</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_attrset</methodname> + <methodparam><type>int</type><parameter>attributes</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1684,12 +1588,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_baudrate</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>ncurses_baudrate</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1704,12 +1606,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_beep</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>ncurses_beep</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_beep</function> sends an audlible alert (bell) @@ -1729,12 +1629,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_bkgd</function></funcdef> - <paramdef>int <parameter>attrchar</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_bkgd</methodname> + <methodparam><type>int</type><parameter>attrchar</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1749,19 +1647,17 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_border</function></funcdef> - <paramdef>int <parameter>left</parameter></paramdef> - <paramdef>int <parameter>right</parameter></paramdef> - <paramdef>int <parameter>top</parameter></paramdef> - <paramdef>int <parameter>bottom</parameter></paramdef> - <paramdef>int <parameter>tl_corner</parameter></paramdef> - <paramdef>int <parameter>tr_corner</parameter></paramdef> - <paramdef>int <parameter>bl_corner</parameter></paramdef> - <paramdef>int <parameter>br_corner</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_border</methodname> + <methodparam><type>int</type><parameter>left</parameter></methodparam> + <methodparam><type>int</type><parameter>right</parameter></methodparam> + <methodparam><type>int</type><parameter>top</parameter></methodparam> + <methodparam><type>int</type><parameter>bottom</parameter></methodparam> + <methodparam><type>int</type><parameter>tl_corner</parameter></methodparam> + <methodparam><type>int</type><parameter>tr_corner</parameter></methodparam> + <methodparam><type>int</type><parameter>bl_corner</parameter></methodparam> + <methodparam><type>int</type><parameter>br_corner</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1776,12 +1672,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_color_set</function></funcdef> - <paramdef>int <parameter>pair</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_color_set</methodname> + <methodparam><type>int</type><parameter>pair</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1796,12 +1690,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_curs_set</function></funcdef> - <paramdef>int <parameter>visibility</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_curs_set</methodname> + <methodparam><type>int</type><parameter>visibility</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1816,13 +1708,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_define_key</function></funcdef> - <paramdef>string <parameter>definition</parameter></paramdef> - <paramdef>int <parameter>keycode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_define_key</methodname> + <methodparam><type>string</type><parameter>definition</parameter></methodparam> + <methodparam><type>int</type><parameter>keycode</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1837,12 +1727,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_delay_output</function></funcdef> - <paramdef>int <parameter>milliseconds</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_delay_output</methodname> + <methodparam><type>int</type><parameter>milliseconds</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1857,12 +1745,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_delwin</function></funcdef> - <paramdef>resource <parameter>window</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_delwin</methodname> + <methodparam><type>resource</type><parameter>window</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1877,12 +1763,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_echochar</function></funcdef> - <paramdef>int <parameter>character</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_echochar</methodname> + <methodparam><type>int</type><parameter>character</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1897,12 +1781,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_end</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>ncurses_end</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1917,12 +1799,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_filter</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>ncurses_filter</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1937,12 +1817,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_getch</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>ncurses_getch</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1957,12 +1835,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_halfdelay</function></funcdef> - <paramdef>int <parameter>tenth</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_halfdelay</methodname> + <methodparam><type>int</type><parameter>tenth</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1977,12 +1853,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_has_key</function></funcdef> - <paramdef>int <parameter>keycode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_has_key</methodname> + <methodparam><type>int</type><parameter>keycode</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -1997,13 +1871,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_hline</function></funcdef> - <paramdef>int <parameter>charattr</parameter></paramdef> - <paramdef>int <parameter>n</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_hline</methodname> + <methodparam><type>int</type><parameter>charattr</parameter></methodparam> + <methodparam><type>int</type><parameter>n</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2018,12 +1890,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_init</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>ncurses_init</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2038,15 +1908,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_init_color</function></funcdef> - <paramdef>int <parameter>color</parameter></paramdef> - <paramdef>int <parameter>r</parameter></paramdef> - <paramdef>int <parameter>g</parameter></paramdef> - <paramdef>int <parameter>b</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_init_color</methodname> + <methodparam><type>int</type><parameter>color</parameter></methodparam> + <methodparam><type>int</type><parameter>r</parameter></methodparam> + <methodparam><type>int</type><parameter>g</parameter></methodparam> + <methodparam><type>int</type><parameter>b</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2061,14 +1929,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_init_pair</function></funcdef> - <paramdef>int <parameter>pair</parameter></paramdef> - <paramdef>int <parameter>fg</parameter></paramdef> - <paramdef>int <parameter>bg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_init_pair</methodname> + <methodparam><type>int</type><parameter>pair</parameter></methodparam> + <methodparam><type>int</type><parameter>fg</parameter></methodparam> + <methodparam><type>int</type><parameter>bg</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2083,12 +1949,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_insch</function></funcdef> - <paramdef>int <parameter>character</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_insch</methodname> + <methodparam><type>int</type><parameter>character</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2103,12 +1967,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_insdelln</function></funcdef> - <paramdef>int <parameter>count</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_insdelln</methodname> + <methodparam><type>int</type><parameter>count</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2123,12 +1985,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_insstr</function></funcdef> - <paramdef>string <parameter>text</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_insstr</methodname> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2143,12 +2003,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_instr</function></funcdef> - <paramdef>string <parameter>buffer</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_instr</methodname> + <methodparam><type>string</type><parameter>buffer</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_instr</function> returns the number of @@ -2167,13 +2025,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_keyok</function></funcdef> - <paramdef>int <parameter>keycode</parameter></paramdef> - <paramdef>bool <parameter>enable</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_keyok</methodname> + <methodparam><type>int</type><parameter>keycode</parameter></methodparam> + <methodparam><type>bool</type><parameter>enable</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2188,12 +2044,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_mouseinterval</function></funcdef> - <paramdef>int <parameter>milliseconds</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_mouseinterval</methodname> + <methodparam><type>int</type><parameter>milliseconds</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2208,13 +2062,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_move</function></funcdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_move</methodname> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2229,14 +2081,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_mvaddch</function></funcdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>c</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_mvaddch</methodname> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>c</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2251,15 +2101,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_mvaddchnstr</function></funcdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>string <parameter>s</parameter></paramdef> - <paramdef>int <parameter>n</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_mvaddchnstr</methodname> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>string</type><parameter>s</parameter></methodparam> + <methodparam><type>int</type><parameter>n</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2274,14 +2122,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_mvaddchstr</function></funcdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>string <parameter>s</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_mvaddchstr</methodname> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>string</type><parameter>s</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2296,15 +2142,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_mvaddnstr</function></funcdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>string <parameter>s</parameter></paramdef> - <paramdef>int <parameter>n</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_mvaddnstr</methodname> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>string</type><parameter>s</parameter></methodparam> + <methodparam><type>int</type><parameter>n</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2319,14 +2163,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_mvaddstr</function></funcdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>string <parameter>s</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_mvaddstr</methodname> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>string</type><parameter>s</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2341,15 +2183,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_mvcur</function></funcdef> - <paramdef>int <parameter>old_y</parameter></paramdef> - <paramdef>int <parameter>old_x</parameter></paramdef> - <paramdef>int <parameter>new_y</parameter></paramdef> - <paramdef>int <parameter>new_x</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_mvcur</methodname> + <methodparam><type>int</type><parameter>old_y</parameter></methodparam> + <methodparam><type>int</type><parameter>old_x</parameter></methodparam> + <methodparam><type>int</type><parameter>new_y</parameter></methodparam> + <methodparam><type>int</type><parameter>new_x</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2364,13 +2204,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_mvdelch</function></funcdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_mvdelch</methodname> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2385,13 +2223,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_mvgetch</function></funcdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_mvgetch</methodname> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2406,15 +2242,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_mvhline</function></funcdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>attrchar</parameter></paramdef> - <paramdef>int <parameter>n</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_mvhline</methodname> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>attrchar</parameter></methodparam> + <methodparam><type>int</type><parameter>n</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2429,13 +2263,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_mvinch</function></funcdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_mvinch</methodname> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2450,15 +2282,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_mvvline</function></funcdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>attrchar</parameter></paramdef> - <paramdef>int <parameter>n</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_mvvline</methodname> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>attrchar</parameter></methodparam> + <methodparam><type>int</type><parameter>n</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2473,15 +2303,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_mvwaddstr</function></funcdef> - <paramdef>resource <parameter>window</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_mvwaddstr</methodname> + <methodparam><type>resource</type><parameter>window</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2496,12 +2324,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_napms</function></funcdef> - <paramdef>int <parameter>milliseconds</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_napms</methodname> + <methodparam><type>int</type><parameter>milliseconds</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2516,15 +2342,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_newwin</function></funcdef> - <paramdef>int <parameter>rows</parameter></paramdef> - <paramdef>int <parameter>cols</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_newwin</methodname> + <methodparam><type>int</type><parameter>rows</parameter></methodparam> + <methodparam><type>int</type><parameter>cols</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2539,12 +2363,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_noqiflush</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>ncurses_noqiflush</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2559,12 +2381,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_putp</function></funcdef> - <paramdef>string <parameter>text</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_putp</methodname> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2579,12 +2399,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_qiflush</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>ncurses_qiflush</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2599,12 +2417,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_refresh</function></funcdef> - <paramdef>int <parameter>ch</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_refresh</methodname> + <methodparam><type>int</type><parameter>ch</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2619,12 +2435,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_scr_dump</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_scr_dump</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2639,12 +2453,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_scr_init</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_scr_init</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2659,12 +2471,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_scr_restore</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_scr_restore</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2679,12 +2489,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_scr_set</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_scr_set</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2699,12 +2507,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_scrl</function></funcdef> - <paramdef>int <parameter>count</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_scrl</methodname> + <methodparam><type>int</type><parameter>count</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2719,12 +2525,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_slk_attroff</function></funcdef> - <paramdef>int <parameter>intarg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_slk_attroff</methodname> + <methodparam><type>int</type><parameter>intarg</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2739,12 +2543,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_slk_attron</function></funcdef> - <paramdef>int <parameter>intarg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_slk_attron</methodname> + <methodparam><type>int</type><parameter>intarg</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2759,12 +2561,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_slk_attrset</function></funcdef> - <paramdef>int <parameter>intarg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_slk_attrset</methodname> + <methodparam><type>int</type><parameter>intarg</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2779,12 +2579,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_slk_color</function></funcdef> - <paramdef>int <parameter>intarg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_slk_color</methodname> + <methodparam><type>int</type><parameter>intarg</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2799,12 +2597,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_standend</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>ncurses_standend</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2819,12 +2615,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_standout</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>ncurses_standout</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2839,12 +2633,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_start_color</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>ncurses_start_color</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2859,12 +2651,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_typeahead</function></funcdef> - <paramdef>int <parameter>fd</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_typeahead</methodname> + <methodparam><type>int</type><parameter>fd</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2879,12 +2669,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_ungetch</function></funcdef> - <paramdef>int <parameter>keycode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_ungetch</methodname> + <methodparam><type>int</type><parameter>keycode</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2899,12 +2687,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_use_extended_names</function></funcdef> - <paramdef>bool <parameter>flag</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_use_extended_names</methodname> + <methodparam><type>bool</type><parameter>flag</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2919,12 +2705,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_vidattr</function></funcdef> - <paramdef>int <parameter>intarg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_vidattr</methodname> + <methodparam><type>int</type><parameter>intarg</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2939,13 +2723,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_vline</function></funcdef> - <paramdef>int <parameter>charattr</parameter></paramdef> - <paramdef>int <parameter>n</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_vline</methodname> + <methodparam><type>int</type><parameter>charattr</parameter></methodparam> + <methodparam><type>int</type><parameter>n</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2960,12 +2742,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_wrefresh</function></funcdef> - <paramdef>resource <parameter>window</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_wrefresh</methodname> + <methodparam><type>resource</type><parameter>window</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -2980,12 +2760,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>ncurses_bkgdset</function></funcdef> - <paramdef>int <parameter>attrchar</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>ncurses_bkgdset</methodname> + <methodparam><type>int</type><parameter>attrchar</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -3000,12 +2778,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>ncurses_timeout</function></funcdef> - <paramdef>int <parameter>millisec</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>ncurses_timeout</methodname> + <methodparam><type>int</type><parameter>millisec</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -3020,12 +2796,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>ncurses_use_env</function></funcdef> - <paramdef>bool <parameter>flag</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>ncurses_use_env</methodname> + <methodparam><type>bool</type><parameter>flag</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> undocumented @@ -3040,12 +2814,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ncurses_termname</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>ncurses_termname</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_termname</function> returns terminals @@ -3065,12 +2837,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ncurses_longname</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>ncurses_longname</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_longname</function> returns a verbose @@ -3091,13 +2861,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ncurses_mousemask</function></funcdef> - <paramdef>int <parameter>newmask</parameter></paramdef> - <paramdef>int <parameter>oldmask</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ncurses_mousemask</methodname> + <methodparam><type>int</type><parameter>newmask</parameter></methodparam> + <methodparam><type>int</type><parameter>oldmask</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Function <function>ncurses_mousemask</function> will set mouse events @@ -3181,12 +2949,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_getmouse</function></funcdef> - <paramdef>array <parameter>mevent</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ncurses_getmouse</methodname> + <methodparam><type>array</type><parameter>mevent</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_getmouse</function> reads mouse event out of @@ -3246,12 +3012,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ncurses_ungetmouse</function></funcdef> - <paramdef>array <parameter>mevent</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ncurses_ungetmouse</methodname> + <methodparam><type>array</type><parameter>mevent</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>ncurses_getmouse</function> pushes a KEY_MOUSE event @@ -3302,4 +3066,5 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/network.xml diff -u phpdoc/en/functions/network.xml:1.52 phpdoc/en/functions/network.xml:1.53 --- phpdoc/en/functions/network.xml:1.52 Wed Jan 2 04:46:33 2002 +++ phpdoc/en/functions/network.xml Sat Feb 2 10:36:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.52 $ --> +<!-- $Revision: 1.53 $ --> <reference id="ref.network"> <title>Network Functions</title> <titleabbrev>Network</titleabbrev> @@ -14,15 +14,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>checkdnsrr</function></funcdef> - <paramdef>string <parameter>host</parameter></paramdef> - <paramdef>string - <parameter><optional>type</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>checkdnsrr</methodname> + <methodparam><type>string</type><parameter>host</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>type</parameter></methodparam> + </methodsynopsis> <simpara> Searches DNS for records of type <parameter>type</parameter> corresponding to <parameter>host</parameter>. Returns &true; if any @@ -55,12 +51,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>closelog</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>closelog</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> <function>closelog</function> closes the descriptor being used to write to the system logger. The use of @@ -81,12 +75,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>debugger_off</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>debugger_off</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Disables the internal PHP debugger. The debugger is still under development. @@ -101,12 +93,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>debugger_on</function></funcdef> - <paramdef>string <parameter>address</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>debugger_on</methodname> + <methodparam><type>string</type><parameter>address</parameter></methodparam> + </methodsynopsis> <para> Enables the internal PHP debugger, connecting it to <parameter>address</parameter>. The debugger is still under @@ -122,12 +112,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>define_syslog_variables</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>define_syslog_variables</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Initializes all constants used in the syslog functions. </para> @@ -149,24 +137,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>fsockopen</function></funcdef> - <paramdef> - string <parameter><optional>udp://</optional>hostname</parameter> - </paramdef> - <paramdef>int <parameter>port</parameter></paramdef> - <paramdef>int - <parameter><optional>errno</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>errstr</optional></parameter> - </paramdef> - <paramdef>float - <parameter><optional>timeout</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>fsockopen</methodname> + <methodparam choice="opt"><type>string</type><parameter>udp://hostname</parameter></methodparam> + <methodparam><type>int</type><parameter>port</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>errno</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>errstr</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>timeout</parameter></methodparam> + </methodsynopsis> <para> Initiates a stream connection in the Internet (AF_INET, using TCP or UDP) or Unix (AF_UNIX) domain. For the Internet domain, it @@ -271,12 +249,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>gethostbyaddr</function></funcdef> - <paramdef>string <parameter>ip_address</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>gethostbyaddr</methodname> + <methodparam><type>string</type><parameter>ip_address</parameter></methodparam> + </methodsynopsis> <para> Returns the host name of the Internet host specified by <parameter>ip_address</parameter>. If an error occurs, returns @@ -297,12 +273,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>gethostbyname</function></funcdef> - <paramdef>string <parameter>hostname</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>gethostbyname</methodname> + <methodparam><type>string</type><parameter>hostname</parameter></methodparam> + </methodsynopsis> <para> Returns the IP address of the Internet host specified by <parameter>hostname</parameter>. @@ -323,12 +297,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>gethostbynamel</function></funcdef> - <paramdef>string <parameter>hostname</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>gethostbynamel</methodname> + <methodparam><type>string</type><parameter>hostname</parameter></methodparam> + </methodsynopsis> <para> Returns a list of IP addresses to which the Internet host specified by <parameter>hostname</parameter> resolves. @@ -351,16 +323,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>getmxrr</function></funcdef> - <paramdef>string <parameter>hostname</parameter></paramdef> - <paramdef>array <parameter>mxhosts</parameter></paramdef> - <paramdef>array - <parameter><optional>weight</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>getmxrr</methodname> + <methodparam><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam><type>array</type><parameter>mxhosts</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>weight</parameter></methodparam> + </methodsynopsis> <simpara> Searches DNS for MX records corresponding to <parameter>hostname</parameter>. Returns &true; if any records are @@ -392,12 +360,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>getprotobyname</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>getprotobyname</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> <para> <function>getprotobyname</function> returns the protocol number associated with the protocol <parameter>name</parameter> as per @@ -418,12 +384,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>getprotobynumber</function></funcdef> - <paramdef>int <parameter>number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>getprotobynumber</methodname> + <methodparam><type>int</type><parameter>number</parameter></methodparam> + </methodsynopsis> <para> <function>getprotobynumber</function> returns the protocol name associated with protocol <parameter>number</parameter> as per @@ -444,13 +408,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>getservbyname</function></funcdef> - <paramdef>string <parameter>service</parameter></paramdef> - <paramdef>string <parameter>protocol</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>getservbyname</methodname> + <methodparam><type>string</type><parameter>service</parameter></methodparam> + <methodparam><type>string</type><parameter>protocol</parameter></methodparam> + </methodsynopsis> <para> <function>getservbyname</function> returns the Internet port which corresponds to <parameter>service</parameter> for the @@ -474,13 +436,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>getservbyport</function></funcdef> - <paramdef>int <parameter>port</parameter></paramdef> - <paramdef>string <parameter>protocol</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>getservbyport</methodname> + <methodparam><type>int</type><parameter>port</parameter></methodparam> + <methodparam><type>string</type><parameter>protocol</parameter></methodparam> + </methodsynopsis> <para> <function>getservbyport</function> returns the Internet service associated with <parameter>port</parameter> for the specified @@ -504,12 +464,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ip2long</function></funcdef> - <paramdef>string <parameter>ip_address</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ip2long</methodname> + <methodparam><type>string</type><parameter>ip_address</parameter></methodparam> + </methodsynopsis> <para> The function <function>ip2long</function> generates an IPv4 Internet network address from its Internet standard format (dotted string) @@ -566,12 +524,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>long2ip</function></funcdef> - <paramdef>int <parameter>proper_address</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>long2ip</methodname> + <methodparam><type>int</type><parameter>proper_address</parameter></methodparam> + </methodsynopsis> <para> The function <function>long2ip</function> generates an Internet address in dotted format (i.e.: aaa.bbb.ccc.ddd) from the proper address @@ -590,14 +546,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>openlog</function></funcdef> - <paramdef>string <parameter>ident</parameter></paramdef> - <paramdef>int <parameter>option</parameter></paramdef> - <paramdef>int <parameter>facility</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>openlog</methodname> + <methodparam><type>string</type><parameter>ident</parameter></methodparam> + <methodparam><type>int</type><parameter>option</parameter></methodparam> + <methodparam><type>int</type><parameter>facility</parameter></methodparam> + </methodsynopsis> <para> <function>openlog</function> opens a connection to the system logger for a program. The string <parameter>ident</parameter> is @@ -744,22 +698,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pfsockopen</function></funcdef> - <paramdef>string <parameter>hostname</parameter></paramdef> - <paramdef>int <parameter>port</parameter></paramdef> - <paramdef>int - <parameter><optional>errno</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>errstr</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>timeout</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pfsockopen</methodname> + <methodparam><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam><type>int</type><parameter>port</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>errno</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>errstr</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + </methodsynopsis> <para> This function behaves exactly as <function>fsockopen</function> with the difference that the connection is not closed after the @@ -778,14 +724,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>socket_get_status</function></funcdef> - <paramdef>resource - <parameter>socket_get_status</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>socket_get_status</methodname> + <methodparam><type>resource</type><parameter>socket_get_status</parameter></methodparam> + </methodsynopsis> <para> Returns information about an existing socket resource. Currently returns four entries in the result array: @@ -832,13 +774,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>socket_set_blocking</function></funcdef> - <paramdef>int <parameter>socket descriptor</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>socket_set_blocking</methodname> + <methodparam><type>int</type><parameter>socket descriptor</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> If <parameter>mode</parameter> is &false;, the given socket descriptor will be switched to non-blocking mode, and if &true;, it @@ -862,14 +802,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>socket_set_timeout</function></funcdef> - <paramdef>int <parameter>socket descriptor</parameter></paramdef> - <paramdef>int <parameter>seconds</parameter></paramdef> - <paramdef>int <parameter>microseconds</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>socket_set_timeout</methodname> + <methodparam><type>int</type><parameter>socket descriptor</parameter></methodparam> + <methodparam><type>int</type><parameter>seconds</parameter></methodparam> + <methodparam><type>int</type><parameter>microseconds</parameter></methodparam> + </methodsynopsis> <para> Sets the timeout value on <parameter>socket descriptor</parameter>, expressed in the sum of <parameter>seconds</parameter> and @@ -913,13 +851,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>syslog</function></funcdef> - <paramdef>int <parameter>priority</parameter></paramdef> - <paramdef>string <parameter>message</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>syslog</methodname> + <methodparam><type>int</type><parameter>priority</parameter></methodparam> + <methodparam><type>string</type><parameter>message</parameter></methodparam> + </methodsynopsis> <para> <function>syslog</function> generates a log message that will be distributed by the system logger. @@ -1046,3 +982,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/nis.xml diff -u phpdoc/en/functions/nis.xml:1.20 phpdoc/en/functions/nis.xml:1.21 --- phpdoc/en/functions/nis.xml:1.20 Sat Dec 15 09:49:26 2001 +++ phpdoc/en/functions/nis.xml Sat Feb 2 10:36:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.20 $ --> +<!-- $Revision: 1.21 $ --> <reference id="ref.nis"> <title>YP/NIS Functions</title> <titleabbrev>YP/NIS</titleabbrev> @@ -26,12 +26,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yp_get_default_domain</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>yp_get_default_domain</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> <function>yp_get_default_domain</function> returns the default domain of the node or &false;. Can be used as the domain parameter @@ -72,13 +70,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yp_order</function></funcdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>map</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>yp_order</methodname> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>map</parameter></methodparam> + </methodsynopsis> <para> <function>yp_order</function> returns the order number for a map or &false;. @@ -115,13 +111,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>yp_master</function></funcdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>map</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>yp_master</methodname> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>map</parameter></methodparam> + </methodsynopsis> <para> <function>yp_master</function> returns the machine name of the master NIS server for a map. @@ -156,14 +150,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>yp_match</function></funcdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>map</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>yp_match</methodname> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>map</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + </methodsynopsis> <para> <function>yp_match</function> returns the value associated with the passed key out of the specified map or &false;. This key must @@ -204,13 +196,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>yp_first</function></funcdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>map</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>yp_first</methodname> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>map</parameter></methodparam> + </methodsynopsis> <para> <function>yp_first</function> returns the first key-value pair from the named map in the named domain, otherwise &false;. @@ -248,14 +238,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>yp_next</function></funcdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>map</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>yp_next</methodname> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>map</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + </methodsynopsis> <para> <function>yp_next</function> returns the next key-value pair in the named map after the specified key or &false;. @@ -301,12 +289,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yp_errno</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>yp_errno</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> <function>yp_errno</function> returns the error code of the previous operation. @@ -349,12 +335,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>yp_err_string</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>yp_err_string</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> <function>yp_err_string</function> returns the error message associated with the previous operation. Useful to indicate what @@ -387,14 +371,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>yp_all</function></funcdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>map</parameter></paramdef> - <paramdef>string <parameter>callback</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>yp_all</methodname> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>map</parameter></methodparam> + <methodparam><type>string</type><parameter>callback</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -410,13 +392,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>yp_cat</function></funcdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>map</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>yp_cat</methodname> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>map</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -445,3 +425,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/notes.xml diff -u phpdoc/en/functions/notes.xml:1.4 phpdoc/en/functions/notes.xml:1.5 --- phpdoc/en/functions/notes.xml:1.4 Sun Jan 13 23:04:12 2002 +++ phpdoc/en/functions/notes.xml Sat Feb 2 10:36:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <reference id="ref.notes"> <title>Lotus Notes functions</title> <titleabbrev>Lotus Notes</titleabbrev> @@ -17,12 +17,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>notes_create_db</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>notes_create_db</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -37,12 +35,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>notes_drop_db</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>notes_drop_db</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -57,12 +53,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>notes_version</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>notes_version</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -77,13 +71,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>notes_create_note</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - <paramdef>string <parameter>form_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>notes_create_note</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam><type>string</type><parameter>form_name</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -98,14 +90,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>notes_mark_read</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - <paramdef>string <parameter>user_name</parameter></paramdef> - <paramdef>string <parameter>note_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>notes_mark_read</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam><type>string</type><parameter>user_name</parameter></methodparam> + <methodparam><type>string</type><parameter>note_id</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -120,14 +110,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>notes_mark_unread</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - <paramdef>string <parameter>user_name</parameter></paramdef> - <paramdef>string <parameter>note_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>notes_mark_unread</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam><type>string</type><parameter>user_name</parameter></methodparam> + <methodparam><type>string</type><parameter>note_id</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -142,13 +130,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>notes_unread</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - <paramdef>string <parameter>user_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>notes_unread</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam><type>string</type><parameter>user_name</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -163,14 +149,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>notes_header_info</function></funcdef> - <paramdef>string <parameter>server</parameter></paramdef> - <paramdef>string <parameter>mailbox</parameter></paramdef> - <paramdef>int <parameter>msg_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>notes_header_info</methodname> + <methodparam><type>string</type><parameter>server</parameter></methodparam> + <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> + <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -185,14 +169,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>notes_body</function></funcdef> - <paramdef>string <parameter>server</parameter></paramdef> - <paramdef>string <parameter>mailbox</parameter></paramdef> - <paramdef>int <parameter>msg_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>notes_body</methodname> + <methodparam><type>string</type><parameter>server</parameter></methodparam> + <methodparam><type>string</type><parameter>mailbox</parameter></methodparam> + <methodparam><type>int</type><parameter>msg_number</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -207,16 +189,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>notes_find_note</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>string - <parameter><optional>type</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>notes_find_note</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>type</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -231,13 +209,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>notes_nav_create</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>notes_nav_create</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -252,13 +228,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>notes_search</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - <paramdef>string <parameter>keywords</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>notes_search</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam><type>string</type><parameter>keywords</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -273,13 +247,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>notes_copy_db</function></funcdef> - <paramdef>string <parameter>from_database_name</parameter></paramdef> - <paramdef>string <parameter>to_database_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>notes_copy_db</methodname> + <methodparam><type>string</type><parameter>from_database_name</parameter></methodparam> + <methodparam><type>string</type><parameter>to_database_name</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -294,12 +266,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>notes_list_msgs</function></funcdef> - <paramdef>string <parameter>db</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>notes_list_msgs</methodname> + <methodparam><type>string</type><parameter>db</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -329,4 +299,5 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/oci8.xml diff -u phpdoc/en/functions/oci8.xml:1.40 phpdoc/en/functions/oci8.xml:1.41 --- phpdoc/en/functions/oci8.xml:1.40 Tue Dec 18 16:12:53 2001 +++ phpdoc/en/functions/oci8.xml Sat Feb 2 10:36:05 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.40 $ --> +<!-- $Revision: 1.41 $ --> <reference id="ref.oci8"> <title>Oracle 8 functions</title> <titleabbrev>OCI8</titleabbrev> @@ -164,16 +164,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCIDefineByName</function></funcdef> - <paramdef>int <parameter>stmt</parameter></paramdef> - <paramdef>string <parameter>Column-Name</parameter></paramdef> - <paramdef>mixed <parameter>variable</parameter></paramdef> - <paramdef>int <parameter><optional>type</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCIDefineByName</methodname> + <methodparam><type>int</type><parameter>stmt</parameter></methodparam> + <methodparam><type>string</type><parameter>Column-Name</parameter></methodparam> + <methodparam><type>mixed</type><parameter>variable</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam> + </methodsynopsis> <para> <function>OCIDefineByName</function> uses fetches SQL-Columns into user-defined PHP-Variables. Be careful that Oracle user @@ -230,17 +227,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCIBindByName</function></funcdef> - <paramdef>int <parameter>stmt</parameter></paramdef> - <paramdef>string <parameter>ph_name</parameter></paramdef> - <paramdef>mixed &amp;<parameter>variable</parameter></paramdef> - <paramdef>int <parameter>length</parameter></paramdef> - <paramdef>int <parameter> - <optional>type</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCIBindByName</methodname> + <methodparam><type>int</type><parameter>stmt</parameter></methodparam> + <methodparam><type>string</type><parameter>ph_name</parameter></methodparam> + <methodparam><type>mixed &amp;</type><parameter>variable</parameter></methodparam> + <methodparam><type>int</type><parameter>length</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + type</parameter></methodparam> + </methodsynopsis> <para> <function>OCIBindByName</function> binds the PHP variable <parameter>variable</parameter> to the Oracle placeholder @@ -340,16 +335,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCILogon</function></funcdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>string - <parameter><optional>db</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCILogon</methodname> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>db</parameter></methodparam> + </methodsynopsis> <para> <function>OCILogon</function> returns an connection identifier needed for most other OCI calls. The optional third parameter @@ -468,16 +459,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCIPLogon</function></funcdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>string - <parameter><optional>db</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCIPLogon</methodname> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>db</parameter></methodparam> + </methodsynopsis> <para> <function>OCIPLogon</function> creates a persistent connection to an Oracle 8 database and logs on. The optional third parameter @@ -502,16 +489,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCINLogon</function></funcdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>string - <parameter><optional>db</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCINLogon</methodname> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>db</parameter></methodparam> + </methodsynopsis> <para> <function>OCINLogon</function> creates a new connection to an Oracle 8 database and logs on. The optional third parameter can @@ -634,12 +617,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCILogOff</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCILogOff</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>OCILogOff</function> closes an Oracle connection. </para> @@ -653,15 +634,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCIExecute</function></funcdef> - <paramdef>int <parameter>statement</parameter></paramdef> - <paramdef>int - <parameter><optional>mode</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCIExecute</methodname> + <methodparam><type>int</type><parameter>statement</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> <function>OCIExecute</function> executes a previously parsed statement. (see <function>OCIParse</function>. The optional @@ -680,12 +657,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCICommit</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCICommit</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>OCICommit</function> commits all outstanding statements for Oracle connection <parameter>connection</parameter>. @@ -700,12 +675,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCIRollback</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCIRollback</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>OCIRollback</function> rolls back all outstanding statements for Oracle connection <parameter>connection</parameter>. @@ -722,15 +695,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>OCINewDescriptor</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int - <parameter><optional>type</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>OCINewDescriptor</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam> + </methodsynopsis> <para> <function>OCINewDescriptor</function> Allocates storage to hold descriptors or LOB locators. Valid values for the valid @@ -852,12 +821,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCIRowCount</function></funcdef> - <paramdef>int <parameter>statement</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCIRowCount</methodname> + <methodparam><type>int</type><parameter>statement</parameter></methodparam> + </methodsynopsis> <para> <function>OCIRowCount</function> returns the number of rows affected for eg update-statements. This function will not tell you the number @@ -901,12 +868,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCINumCols</function></funcdef> - <paramdef>int <parameter>stmt</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCINumCols</methodname> + <methodparam><type>int</type><parameter>stmt</parameter></methodparam> + </methodsynopsis> <para> <function>OCINumCols</function> returns the number of columns in a statement @@ -948,13 +913,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>OCIResult</function></funcdef> - <paramdef>int <parameter>statement</parameter></paramdef> - <paramdef>mixed <parameter>column</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>OCIResult</methodname> + <methodparam><type>int</type><parameter>statement</parameter></methodparam> + <methodparam><type>mixed</type><parameter>column</parameter></methodparam> + </methodsynopsis> <para> <function>OCIResult</function> returns the data for column <parameter>column</parameter> in the current row (see @@ -972,12 +935,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCIFetch</function></funcdef> - <paramdef>int <parameter>statement</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCIFetch</methodname> + <methodparam><type>int</type><parameter>statement</parameter></methodparam> + </methodsynopsis> <para> <function>OCIFetch</function> fetches the next row (for SELECT statements) into the internal result-buffer. @@ -992,16 +953,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCIFetchInto</function></funcdef> - <paramdef>int <parameter>stmt</parameter></paramdef> - <paramdef>array &amp;<parameter>result</parameter></paramdef> - <paramdef>int - <parameter><optional>mode</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCIFetchInto</methodname> + <methodparam><type>int</type><parameter>stmt</parameter></methodparam> + <methodparam><type>array &amp;</type><parameter>result</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> <function>OCIFetchInto</function> fetches the next row (for SELECT statements) into the <parameter>result</parameter> array. @@ -1042,13 +999,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCIFetchStatement</function></funcdef> - <paramdef>int <parameter>stmt</parameter></paramdef> - <paramdef>array &amp;<parameter>variable</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCIFetchStatement</methodname> + <methodparam><type>int</type><parameter>stmt</parameter></methodparam> + <methodparam><type>array &amp;</type><parameter>variable</parameter></methodparam> + </methodsynopsis> <para> <function>OCIFetchStatement</function> fetches all the rows from a result into a user-defined array. @@ -1108,13 +1063,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCIColumnIsNULL</function></funcdef> - <paramdef>int <parameter>stmt</parameter></paramdef> - <paramdef>mixed <parameter>column</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCIColumnIsNULL</methodname> + <methodparam><type>int</type><parameter>stmt</parameter></methodparam> + <methodparam><type>mixed</type><parameter>column</parameter></methodparam> + </methodsynopsis> <para> <function>OCIColumnIsNULL</function> returns &true; if the returned column <parameter>column</parameter> in the result from the @@ -1132,13 +1085,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>OCIColumnName</function></funcdef> - <paramdef>int <parameter>stmt</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>OCIColumnName</methodname> + <methodparam><type>int</type><parameter>stmt</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <simpara> <function>OCIColumnName</function> returns the name of the column corresponding to the column number (1-based) that is passed in. @@ -1194,13 +1145,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCIColumnSize</function></funcdef> - <paramdef>int <parameter>stmt</parameter></paramdef> - <paramdef>mixed <parameter>column</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCIColumnSize</methodname> + <methodparam><type>int</type><parameter>stmt</parameter></methodparam> + <methodparam><type>mixed</type><parameter>column</parameter></methodparam> + </methodsynopsis> <para> <function>OCIColumnSize</function> returns the size of the column as given by Oracle. You can either use @@ -1259,13 +1208,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>OCIColumnType</function></funcdef> - <paramdef>int <parameter>stmt</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>OCIColumnType</methodname> + <methodparam><type>int</type><parameter>stmt</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <simpara> <function>OCIColumnType</function> returns the data type of the column corresponding to the column number (1-based) that is passed @@ -1323,12 +1270,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>OCIServerVersion</function></funcdef> - <paramdef>int <parameter>conn</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>OCIServerVersion</methodname> + <methodparam><type>int</type><parameter>conn</parameter></methodparam> + </methodsynopsis> <para> <example> <title>OCIServerVersion</title> @@ -1353,12 +1298,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>OCIStatementType</function></funcdef> - <paramdef>int <parameter>stmt</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>OCIStatementType</methodname> + <methodparam><type>int</type><parameter>stmt</parameter></methodparam> + </methodsynopsis> <para> <function>OCIStatementType</function> returns one of the following values: @@ -1408,12 +1351,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCINewCursor</function></funcdef> - <paramdef>int <parameter>conn</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCINewCursor</methodname> + <methodparam><type>int</type><parameter>conn</parameter></methodparam> + </methodsynopsis> <para> <function>OCINewCursor</function> allocates a new statement handle on the specified connection. @@ -1500,12 +1441,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCIFreeStatement</function></funcdef> - <paramdef>int <parameter>stmt</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCIFreeStatement</methodname> + <methodparam><type>int</type><parameter>stmt</parameter></methodparam> + </methodsynopsis> <para> <function>OCIFreeStatement</function> returns &true; if successful, or &false; if unsuccessful. @@ -1522,12 +1461,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCIFreeCursor</function></funcdef> - <paramdef>int <parameter>stmt</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCIFreeCursor</methodname> + <methodparam><type>int</type><parameter>stmt</parameter></methodparam> + </methodsynopsis> <para> <function>OCIFreeCursor</function> returns &true; if successful, or &false; if unsuccessful. @@ -1542,12 +1479,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCIFreeDesc</function></funcdef> - <paramdef>object <parameter>lob</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCIFreeDesc</methodname> + <methodparam><type>object</type><parameter>lob</parameter></methodparam> + </methodsynopsis> <para> <function>OCIFreeDesc</function> returns &true; if successful, or &false; if unsuccessful. @@ -1562,13 +1497,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCIParse</function></funcdef> - <paramdef>int <parameter>conn</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCIParse</methodname> + <methodparam><type>int</type><parameter>conn</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> <simpara> <function>OCIParse</function> parses the <parameter>query</parameter> using <parameter>conn</parameter>. @@ -1587,14 +1520,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>OCIError</function></funcdef> - <paramdef>int - <parameter><optional>stmt|conn|global</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>OCIError</methodname> + <methodparam choice="opt"><type>int</type><parameter>stmt|conn|global</parameter></methodparam> + </methodsynopsis> <simpara> <function>OCIError</function> returns the last error found. If the optional <parameter>stmt|conn|global</parameter> is not @@ -1618,12 +1547,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>OCIInternalDebug</function></funcdef> - <paramdef>int <parameter>onoff</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>OCIInternalDebug</methodname> + <methodparam><type>int</type><parameter>onoff</parameter></methodparam> + </methodsynopsis> <simpara> <function>OCIInternalDebug</function> enables internal debug output. Set <parameter>onoff</parameter> to 0 to turn debug @@ -1639,12 +1566,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCICancel</function></funcdef> - <paramdef>int <parameter>stmt</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCICancel</methodname> + <methodparam><type>int</type><parameter>stmt</parameter></methodparam> + </methodsynopsis> <simpara> If you do not want read more data from a cursor, then call <function>OCICancel</function>. @@ -1659,13 +1584,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCISetPrefetch</function></funcdef> - <paramdef>int <parameter>stmt</parameter></paramdef> - <paramdef>int <parameter>rows</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCISetPrefetch</methodname> + <methodparam><type>int</type><parameter>stmt</parameter></methodparam> + <methodparam><type>int</type><parameter>rows</parameter></methodparam> + </methodsynopsis> <simpara> Sets the number of top level rows to be prefetched. The default value is 1 row. </simpara> @@ -1679,15 +1602,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>OCIWriteLobToFile</function></funcdef> - <paramdef>object <parameter>lob</parameter></paramdef> - <paramdef>string <parameter><optional>filename</optional></parameter></paramdef> - <paramdef>int <parameter><optional>start</optional></parameter></paramdef> - <paramdef>int <parameter><optional>lenght</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>OCIWriteLobToFile</methodname> + <methodparam><type>object</type><parameter>lob</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>start</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>lenght</parameter></methodparam> + </methodsynopsis> <simpara> Coming soon. </simpara> @@ -1701,12 +1622,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>OCISaveLobFile</function></funcdef> - <paramdef>object <parameter>lob</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>OCISaveLobFile</methodname> + <methodparam><type>object</type><parameter>lob</parameter></methodparam> + </methodsynopsis> <simpara> Coming soon. </simpara> @@ -1720,12 +1639,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>OCISaveLob</function></funcdef> - <paramdef>object <parameter>lob</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>OCISaveLob</methodname> + <methodparam><type>object</type><parameter>lob</parameter></methodparam> + </methodsynopsis> <simpara> Coming soon. </simpara> @@ -1739,12 +1656,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>OCILoadLob</function></funcdef> - <paramdef>object <parameter>lob</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>OCILoadLob</methodname> + <methodparam><type>object</type><parameter>lob</parameter></methodparam> + </methodsynopsis> <simpara> Coming soon. </simpara> @@ -1758,13 +1673,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCIColumnScale</function></funcdef> - <paramdef>int <parameter>stmt</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCIColumnScale</methodname> + <methodparam><type>int</type><parameter>stmt</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <simpara> Coming soon. </simpara> @@ -1778,13 +1691,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>OCIColumnPrecision</function></funcdef> - <paramdef>int <parameter>stmt</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>OCIColumnPrecision</methodname> + <methodparam><type>int</type><parameter>stmt</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <simpara> Coming soon. </simpara> @@ -1798,13 +1709,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>OCIColumnTypeRaw</function></funcdef> - <paramdef>int <parameter>stmt</parameter></paramdef> - <paramdef>int <parameter>col</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>OCIColumnTypeRaw</methodname> + <methodparam><type>int</type><parameter>stmt</parameter></methodparam> + <methodparam><type>int</type><parameter>col</parameter></methodparam> + </methodsynopsis> <simpara> Coming soon. </simpara> @@ -1818,14 +1727,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>OCINewCollection</function></funcdef> - <paramdef>int <parameter>conn</parameter></paramdef> - <paramdef>string <parameter>tdo</parameter></paramdef> - <paramdef>string <parameter><optional>shema</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>OCINewCollection</methodname> + <methodparam><type>int</type><parameter>conn</parameter></methodparam> + <methodparam><type>string</type><parameter>tdo</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>shema</parameter></methodparam> + </methodsynopsis> <simpara> Coming soon. </simpara> @@ -1839,12 +1746,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>OCIFreeCollection</function></funcdef> - <paramdef>object <parameter>lob</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>OCIFreeCollection</methodname> + <methodparam><type>object</type><parameter>lob</parameter></methodparam> + </methodsynopsis> <simpara> Coming soon. </simpara> @@ -1858,13 +1763,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>OCICollAssign</function></funcdef> - <paramdef>object <parameter>collection</parameter></paramdef> - <paramdef>object <parameter>object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>OCICollAssign</methodname> + <methodparam><type>object</type><parameter>collection</parameter></methodparam> + <methodparam><type>object</type><parameter>object</parameter></methodparam> + </methodsynopsis> <simpara> Coming soon. </simpara> @@ -1878,13 +1781,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>OCICollAppend</function></funcdef> - <paramdef>object <parameter>collection</parameter></paramdef> - <paramdef>object <parameter>object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>OCICollAppend</methodname> + <methodparam><type>object</type><parameter>collection</parameter></methodparam> + <methodparam><type>object</type><parameter>object</parameter></methodparam> + </methodsynopsis> <simpara> Coming soon. </simpara> @@ -1898,14 +1799,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>OCICollAssignElem</function></funcdef> - <paramdef>object <parameter>collection</parameter></paramdef> - <paramdef>string <parameter>ndx</parameter></paramdef> - <paramdef>string <parameter>val</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>OCICollAssignElem</methodname> + <methodparam><type>object</type><parameter>collection</parameter></methodparam> + <methodparam><type>string</type><parameter>ndx</parameter></methodparam> + <methodparam><type>string</type><parameter>val</parameter></methodparam> + </methodsynopsis> <simpara> Coming soon. </simpara> @@ -1919,13 +1818,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>OCICollGetElem</function></funcdef> - <paramdef>object <parameter>collection</parameter></paramdef> - <paramdef>string <parameter>ndx</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>OCICollGetElem</methodname> + <methodparam><type>object</type><parameter>collection</parameter></methodparam> + <methodparam><type>string</type><parameter>ndx</parameter></methodparam> + </methodsynopsis> <simpara> Coming soon. </simpara> @@ -1939,12 +1836,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>OCICollMax</function></funcdef> - <paramdef>object <parameter>collection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>OCICollMax</methodname> + <methodparam><type>object</type><parameter>collection</parameter></methodparam> + </methodsynopsis> <simpara> Coming soon. </simpara> @@ -1958,12 +1853,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>OCICollSize</function></funcdef> - <paramdef>object <parameter>collection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>OCICollSize</methodname> + <methodparam><type>object</type><parameter>collection</parameter></methodparam> + </methodsynopsis> <simpara> Coming soon. </simpara> @@ -1977,13 +1870,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>OCICollTrim</function></funcdef> - <paramdef>object <parameter>collection</parameter></paramdef> - <paramdef>int <parameter>num</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>OCICollTrim</methodname> + <methodparam><type>object</type><parameter>collection</parameter></methodparam> + <methodparam><type>int</type><parameter>num</parameter></methodparam> + </methodsynopsis> <simpara> Coming soon. </simpara> @@ -2012,3 +1903,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/openssl.xml diff -u phpdoc/en/functions/openssl.xml:1.20 phpdoc/en/functions/openssl.xml:1.21 --- phpdoc/en/functions/openssl.xml:1.20 Tue Dec 18 10:11:31 2001 +++ phpdoc/en/functions/openssl.xml Sat Feb 2 10:36:06 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.20 $ --> +<!-- $Revision: 1.21 $ --> <reference id="ref.openssl"> <title>OpenSSL functions</title> <titleabbrev>OpenSSL</titleabbrev> @@ -184,12 +184,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>openssl_error_string</function></funcdef> + <methodsynopsis> + <type>mixed</type><methodname>openssl_error_string</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> Returns an error message string, or &false; if there are no more error @@ -229,12 +227,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>openssl_free_key</function></funcdef> - <paramdef>resource <parameter>key_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>openssl_free_key</methodname> + <methodparam><type>resource</type><parameter>key_identifier</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>openssl_free_key</function> frees the key associated with @@ -250,13 +246,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>openssl_get_privatekey</function></funcdef> - <paramdef>mixed <parameter>key</parameter></paramdef> - <paramdef>string <parameter><optional>passphrase</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>openssl_get_privatekey</methodname> + <methodparam><type>mixed</type><parameter>key</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Returns a positive key resource identifier on success, or &false; on error. @@ -278,12 +272,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>openssl_get_publickey</function></funcdef> - <paramdef>mixed <parameter>certificate</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>openssl_get_publickey</methodname> + <methodparam><type>mixed</type><parameter>certificate</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Returns a positive key resource identifier on success, or &false; on error. @@ -304,15 +296,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>openssl_open</function></funcdef> - <paramdef>string <parameter>sealed_data</parameter></paramdef> - <paramdef>string <parameter>open_data</parameter></paramdef> - <paramdef>string <parameter>env_key</parameter></paramdef> - <paramdef>mixed <parameter>priv_key_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>openssl_open</methodname> + <methodparam><type>string</type><parameter>sealed_data</parameter></methodparam> + <methodparam><type>string</type><parameter>open_data</parameter></methodparam> + <methodparam><type>string</type><parameter>env_key</parameter></methodparam> + <methodparam><type>mixed</type><parameter>priv_key_id</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Returns &true; on success, or &false; on error. If successful the opened @@ -367,15 +357,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>openssl_seal</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>string <parameter>sealed_data</parameter></paramdef> - <paramdef>array <parameter>env_keys</parameter></paramdef> - <paramdef>array <parameter>pub_key_ids</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>openssl_seal</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>string</type><parameter>sealed_data</parameter></methodparam> + <methodparam><type>array</type><parameter>env_keys</parameter></methodparam> + <methodparam><type>array</type><parameter>pub_key_ids</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Returns the length of the sealed data on success, or &false; on error. @@ -437,14 +425,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>openssl_sign</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>string <parameter>signature</parameter></paramdef> - <paramdef>mixed <parameter>priv_key_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>openssl_sign</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>string</type><parameter>signature</parameter></methodparam> + <methodparam><type>mixed</type><parameter>priv_key_id</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Returns &true; on success, or &false; on failure. @@ -493,14 +479,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>openssl_verify</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>string <parameter>signature</parameter></paramdef> - <paramdef>mixed <parameter>pub_key_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>openssl_verify</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>string</type><parameter>signature</parameter></methodparam> + <methodparam><type>mixed</type><parameter>pub_key_id</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Returns 1 if the signature is correct, 0 if it is incorrect, and @@ -555,15 +539,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>openssl_pkcs7_decrypt</function></funcdef> - <paramdef>string <parameter>infilename</parameter></paramdef> - <paramdef>string <parameter>outfilename</parameter></paramdef> - <paramdef>mixed <parameter>recipcert</parameter></paramdef> - <paramdef>mixed <parameter>recipkey</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>openssl_pkcs7_decrypt</methodname> + <methodparam><type>string</type><parameter>infilename</parameter></methodparam> + <methodparam><type>string</type><parameter>outfilename</parameter></methodparam> + <methodparam><type>mixed</type><parameter>recipcert</parameter></methodparam> + <methodparam><type>mixed</type><parameter>recipkey</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Decrypts the S/MIME encrypted message contained in the file specified by @@ -606,16 +588,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>openssl_pkcs7_encrypt</function></funcdef> - <paramdef>string <parameter>infilename</parameter></paramdef> - <paramdef>string <parameter>outfilename</parameter></paramdef> - <paramdef>mixed <parameter>recipcerts</parameter></paramdef> - <paramdef>array <parameter>headers</parameter></paramdef> - <paramdef>long <parameter><optional>flags</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>openssl_pkcs7_encrypt</methodname> + <methodparam><type>string</type><parameter>infilename</parameter></methodparam> + <methodparam><type>string</type><parameter>outfilename</parameter></methodparam> + <methodparam><type>mixed</type><parameter>recipcerts</parameter></methodparam> + <methodparam><type>array</type><parameter>headers</parameter></methodparam> + <methodparam choice="opt"><type>long</type><parameter>flags</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>openssl_pkcs7_encrypt</function> takes the contents of the @@ -682,20 +662,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>openssl_pkcs7_sign</function></funcdef> - <paramdef>string <parameter>infilename</parameter></paramdef> - <paramdef>string <parameter>outfilename</parameter></paramdef> - <paramdef>mixed <parameter>signcert</parameter></paramdef> - <paramdef>mixed <parameter>privkey</parameter></paramdef> - <paramdef>array <parameter>headers</parameter></paramdef> - <paramdef>long - <parameter><optional>flags</optional></parameter></paramdef> - <paramdef>string - <parameter><optional>extracertsfilename</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>openssl_pkcs7_sign</methodname> + <methodparam><type>string</type><parameter>infilename</parameter></methodparam> + <methodparam><type>string</type><parameter>outfilename</parameter></methodparam> + <methodparam><type>mixed</type><parameter>signcert</parameter></methodparam> + <methodparam><type>mixed</type><parameter>privkey</parameter></methodparam> + <methodparam><type>array</type><parameter>headers</parameter></methodparam> + <methodparam choice="opt"><type>long</type><parameter>flags</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>extracertsfilename</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>openssl_pkcs7_sign</function> takes the contents of the file @@ -765,16 +741,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>openssl_pkcs7_verify</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>int <parameter>flags</parameter></paramdef> - <paramdef>string <parameter><optional>outfilename</optional></parameter></paramdef> - <paramdef>array <parameter><optional>cainfo</optional></parameter></paramdef> - <paramdef>string <parameter><optional>extracerts</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>openssl_pkcs7_verify</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>int</type><parameter>flags</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>outfilename</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>cainfo</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>extracerts</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>openssl_pkcs7_verify</function> reads the S/MIME message @@ -819,16 +793,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>openssl_x509_checkpurpose</function></funcdef> - <paramdef>mixed <parameter>x509cert</parameter></paramdef> - <paramdef>int <parameter>purpose</parameter></paramdef> - <paramdef>array <parameter>cainfo</parameter></paramdef> - <paramdef>string - <parameter><optional>untrustedfile</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>openssl_x509_checkpurpose</methodname> + <methodparam><type>mixed</type><parameter>x509cert</parameter></methodparam> + <methodparam><type>int</type><parameter>purpose</parameter></methodparam> + <methodparam><type>array</type><parameter>cainfo</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>untrustedfile</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Returns &true; if the certificate can be used for the intended purpose, @@ -911,12 +882,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>openssl_x509_free</function></funcdef> - <paramdef>resource <parameter>x509cert</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>openssl_x509_free</methodname> + <methodparam><type>resource</type><parameter>x509cert</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>openssl_x509_free</function> frees the certificate associated @@ -938,14 +907,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>openssl_x509_parse</function></funcdef> - <paramdef>mixed <parameter>x509cert</parameter></paramdef> - <paramdef>bool - <parameter><optional>shortnames</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>openssl_x509_parse</methodname> + <methodparam><type>mixed</type><parameter>x509cert</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>shortnames</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>openssl_x509_parse</function> returns information about the @@ -974,12 +940,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>openssl_x509_read</function></funcdef> - <paramdef>mixed <parameter>x509certdata</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>openssl_x509_read</methodname> + <methodparam><type>mixed</type><parameter>x509certdata</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>openssl_x509_read</function> parses the certificate supplied by @@ -1003,16 +967,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>openssl_x509_export_to_file</function></funcdef> - <paramdef>mixed <parameter>x509</parameter></paramdef> - <paramdef>string <parameter>outfilename</parameter></paramdef> - <paramdef>bool - <parameter><optional>notext</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>openssl_x509_export_to_file</methodname> + <methodparam><type>mixed</type><parameter>x509</parameter></methodparam> + <methodparam><type>string</type><parameter>outfilename</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>notext</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1027,16 +987,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>openssl_x509_export</function></funcdef> - <paramdef>mixed <parameter>x509</parameter></paramdef> - <paramdef>string <parameter>outfilename</parameter></paramdef> - <paramdef>bool - <parameter><optional>notext</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>openssl_x509_export</methodname> + <methodparam><type>mixed</type><parameter>x509</parameter></methodparam> + <methodparam><type>string</type><parameter>outfilename</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>notext</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1051,13 +1007,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>openssl_x509_check_private_key</function></funcdef> - <paramdef>mixed <parameter>cert</parameter></paramdef> - <paramdef>mixed <parameter>key</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>openssl_x509_check_private_key</methodname> + <methodparam><type>mixed</type><parameter>cert</parameter></methodparam> + <methodparam><type>mixed</type><parameter>key</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1072,16 +1026,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>openssl_csr_export_to_file</function></funcdef> - <paramdef>resource <parameter>csr</parameter></paramdef> - <paramdef>string <parameter>outfilename</parameter></paramdef> - <paramdef>bool - <parameter><optional>notext</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>openssl_csr_export_to_file</methodname> + <methodparam><type>resource</type><parameter>csr</parameter></methodparam> + <methodparam><type>string</type><parameter>outfilename</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>notext</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1096,16 +1046,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>openssl_csr_export</function></funcdef> - <paramdef>resource <parameter>csr</parameter></paramdef> - <paramdef>string <parameter>out</parameter></paramdef> - <paramdef>bool - <parameter><optional>notext</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>openssl_csr_export</methodname> + <methodparam><type>resource</type><parameter>csr</parameter></methodparam> + <methodparam><type>string</type><parameter>out</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>notext</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1120,15 +1066,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>openssl_csr_sign</function></funcdef> - <paramdef>mixed <parameter>csr</parameter></paramdef> - <paramdef>mixed <parameter>x509</parameter></paramdef> - <paramdef>mixed <parameter>priv_key</parameter></paramdef> - <paramdef>long <parameter>days</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>openssl_csr_sign</methodname> + <methodparam><type>mixed</type><parameter>csr</parameter></methodparam> + <methodparam><type>mixed</type><parameter>x509</parameter></methodparam> + <methodparam><type>mixed</type><parameter>priv_key</parameter></methodparam> + <methodparam><type>long</type><parameter>days</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1143,19 +1087,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>openssl_csr_new</function></funcdef> - <paramdef>array <parameter>dn</parameter></paramdef> - <paramdef>resource <parameter>privkey</parameter></paramdef> - <paramdef>array - <parameter><optional>extraattribs</optional></parameter> - </paramdef> - <paramdef>array - <parameter><optional>configargs</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>openssl_csr_new</methodname> + <methodparam><type>array</type><parameter>dn</parameter></methodparam> + <methodparam><type>resource</type><parameter>privkey</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>extraattribs</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>configargs</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1170,14 +1108,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>openssl_pkey_new</function></funcdef> - <paramdef>array - <parameter><optional>configargs</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>openssl_pkey_new</methodname> + <methodparam choice="opt"><type>array</type><parameter>configargs</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1192,19 +1126,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>openssl_pkey_export_to_file</function></funcdef> - <paramdef>mixed <parameter>key</parameter></paramdef> - <paramdef>string <parameter>outfilename</parameter></paramdef> - <paramdef>string - <parameter><optional>passphrase</optional></parameter> - </paramdef> - <paramdef>array - <parameter><optional>config_args</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>openssl_pkey_export_to_file</methodname> + <methodparam><type>mixed</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>outfilename</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>config_args</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1219,19 +1147,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>openssl_pkey_export</function></funcdef> - <paramdef>mixed <parameter>key</parameter></paramdef> - <paramdef>mixed <parameter>out</parameter></paramdef> - <paramdef>string - <parameter><optional>passphrase</optional></parameter> - </paramdef> - <paramdef>array - <parameter><optional>config_args</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>openssl_pkey_export</methodname> + <methodparam><type>mixed</type><parameter>key</parameter></methodparam> + <methodparam><type>mixed</type><parameter>out</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>config_args</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1246,17 +1168,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>openssl_private_encrypt</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>string <parameter>crypted</parameter></paramdef> - <paramdef>mixed <parameter>key</parameter></paramdef> - <paramdef>int - <parameter><optional>padding</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>openssl_private_encrypt</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>string</type><parameter>crypted</parameter></methodparam> + <methodparam><type>mixed</type><parameter>key</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>padding</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1271,17 +1189,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>openssl_private_decrypt</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>string <parameter>crypted</parameter></paramdef> - <paramdef>mixed <parameter>key</parameter></paramdef> - <paramdef>int - <parameter><optional>padding</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>openssl_private_decrypt</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>string</type><parameter>crypted</parameter></methodparam> + <methodparam><type>mixed</type><parameter>key</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>padding</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1296,17 +1210,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>openssl_public_encrypt</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>string <parameter>crypted</parameter></paramdef> - <paramdef>mixed <parameter>key</parameter></paramdef> - <paramdef>int - <parameter><optional>padding</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>openssl_public_encrypt</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>string</type><parameter>crypted</parameter></methodparam> + <methodparam><type>mixed</type><parameter>key</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>padding</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1321,17 +1231,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>openssl_public_decrypt</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>string <parameter>crypted</parameter></paramdef> - <paramdef>resource <parameter>key</parameter></paramdef> - <paramdef>int - <parameter><optional>padding</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>openssl_public_decrypt</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>string</type><parameter>crypted</parameter></methodparam> + <methodparam><type>resource</type><parameter>key</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>padding</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1361,3 +1267,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/oracle.xml diff -u phpdoc/en/functions/oracle.xml:1.28 phpdoc/en/functions/oracle.xml:1.29 --- phpdoc/en/functions/oracle.xml:1.28 Sat Jan 26 10:37:56 2002 +++ phpdoc/en/functions/oracle.xml Sat Feb 2 10:36:06 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.28 $ --> +<!-- $Revision: 1.29 $ --> <reference id="ref.oracle"> <title>Oracle functions</title> <titleabbrev>Oracle</titleabbrev> @@ -11,16 +11,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ora_bind</function></funcdef> - <paramdef>int <parameter>cursor</parameter></paramdef> - <paramdef>string <parameter>PHP variable name</parameter></paramdef> - <paramdef>string <parameter>SQL parameter name</parameter></paramdef> - <paramdef>int <parameter>length</parameter></paramdef> - <paramdef>int <parameter><optional>type</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ora_bind</methodname> + <methodparam><type>int</type><parameter>cursor</parameter></methodparam> + <methodparam><type>string</type><parameter>PHP variable name</parameter></methodparam> + <methodparam><type>string</type><parameter>SQL parameter name</parameter></methodparam> + <methodparam><type>int</type><parameter>length</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if the bind succeeds, otherwise &false;. Details about the error can be retrieved using the @@ -67,12 +65,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ora_close</function></funcdef> - <paramdef>int <parameter>cursor</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ora_close</methodname> + <methodparam><type>int</type><parameter>cursor</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if the close succeeds, otherwise &false;. Details about the error can be retrieved using the @@ -93,13 +89,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>Ora_ColumnName</function></funcdef> - <paramdef>int <parameter>cursor</parameter></paramdef> - <paramdef>int <parameter>column</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>Ora_ColumnName</methodname> + <methodparam><type>int</type><parameter>cursor</parameter></methodparam> + <methodparam><type>int</type><parameter>column</parameter></methodparam> + </methodsynopsis> <para> Returns the name of the field/column <parameter>column</parameter> on the cursor @@ -116,13 +110,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>Ora_ColumnSize</function></funcdef> - <paramdef>int <parameter>cursor</parameter></paramdef> - <paramdef>int <parameter>column</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>Ora_ColumnSize</methodname> + <methodparam><type>int</type><parameter>cursor</parameter></methodparam> + <methodparam><type>int</type><parameter>column</parameter></methodparam> + </methodsynopsis> <para> Returns the size of the Oracle column <parameter>column</parameter> on the cursor @@ -138,13 +130,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>Ora_ColumnType</function></funcdef> - <paramdef>int <parameter>cursor</parameter></paramdef> - <paramdef>int <parameter>column</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>Ora_ColumnType</methodname> + <methodparam><type>int</type><parameter>cursor</parameter></methodparam> + <methodparam><type>int</type><parameter>column</parameter></methodparam> + </methodsynopsis> <para> Returns the Oracle data type name of the field/column <parameter>column</parameter> on the cursor @@ -172,12 +162,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ora_commit</function></funcdef> - <paramdef>int <parameter>conn</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ora_commit</methodname> + <methodparam><type>int</type><parameter>conn</parameter></methodparam> + </methodsynopsis> <para> Returns &true; on success, &false; on error. Details about the error can be retrieved using the <function>ora_error</function> @@ -198,12 +186,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ora_commitoff</function></funcdef> - <paramdef>int <parameter>conn</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ora_commitoff</methodname> + <methodparam><type>int</type><parameter>conn</parameter></methodparam> + </methodsynopsis> <para> Returns &true; on success, &false; on error. Details about the error can be retrieved using the <function>ora_error</function> and @@ -223,12 +209,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ora_commiton</function></funcdef> - <paramdef>int <parameter>conn</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ora_commiton</methodname> + <methodparam><type>int</type><parameter>conn</parameter></methodparam> + </methodsynopsis> <para> This function turns on automatic commit after each <function>ora_exec</function> on the given connection. @@ -248,13 +232,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ora_do</function></funcdef> - <paramdef>int <parameter>conn</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ora_do</methodname> + <methodparam><type>int</type><parameter>conn</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> <para> This function is quick combination of <function>ora_parse</function>, <function>ora_exec</function> and <function>ora_fetch</function>. @@ -279,12 +261,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>Ora_Error</function></funcdef> - <paramdef>int <parameter>cursor_or_connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>Ora_Error</methodname> + <methodparam><type>int</type><parameter>cursor_or_connection</parameter></methodparam> + </methodsynopsis> <para> Returns an error message of the form <replaceable>XXX</replaceable>-<replaceable>NNNNN</replaceable> @@ -320,12 +300,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>Ora_ErrorCode</function></funcdef> - <paramdef>int <parameter>cursor_or_connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>Ora_ErrorCode</methodname> + <methodparam><type>int</type><parameter>cursor_or_connection</parameter></methodparam> + </methodsynopsis> <para> Returns the numeric error code of the last executed statement on the specified cursor or connection. @@ -344,12 +322,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ora_exec</function></funcdef> - <paramdef>int <parameter>cursor</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ora_exec</methodname> + <methodparam><type>int</type><parameter>cursor</parameter></methodparam> + </methodsynopsis> <para> Returns &true; on success, &false; on error. Details about the error can be retrieved using the <function>ora_error</function> and @@ -369,12 +345,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ora_fetch</function></funcdef> - <paramdef>int <parameter>cursor</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ora_fetch</methodname> + <methodparam><type>int</type><parameter>cursor</parameter></methodparam> + </methodsynopsis> <para> Returns &true; (a row was fetched) or &false; (no more rows, or an error occured). If an error occured, details can be retrieved @@ -399,18 +373,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ora_fetch_into</function></funcdef> - <paramdef>int <parameter>cursor</parameter></paramdef> - <paramdef>array <parameter>result</parameter></paramdef> - <paramdef>int - <parameter> - <optional>flags</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ora_fetch_into</methodname> + <methodparam><type>int</type><parameter>cursor</parameter></methodparam> + <methodparam><type>array</type><parameter>result</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + flags + </parameter></methodparam> + </methodsynopsis> <para> You can fetch a row into an array with this function. <example> @@ -442,13 +412,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>ora_getcolumn</function></funcdef> - <paramdef>int <parameter>cursor</parameter></paramdef> - <paramdef>mixed <parameter>column</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>ora_getcolumn</methodname> + <methodparam><type>int</type><parameter>cursor</parameter></methodparam> + <methodparam><type>mixed</type><parameter>column</parameter></methodparam> + </methodsynopsis> <para> Returns the column data. If an error occurs, &false; is returned and <function>ora_errorcode</function> @@ -470,12 +438,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ora_logoff</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ora_logoff</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> Returns &true; on success, &false; on error. Details about the error can be retrieved using the <function>ora_error</function> and @@ -497,13 +463,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ora_logon</function></funcdef> - <paramdef>string <parameter>user</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ora_logon</methodname> + <methodparam><type>string</type><parameter>user</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + </methodsynopsis> <para> Establishes a connection between PHP and an Oracle database with the given username and password. @@ -544,13 +508,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ora_plogon</function></funcdef> - <paramdef>string <parameter>user</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ora_plogon</methodname> + <methodparam><type>string</type><parameter>user</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + </methodsynopsis> <para> Establishes a persistent connection between PHP and an Oracle database with the given username and password. @@ -568,12 +530,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ora_numcols</function></funcdef> - <paramdef>int <parameter>cursor_ind</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ora_numcols</methodname> + <methodparam><type>int</type><parameter>cursor_ind</parameter></methodparam> + </methodsynopsis> <para> <function>ora_numcols</function> returns the number of columns in a result. Only returns meaningful values after an parse/exec/fetch sequence. @@ -592,12 +552,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ora_numrows</function></funcdef> - <paramdef>int <parameter>cursor_ind</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ora_numrows</methodname> + <methodparam><type>int</type><parameter>cursor_ind</parameter></methodparam> + </methodsynopsis> <para> <function>ora_numrows</function> returns the number of rows in a result. </para> @@ -611,12 +569,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ora_open</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ora_open</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> Opens an Oracle cursor associated with connection. </para> @@ -635,14 +591,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ora_parse</function></funcdef> - <paramdef>int <parameter>cursor_ind</parameter></paramdef> - <paramdef>string <parameter>sql_statement</parameter></paramdef> - <paramdef>int <parameter>defer</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ora_parse</methodname> + <methodparam><type>int</type><parameter>cursor_ind</parameter></methodparam> + <methodparam><type>string</type><parameter>sql_statement</parameter></methodparam> + <methodparam><type>int</type><parameter>defer</parameter></methodparam> + </methodsynopsis> <para> This function parses an SQL statement or a PL/SQL block and associates it with the given cursor. @@ -664,12 +618,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ora_rollback</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ora_rollback</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> This function undoes an Oracle transaction. (See <function>ora_commit</function> for the definition of a @@ -704,3 +656,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/outcontrol.xml diff -u phpdoc/en/functions/outcontrol.xml:1.25 phpdoc/en/functions/outcontrol.xml:1.26 --- phpdoc/en/functions/outcontrol.xml:1.25 Sat Jan 12 12:01:29 2002 +++ phpdoc/en/functions/outcontrol.xml Sat Feb 2 10:36:06 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.25 $ --> +<!-- $Revision: 1.26 $ --> <reference id="ref.outcontrol"> <title>Output Control Functions</title> <titleabbrev>Output Control</titleabbrev> @@ -55,12 +55,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>flush</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>flush</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <simpara> Flushes the output buffers of PHP and whatever backend PHP is using (CGI, a web server, etc). This effectively tries to push @@ -106,16 +104,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>ob_start</function></funcdef> - <paramdef>string - <parameter> - <optional>output_callback</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>ob_start</methodname> + <methodparam choice="opt"><type>string</type><parameter> + output_callback + </parameter></methodparam> + </methodsynopsis> <para> This function will turn output buffering on. While output buffering is active no output is sent from the script (other than @@ -222,12 +216,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ob_get_contents</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>ob_get_contents</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This will return the contents of the output buffer or &false;, if output buffering isn't active. @@ -248,12 +240,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ob_get_length</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>ob_get_length</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This will return the length of the contents in the output buffer or &false;, if output buffering isn't active. @@ -274,12 +264,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ob_get_level</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>ob_get_level</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This will return the level of nested output buffering handlers. </para> @@ -299,15 +287,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ob_gzhandler</function></funcdef> - <paramdef>string <parameter>buffer</parameter></paramdef> - <paramdef>int - <parameter><optional>mode</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ob_gzhandler</methodname> + <methodparam><type>string</type><parameter>buffer</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <note> <para> <parameter>mode</parameter> was added in PHP 4.0.5. @@ -359,12 +343,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>ob_flush</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>ob_flush</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This function will send the contents of the output buffer (if any). If you want to further @@ -395,12 +377,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>ob_clean</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>ob_clean</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This function discards the contents of the output buffer. </para> @@ -425,12 +405,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>ob_end_flush</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>ob_end_flush</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This function will send the contents of the output buffer (if any) and turn output buffering off. If you want to further @@ -457,12 +435,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>ob_end_clean</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>ob_end_clean</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This function discards the contents of the output buffer and turns off output buffering. @@ -484,14 +460,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>ob_implicit_flush</function></funcdef> - <paramdef>int - <parameter><optional>flag</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>ob_implicit_flush</methodname> + <methodparam choice="opt"><type>int</type><parameter>flag</parameter></methodparam> + </methodsynopsis> <para> <function>ob_implicit_flush</function> will turn implicit flushing on or off (if no <parameter>flag</parameter> is given, @@ -534,3 +506,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/overload.xml diff -u phpdoc/en/functions/overload.xml:1.4 phpdoc/en/functions/overload.xml:1.5 --- phpdoc/en/functions/overload.xml:1.4 Wed Dec 12 15:47:13 2001 +++ phpdoc/en/functions/overload.xml Sat Feb 2 10:36:06 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <reference id="ref.overload"> <title>Object property and method call overloading</title> <titleabbrev>Object overloading</titleabbrev> @@ -99,18 +99,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>overload</function> - </funcdef> - <paramdef>string - <parameter> - <optional>class_name</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>overload</methodname> + <methodparam choice="opt"><type>string</type><parameter> + class_name + </parameter></methodparam> + </methodsynopsis> <para> The <function>overload</function> function will enable property and method call overloading for a class identified @@ -142,3 +136,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/ovrimos.xml diff -u phpdoc/en/functions/ovrimos.xml:1.14 phpdoc/en/functions/ovrimos.xml:1.15 --- phpdoc/en/functions/ovrimos.xml:1.14 Wed Dec 12 15:47:13 2001 +++ phpdoc/en/functions/ovrimos.xml Sat Feb 2 10:36:06 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.14 $ --> +<!-- $Revision: 1.15 $ --> <reference id="ref.ovrimos"> <title>Ovrimos SQL functions</title> <titleabbrev>OvrimosSQL</titleabbrev> @@ -50,15 +50,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ovrimos_connect</function></funcdef> - <paramdef>string <parameter>host</parameter></paramdef> - <paramdef>string <parameter>db</parameter></paramdef> - <paramdef>string <parameter>user</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ovrimos_connect</methodname> + <methodparam><type>string</type><parameter>host</parameter></methodparam> + <methodparam><type>string</type><parameter>db</parameter></methodparam> + <methodparam><type>string</type><parameter>user</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + </methodsynopsis> <para> <function>ovrimos_connect</function> is used to connect to the specified database. @@ -104,12 +102,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>ovrimos_close</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>ovrimos_close</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>ovrimos_close</function> is used to close the specified connection. @@ -131,13 +127,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ovrimos_longreadlen</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter>length</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ovrimos_longreadlen</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> <para> <function>ovrimos_longreadlen</function> is used to specify how many bytes are to be retrieved from long datatypes. @@ -158,13 +152,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ovrimos_prepare</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ovrimos_prepare</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> <para> <function>ovrimos_prepare</function> is used to prepare an SQL statement. </para> @@ -214,15 +206,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ovrimos_execute</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>array - <parameter><optional>parameters_array</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ovrimos_execute</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>parameters_array</parameter></methodparam> + </methodsynopsis> <para> <function>ovrimos_execute</function> is used to execute an SQL statement. @@ -247,12 +235,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ovrimos_cursor</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ovrimos_cursor</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> <function>ovrimos_cursor</function> is used to get the name of the cursor. @@ -272,13 +258,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ovrimos_exec</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ovrimos_exec</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> <para> <function>ovrimos_exec</function> is used to execute an SQL statement. @@ -298,19 +282,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ovrimos_fetch_into</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>array <parameter>result_array</parameter></paramdef> - <paramdef>string - <parameter><optional>how</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>rownumber</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ovrimos_fetch_into</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam><type>array</type><parameter>result_array</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>how</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>rownumber</parameter></methodparam> + </methodsynopsis> <para> <function>ovrimos_fetch_into</function> is used to fetch a row from the result set. @@ -372,18 +350,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ovrimos_fetch_row</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int - <parameter><optional>how</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>row_number</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ovrimos_fetch_row</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>how</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>row_number</parameter></methodparam> + </methodsynopsis> <para> <function>ovrimos_fetch_row</function> is used to fetch a row from the result set. @@ -439,13 +411,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ovrimos_result</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>mixed <parameter>field</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ovrimos_result</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam><type>mixed</type><parameter>field</parameter></methodparam> + </methodsynopsis> <para> <function>ovrimos_result</function> is used to retrieve the output column. @@ -466,15 +436,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ovrimos_result_all</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>string - <parameter><optional>format</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ovrimos_result_all</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>format</parameter></methodparam> + </methodsynopsis> <para> <function>ovrimos_result_all</function> is used to print an HTML table containing the whole result set. @@ -581,12 +547,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ovrimos_num_rows</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ovrimos_num_rows</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> <function>ovrimos_num_rows</function> is used to get the number of rows affected by update operations. @@ -605,12 +569,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ovrimos_num_fields</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ovrimos_num_fields</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> <function>ovrimos_num_fields</function> is used to get the number of columns. @@ -629,13 +591,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ovrimos_field_name</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter>field_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ovrimos_field_name</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam><type>int</type><parameter>field_number</parameter></methodparam> + </methodsynopsis> <para> <function>ovrimos_field_name</function> is used to get the output column name. @@ -656,13 +616,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ovrimos_field_type</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter>field_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ovrimos_field_type</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam><type>int</type><parameter>field_number</parameter></methodparam> + </methodsynopsis> <para> <function>ovrimos_field_type</function> is used to get the (numeric) type of the output column. @@ -681,13 +639,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ovrimos_field_len</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter>field_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ovrimos_field_len</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam><type>int</type><parameter>field_number</parameter></methodparam> + </methodsynopsis> <para> <function>ovrimos_field_len</function> is used to get the length of the output column with number <parameter>field_number</parameter>, @@ -709,13 +665,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ovrimos_field_num</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>string <parameter>field_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ovrimos_field_num</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam><type>string</type><parameter>field_name</parameter></methodparam> + </methodsynopsis> <para> <function>ovrimos_field_num</function> is used to get the (1-based) index of the output column. @@ -734,12 +688,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>ovrimos_free_result</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>ovrimos_free_result</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> <function>ovrimos_free_result</function> is used to free the result_id. @@ -758,12 +710,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ovrimos_commit</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ovrimos_commit</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + </methodsynopsis> <para> <function>ovrimos_commit</function> is used to commit the transaction. @@ -781,12 +731,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ovrimos_rollback</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ovrimos_rollback</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + </methodsynopsis> <para> <function>ovrimos_rollback</function> is used to roll back the transaction. @@ -819,3 +767,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/pcntl.xml diff -u phpdoc/en/functions/pcntl.xml:1.9 phpdoc/en/functions/pcntl.xml:1.10 --- phpdoc/en/functions/pcntl.xml:1.9 Sun Dec 16 07:27:47 2001 +++ phpdoc/en/functions/pcntl.xml Sat Feb 2 10:36:06 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <reference id="ref.pcntl"> <title>Process Control Functions</title> <titleabbrev>PCNTL</titleabbrev> @@ -175,12 +175,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pcntl_fork</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>pcntl_fork</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> The <function>pcntl_fork</function> function creates a child process that differs from the parent process only in it's PID and @@ -228,13 +226,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pcntl_signal</function></funcdef> - <paramdef>int <parameter>signo</parameter></paramdef> - <paramdef>mixed <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pcntl_signal</methodname> + <methodparam><type>int</type><parameter>signo</parameter></methodparam> + <methodparam><type>mixed</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> The <function>pcntl_signal</function> function installs a new signal handler for the signal indicated by @@ -307,14 +303,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pcntl_waitpid</function></funcdef> - <paramdef>int <parameter>pid</parameter></paramdef> - <paramdef>int <parameter>status</parameter></paramdef> - <paramdef>int <parameter>options</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pcntl_waitpid</methodname> + <methodparam><type>int</type><parameter>pid</parameter></methodparam> + <methodparam><type>int</type><parameter>status</parameter></methodparam> + <methodparam><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> <para> The <function>pcntl_waitpid</function> function suspends execution of the current process until a child as specified by the @@ -429,12 +423,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pcntl_wexitstatus</function></funcdef> - <paramdef>int <parameter>status</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pcntl_wexitstatus</methodname> + <methodparam><type>int</type><parameter>status</parameter></methodparam> + </methodsynopsis> <para> Returns the return code of a terminated child. This function is only useful if <function>pcntl_wifexited</function> returned @@ -462,12 +454,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pcntl_wifexited</function></funcdef> - <paramdef>int <parameter>status</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pcntl_wifexited</methodname> + <methodparam><type>int</type><parameter>status</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if the child status code represents a successful exit. @@ -495,12 +485,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pcntl_wifsignaled</function></funcdef> - <paramdef>int <parameter>status</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pcntl_wifsignaled</methodname> + <methodparam><type>int</type><parameter>status</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if the child process exited because of a signal which was not caught. @@ -527,12 +515,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pcntl_wifstopped</function></funcdef> - <paramdef>int <parameter>status</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pcntl_wifstopped</methodname> + <methodparam><type>int</type><parameter>status</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if the child process which caused the return is currently stopped; this is only possible if the call to @@ -560,12 +546,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pcntl_wstopsig</function></funcdef> - <paramdef>int <parameter>status</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pcntl_wstopsig</methodname> + <methodparam><type>int</type><parameter>status</parameter></methodparam> + </methodsynopsis> <para> Returns the number of the signal which caused the child to stop. This function is only useful if @@ -593,12 +577,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pcntl_wtermsig</function></funcdef> - <paramdef>int <parameter>status</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pcntl_wtermsig</methodname> + <methodparam><type>int</type><parameter>status</parameter></methodparam> + </methodsynopsis> <para> Returns the number of the signal that caused the child process to terminate. This function is only useful if @@ -626,14 +608,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pcntl_exec</function></funcdef> - <paramdef>string <parameter>path</parameter></paramdef> - <paramdef>array <parameter><optional>args</optional></parameter></paramdef> - <paramdef>array <parameter><optional>envs</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pcntl_exec</methodname> + <methodparam><type>string</type><parameter>path</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>args</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>envs</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -662,3 +642,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/pcre.xml diff -u phpdoc/en/functions/pcre.xml:1.72 phpdoc/en/functions/pcre.xml:1.73 --- phpdoc/en/functions/pcre.xml:1.72 Tue Jan 29 08:51:44 2002 +++ phpdoc/en/functions/pcre.xml Sat Feb 2 10:36:06 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.72 $ --> +<!-- $Revision: 1.73 $ --> <reference id="ref.pcre"> <title>Regular Expression Functions (Perl-Compatible)</title> <titleabbrev>PCRE</titleabbrev> @@ -79,16 +79,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>preg_match</function></funcdef> - <paramdef>string <parameter>pattern</parameter></paramdef> - <paramdef>string <parameter>subject</parameter></paramdef> - <paramdef>array - <parameter><optional>matches</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>preg_match</methodname> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + <methodparam><type>string</type><parameter>subject</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>matches</parameter></methodparam> + </methodsynopsis> <para> Searches <parameter>subject</parameter> for a match to the regular expression given in <parameter>pattern</parameter>. @@ -173,17 +169,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>preg_match_all</function></funcdef> - <paramdef>string <parameter>pattern</parameter></paramdef> - <paramdef>string <parameter>subject</parameter></paramdef> - <paramdef>array <parameter>matches</parameter></paramdef> - <paramdef>int - <parameter><optional>order</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>preg_match_all</methodname> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + <methodparam><type>string</type><parameter>subject</parameter></methodparam> + <methodparam><type>array</type><parameter>matches</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>order</parameter></methodparam> + </methodsynopsis> <para> Searches <parameter>subject</parameter> for all matches to the regular expression given in <parameter>pattern</parameter> and puts them in @@ -336,17 +328,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>preg_replace</function></funcdef> - <paramdef>mixed <parameter>pattern</parameter></paramdef> - <paramdef>mixed <parameter>replacement</parameter></paramdef> - <paramdef>mixed <parameter>subject</parameter></paramdef> - <paramdef>int - <parameter><optional>limit</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>preg_replace</methodname> + <methodparam><type>mixed</type><parameter>pattern</parameter></methodparam> + <methodparam><type>mixed</type><parameter>replacement</parameter></methodparam> + <methodparam><type>mixed</type><parameter>subject</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>limit</parameter></methodparam> + </methodsynopsis> <para> Searches <parameter>subject</parameter> for matches to <parameter> pattern</parameter> and replaces them with @@ -498,17 +486,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>preg_replace_callback</function></funcdef> - <paramdef>mixed <parameter>pattern</parameter></paramdef> - <paramdef>mixed <parameter>callback</parameter></paramdef> - <paramdef>mixed <parameter>subject</parameter></paramdef> - <paramdef>int - <parameter><optional>limit</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>preg_replace_callback</methodname> + <methodparam><type>mixed</type><parameter>pattern</parameter></methodparam> + <methodparam><type>mixed</type><parameter>callback</parameter></methodparam> + <methodparam><type>mixed</type><parameter>subject</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>limit</parameter></methodparam> + </methodsynopsis> <para> The behavior of this function is almost identical to <function>preg_replace</function>, except for the fact that instead of @@ -530,19 +514,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>preg_split</function></funcdef> - <paramdef>string <parameter>pattern</parameter></paramdef> - <paramdef>string <parameter>subject</parameter></paramdef> - <paramdef>int - <parameter><optional>limit</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>preg_split</methodname> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + <methodparam><type>string</type><parameter>subject</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>limit</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <note> <para> @@ -631,15 +609,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>preg_quote</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>string - <parameter><optional>delimiter</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>preg_quote</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>delimiter</parameter></methodparam> + </methodsynopsis> <para> <function>preg_quote</function> takes <parameter>str</parameter> and puts a backslash in front of every character that is part of @@ -696,13 +670,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>preg_grep</function></funcdef> - <paramdef>string <parameter>pattern</parameter></paramdef> - <paramdef>array <parameter>input</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>preg_grep</methodname> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + <methodparam><type>array</type><parameter>input</parameter></methodparam> + </methodsynopsis> <para> <function>preg_grep</function> returns the array consisting of @@ -2612,3 +2584,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/pdf.xml diff -u phpdoc/en/functions/pdf.xml:1.76 phpdoc/en/functions/pdf.xml:1.77 --- phpdoc/en/functions/pdf.xml:1.76 Sun Jan 6 21:52:21 2002 +++ phpdoc/en/functions/pdf.xml Sat Feb 2 10:36:07 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.76 $ --> +<!-- $Revision: 1.77 $ --> <reference id="ref.pdf"> <title>PDF functions </title> <titleabbrev>PDF</titleabbrev> @@ -446,15 +446,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_add_bookmark</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - <paramdef>int <parameter><optional>parent</optional></parameter></paramdef> - <paramdef>int <parameter><optional>open</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pdf_add_bookmark</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>parent</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>open</parameter></methodparam> + </methodsynopsis> <para> Add a nested bookmark under <parameter>parent</parameter>, or a new top-level bookmark if <parameter>parent</parameter> = 0. Returns a bookmark descriptor @@ -471,17 +469,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_add_launchlink</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>llx</parameter></paramdef> - <paramdef>float <parameter>lly</parameter></paramdef> - <paramdef>float <parameter>urx</parameter></paramdef> - <paramdef>float <parameter>ury</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pdf_add_launchlink</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>llx</parameter></methodparam> + <methodparam><type>float</type><parameter>lly</parameter></methodparam> + <methodparam><type>float</type><parameter>urx</parameter></methodparam> + <methodparam><type>float</type><parameter>ury</parameter></methodparam> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Add a launch annotation (to a target of arbitrary file type). </para> @@ -495,18 +491,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_add_locallink</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>llx</parameter></paramdef> - <paramdef>float <parameter>lly</parameter></paramdef> - <paramdef>float <parameter>urx</parameter></paramdef> - <paramdef>float <parameter>ury</parameter></paramdef> - <paramdef>int <parameter>page</parameter></paramdef> - <paramdef>string <parameter>dest</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pdf_add_locallink</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>llx</parameter></methodparam> + <methodparam><type>float</type><parameter>lly</parameter></methodparam> + <methodparam><type>float</type><parameter>urx</parameter></methodparam> + <methodparam><type>float</type><parameter>ury</parameter></methodparam> + <methodparam><type>int</type><parameter>page</parameter></methodparam> + <methodparam><type>string</type><parameter>dest</parameter></methodparam> + </methodsynopsis> <para> Add a link annotation to a target within the current PDF file. </para> @@ -520,20 +514,18 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_add_note</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>llx</parameter></paramdef> - <paramdef>float <parameter>lly</parameter></paramdef> - <paramdef>float <parameter>urx</parameter></paramdef> - <paramdef>float <parameter>ury</parameter></paramdef> - <paramdef>string <parameter>contents</parameter></paramdef> - <paramdef>string <parameter>title</parameter></paramdef> - <paramdef>string <parameter>icon</parameter></paramdef> - <paramdef>int <parameter>open</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pdf_add_note</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>llx</parameter></methodparam> + <methodparam><type>float</type><parameter>lly</parameter></methodparam> + <methodparam><type>float</type><parameter>urx</parameter></methodparam> + <methodparam><type>float</type><parameter>ury</parameter></methodparam> + <methodparam><type>string</type><parameter>contents</parameter></methodparam> + <methodparam><type>string</type><parameter>title</parameter></methodparam> + <methodparam><type>string</type><parameter>icon</parameter></methodparam> + <methodparam><type>int</type><parameter>open</parameter></methodparam> + </methodsynopsis> <para> Add a note annotation. icon is one of of "comment, "insert", "note", "paragraph", "newparagraph", "key", or "help". @@ -564,19 +556,17 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_add_pdflink</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>llx</parameter></paramdef> - <paramdef>float <parameter>lly</parameter></paramdef> - <paramdef>float <parameter>urx</parameter></paramdef> - <paramdef>float <parameter>ury</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>int <parameter>page</parameter></paramdef> - <paramdef>string <parameter>dest</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pdf_add_pdflink</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>llx</parameter></methodparam> + <methodparam><type>float</type><parameter>lly</parameter></methodparam> + <methodparam><type>float</type><parameter>urx</parameter></methodparam> + <methodparam><type>float</type><parameter>ury</parameter></methodparam> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>int</type><parameter>page</parameter></methodparam> + <methodparam><type>string</type><parameter>dest</parameter></methodparam> + </methodsynopsis> <para> Add a file link annotation (to a PDF target). </para> @@ -590,13 +580,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_add_thumbnail</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>int <parameter>image</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pdf_add_thumbnail</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>int</type><parameter>image</parameter></methodparam> + </methodsynopsis> <para> Add an existing image as thumbnail for the current page. </para> @@ -610,17 +598,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_add_weblink</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>llx</parameter></paramdef> - <paramdef>float <parameter>lly</parameter></paramdef> - <paramdef>float <parameter>urx</parameter></paramdef> - <paramdef>float <parameter>ury</parameter></paramdef> - <paramdef>string <parameter>url</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pdf_add_weblink</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>llx</parameter></methodparam> + <methodparam><type>float</type><parameter>lly</parameter></methodparam> + <methodparam><type>float</type><parameter>urx</parameter></methodparam> + <methodparam><type>float</type><parameter>ury</parameter></methodparam> + <methodparam><type>string</type><parameter>url</parameter></methodparam> + </methodsynopsis> <para> Add a weblink annotation to a target URL on the Web. </para> @@ -634,17 +620,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_arc</function></funcdef> - <paramdef>resource <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - <paramdef>float <parameter>r</parameter></paramdef> - <paramdef>float <parameter>alpha</parameter></paramdef> - <paramdef>float <parameter>beta</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_arc</methodname> + <methodparam><type>resource</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>x</parameter></methodparam> + <methodparam><type>float</type><parameter>y</parameter></methodparam> + <methodparam><type>float</type><parameter>r</parameter></methodparam> + <methodparam><type>float</type><parameter>alpha</parameter></methodparam> + <methodparam><type>float</type><parameter>beta</parameter></methodparam> + </methodsynopsis> <para> Draw a counterclockwise circular arc from alpha to beta degrees </para> @@ -661,17 +645,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_arc</function></funcdef> - <paramdef>resource <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - <paramdef>float <parameter>r</parameter></paramdef> - <paramdef>float <parameter>alpha</parameter></paramdef> - <paramdef>float <parameter>beta</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_arc</methodname> + <methodparam><type>resource</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>x</parameter></methodparam> + <methodparam><type>float</type><parameter>y</parameter></methodparam> + <methodparam><type>float</type><parameter>r</parameter></methodparam> + <methodparam><type>float</type><parameter>alpha</parameter></methodparam> + <methodparam><type>float</type><parameter>beta</parameter></methodparam> + </methodsynopsis> <para> Draw a clockwise circular arc from alpha to beta degrees </para> @@ -688,21 +670,19 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_attach_file</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>llx</parameter></paramdef> - <paramdef>float <parameter>lly</parameter></paramdef> - <paramdef>float <parameter>urx</parameter></paramdef> - <paramdef>float <parameter>ury</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>string <parameter>description</parameter></paramdef> - <paramdef>string <parameter>author</parameter></paramdef> - <paramdef>string <parameter>mimetype</parameter></paramdef> - <paramdef>string <parameter>icon</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pdf_attach_file</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>llx</parameter></methodparam> + <methodparam><type>float</type><parameter>lly</parameter></methodparam> + <methodparam><type>float</type><parameter>urx</parameter></methodparam> + <methodparam><type>float</type><parameter>ury</parameter></methodparam> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>string</type><parameter>description</parameter></methodparam> + <methodparam><type>string</type><parameter>author</parameter></methodparam> + <methodparam><type>string</type><parameter>mimetype</parameter></methodparam> + <methodparam><type>string</type><parameter>icon</parameter></methodparam> + </methodsynopsis> <para> Add a file attachment annotation. icon is one of "graph, "paperclip", "pushpin", or "tag". @@ -717,14 +697,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_begin_page</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>width</parameter></paramdef> - <paramdef>float <parameter>height</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_begin_page</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>width</parameter></methodparam> + <methodparam><type>float</type><parameter>height</parameter></methodparam> + </methodsynopsis> <para> Add a new page to the document. The <parameter>width</parameter> and <parameter>height</parameter> are specified in points, which are @@ -803,17 +781,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_begin_pattern</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>width</parameter></paramdef> - <paramdef>float <parameter>height</parameter></paramdef> - <paramdef>float <parameter>xstep</parameter></paramdef> - <paramdef>float <parameter>ystep</parameter></paramdef> - <paramdef>int <parameter>painttype</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pdf_begin_pattern</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>width</parameter></methodparam> + <methodparam><type>float</type><parameter>height</parameter></methodparam> + <methodparam><type>float</type><parameter>xstep</parameter></methodparam> + <methodparam><type>float</type><parameter>ystep</parameter></methodparam> + <methodparam><type>int</type><parameter>painttype</parameter></methodparam> + </methodsynopsis> <para> Starts a new pattern definition and returns a pattern handle. <parameter>width</parameter>, and <parameter>height</parameter> @@ -833,14 +809,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_begin_template</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>width</parameter></paramdef> - <paramdef>float <parameter>height</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_begin_template</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>width</parameter></methodparam> + <methodparam><type>float</type><parameter>height</parameter></methodparam> + </methodsynopsis> <para> Start a new template definition. </para> @@ -854,15 +828,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_circle</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - <paramdef>float <parameter>r</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_circle</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>x</parameter></methodparam> + <methodparam><type>float</type><parameter>y</parameter></methodparam> + <methodparam><type>float</type><parameter>r</parameter></methodparam> + </methodsynopsis> <para> Draw a circle with center (x, y) and radius r. </para> @@ -876,12 +848,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_clip</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_clip</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + </methodsynopsis> <para> Use the current path as clipping path. </para> @@ -895,12 +865,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_close</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_close</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + </methodsynopsis> <para> Close the generated PDF file, and free all document-related resources. </para> @@ -914,12 +882,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_closepath</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_closepath</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + </methodsynopsis> <para> Close the current path. </para> @@ -933,12 +899,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_closepath_fill_stroke</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_closepath_fill_stroke</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + </methodsynopsis> <para> Close the path, fill, and stroke it. </para> @@ -952,12 +916,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_closepath_stroke</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_closepath_stroke</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + </methodsynopsis> <para> Close the path, and stroke it. </para> @@ -971,13 +933,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_close_image</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>int <parameter>image</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_close_image</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>int</type><parameter>image</parameter></methodparam> + </methodsynopsis> <para> Close an <parameter>image</parameter> retrieved with one of the <function>pdf_open_image*</function> functions. @@ -994,13 +954,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_close_pdi</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>int <parameter>dochandle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_close_pdi</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>int</type><parameter>dochandle</parameter></methodparam> + </methodsynopsis> <para> Close all open page handles, and close the input PDF document. </para> @@ -1016,13 +974,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_close_pdi_page</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>int <parameter>pagehandle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_close_pdi_page</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>int</type><parameter>pagehandle</parameter></methodparam> + </methodsynopsis> <para> Close the page handle, and free all page-related resources. </para> @@ -1036,18 +992,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_concat</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>a</parameter></paramdef> - <paramdef>float <parameter>b</parameter></paramdef> - <paramdef>float <parameter>c</parameter></paramdef> - <paramdef>float <parameter>d</parameter></paramdef> - <paramdef>float <parameter>e</parameter></paramdef> - <paramdef>float <parameter>f</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_concat</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>a</parameter></methodparam> + <methodparam><type>float</type><parameter>b</parameter></methodparam> + <methodparam><type>float</type><parameter>c</parameter></methodparam> + <methodparam><type>float</type><parameter>d</parameter></methodparam> + <methodparam><type>float</type><parameter>e</parameter></methodparam> + <methodparam><type>float</type><parameter>f</parameter></methodparam> + </methodsynopsis> <para> Concatenate a matrix to the CTM. </para> @@ -1061,13 +1015,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_continue_text</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_continue_text</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + </methodsynopsis> <para> Print text at the next line. The spacing between lines is determined by the <parameter>leading</parameter> parameter. @@ -1082,18 +1034,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_curveto</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>x1</parameter></paramdef> - <paramdef>float <parameter>y1</parameter></paramdef> - <paramdef>float <parameter>x2</parameter></paramdef> - <paramdef>float <parameter>y2</parameter></paramdef> - <paramdef>float <parameter>x3</parameter></paramdef> - <paramdef>float <parameter>y3</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_curveto</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>x1</parameter></methodparam> + <methodparam><type>float</type><parameter>y1</parameter></methodparam> + <methodparam><type>float</type><parameter>x2</parameter></methodparam> + <methodparam><type>float</type><parameter>y2</parameter></methodparam> + <methodparam><type>float</type><parameter>x3</parameter></methodparam> + <methodparam><type>float</type><parameter>y3</parameter></methodparam> + </methodsynopsis> <para> Draw a Bezier curve from the current point, using 3 more control points. </para> @@ -1107,12 +1057,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_delete</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_delete</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + </methodsynopsis> <para> Delete the PDF object, and free all internal resources. </para> @@ -1126,12 +1074,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_end_page</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_end_page</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + </methodsynopsis> <para> Finish the page. </para> @@ -1158,12 +1104,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_end_pattern</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_end_pattern</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + </methodsynopsis> <para> Finish the pattern definition. </para> @@ -1177,12 +1121,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_end_template</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_end_template</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + </methodsynopsis> <para> Finish the template definition. </para> @@ -1196,12 +1138,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_fill_stroke</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_fill_stroke</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + </methodsynopsis> <para> Fill the interior of the path with the current fill color. </para> @@ -1215,12 +1155,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_fill_stroke</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_fill_stroke</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + </methodsynopsis> <para> Fill and stroke the path with the current fill and stroke color. </para> @@ -1234,15 +1172,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_findfont</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>string <parameter>fontname</parameter></paramdef> - <paramdef>string <parameter>encoding</parameter></paramdef> - <paramdef>int <parameter>embed</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pdf_findfont</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>string</type><parameter>fontname</parameter></methodparam> + <methodparam><type>string</type><parameter>encoding</parameter></methodparam> + <methodparam><type>int</type><parameter>embed</parameter></methodparam> + </methodsynopsis> <para> Prepare a font for later use with <function>pdf_setfont</function>. The metrics will be loaded, and if embed is nonzero, the font file @@ -1282,12 +1218,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pdf_get_buffer</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pdf_get_buffer</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + </methodsynopsis> <para> Get the contents of the PDF output buffer. The result must be used by the client before calling any other PDFlib function. @@ -1350,13 +1284,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pdf_get_image_height</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>int <parameter>image</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pdf_get_image_height</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>int</type><parameter>image</parameter></methodparam> + </methodsynopsis> <para> <function>pdf_get_image_height</function> is deprecated, use <function>pdf_get_value</function> instead. @@ -1371,13 +1303,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pdf_get_image_width</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>int <parameter>image</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pdf_get_image_width</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>int</type><parameter>image</parameter></methodparam> + </methodsynopsis> <para> The <function>pdf_get_image_width</function> is deprecated, use <function>pdf_get_value</function> instead. @@ -1392,14 +1322,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pdf_get_parameter</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>float <parameter><optional>modifier</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pdf_get_parameter</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>modifier</parameter></methodparam> + </methodsynopsis> <para> Get the contents of some PDFlib parameter with string type. </para> @@ -1413,16 +1341,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pdf_get_pdi_parameter</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>int <parameter>doc</parameter></paramdef> - <paramdef>int <parameter>page</parameter></paramdef> - <paramdef>int <parameter>index</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pdf_get_pdi_parameter</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>int</type><parameter>doc</parameter></methodparam> + <methodparam><type>int</type><parameter>page</parameter></methodparam> + <methodparam><type>int</type><parameter>index</parameter></methodparam> + </methodsynopsis> <para> Get the contents of some PDI document parameter with string type. </para> @@ -1436,16 +1362,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pdf_get_pdi_value</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>int <parameter>doc</parameter></paramdef> - <paramdef>int <parameter>page</parameter></paramdef> - <paramdef>int <parameter>index</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pdf_get_pdi_value</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>int</type><parameter>doc</parameter></methodparam> + <methodparam><type>int</type><parameter>page</parameter></methodparam> + <methodparam><type>int</type><parameter>index</parameter></methodparam> + </methodsynopsis> <para> Get the contents of some PDI document parameter with numerical type. </para> @@ -1461,12 +1385,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_get_majorversion</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>pdf_get_majorversion</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns the major version number of the PDFlib. </para> @@ -1482,12 +1404,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_get_majorversion</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>pdf_get_majorversion</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns the minor version number of the PDFlib. </para> @@ -1501,14 +1421,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>pdf_get_value</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>float <parameter><optional>modifier</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>pdf_get_value</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>modifier</parameter></methodparam> + </methodsynopsis> <para> Get the contents of some PDFlib parameter with float type. </para> @@ -1522,12 +1440,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_initgraphics</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_initgraphics</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + </methodsynopsis> <para> Reset all implicit color and graphics state parameters to their defaults. </para> @@ -1541,14 +1457,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_lineto</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_lineto</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>x</parameter></methodparam> + <methodparam><type>float</type><parameter>y</parameter></methodparam> + </methodsynopsis> <para> Draw a line from the current point to (<parameter>x</parameter>, <parameter>y</parameter>). @@ -1563,13 +1477,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_makespotcolor</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>string <parameter>spotname</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_makespotcolor</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>string</type><parameter>spotname</parameter></methodparam> + </methodsynopsis> <para> Make a named spot color from the current color. </para> @@ -1583,14 +1495,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_moveto</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_moveto</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>x</parameter></methodparam> + <methodparam><type>float</type><parameter>y</parameter></methodparam> + </methodsynopsis> <para> Set the current point. </para> @@ -1611,12 +1521,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_new</function></funcdef> - <paramdef><parameter></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pdf_new</methodname> + <methodparam><parameter/></methodparam> + </methodsynopsis> <para> Create a new PDF object, using default error handling and memory management. @@ -1650,18 +1558,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_open_CCITT</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>int <parameter>width</parameter></paramdef> - <paramdef>int <parameter>height</parameter></paramdef> - <paramdef>int <parameter>BitReverse</parameter></paramdef> - <paramdef>int <parameter>k</parameter></paramdef> - <paramdef>int <parameter>Blackls1</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pdf_open_CCITT</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>int</type><parameter>width</parameter></methodparam> + <methodparam><type>int</type><parameter>height</parameter></methodparam> + <methodparam><type>int</type><parameter>BitReverse</parameter></methodparam> + <methodparam><type>int</type><parameter>k</parameter></methodparam> + <methodparam><type>int</type><parameter>Blackls1</parameter></methodparam> + </methodsynopsis> <para> Open a raw CCITT image. </para> @@ -1675,13 +1581,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_open_file</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>string <parameter><optional>filename</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pdf_open_file</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Create a new PDF file using the supplied file name. If <parameter>filename</parameter> is empty the PDF document @@ -1747,21 +1651,19 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_open_image</function></funcdef> - <paramdef>int <parameter>PDF-document</parameter></paramdef> - <paramdef>string <parameter>imagetype</parameter></paramdef> - <paramdef>string <parameter>source</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>long <parameter>length</parameter></paramdef> - <paramdef>int <parameter>width</parameter></paramdef> - <paramdef>int <parameter>height</parameter></paramdef> - <paramdef>int <parameter>components</parameter></paramdef> - <paramdef>int <parameter>bpc</parameter></paramdef> - <paramdef>string <parameter>params</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pdf_open_image</methodname> + <methodparam><type>int</type><parameter>PDF-document</parameter></methodparam> + <methodparam><type>string</type><parameter>imagetype</parameter></methodparam> + <methodparam><type>string</type><parameter>source</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>long</type><parameter>length</parameter></methodparam> + <methodparam><type>int</type><parameter>width</parameter></methodparam> + <methodparam><type>int</type><parameter>height</parameter></methodparam> + <methodparam><type>int</type><parameter>components</parameter></methodparam> + <methodparam><type>int</type><parameter>bpc</parameter></methodparam> + <methodparam><type>string</type><parameter>params</parameter></methodparam> + </methodsynopsis> <para> Use image data from a variety of data sources. Supported types are "jpeg", "ccitt", "raw". Supported sources are "memory", "fileref", @@ -1778,16 +1680,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_open_image_file</function></funcdef> - <paramdef>int <parameter>PDF-document</parameter></paramdef> - <paramdef>string <parameter>imagetype</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>string <parameter><optional>stringparam</optional></parameter></paramdef> - <paramdef>string <parameter><optional>intparam</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pdf_open_image_file</methodname> + <methodparam><type>int</type><parameter>PDF-document</parameter></methodparam> + <methodparam><type>string</type><parameter>imagetype</parameter></methodparam> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>stringparam</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>intparam</parameter></methodparam> + </methodsynopsis> <para> Open an image file. Supported types are "jpeg", "tiff", "gif", and "png". <parameter>stringparam</parameter> is either @@ -1821,13 +1721,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_open_memory_image</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>int <parameter>image</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pdf_open_memory_image</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>int</type><parameter>image</parameter></methodparam> + </methodsynopsis> <para> The <function>pdf_open_memory_image</function> function takes an image created with the PHP's image functions and makes it available @@ -1866,15 +1764,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_open_pdi</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>string <parameter>stringparam</parameter></paramdef> - <paramdef>int <parameter>intparam</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pdf_open_pdi</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>string</type><parameter>stringparam</parameter></methodparam> + <methodparam><type>int</type><parameter>intparam</parameter></methodparam> + </methodsynopsis> <para> Open an existing PDF document for later use. </para> @@ -1890,15 +1786,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_open_pdi_page</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>int <parameter>dochandle</parameter></paramdef> - <paramdef>int <parameter>pagenumber</parameter></paramdef> - <paramdef>string <parameter>pagelabel</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pdf_open_pdi_page</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>int</type><parameter>dochandle</parameter></methodparam> + <methodparam><type>int</type><parameter>pagenumber</parameter></methodparam> + <methodparam><type>string</type><parameter>pagelabel</parameter></methodparam> + </methodsynopsis> <para> Prepare a page for later use with <function>pdf_place_image</function> </para> @@ -1930,13 +1824,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_open_tiff</function></funcdef> - <paramdef>int <parameter>PDF-document</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pdf_open_tiff</methodname> + <methodparam><type>int</type><parameter>PDF-document</parameter></methodparam> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Deprecated. </para> @@ -1953,16 +1845,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_place_image</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>int <parameter>image</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - <paramdef>float <parameter>scale</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_place_image</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>int</type><parameter>image</parameter></methodparam> + <methodparam><type>float</type><parameter>x</parameter></methodparam> + <methodparam><type>float</type><parameter>y</parameter></methodparam> + <methodparam><type>float</type><parameter>scale</parameter></methodparam> + </methodsynopsis> <para> Place an image with the lower left corner at (<parameter>x</parameter>, <parameter>y</parameter>), and scale it. @@ -1977,17 +1867,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_place_pdi_page</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>int <parameter>page</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - <paramdef>float <parameter>sx</parameter></paramdef> - <paramdef>float <parameter>sy</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_place_pdi_page</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>int</type><parameter>page</parameter></methodparam> + <methodparam><type>float</type><parameter>x</parameter></methodparam> + <methodparam><type>float</type><parameter>y</parameter></methodparam> + <methodparam><type>float</type><parameter>sx</parameter></methodparam> + <methodparam><type>float</type><parameter>sy</parameter></methodparam> + </methodsynopsis> <para> Place a PDF page with the lower left corner at (<parameter>x</parameter>, <parameter>y</parameter>), and scale it. @@ -2002,16 +1890,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_rect</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - <paramdef>float <parameter>width</parameter></paramdef> - <paramdef>float <parameter>height</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_rect</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>x</parameter></methodparam> + <methodparam><type>float</type><parameter>y</parameter></methodparam> + <methodparam><type>float</type><parameter>width</parameter></methodparam> + <methodparam><type>float</type><parameter>height</parameter></methodparam> + </methodsynopsis> <para> Draw a rectangle at lower left (x, y) with width and height. </para> @@ -2025,12 +1911,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_restore</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_restore</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + </methodsynopsis> <para> Restore the most recently saved graphics state. </para> @@ -2044,13 +1928,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_rotate</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>phi</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_rotate</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>phi</parameter></methodparam> + </methodsynopsis> <para> Rotate the coordinate system by phi degrees. </para> @@ -2064,12 +1946,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_save</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_save</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + </methodsynopsis> <para> Save the current graphics state. </para> @@ -2083,14 +1963,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_scale</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>x-scale</parameter></paramdef> - <paramdef>float <parameter>y-scale</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_scale</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>x-scale</parameter></methodparam> + <methodparam><type>float</type><parameter>y-scale</parameter></methodparam> + </methodsynopsis> <para> Scale the coordinate system. </para> @@ -2104,18 +1982,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_setcolor</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>string <parameter>type</parameter></paramdef> - <paramdef>string <parameter>colorspace</parameter></paramdef> - <paramdef>float <parameter>c1</parameter></paramdef> - <paramdef>float <parameter><optional>c2</optional></parameter></paramdef> - <paramdef>float <parameter><optional>c3</optional></parameter></paramdef> - <paramdef>float <parameter><optional>c4</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_setcolor</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>string</type><parameter>type</parameter></methodparam> + <methodparam><type>string</type><parameter>colorspace</parameter></methodparam> + <methodparam><type>float</type><parameter>c1</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>c2</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>c3</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>c4</parameter></methodparam> + </methodsynopsis> <para> Set the current color space and color. The parameter <parameter>type</parameter> can be "fill", "stroke", or "both" to @@ -2179,14 +2055,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_setdash</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>b</parameter></paramdef> - <paramdef>float <parameter>w</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_setdash</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>b</parameter></methodparam> + <methodparam><type>float</type><parameter>w</parameter></methodparam> + </methodsynopsis> <para> Set the current dash pattern to <parameter>b</parameter> black and <parameter>w</parameter> white units. @@ -2201,13 +2075,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_setflat</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>flatness</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_setflat</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>flatness</parameter></methodparam> + </methodsynopsis> <para> Set the flatness to a value between 0 and 100 inclusive. </para> @@ -2221,14 +2093,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_setfont</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>int <parameter>font</parameter></paramdef> - <paramdef>float <parameter>size</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_setfont</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>int</type><parameter>font</parameter></methodparam> + <methodparam><type>float</type><parameter>size</parameter></methodparam> + </methodsynopsis> <para> Set the current font in the given size, using a <parameter>font</parameter> handle returned by @@ -2247,13 +2117,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_setgray</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>gray</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_setgray</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>gray</parameter></methodparam> + </methodsynopsis> <para> Set the current fill and stroke color. </para> @@ -2272,13 +2140,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_setgray_fill</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>gray</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_setgray_fill</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>gray</parameter></methodparam> + </methodsynopsis> <para> Set the current fill color to a gray value between 0 and 1 inclusive. </para> @@ -2297,13 +2163,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_setgray_stroke</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>gray</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_setgray_stroke</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>gray</parameter></methodparam> + </methodsynopsis> <para> Set the current stroke color to a gray value between 0 and 1 inclusive </para> @@ -2322,13 +2186,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_setlinecap</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>int <parameter>linecap</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_setlinecap</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>int</type><parameter>linecap</parameter></methodparam> + </methodsynopsis> <para> Set the <parameter>linecap</parameter> parameter to a value between 0 and 2 inclusive. </para> @@ -2342,13 +2204,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_setlinejoin</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>long <parameter>linejoin</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_setlinejoin</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>long</type><parameter>linejoin</parameter></methodparam> + </methodsynopsis> <para> Set the line join parameter to a value between 0 and 2 inclusive. </para> @@ -2362,13 +2222,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_setlinewidth</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>width</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_setlinewidth</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>width</parameter></methodparam> + </methodsynopsis> <para> Set the current linewidth to width. </para> @@ -2382,18 +2240,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_setmatrix</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>a</parameter></paramdef> - <paramdef>float <parameter>b</parameter></paramdef> - <paramdef>float <parameter>c</parameter></paramdef> - <paramdef>float <parameter>d</parameter></paramdef> - <paramdef>float <parameter>e</parameter></paramdef> - <paramdef>float <parameter>f</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_setmatrix</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>a</parameter></methodparam> + <methodparam><type>float</type><parameter>b</parameter></methodparam> + <methodparam><type>float</type><parameter>c</parameter></methodparam> + <methodparam><type>float</type><parameter>d</parameter></methodparam> + <methodparam><type>float</type><parameter>e</parameter></methodparam> + <methodparam><type>float</type><parameter>f</parameter></methodparam> + </methodsynopsis> <para> Explicitly set the current transformation matrix. </para> @@ -2407,13 +2263,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_setmiterlimit</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>miter</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_setmiterlimit</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>miter</parameter></methodparam> + </methodsynopsis> <para> Set the miter limit to a value greater than or equal to 1. </para> @@ -2427,13 +2281,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_setpolydash</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float *<parameter>dasharray</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_setpolydash</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float *</type><parameter>dasharray</parameter></methodparam> + </methodsynopsis> <para> Set a more complicated dash pattern defined by an array. </para> @@ -2447,15 +2299,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_setrgbcolor</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>red value</parameter></paramdef> - <paramdef>float <parameter>green value</parameter></paramdef> - <paramdef>float <parameter>blue value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_setrgbcolor</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>red value</parameter></methodparam> + <methodparam><type>float</type><parameter>green value</parameter></methodparam> + <methodparam><type>float</type><parameter>blue value</parameter></methodparam> + </methodsynopsis> <para> Set the current fill and stroke color to the supplied RGB values. </para> @@ -2474,15 +2324,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_setrgbcolor_fill</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>red value</parameter></paramdef> - <paramdef>float <parameter>green value</parameter></paramdef> - <paramdef>float <parameter>blue value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_setrgbcolor_fill</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>red value</parameter></methodparam> + <methodparam><type>float</type><parameter>green value</parameter></methodparam> + <methodparam><type>float</type><parameter>blue value</parameter></methodparam> + </methodsynopsis> <para> Set the current fill color to the supplied RGB values. </para> @@ -2501,15 +2349,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_setrgbcolor_stroke</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>red value</parameter></paramdef> - <paramdef>float <parameter>green value</parameter></paramdef> - <paramdef>float <parameter>blue value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_setrgbcolor_stroke</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>red value</parameter></methodparam> + <methodparam><type>float</type><parameter>green value</parameter></methodparam> + <methodparam><type>float</type><parameter>blue value</parameter></methodparam> + </methodsynopsis> <para> Set the current stroke color to the supplied RGB values. </para> @@ -2528,15 +2374,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_set_border_color</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>red</parameter></paramdef> - <paramdef>float <parameter>green</parameter></paramdef> - <paramdef>float <parameter>blue</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_set_border_color</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>red</parameter></methodparam> + <methodparam><type>float</type><parameter>green</parameter></methodparam> + <methodparam><type>float</type><parameter>blue</parameter></methodparam> + </methodsynopsis> <para> Set the border color for all kinds of annotations. </para> @@ -2550,14 +2394,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_set_border_dash</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>black</parameter></paramdef> - <paramdef>float <parameter>white</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_set_border_dash</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>black</parameter></methodparam> + <methodparam><type>float</type><parameter>white</parameter></methodparam> + </methodsynopsis> <para> Set the border dash style for all kinds of annotations. See <function>pdf_setdash</function>. @@ -2572,14 +2414,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_set_border_style</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>string <parameter>style</parameter></paramdef> - <paramdef>float <parameter>width</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_set_border_style</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>string</type><parameter>style</parameter></methodparam> + <methodparam><type>float</type><parameter>width</parameter></methodparam> + </methodsynopsis> <para> Set the border style for all kinds of annotations. <parameter>style</parameter> is "solid" or "dashed". @@ -2644,13 +2484,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_set_horiz_scaling</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>scale</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_set_horiz_scaling</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>scale</parameter></methodparam> + </methodsynopsis> <para> Deprecated. </para> @@ -2667,14 +2505,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_set_info</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_set_info</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> Fill document information field key with value. <parameter>key</parameter> is one of "Subject", "Title", "Creator", @@ -2692,13 +2528,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pdf_set_info_author</function></funcdef> - <paramdef>int <parameter>pdfdoc</parameter></paramdef> - <paramdef>string <parameter>author</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pdf_set_info_author</methodname> + <methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>string</type><parameter>author</parameter></methodparam> + </methodsynopsis> <para> This function is deprecate, use <function>pdf_set_info</function> instead. </para> @@ -2714,13 +2548,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pdf_set_info_creator</function></funcdef> - <paramdef>int <parameter>pdfdoc</parameter></paramdef> - <paramdef>string <parameter>creator</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pdf_set_info_creator</methodname> + <methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>string</type><parameter>creator</parameter></methodparam> + </methodsynopsis> <para> This function is deprecate, use <function>pdf_set_info</function> instead. </para> @@ -2736,13 +2568,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pdf_set_info_keywords</function></funcdef> - <paramdef>int <parameter>pdfdoc</parameter></paramdef> - <paramdef>string <parameter>keywords</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pdf_set_info_keywords</methodname> + <methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>string</type><parameter>keywords</parameter></methodparam> + </methodsynopsis> <para> This function is deprecate, use <function>pdf_set_info</function> instead. </para> @@ -2758,13 +2588,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pdf_set_info_subject</function></funcdef> - <paramdef>int <parameter>pdfdoc</parameter></paramdef> - <paramdef>string <parameter>subject</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pdf_set_info_subject</methodname> + <methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>string</type><parameter>subject</parameter></methodparam> + </methodsynopsis> <para> This function is deprecate, use <function>pdf_set_info</function> instead. </para> @@ -2780,13 +2608,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pdf_set_info_title</function></funcdef> - <paramdef>int <parameter>pdfdoc</parameter></paramdef> - <paramdef>string <parameter>title</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pdf_set_info_title</methodname> + <methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam> + <methodparam><type>string</type><parameter>title</parameter></methodparam> + </methodsynopsis> <para> This function is deprecate, use <function>pdf_set_info</function> instead. </para> @@ -2816,14 +2642,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_set_parameter</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>string <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_set_parameter</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> Set some PDFlib parameter with string type. </para> @@ -2837,14 +2661,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_set_text_pos</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_set_text_pos</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>x</parameter></methodparam> + <methodparam><type>float</type><parameter>y</parameter></methodparam> + </methodsynopsis> <para> Set the text output position. </para> @@ -2903,14 +2725,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_set_value</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>string <parameter>key</parameter></paramdef> - <paramdef>float <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_set_value</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>float</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> Set the value of some PDFlib parameter with float type. </para> @@ -2940,13 +2760,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_show</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_show</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + </methodsynopsis> <para> Print text in the current font and size at the current position. </para> @@ -2960,19 +2778,17 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pdf_show_boxed</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - <paramdef>float <parameter>left</parameter></paramdef> - <paramdef>float <parameter>top</parameter></paramdef> - <paramdef>float <parameter>width</parameter></paramdef> - <paramdef>float <parameter>height</parameter></paramdef> - <paramdef>string <parameter>hmode</parameter></paramdef> - <paramdef>string <parameter><optional>feature</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pdf_show_boxed</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + <methodparam><type>float</type><parameter>left</parameter></methodparam> + <methodparam><type>float</type><parameter>top</parameter></methodparam> + <methodparam><type>float</type><parameter>width</parameter></methodparam> + <methodparam><type>float</type><parameter>height</parameter></methodparam> + <methodparam><type>string</type><parameter>hmode</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>feature</parameter></methodparam> + </methodsynopsis> <para> Format text in the current font and size into the supplied text box according to the requested formatting mode, which must be one of @@ -2996,15 +2812,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_show_xy</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - <paramdef>float <parameter>x</parameter></paramdef> - <paramdef>float <parameter>y</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_show_xy</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + <methodparam><type>float</type><parameter>x</parameter></methodparam> + <methodparam><type>float</type><parameter>y</parameter></methodparam> + </methodsynopsis> <para> Print text in the current font at (x, y). </para> @@ -3018,14 +2832,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_skew</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>alpha</parameter></paramdef> - <paramdef>float <parameter>beta</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_skew</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>alpha</parameter></methodparam> + <methodparam><type>float</type><parameter>beta</parameter></methodparam> + </methodsynopsis> <para> Skew the coordinate system in x and y direction by alpha and beta degrees. @@ -3040,15 +2852,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>pdf_stringwidth</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - <paramdef>int <parameter><optional>font</optional></parameter></paramdef> - <paramdef>float <parameter><optional>size</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>pdf_stringwidth</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>font</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>size</parameter></methodparam> + </methodsynopsis> <para> Returns the width of <parameter>text</parameter> using the last font set by <function>pdf_setfont</function>. If the optional @@ -3078,12 +2888,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_stroke</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_stroke</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + </methodsynopsis> <para> Stroke the path with the current color and line width, and clear it. </para> @@ -3097,14 +2905,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pdf_translate</function></funcdef> - <paramdef>int <parameter>pdf object</parameter></paramdef> - <paramdef>float <parameter>tx</parameter></paramdef> - <paramdef>float <parameter>ty</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>pdf_translate</methodname> + <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> + <methodparam><type>float</type><parameter>tx</parameter></methodparam> + <methodparam><type>float</type><parameter>ty</parameter></methodparam> + </methodsynopsis> <para> Translate the origin of the coordinate system. </para> @@ -3133,3 +2939,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/pfpro.xml diff -u phpdoc/en/functions/pfpro.xml:1.11 phpdoc/en/functions/pfpro.xml:1.12 --- phpdoc/en/functions/pfpro.xml:1.11 Wed Dec 12 15:47:18 2001 +++ phpdoc/en/functions/pfpro.xml Sat Feb 2 10:36:07 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> +<!-- $Revision: 1.12 $ --> <reference id="ref.pfpro"> <title>Verisign Payflow Pro functions</title> <titleabbrev>Verisign Payflow Pro</titleabbrev> @@ -53,12 +53,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pfpro_init</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>pfpro_init</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> <function>pfpro_init</function> is used to initialise the Payflow Pro library. You may omit this call, in which case @@ -78,12 +76,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>pfpro_cleanup</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>pfpro_cleanup</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> <function>pfpro_cleanup</function> is used to shutdown the Payflow Pro library cleanly. It should be called after you @@ -105,34 +101,18 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>pfpro_process</function></funcdef> - <paramdef>array <parameter>parameters</parameter></paramdef> - - <paramdef>string - <parameter><optional>address</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>port</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>timeout</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>proxy address</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>proxy port</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>proxy logon</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>proxy password</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>pfpro_process</methodname> + <methodparam><type>array</type><parameter>parameters</parameter></methodparam> + + <methodparam choice="opt"><type>string</type><parameter>address</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>proxy address</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>proxy port</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>proxy logon</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>proxy password</parameter></methodparam> + </methodsynopsis> <para> Returns: An associative array containing the response </para> @@ -227,33 +207,17 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pfpro_process_raw</function></funcdef> - <paramdef>string <parameter>parameters</parameter></paramdef> - <paramdef>string - <parameter><optional>address</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>port</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>timeout</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>proxy address</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>proxy port</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>proxy logon</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>proxy password</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pfpro_process_raw</methodname> + <methodparam><type>string</type><parameter>parameters</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>address</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>proxy address</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>proxy port</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>proxy logon</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>proxy password</parameter></methodparam> + </methodsynopsis> <para> Returns: A string containing the response. </para> @@ -309,12 +273,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pfpro_version</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>pfpro_version</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> <function>pfpro_version</function> returns the version string of the Payflow Pro library. At the time of writing, this was L211. @@ -344,3 +306,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/pgsql.xml diff -u phpdoc/en/functions/pgsql.xml:1.67 phpdoc/en/functions/pgsql.xml:1.68 --- phpdoc/en/functions/pgsql.xml:1.67 Thu Jan 24 05:02:51 2002 +++ phpdoc/en/functions/pgsql.xml Sat Feb 2 10:36:07 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.67 $ --> +<!-- $Revision: 1.68 $ --> <reference id="ref.pgsql"> <title>PostgreSQL functions</title> <titleabbrev>PostgreSQL</titleabbrev> @@ -210,12 +210,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pg_close</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pg_close</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>pg_close</function> closes down the non-persistent connection to a PostgreSQL database associated with the given @@ -248,12 +246,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pg_cmdtuples</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pg_cmdtuples</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> <function>pg_cmdtuples</function> returns the number of tuples (instances/records/rows) affected by INSERT, UPDATE, and DELETE @@ -288,12 +284,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>pg_connect</function></funcdef> - <paramdef>string <parameter>connection_string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>pg_connect</methodname> + <methodparam><type>string</type><parameter>connection_string</parameter></methodparam> + </methodsynopsis> <para> <function>pg_connect</function> returns a connection resource that is needed by other PostgreSQL functions. @@ -362,12 +356,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pg_dbname</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pg_dbname</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>pg_dbname</function> returns the name of the database that the given PostgreSQL <parameter>connection</parameter> @@ -386,14 +378,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pg_end_copy</function></funcdef> - <paramdef>resource - <parameter><optional>connection</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pg_end_copy</methodname> + <methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>pg_end_copy</function> syncs PostgreSQL frontend (usually a web server process) with the PostgreSQL server after @@ -419,12 +407,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pg_errormessage</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pg_errormessage</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>pg_errormessage</function> returns a string containing the last error message for given @@ -450,13 +436,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>pg_exec</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>pg_exec</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> <para> <function>pg_exec</function> returns a query result resource if query could be executed. It returns &false; on failure or if @@ -508,16 +492,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>pg_fetch_array</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>row</parameter></paramdef> - <paramdef>int - <parameter><optional>result_type</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>pg_fetch_array</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>row</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> + </methodsynopsis> <para> <function>pg_fetch_array</function> returns an array that corresponds to the fetched row (tuples/records). It returns @@ -604,16 +584,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>pg_fetch_object</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>row</parameter></paramdef> - <paramdef>int - <parameter><optional>result_type</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>pg_fetch_object</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>row</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> + </methodsynopsis> <para> <function>pg_fetch_object</function> returns an object with properties that correspond to the fetched row. It returns &false; @@ -719,13 +695,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>pg_fetch_row</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>row</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>pg_fetch_row</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>row</parameter></methodparam> + </methodsynopsis> <para> <function>pg_fetch_row</function> fetches one row of data from the result associated with the specified @@ -796,14 +770,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pg_fieldisnull</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>row</parameter></paramdef> - <paramdef>mixed <parameter>field</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pg_fieldisnull</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>row</parameter></methodparam> + <methodparam><type>mixed</type><parameter>field</parameter></methodparam> + </methodsynopsis> <para> <function>pg_fieldisnull</function> test if a field is &null; or not. It returns 1 if the field in the given row is &null;. It @@ -823,13 +795,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pg_fieldname</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>field_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pg_fieldname</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_number</parameter></methodparam> + </methodsynopsis> <para> <function>pg_fieldname</function> returns the name of the field occupying the given <parameter>field_number</parameter> in the @@ -851,13 +821,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pg_fieldnum</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>string <parameter>field_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pg_fieldnum</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>string</type><parameter>field_name</parameter></methodparam> + </methodsynopsis> <para> <function>pg_fieldnum</function> will return the number of the column (field) slot that corresponds to the @@ -880,14 +848,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pg_fieldprtlen</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>row_number</parameter></paramdef> - <paramdef>string <parameter>field_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pg_fieldprtlen</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>row_number</parameter></methodparam> + <methodparam><type>string</type><parameter>field_name</parameter></methodparam> + </methodsynopsis> <para> <function>pg_fieldprtlen</function> returns the actual printed length (number of characters) of a specific value in a PostgreSQL @@ -911,13 +877,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pg_fieldsize</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>field_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pg_fieldsize</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_number</parameter></methodparam> + </methodsynopsis> <para> <function>pg_fieldsize</function> returns the internal storage size (in bytes) of the field number in the given PostgreSQL @@ -942,13 +906,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pg_fieldtype</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>field_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pg_fieldtype</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_number</parameter></methodparam> + </methodsynopsis> <para> <function>pg_fieldtype</function> returns a string containing the type name of the given <parameter>field_number</parameter> in the @@ -970,12 +932,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pg_freeresult</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pg_freeresult</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> <function>pg_freeresult</function> only needs to be called if you are worried about using too much memory while your script is @@ -1002,12 +962,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pg_getlastoid</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pg_getlastoid</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> <function>pg_getlastoid</function> is used to retrieve the <varname>oid</varname> assigned to an inserted tuple (record) if @@ -1035,12 +993,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pg_host</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pg_host</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>pg_host</function> returns the host name of the given PostgreSQL <parameter>connection</parameter> resource is @@ -1064,12 +1020,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pg_last_notice</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pg_last_notice</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>pg_last_notice</function> returns the last notice message from PostgreSQL server specified by @@ -1106,12 +1060,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pg_loclose</function></funcdef> - <paramdef>resource <parameter>large_object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pg_loclose</methodname> + <methodparam><type>resource</type><parameter>large_object</parameter></methodparam> + </methodsynopsis> <para> <function>pg_loclose</function> closes an Inversion Large Object. <parameter>large_object</parameter> is a resource for the @@ -1138,12 +1090,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pg_locreate</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pg_locreate</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>pg_locreate</function> creates an Inversion Large Object and returns the <varname>oid</varname> of the large @@ -1173,20 +1123,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pg_loexport</function></funcdef> - <paramdef>int - <parameter>oid</parameter> - </paramdef> - <paramdef>string - <parameter>pathname</parameter> - </paramdef> - <paramdef>resource - <parameter><optional>connection</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pg_loexport</methodname> + <methodparam><type>int</type><parameter>oid</parameter></methodparam> + <methodparam><type>string</type><parameter>pathname</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> The <parameter>oid</parameter> argument specifies oid of the large object to export and the <parameter>pathname</parameter> @@ -1212,15 +1154,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pg_loimport</function></funcdef> - <paramdef>string <parameter>pathname</parameter></paramdef> - <paramdef>resource - <parameter><optional>connection</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pg_loimport</methodname> + <methodparam><type>string</type><parameter>pathname</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> The <parameter>pathname</parameter> argument specifies the pathname of the file to be imported as a large object. It returns @@ -1248,14 +1186,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>pg_loopen</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>oid</parameter></paramdef> - <paramdef>string <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>pg_loopen</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>oid</parameter></methodparam> + <methodparam><type>string</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> <function>pg_loopen</function> open an Inversion Large Object and returns large object resource. The resource encapsulates @@ -1290,13 +1226,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pg_loread</function></funcdef> - <paramdef>resource <parameter>large_object</parameter></paramdef> - <paramdef>int <parameter>len</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pg_loread</methodname> + <methodparam><type>resource</type><parameter>large_object</parameter></methodparam> + <methodparam><type>int</type><parameter>len</parameter></methodparam> + </methodsynopsis> <para> <function>pg_loread</function> reads at most <parameter>len</parameter> bytes from a large object and returns @@ -1326,12 +1260,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pg_loreadall</function></funcdef> - <paramdef>resource <parameter>large_object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pg_loreadall</methodname> + <methodparam><type>resource</type><parameter>large_object</parameter></methodparam> + </methodsynopsis> <para> <function>pg_loreadall</function> reads a large object and passes it straight through to the browser after sending all pending @@ -1358,13 +1290,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pg_lounlink</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>oid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pg_lounlink</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>int</type><parameter>oid</parameter></methodparam> + </methodsynopsis> <para> <function>pg_lounlink</function> deletes a large object with the <parameter>oid</parameter>. It returns &true; on success, @@ -1390,13 +1320,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pg_lowrite</function></funcdef> - <paramdef>resource <parameter>large_object</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pg_lowrite</methodname> + <methodparam><type>resource</type><parameter>large_object</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> <para> <function>pg_lowrite</function> writes at most to a large object from a variable <parameter>data</parameter> and returns the number @@ -1424,12 +1352,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pg_numfields</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pg_numfields</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> <function>pg_numfields</function> returns the number of fields (columns) in a PostgreSQL <parameter>result</parameter>. The @@ -1453,12 +1379,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pg_numrows</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pg_numrows</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> <function>pg_numrows</function> will return the number of rows in a PostgreSQL <parameter>result</parameter> resource. @@ -1488,12 +1412,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pg_options</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pg_options</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>pg_options</function> will return a string containing the options specified on the given PostgreSQL @@ -1509,12 +1431,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pg_pconnect</function></funcdef> - <paramdef>string <parameter>connection_string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pg_pconnect</methodname> + <methodparam><type>string</type><parameter>connection_string</parameter></methodparam> + </methodsynopsis> <para> <function>pg_pconnect</function> opens a connection to a PostgreSQL database. It returns a connection resource that is @@ -1593,12 +1513,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pg_port</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pg_port</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>pg_port</function> returns the port number that the given PostgreSQL <parameter>connection</parameter> resource is @@ -1616,15 +1534,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pg_put_line</function></funcdef> - <paramdef>resource - <parameter><optional>connection</optional></parameter> - </paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pg_put_line</methodname> + <methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> <para> <function>pg_put_line</function> sends a NULL-terminated string to the PostgreSQL backend server. This is useful for example for @@ -1671,14 +1585,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>pg_result</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - <paramdef>int <parameter>row_number</parameter></paramdef> - <paramdef>mixed <parameter>field</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>pg_result</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>row_number</parameter></methodparam> + <methodparam><type>mixed</type><parameter>field</parameter></methodparam> + </methodsynopsis> <para> <function>pg_result</function> returns values from a <parameter>result</parameter> resource returned by @@ -1719,15 +1631,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pg_set_client_encoding</function></funcdef> - <paramdef>resource - <parameter><optional>connection</optional></parameter> - </paramdef> - <paramdef>string <parameter>encoding</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pg_set_client_encoding</methodname> + <methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> <para> <function>pg_set_client_encoding</function> sets the client encoding and return 0 if success or -1 if error. @@ -1768,14 +1676,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pg_client_encoding</function></funcdef> - <paramdef>resource - <parameter><optional>connection</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pg_client_encoding</methodname> + <methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>pg_client_encoding</function> returns the client encoding as the string. The returned string should be either : @@ -1812,20 +1716,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pg_trace</function></funcdef> - <paramdef>string - <parameter>pathname</parameter> - </paramdef> - <paramdef>string - <parameter><optional>mode</optional></parameter> - </paramdef> - <paramdef>resource - <parameter><optional>connection</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pg_trace</methodname> + <methodparam><type>string</type><parameter>pathname</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>mode</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>pg_trace</function> enables tracing of the PostgreSQL frontend/backend communication to a debugging file specified as @@ -1867,12 +1763,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pg_tty</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pg_tty</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>pg_tty</function> returns the tty name that server side debugging output is sent to on the given PostgreSQL @@ -1890,14 +1784,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pg_untrace</function></funcdef> - <paramdef>resource - <parameter><optional>connection</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pg_untrace</methodname> + <methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> Stop tracing started by <function>pg_trace</function>. <parameter>connection</parameter> specifies the connection that was @@ -1923,12 +1813,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>pg_get_result</function></funcdef> - <paramdef>resource <parameter><optional>connection</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>pg_get_result</methodname> + <methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>pg_get_result</function> get result resource from async query executed by @@ -1952,12 +1840,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pg_result_status</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pg_result_status</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> <function>pg_result_status</function> returns status of result resource. Possible retun values are PGSQL_EMPTY_QUERY, @@ -1982,17 +1868,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pg_send_query</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - </funcprototype> - <funcprototype> - <funcdef>bool <function>pg_send_query</function></funcdef> - <paramdef>string <parameter>query</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pg_send_query</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pg_send_query</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> <para> <function>pg_send_query</function> send asynchronous query to the <parameter>connection</parameter>. Unlike @@ -2030,12 +1914,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pg_cancel_query</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pg_cancel_query</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>pg_cancel_query</function> cancel asynchronous query sent by <function>pg_send_query</function>. You cannot cancel query executed by @@ -2060,12 +1942,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pg_connection_busy</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pg_connection_busy</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>pg_connection_busy</function> returns &true; if connection busy. If connection is busy, previously sent query to @@ -2091,12 +1971,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pg_connection_reset</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pg_connection_reset</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>pg_connection_reset</function> reset connection with the same parameter when connection is made. It is useful for @@ -2122,12 +2000,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pg_connection_status</function></funcdef> - <paramdef>resource <parameter>connection</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pg_connection_status</methodname> + <methodparam><type>resource</type><parameter>connection</parameter></methodparam> + </methodsynopsis> <para> <function>pg_connection_status</function> returns a connection status. Possible status is <literal>PGSQL_CONNECTION_O</literal> @@ -2150,16 +2026,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pg_copy_from</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>table_name</parameter></paramdef> - <paramdef>array <parameter>rows</parameter></paramdef> - <paramdef>string <parameter><optional>delimiter</optional></parameter></paramdef> - <paramdef>string <parameter><optional>null_as</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pg_copy_from</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>table_name</parameter></methodparam> + <methodparam><type>array</type><parameter>rows</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>delimiter</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>null_as</parameter></methodparam> + </methodsynopsis> <para> <function>pg_copy_from</function> copy table from array. It return &true; for success, otherwise &false;. @@ -2181,15 +2055,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pg_copy_to</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>table_name</parameter></paramdef> - <paramdef>string <parameter><optional>delimiter</optional></parameter></paramdef> - <paramdef>string <parameter><optional>null_as</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pg_copy_to</methodname> + <methodparam><type>int</type><parameter>connection</parameter></methodparam> + <methodparam><type>string</type><parameter>table_name</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>delimiter</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>null_as</parameter></methodparam> + </methodsynopsis> <para> <function>pg_copy_to</function> copy table to array. The result array is returned if it success to copy. Otherwise it returns @@ -2212,12 +2084,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pg_escape_bytea</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pg_escape_bytea</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> <para> <function>pg_escape_string</function> escapes string for bytea datatype. It returns escaped string. @@ -2244,12 +2114,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pg_escape_string</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pg_escape_string</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> <para> <function>pg_escape_string</function> escapes string for text/char datatype. It returns escaped string. @@ -2276,14 +2144,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pg_lo_seek</function></funcdef> - <paramdef>resource <parameter>large_object</parameter></paramdef> - <paramdef>int <parameter>offset</parameter></paramdef> - <paramdef>int <parameter><optional>whence</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pg_lo_seek</methodname> + <methodparam><type>resource</type><parameter>large_object</parameter></methodparam> + <methodparam><type>int</type><parameter>offset</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>whence</parameter></methodparam> + </methodsynopsis> <para> <function>pg_lo_seek</function> seeks position of large object resource. <parameter>whence</parameter> is PGSQL_SEEK_SET, @@ -2306,12 +2172,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pg_lo_tell</function></funcdef> - <paramdef>resource <parameter>large_object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pg_lo_tell</methodname> + <methodparam><type>resource</type><parameter>large_object</parameter></methodparam> + </methodsynopsis> <para> <function>pg_lo_tell</function> returns current position (offset from the beginning of large object). @@ -2333,12 +2197,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>pg_result_error</function></funcdef> - <paramdef>resource <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>pg_result_error</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> <function>pg_result_error</function> returns error message associated with <parameter>result</parameter> resource. Therefore, @@ -2377,3 +2239,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/posix.xml diff -u phpdoc/en/functions/posix.xml:1.18 phpdoc/en/functions/posix.xml:1.19 --- phpdoc/en/functions/posix.xml:1.18 Sun Dec 16 06:51:32 2001 +++ phpdoc/en/functions/posix.xml Sat Feb 2 10:36:07 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.18 $ --> +<!-- $Revision: 1.19 $ --> <reference id="ref.posix"> <title>POSIX functions</title> <titleabbrev>POSIX</titleabbrev> @@ -24,13 +24,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>posix_kill</function></funcdef> - <paramdef>int <parameter>pid</parameter></paramdef> - <paramdef>int <parameter>sig</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>posix_kill</methodname> + <methodparam><type>int</type><parameter>pid</parameter></methodparam> + <methodparam><type>int</type><parameter>sig</parameter></methodparam> + </methodsynopsis> <para> Send the signal <parameter>sig</parameter> to the process with the process identifier <parameter>pid</parameter>. Returns &false;, @@ -52,12 +50,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>posix_getpid</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>posix_getpid</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Return the process identifier of the current process.</para> </refsect1> @@ -70,12 +66,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>posix_getppid</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>posix_getppid</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Return the process identifier of the parent process of the current process. @@ -92,12 +86,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>posix_getuid</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>posix_getuid</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Return the numeric real user ID of the current process. See also <function>posix_getpwuid</function> for information on how to @@ -115,12 +107,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>posix_geteuid</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>posix_geteuid</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Return the numeric effective user ID of the current process. See also <function>posix_getpwuid</function> for information on how @@ -138,12 +128,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>posix_getgid</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>posix_getgid</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Return the numeric real group ID of the current process. See also <function>posix_getgrgid</function> for information on how to @@ -161,12 +149,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>posix_getegid</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>posix_getegid</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Return the numeric effective group ID of the current process. See also <function>posix_getgrgid</function> for information on how @@ -184,12 +170,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>posix_setuid</function></funcdef> - <paramdef>int <parameter>uid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>posix_setuid</methodname> + <methodparam><type>int</type><parameter>uid</parameter></methodparam> + </methodsynopsis> <para> Set the real user ID of the current process. This is a privileged function and you need appropriate privileges (usually root) on @@ -211,12 +195,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>posix_seteuid</function></funcdef> - <paramdef>int <parameter>uid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>posix_seteuid</methodname> + <methodparam><type>int</type><parameter>uid</parameter></methodparam> + </methodsynopsis> <para> Set the real user ID of the current process. This is a privileged function and you need appropriate privileges (usually root) on @@ -238,12 +220,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>posix_setgid</function></funcdef> - <paramdef>int <parameter>gid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>posix_setgid</methodname> + <methodparam><type>int</type><parameter>gid</parameter></methodparam> + </methodsynopsis> <para> Set the real group ID of the current process. This is a privileged function and you need appropriate privileges (usually @@ -267,12 +247,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>posix_setegid</function></funcdef> - <paramdef>int <parameter>gid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>posix_setegid</methodname> + <methodparam><type>int</type><parameter>gid</parameter></methodparam> + </methodsynopsis> <para> Set the effective group ID of the current process. This is a privileged function and you need appropriate privileges (usually @@ -293,12 +271,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>posix_getgroups</function></funcdef> + <methodsynopsis> + <type>array</type><methodname>posix_getgroups</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns an array of integers containing the numeric group ids of the group set of the current process. See also @@ -315,12 +291,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>posix_getlogin</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>posix_getlogin</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns the login name of the user owning the current process. See <function>posix_getpwnam</function> for information how to @@ -338,12 +312,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>posix_getpgrp</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>posix_getpgrp</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Return the process group identifier of the current process. See POSIX.1 and the getpgrp(2) manual page on your POSIX system for @@ -359,12 +331,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>posix_setsid</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>posix_setsid</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Make the current process a session leader. See POSIX.1 and the setsid(2) manual page on your POSIX system for more informations @@ -380,13 +350,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>posix_setpgid</function></funcdef> - <paramdef>int <parameter>pid</parameter></paramdef> - <paramdef>int <parameter>pgid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>posix_setpgid</methodname> + <methodparam><type>int</type><parameter>pid</parameter></methodparam> + <methodparam><type>int</type><parameter>pgid</parameter></methodparam> + </methodsynopsis> <para> Let the process <parameter>pid</parameter> join the process group <parameter>pgid</parameter>. See POSIX.1 and the setsid(2) manual @@ -403,12 +371,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>posix_getpgid</function></funcdef> - <paramdef>int <parameter>pid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>posix_getpgid</methodname> + <methodparam><type>int</type><parameter>pid</parameter></methodparam> + </methodsynopsis> <para> Returns the process group identifier of the process <parameter>pid</parameter>. @@ -428,12 +394,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>posix_getsid</function></funcdef> - <paramdef>int <parameter>pid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>posix_getsid</methodname> + <methodparam><type>int</type><parameter>pid</parameter></methodparam> + </methodsynopsis> <para> Return the sid of the process <parameter>pid</parameter>. If <parameter>pid</parameter> is 0, the sid of the current process @@ -454,12 +418,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>posix_uname</function></funcdef> + <methodsynopsis> + <type>array</type><methodname>posix_uname</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns a hash of strings with information about the system. The indices of the hash are @@ -505,12 +467,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>posix_times</function></funcdef> + <methodsynopsis> + <type>array</type><methodname>posix_times</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns a hash of strings with information about the current process CPU usage. The indices of the hash are @@ -543,12 +503,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>posix_ctermid</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>posix_ctermid</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Needs to be written. </para> @@ -562,12 +520,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>posix_ttyname</function></funcdef> - <paramdef>int <parameter>fd</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>posix_ttyname</methodname> + <methodparam><type>int</type><parameter>fd</parameter></methodparam> + </methodsynopsis> <para> Needs to be written. </para> @@ -583,12 +539,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>posix_isatty</function></funcdef> - <paramdef>int <parameter>fd</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>posix_isatty</methodname> + <methodparam><type>int</type><parameter>fd</parameter></methodparam> + </methodsynopsis> <para> Needs to be written. </para> @@ -602,12 +556,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>posix_getcwd</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>posix_getcwd</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Needs to be written ASAP. </para> @@ -623,13 +575,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>posix_mkfifo</function></funcdef> - <paramdef>string <parameter>pathname</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>posix_mkfifo</methodname> + <methodparam><type>string</type><parameter>pathname</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> Needs to be written ASAP. </para> @@ -644,12 +594,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>posix_getgrnam</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>posix_getgrnam</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> <para> Needs to be written. </para> @@ -663,12 +611,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>posix_getgrgid</function></funcdef> - <paramdef>int <parameter>gid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>posix_getgrgid</methodname> + <methodparam><type>int</type><parameter>gid</parameter></methodparam> + </methodsynopsis> <para> Needs to be written. </para> @@ -682,12 +628,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>posix_getpwnam</function></funcdef> - <paramdef>string <parameter>username</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>posix_getpwnam</methodname> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + </methodsynopsis> <para> Returns an associative array containing information about a user referenced by an alphanumeric username, passed in the @@ -777,12 +721,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>posix_getpwuid</function></funcdef> - <paramdef>int <parameter>uid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>posix_getpwuid</methodname> + <methodparam><type>int</type><parameter>uid</parameter></methodparam> + </methodsynopsis> <para> Returns an associative array containing information about a user referenced by a numeric user ID, passed in the @@ -872,12 +814,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>posix_getrlimit</function></funcdef> + <methodsynopsis> + <type>array</type><methodname>posix_getrlimit</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Needs to be written ASAP. </para> @@ -906,3 +846,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/printer.xml diff -u phpdoc/en/functions/printer.xml:1.13 phpdoc/en/functions/printer.xml:1.14 --- phpdoc/en/functions/printer.xml:1.13 Wed Dec 12 15:47:20 2001 +++ phpdoc/en/functions/printer.xml Sat Feb 2 10:36:07 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.13 $ --> +<!-- $Revision: 1.14 $ --> <reference id="ref.printer"> <title>Printer functions</title> <titleabbrev>Printer</titleabbrev> @@ -18,12 +18,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>printer_open</function></funcdef> - <paramdef>string <parameter><optional>devicename</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>printer_open</methodname> + <methodparam choice="opt"><type>string</type><parameter>devicename</parameter></methodparam> + </methodsynopsis> <para> This function tries to open a connection to the printer <parameter>devicename</parameter>, and returns a handle on success @@ -58,12 +56,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>printer_abort</function></funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>printer_abort</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> This function deletes the printers spool file. </para> @@ -90,12 +86,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>printer_close</function></funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>printer_close</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> This function closes the printer connection. <function>printer_close</function> also closes the active device @@ -124,13 +118,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>printer_write</function></funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - <paramdef>string <parameter>content</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>printer_write</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>string</type><parameter>content</parameter></methodparam> + </methodsynopsis> <para> Writes <parameter>content</parameter> directly to the printer, and returns &true; on success or &false; if it failed. @@ -160,14 +152,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>printer_list</function></funcdef> - <paramdef>int <parameter>enumtype</parameter></paramdef> - <paramdef>string <parameter><optional>name</optional></parameter></paramdef> - <paramdef>int <parameter><optional>level</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>printer_list</methodname> + <methodparam><type>int</type><parameter>enumtype</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>level</parameter></methodparam> + </methodsynopsis> <para> The function enumerates available printers and their capabilities. <parameter>level</parameter> sets the level of information request. @@ -244,14 +234,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>printer_set_option</function></funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - <paramdef>int <parameter>option</parameter></paramdef> - <paramdef>mixed <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>printer_set_option</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>int</type><parameter>option</parameter></methodparam> + <methodparam><type>mixed</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> The function sets the following options for the current connection: <parameter>handle</parameter> must be a valid handle to a printer. @@ -477,13 +465,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>printer_get_option</function></funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - <paramdef>string <parameter>option</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>printer_get_option</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>string</type><parameter>option</parameter></methodparam> + </methodsynopsis> <para> The function retrieves the configuration setting of <parameter>option</parameter>. <parameter>handle</parameter> must be a valid handle to a printer. @@ -525,12 +511,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>printer_create_dc</function></funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>printer_create_dc</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> The function creates a new device context. A device context is used to customize the graphic objects of the document. @@ -575,12 +559,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>printer_delete_dc</function></funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>printer_delete_dc</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> The function deletes the device context and returns &true; on success, or &false; if an error occurred. For an example see @@ -598,13 +580,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>printer_start_doc</function></funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - <paramdef>string <parameter><optional>document</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>printer_start_doc</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>document</parameter></methodparam> + </methodsynopsis> <para> The function creates a new document in the printer spooler. A document can contain multiple pages, it's used to schedule the print job in the @@ -636,14 +616,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>printer_end_doc</function> - </funcdef> - <paramdef>resource <parameter>handle</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>printer_end_doc</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> Closes a new document in the printer spooler. The document is now ready for printing. For an example see @@ -660,14 +636,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>printer_start_page</function> - </funcdef> - <paramdef>resource <parameter>handle</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>printer_start_page</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> The function creates a new page in the active document. For an example see <function>printer_start_doc</function>. @@ -684,14 +656,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>printer_end_page</function> - </funcdef> - <paramdef>resource <parameter>handle</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>printer_end_page</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> The function closes the active page in the active document. For an example see <function>printer_start_doc</function>. @@ -708,15 +676,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>printer_create_pen</function> - </funcdef> - <paramdef>int <parameter>style</parameter></paramdef> - <paramdef>int <parameter>width</parameter></paramdef> - <paramdef>string <parameter>color</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>printer_create_pen</methodname> + <methodparam><type>int</type><parameter>style</parameter></methodparam> + <methodparam><type>int</type><parameter>width</parameter></methodparam> + <methodparam><type>string</type><parameter>color</parameter></methodparam> + </methodsynopsis> <para> The function creates a new pen and returns a handle to it. A pen is used to draw lines and curves. For an example see @@ -774,13 +739,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>printer_delete_pen</function> - </funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>printer_delete_pen</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> The function deletes the selected pen. For an example see <function>printer_select_pen</function>. It returns &true; on success, @@ -798,14 +760,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>printer_select_pen</function> - </funcdef> - <paramdef>resource <parameter>printer_handle</parameter></paramdef> - <paramdef>resource <parameter>pen_handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>printer_select_pen</methodname> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>pen_handle</parameter></methodparam> + </methodsynopsis> <para> The function selects a pen as the active drawing object of the actual device context. A pen is used to draw lines and curves. I.e. if you draw @@ -849,14 +808,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>printer_create_brush</function> - </funcdef> - <paramdef>int <parameter>style</parameter></paramdef> - <paramdef>string <parameter>color</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>printer_create_brush</methodname> + <methodparam><type>int</type><parameter>style</parameter></methodparam> + <methodparam><type>string</type><parameter>color</parameter></methodparam> + </methodsynopsis> <para> The function creates a new brush and returns a handle to it. A brush is used to fill shapes. For an example see @@ -925,13 +881,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>printer_delete_brush</function> - </funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>printer_delete_brush</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> The function deletes the selected brush. For an example see <function>printer_select_brush</function>. It returns &true; on @@ -948,14 +901,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>printer_select_brush</function> - </funcdef> - <paramdef>resource <parameter>printer_handle</parameter></paramdef> - <paramdef>resource <parameter>brush_handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>printer_select_brush</methodname> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>brush_handle</parameter></methodparam> + </methodsynopsis> <para> The function selects a brush as the active drawing object of the actual device context. A brush is used to fill shapes. If you draw an rectangle @@ -1009,20 +959,17 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>printer_create_font</function> - </funcdef> - <paramdef>string <parameter>face</parameter></paramdef> - <paramdef>int <parameter>height</parameter></paramdef> - <paramdef>int <parameter>width</parameter></paramdef> - <paramdef>int <parameter>font_weight</parameter></paramdef> - <paramdef>bool <parameter>italic</parameter></paramdef> - <paramdef>bool <parameter>underline</parameter></paramdef> - <paramdef>bool <parameter>strikeout</parameter></paramdef> - <paramdef>int <parameter>orientaton</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>printer_create_font</methodname> + <methodparam><type>string</type><parameter>face</parameter></methodparam> + <methodparam><type>int</type><parameter>height</parameter></methodparam> + <methodparam><type>int</type><parameter>width</parameter></methodparam> + <methodparam><type>int</type><parameter>font_weight</parameter></methodparam> + <methodparam><type>bool</type><parameter>italic</parameter></methodparam> + <methodparam><type>bool</type><parameter>underline</parameter></methodparam> + <methodparam><type>bool</type><parameter>strikeout</parameter></methodparam> + <methodparam><type>int</type><parameter>orientaton</parameter></methodparam> + </methodsynopsis> <para> The function creates a new font and returns a handle to it. A font is used to draw text. For an example see @@ -1108,13 +1055,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>printer_delete_font</function> - </funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>printer_delete_font</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> The function deletes the selected font. For an example see <function>printer_select_font</function>. It returns &true; on success, @@ -1131,14 +1075,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>printer_select_font</function> - </funcdef> - <paramdef>resource <parameter>printer_handle</parameter></paramdef> - <paramdef>resource <parameter>font_handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>printer_select_font</methodname> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> + <methodparam><type>resource</type><parameter>font_handle</parameter></methodparam> + </methodsynopsis> <para> The function selects a font to draw text. <parameter>printer_handle</parameter> must be a valid handle to a @@ -1176,14 +1117,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>printer_logical_fontheight</function> - </funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - <paramdef>int <parameter>height</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>printer_logical_fontheight</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>int</type><parameter>height</parameter></methodparam> + </methodsynopsis> <para> The function calculates the logical font height of <parameter>height</parameter>. <parameter>handle</parameter> must @@ -1211,19 +1149,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>printer_draw_roundrect</function> - </funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - <paramdef>int <parameter>ul_x</parameter></paramdef> - <paramdef>int <parameter>ul_y</parameter></paramdef> - <paramdef>int <parameter>lr_x</parameter></paramdef> - <paramdef>int <parameter>lr_y</parameter></paramdef> - <paramdef>int <parameter>width</parameter></paramdef> - <paramdef>int <parameter>height</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>printer_draw_roundrect</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>int</type><parameter>ul_x</parameter></methodparam> + <methodparam><type>int</type><parameter>ul_y</parameter></methodparam> + <methodparam><type>int</type><parameter>lr_x</parameter></methodparam> + <methodparam><type>int</type><parameter>lr_y</parameter></methodparam> + <methodparam><type>int</type><parameter>width</parameter></methodparam> + <methodparam><type>int</type><parameter>height</parameter></methodparam> + </methodsynopsis> <para> The function simply draws a rectangle with rounded corners. </para> @@ -1284,17 +1219,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>printer_draw_rectangle</function> - </funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - <paramdef>int <parameter>ul_x</parameter></paramdef> - <paramdef>int <parameter>ul_y</parameter></paramdef> - <paramdef>int <parameter>lr_x</parameter></paramdef> - <paramdef>int <parameter>lr_y</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>printer_draw_rectangle</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>int</type><parameter>ul_x</parameter></methodparam> + <methodparam><type>int</type><parameter>ul_y</parameter></methodparam> + <methodparam><type>int</type><parameter>lr_x</parameter></methodparam> + <methodparam><type>int</type><parameter>lr_y</parameter></methodparam> + </methodsynopsis> <para> The function simply draws a rectangle. </para> @@ -1350,17 +1282,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>printer_draw_elipse</function> - </funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - <paramdef>int <parameter>ul_x</parameter></paramdef> - <paramdef>int <parameter>ul_y</parameter></paramdef> - <paramdef>int <parameter>lr_x</parameter></paramdef> - <paramdef>int <parameter>lr_y</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>printer_draw_elipse</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>int</type><parameter>ul_x</parameter></methodparam> + <methodparam><type>int</type><parameter>ul_y</parameter></methodparam> + <methodparam><type>int</type><parameter>lr_x</parameter></methodparam> + <methodparam><type>int</type><parameter>lr_y</parameter></methodparam> + </methodsynopsis> <para> The function simply draws an ellipse. <parameter>handle</parameter> must be a valid handle to a printer. @@ -1414,16 +1343,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>printer_draw_text</function> - </funcdef> - <paramdef>resource <parameter>printer_handle</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>printer_draw_text</methodname> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> + <methodparam><type>string</type><parameter>text</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + </methodsynopsis> <para> The function simply draws <parameter>text</parameter> at position <parameter>x</parameter>, <parameter>y</parameter> using the selected @@ -1459,16 +1385,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>printer_draw_line</function></funcdef> - <paramdef>resource <parameter>printer_handle</parameter></paramdef> - <paramdef>int <parameter>from_x</parameter></paramdef> - <paramdef>int <parameter>from_y</parameter></paramdef> - <paramdef>int <parameter>to_x</parameter></paramdef> - <paramdef>int <parameter>to_y</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>printer_draw_line</methodname> + <methodparam><type>resource</type><parameter>printer_handle</parameter></methodparam> + <methodparam><type>int</type><parameter>from_x</parameter></methodparam> + <methodparam><type>int</type><parameter>from_y</parameter></methodparam> + <methodparam><type>int</type><parameter>to_x</parameter></methodparam> + <methodparam><type>int</type><parameter>to_y</parameter></methodparam> + </methodsynopsis> <para> The function simply draws a line from position <parameter>from_x</parameter>, <parameter>from_y</parameter> to @@ -1508,21 +1432,18 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>printer_draw_chord</function> - </funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - <paramdef>int <parameter>rec_x</parameter></paramdef> - <paramdef>int <parameter>rec_y</parameter></paramdef> - <paramdef>int <parameter>rec_x1</parameter></paramdef> - <paramdef>int <parameter>rec_y1</parameter></paramdef> - <paramdef>int <parameter>rad_x</parameter></paramdef> - <paramdef>int <parameter>rad_y</parameter></paramdef> - <paramdef>int <parameter>rad_x1</parameter></paramdef> - <paramdef>int <parameter>rad_y1</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>printer_draw_chord</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>int</type><parameter>rec_x</parameter></methodparam> + <methodparam><type>int</type><parameter>rec_y</parameter></methodparam> + <methodparam><type>int</type><parameter>rec_x1</parameter></methodparam> + <methodparam><type>int</type><parameter>rec_y1</parameter></methodparam> + <methodparam><type>int</type><parameter>rad_x</parameter></methodparam> + <methodparam><type>int</type><parameter>rad_y</parameter></methodparam> + <methodparam><type>int</type><parameter>rad_x1</parameter></methodparam> + <methodparam><type>int</type><parameter>rad_y1</parameter></methodparam> + </methodsynopsis> <para> The function simply draws an chord. <parameter>handle</parameter> must be a valid handle to a printer. @@ -1594,20 +1515,18 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>printer_draw_pie</function></funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - <paramdef>int <parameter>rec_x</parameter></paramdef> - <paramdef>int <parameter>rec_y</parameter></paramdef> - <paramdef>int <parameter>rec_x1</parameter></paramdef> - <paramdef>int <parameter>rec_y1</parameter></paramdef> - <paramdef>int <parameter>rad1_x</parameter></paramdef> - <paramdef>int <parameter>rad1_y</parameter></paramdef> - <paramdef>int <parameter>rad2_x</parameter></paramdef> - <paramdef>int <parameter>rad2_y</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>printer_draw_pie</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>int</type><parameter>rec_x</parameter></methodparam> + <methodparam><type>int</type><parameter>rec_y</parameter></methodparam> + <methodparam><type>int</type><parameter>rec_x1</parameter></methodparam> + <methodparam><type>int</type><parameter>rec_y1</parameter></methodparam> + <methodparam><type>int</type><parameter>rad1_x</parameter></methodparam> + <methodparam><type>int</type><parameter>rad1_y</parameter></methodparam> + <methodparam><type>int</type><parameter>rad2_x</parameter></methodparam> + <methodparam><type>int</type><parameter>rad2_y</parameter></methodparam> + </methodsynopsis> <para> The function simply draws an pie. <parameter>handle</parameter> must be a valid handle to a printer. @@ -1679,16 +1598,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>printer_draw_bmp</function> - </funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>int <parameter>x</parameter></paramdef> - <paramdef>int <parameter>y</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>printer_draw_bmp</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>int</type><parameter>x</parameter></methodparam> + <methodparam><type>int</type><parameter>y</parameter></methodparam> + </methodsynopsis> <para> The function simply draws an bmp the bitmap <parameter>filename</parameter> at position <parameter>x</parameter>, @@ -1737,3 +1653,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/pspell.xml diff -u phpdoc/en/functions/pspell.xml:1.22 phpdoc/en/functions/pspell.xml:1.23 --- phpdoc/en/functions/pspell.xml:1.22 Wed Dec 12 15:47:22 2001 +++ phpdoc/en/functions/pspell.xml Sat Feb 2 10:36:08 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.22 $ --> +<!-- $Revision: 1.23 $ --> <!-- pspell currently (2001-08-14) doesn't use resources --> <reference id="ref.pspell"> @@ -27,13 +27,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pspell_add_to_personal</function></funcdef> - <paramdef>int <parameter>dictionary_link</parameter></paramdef> - <paramdef>string <parameter>word</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pspell_add_to_personal</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + <methodparam><type>string</type><parameter>word</parameter></methodparam> + </methodsynopsis> <simpara> <function>pspell_add_to_personal</function> adds a word to the personal wordlist. If you used <function>pspell_new_config</function> with @@ -68,13 +66,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pspell_add_to_session</function></funcdef> - <paramdef>int <parameter>dictionary_link</parameter></paramdef> - <paramdef>string <parameter>word</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pspell_add_to_session</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + <methodparam><type>string</type><parameter>word</parameter></methodparam> + </methodsynopsis> <simpara> <function>pspell_add_to_session</function> adds a word to the wordlist associated with the current session. It is very similar to @@ -90,13 +86,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>pspell_check</function></funcdef> - <paramdef>int <parameter>dictionary_link</parameter></paramdef> - <paramdef>string <parameter>word</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>pspell_check</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + <methodparam><type>string</type><parameter>word</parameter></methodparam> + </methodsynopsis> <simpara> <function>pspell_check</function> checks the spelling of a word and returns &true; if the spelling is correct, &false; if not. @@ -127,12 +121,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pspell_clear_session</function></funcdef> - <paramdef>int <parameter>dictionary_link</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pspell_clear_session</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + </methodsynopsis> <simpara> <function>pspell_clear_session</function> clears the current session. The current wordlist becomes blank, and, for example, if you try to save @@ -164,27 +156,19 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pspell_config_create</function></funcdef> - <paramdef>string <parameter>language</parameter></paramdef> - <paramdef>string - <parameter> - <optional>spelling</optional> - </parameter> - </paramdef> - <paramdef>string - <parameter> - <optional>jargon</optional> - </parameter> - </paramdef> - <paramdef>string - <parameter> - <optional>encoding</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pspell_config_create</methodname> + <methodparam><type>string</type><parameter>language</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + spelling + </parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + jargon + </parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + encoding + </parameter></methodparam> + </methodsynopsis> <simpara> <function>pspell_config_create</function> has a very similar syntax to <function>pspell_new</function>. In fact, using @@ -267,13 +251,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pspell_config_ignore</function></funcdef> - <paramdef>int <parameter>dictionary_link</parameter></paramdef> - <paramdef>int <parameter>n</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pspell_config_ignore</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + <methodparam><type>int</type><parameter>n</parameter></methodparam> + </methodsynopsis> <simpara> <function>pspell_config_ignore</function> should be used on a config before calling <function>pspell_new_config</function>. This function @@ -303,13 +285,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pspell_config_mode</function></funcdef> - <paramdef>int <parameter>dictionary_link</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pspell_config_mode</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <simpara> <function>pspell_config_mode</function> should be used on a config before calling <function>pspell_new_config</function>. This function @@ -362,13 +342,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pspell_config_personal</function></funcdef> - <paramdef>int <parameter>dictionary_link</parameter></paramdef> - <paramdef>string <parameter>file</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pspell_config_personal</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + <methodparam><type>string</type><parameter>file</parameter></methodparam> + </methodsynopsis> <simpara> <function>pspell_config_personal</function> should be used on a config before calling <function>pspell_new_config</function>. The personal @@ -403,13 +381,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pspell_config_repl</function></funcdef> - <paramdef>int <parameter>dictionary_link</parameter></paramdef> - <paramdef>string <parameter>file</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pspell_config_repl</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + <methodparam><type>string</type><parameter>file</parameter></methodparam> + </methodsynopsis> <simpara> <function>pspell_config_repl</function> should be used on a config before calling <function>pspell_new_config</function>. The replacement @@ -446,13 +422,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pspell_config_runtogether</function></funcdef> - <paramdef>int <parameter>dictionary_link</parameter></paramdef> - <paramdef>bool <parameter>flag</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pspell_config_runtogether</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + <methodparam><type>bool</type><parameter>flag</parameter></methodparam> + </methodsynopsis> <simpara> <function>pspell_config_runtogether</function> should be used on a config before calling <function>pspell_new_config</function>. This function @@ -487,13 +461,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pspell_config_save_repl</function></funcdef> - <paramdef>int <parameter>dictionary_link</parameter></paramdef> - <paramdef>bool <parameter>flag</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pspell_config_save_repl</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + <methodparam><type>bool</type><parameter>flag</parameter></methodparam> + </methodsynopsis> <simpara> <function>pspell_config_save_repl</function> should be used on a config before calling <function>pspell_new_config</function>. It determines @@ -515,33 +487,23 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pspell_new</function></funcdef> - <!-- not yet resource... --> - <paramdef>string <parameter>language</parameter></paramdef> - <paramdef>string - <parameter> - <optional>spelling</optional> - </parameter> - </paramdef> - <paramdef>string - <parameter> - <optional>jargon</optional> - </parameter> - </paramdef> - <paramdef>string - <parameter> - <optional>encoding</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>mode</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pspell_new</methodname> + + <methodparam><type>string</type><parameter>language</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + spelling + </parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + jargon + </parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + encoding + </parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + mode + </parameter></methodparam> + </methodsynopsis> <simpara> <function>pspell_new</function> opens up a new dictionary and returns the dictionary link identifier for use in other pspell @@ -633,12 +595,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pspell_new_config</function></funcdef> - <paramdef>int <parameter>config</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pspell_new_config</methodname> + <methodparam><type>int</type><parameter>config</parameter></methodparam> + </methodsynopsis> <simpara> <function>pspell_new_config</function> opens up a new dictionary with settings specified in a config, created with with @@ -675,33 +635,23 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pspell_new_personal</function></funcdef> - <paramdef>string <parameter>personal</parameter></paramdef> - <paramdef>string <parameter>language</parameter></paramdef> - <paramdef>string - <parameter> - <optional>spelling</optional> - </parameter> - </paramdef> - <paramdef>string - <parameter> - <optional>jargon</optional> - </parameter> - </paramdef> - <paramdef>string - <parameter> - <optional>encoding</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>mode</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pspell_new_personal</methodname> + <methodparam><type>string</type><parameter>personal</parameter></methodparam> + <methodparam><type>string</type><parameter>language</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + spelling + </parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + jargon + </parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter> + encoding + </parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + mode + </parameter></methodparam> + </methodsynopsis> <simpara> <function>pspell_new_personal</function> opens up a new dictionary with a personal wordlist and returns the dictionary link identifier for use @@ -806,12 +756,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pspell_save_wordlist</function></funcdef> - <paramdef>int <parameter>dictionary_link</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pspell_save_wordlist</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + </methodsynopsis> <simpara> <function>pspell_save_wordlist</function> saves the personal wordlist from the current session. The dictionary has to be open with @@ -846,14 +794,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>pspell_store_replacement</function></funcdef> - <paramdef>int <parameter>dictionary_link</parameter></paramdef> - <paramdef>string <parameter>misspelled</parameter></paramdef> - <paramdef>string <parameter>correct</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>pspell_store_replacement</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + <methodparam><type>string</type><parameter>misspelled</parameter></methodparam> + <methodparam><type>string</type><parameter>correct</parameter></methodparam> + </methodsynopsis> <simpara> <function>pspell_store_replacement</function> stores a replacement pair for a word, so that replacement can be returned by @@ -893,13 +839,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>pspell_suggest</function></funcdef> - <paramdef>int <parameter>dictionary_link</parameter></paramdef> - <paramdef>string <parameter>word</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>pspell_suggest</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + <methodparam><type>string</type><parameter>word</parameter></methodparam> + </methodsynopsis> <simpara> <function>pspell_suggest</function> returns an array of possible spellings for the given word. @@ -947,3 +891,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/qtdom.xml diff -u phpdoc/en/functions/qtdom.xml:1.1 phpdoc/en/functions/qtdom.xml:1.2 --- phpdoc/en/functions/qtdom.xml:1.1 Sat Dec 15 09:54:58 2001 +++ phpdoc/en/functions/qtdom.xml Sat Feb 2 10:36:08 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <reference id="ref.qtdom"> <title>qtdom functions</title> <titleabbrev>qtdom functions</titleabbrev> @@ -17,12 +17,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>qdom_tree</function></funcdef> - <paramdef>string <parameter></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>qdom_tree</methodname> + <methodparam><type>string</type><parameter/></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -37,12 +35,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>qdom_error</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>qdom_error</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -72,4 +68,5 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/readline.xml diff -u phpdoc/en/functions/readline.xml:1.16 phpdoc/en/functions/readline.xml:1.17 --- phpdoc/en/functions/readline.xml:1.16 Wed Dec 12 15:47:22 2001 +++ phpdoc/en/functions/readline.xml Sat Feb 2 10:36:08 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.16 $ --> +<!-- $Revision: 1.17 $ --> <reference id="ref.readline"> <title>GNU Readline</title> <titleabbrev>Readline</titleabbrev> @@ -29,14 +29,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>readline</function></funcdef> - <paramdef>string - <parameter><optional>prompt</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>readline</methodname> + <methodparam choice="opt"><type>string</type><parameter>prompt</parameter></methodparam> + </methodsynopsis> <para> This function returns a single string from the user. You may specify a string with which to prompt the user. The line @@ -72,12 +68,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>readline_add_history</function></funcdef> - <paramdef>string <parameter>line</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>readline_add_history</methodname> + <methodparam><type>string</type><parameter>line</parameter></methodparam> + </methodsynopsis> <para> This function adds a line to the command line history. </para> @@ -91,12 +85,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>readline_clear_history</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>readline_clear_history</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This function clears the entire command line history. </para> @@ -110,14 +102,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool - <function>readline_completion_function</function> - </funcdef> - <paramdef>string <parameter>line</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>readline_completion_function</methodname> + <methodparam><type>string</type><parameter>line</parameter></methodparam> + </methodsynopsis> <para> This function registers a completion function. You must supply the name of an existing function which accepts a partial command @@ -135,17 +123,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>readline_info</function></funcdef> - <paramdef>string - <parameter><optional>varname</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>newvalue</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>readline_info</methodname> + <methodparam choice="opt"><type>string</type><parameter>varname</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>newvalue</parameter></methodparam> + </methodsynopsis> <para> If called with no parameters, this function returns an array of values for all the setting readline uses. The elements will @@ -168,12 +150,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>readline_list_history</function></funcdef> + <methodsynopsis> + <type>array</type><methodname>readline_list_history</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This function returns an array of the entire command line history. The elements are indexed by integers starting at zero. @@ -188,14 +168,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool - <function>readline_read_history</function> - </funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>readline_read_history</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> This function reads a command history from a file. </para> @@ -210,14 +186,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool - <function>readline_write_history</function> - </funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>readline_write_history</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> This function writes the command history to a file. </para> @@ -246,3 +218,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/recode.xml diff -u phpdoc/en/functions/recode.xml:1.17 phpdoc/en/functions/recode.xml:1.18 --- phpdoc/en/functions/recode.xml:1.17 Wed Dec 12 15:47:22 2001 +++ phpdoc/en/functions/recode.xml Sat Feb 2 10:36:08 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.17 $ --> +<!-- $Revision: 1.18 $ --> <reference id="ref.recode"> <title>GNU Recode functions</title> <titleabbrev>Recode</titleabbrev> @@ -29,13 +29,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>recode_string</function></funcdef> - <paramdef>string <parameter>request</parameter></paramdef> - <paramdef>string <parameter>string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>recode_string</methodname> + <methodparam><type>string</type><parameter>request</parameter></methodparam> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> <para> Recode the string <parameter>string</parameter> according to the recode request <parameter>request</parameter>. Returns the @@ -64,13 +62,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>recode</function></funcdef> - <paramdef>string <parameter>request</parameter></paramdef> - <paramdef>string <parameter>string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>recode</methodname> + <methodparam><type>string</type><parameter>request</parameter></methodparam> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> <note> <simpara> This is an alias for <function>recode_string</function>. It has @@ -89,14 +85,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>recode_file</function></funcdef> - <paramdef>string <parameter>request</parameter></paramdef> - <paramdef>resource <parameter>input</parameter></paramdef> - <paramdef>resource <parameter>output</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>recode_file</methodname> + <methodparam><type>string</type><parameter>request</parameter></methodparam> + <methodparam><type>resource</type><parameter>input</parameter></methodparam> + <methodparam><type>resource</type><parameter>output</parameter></methodparam> + </methodsynopsis> <para> Recode the file referenced by file handle <parameter>input</parameter> into the file referenced by file @@ -145,3 +139,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/regex.xml diff -u phpdoc/en/functions/regex.xml:1.37 phpdoc/en/functions/regex.xml:1.38 --- phpdoc/en/functions/regex.xml:1.37 Thu Jan 31 08:14:46 2002 +++ phpdoc/en/functions/regex.xml Sat Feb 2 10:36:08 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.37 $ --> +<!-- $Revision: 1.38 $ --> <reference id="ref.regex"> <title>Regular Expression Functions (POSIX Extended)</title> <titleabbrev>Regexps</titleabbrev> @@ -98,16 +98,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ereg</function></funcdef> - <paramdef>string <parameter>pattern</parameter></paramdef> - <paramdef>string <parameter>string</parameter></paramdef> - <paramdef>array - <parameter><optional>regs</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ereg</methodname> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>regs</parameter></methodparam> + </methodsynopsis> <note> <para> <function>preg_match</function>, which uses a Perl-compatible @@ -179,14 +175,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ereg_replace</function></funcdef> - <paramdef>string <parameter>pattern</parameter></paramdef> - <paramdef>string <parameter>replacement</parameter></paramdef> - <paramdef>string <parameter>string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ereg_replace</methodname> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + <methodparam><type>string</type><parameter>replacement</parameter></methodparam> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> <note> <para> <function>preg_replace</function>, which uses a Perl-compatible @@ -287,16 +281,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>eregi</function></funcdef> - <paramdef>string <parameter>pattern</parameter></paramdef> - <paramdef>string <parameter>string</parameter></paramdef> - <paramdef>array - <parameter><optional>regs</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>eregi</methodname> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>regs</parameter></methodparam> + </methodsynopsis> <para> This function is identical to <function>ereg</function> except that this ignores case distinction when matching alphabetic @@ -327,14 +317,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>eregi_replace</function></funcdef> - <paramdef>string <parameter>pattern</parameter></paramdef> - <paramdef>string <parameter>replacement</parameter></paramdef> - <paramdef>string <parameter>string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>eregi_replace</methodname> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + <methodparam><type>string</type><parameter>replacement</parameter></methodparam> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> <para> This function is identical to <function>ereg_replace</function> except that this ignores case distinction when matching @@ -354,16 +342,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>split</function></funcdef> - <paramdef>string <parameter>pattern</parameter></paramdef> - <paramdef>string <parameter>string</parameter></paramdef> - <paramdef>int - <parameter><optional>limit</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>split</methodname> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>limit</parameter></methodparam> + </methodsynopsis> <note> <para> <function>preg_split</function>, which uses a Perl-compatible @@ -469,16 +453,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>spliti</function></funcdef> - <paramdef>string <parameter>pattern</parameter></paramdef> - <paramdef>string <parameter>string</parameter></paramdef> - <paramdef>int - <parameter><optional>limit</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>spliti</methodname> + <methodparam><type>string</type><parameter>pattern</parameter></methodparam> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>limit</parameter></methodparam> + </methodsynopsis> <para> This function is identical to <function>split</function> except that this ignores case distinction when matching alphabetic @@ -503,12 +483,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>sql_regcase</function></funcdef> - <paramdef>string <parameter>string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>sql_regcase</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> <para> Returns a valid regular expression which will match <parameter>string</parameter>, ignoring case. This expression is @@ -556,3 +534,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/satellite.xml diff -u phpdoc/en/functions/satellite.xml:1.21 phpdoc/en/functions/satellite.xml:1.22 --- phpdoc/en/functions/satellite.xml:1.21 Tue Dec 18 14:08:15 2001 +++ phpdoc/en/functions/satellite.xml Sat Feb 2 10:36:08 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.21 $ --> +<!-- $Revision: 1.22 $ --> <!-- Author: David Eriksson <david@2good.com> --> <reference id="ref.satellite"> @@ -22,12 +22,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>new <function>OrbitObject</function></funcdef> - <paramdef>string <parameter>ior</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>new</type><methodname>OrbitObject</methodname> + <methodparam><type>string</type><parameter>ior</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> This class provides access to a CORBA object. The @@ -80,12 +78,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>new <function>OrbitEnum</function></funcdef> - <paramdef>string <parameter>id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>new</type><methodname>OrbitEnum</methodname> + <methodparam><type>string</type><parameter>id</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> This class represents the enumeration identified with the @@ -132,12 +128,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>new <function>OrbitStruct</function></funcdef> - <paramdef>string <parameter>id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>new</type><methodname>OrbitStruct</methodname> + <methodparam><type>string</type><parameter>id</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> This class represents the structure identified with the @@ -199,14 +193,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool - <function>satellite_caught_exception</function> - </funcdef> - <paramdef></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>satellite_caught_exception</methodname> + <void/> + </methodsynopsis> &warn.experimental.func; <para> This function returns &true; if an exception has been caught. @@ -259,12 +249,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>satellite_exception_id</function></funcdef> - <paramdef></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>satellite_exception_id</methodname> + <void/> + </methodsynopsis> &warn.experimental.func; <para> Return a repository id string. (E.g. "IDL:MyException:1.0".) For @@ -283,14 +271,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>OrbitStruct - <function>satellite_exception_value</function> - </funcdef> - <paramdef></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>OrbitStruct</type><methodname>satellite_exception_value</methodname> + <void/> + </methodsynopsis> &warn.experimental.func; <para> Return an exception struct. For example usage see @@ -308,12 +292,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>satellite_object_to_string</function></funcdef> - <paramdef>object <parameter>obj</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>satellite_object_to_string</methodname> + <methodparam><type>object</type><parameter>obj</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -329,12 +311,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>satellite_load_idl</function></funcdef> - <paramdef>string <parameter>file</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>satellite_load_idl</methodname> + <methodparam><type>string</type><parameter>file</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -350,12 +330,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>satellite_get_repository_id</function></funcdef> - <paramdef>object <parameter>obj</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>satellite_get_repository_id</methodname> + <methodparam><type>object</type><parameter>obj</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -384,3 +362,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/sem.xml diff -u phpdoc/en/functions/sem.xml:1.18 phpdoc/en/functions/sem.xml:1.19 --- phpdoc/en/functions/sem.xml:1.18 Sun Dec 16 05:19:06 2001 +++ phpdoc/en/functions/sem.xml Sat Feb 2 10:36:08 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.18 $ --> +<!-- $Revision: 1.19 $ --> <reference id="ref.sem"> <title>Semaphore and Shared Memory Functions</title> <titleabbrev>Semaphore</titleabbrev> @@ -61,18 +61,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>sem_get</function></funcdef> - <paramdef>int <parameter>key</parameter></paramdef> - <paramdef>int - <parameter><optional>max_acquire</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>perm</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>sem_get</methodname> + <methodparam><type>int</type><parameter>key</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>max_acquire</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>perm</parameter></methodparam> + </methodsynopsis> <para> Returns: A positive semaphore identifier on success, or &false; on error. @@ -110,12 +104,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>sem_acquire</function></funcdef> - <paramdef>int <parameter>sem_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>sem_acquire</methodname> + <methodparam><type>int</type><parameter>sem_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns: &true; on success, &false; on error. </para> @@ -145,12 +137,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>sem_release</function></funcdef> - <paramdef>int <parameter>sem_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>sem_release</methodname> + <methodparam><type>int</type><parameter>sem_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns: &true; on success, &false; on error. </para> @@ -182,12 +172,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>sem_remove</function></funcdef> - <paramdef>int <parameter>sem_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>sem_remove</methodname> + <methodparam><type>int</type><parameter>sem_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns: &true; on success, &false; on error. @@ -222,18 +210,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>shm_attach</function></funcdef> - <paramdef>int <parameter>key</parameter></paramdef> - <paramdef>int - <parameter><optional>memsize</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>perm</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>shm_attach</methodname> + <methodparam><type>int</type><parameter>key</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>memsize</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>perm</parameter></methodparam> + </methodsynopsis> <para> <function>shm_attach</function> returns an id that that can be used to access the System V shared memory with the given key, the @@ -264,12 +246,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>shm_detach</function></funcdef> - <paramdef>int <parameter>shm_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>shm_detach</methodname> + <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> + </methodsynopsis> <para> <function>shm_detach</function> disconnects from the shared memory given by the <parameter>shm_identifier</parameter> created @@ -286,12 +266,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>shm_remove</function></funcdef> - <paramdef>int <parameter>shm_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>shm_remove</methodname> + <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> + </methodsynopsis> <para> Removes shared memory from Unix systems. All data will be destroyed. @@ -312,14 +290,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>shm_put_var</function></funcdef> - <paramdef>int <parameter>shm_identifier</parameter></paramdef> - <paramdef>int <parameter>variable_key</parameter></paramdef> - <paramdef>mixed <parameter>variable</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>shm_put_var</methodname> + <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>variable_key</parameter></methodparam> + <methodparam><type>mixed</type><parameter>variable</parameter></methodparam> + </methodsynopsis> <para> Inserts or updates a <parameter>variable</parameter> with a given <parameter>variable_key</parameter>. <link @@ -340,13 +316,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>shm_get_var</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - <paramdef>int <parameter>variable_key</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>shm_get_var</methodname> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>int</type><parameter>variable_key</parameter></methodparam> + </methodsynopsis> <para> <function>shm_get_var</function> returns the variable with a given <parameter>variable_key</parameter>. The variable is still present @@ -368,13 +342,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>shm_remove_var</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - <paramdef>int <parameter>variable_key</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>shm_remove_var</methodname> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>int</type><parameter>variable_key</parameter></methodparam> + </methodsynopsis> <para> Removes a variable with a given <parameter>variable_key</parameter> and frees the occupied memory. @@ -396,13 +368,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ftok</function></funcdef> - <paramdef>string <parameter>pathname</parameter></paramdef> - <paramdef>string <parameter>proj</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ftok</methodname> + <methodparam><type>string</type><parameter>pathname</parameter></methodparam> + <methodparam><type>string</type><parameter>proj</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -431,3 +401,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/sesam.xml diff -u phpdoc/en/functions/sesam.xml:1.21 phpdoc/en/functions/sesam.xml:1.22 --- phpdoc/en/functions/sesam.xml:1.21 Fri Dec 21 04:41:35 2001 +++ phpdoc/en/functions/sesam.xml Sat Feb 2 10:36:08 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.21 $ --> +<!-- $Revision: 1.22 $ --> <reference id="ref.sesam"> <title>SESAM database functions</title> <titleabbrev>SESAM</titleabbrev> @@ -508,14 +508,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>sesam_connect</function></funcdef> - <paramdef>string <parameter>catalog</parameter></paramdef> - <paramdef>string <parameter>schema</parameter></paramdef> - <paramdef>string <parameter>user</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>sesam_connect</methodname> + <methodparam><type>string</type><parameter>catalog</parameter></methodparam> + <methodparam><type>string</type><parameter>schema</parameter></methodparam> + <methodparam><type>string</type><parameter>user</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if a connection to the SESAM database was made, or &false; on error. @@ -571,12 +569,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>sesam_disconnect</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>sesam_disconnect</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns: always &true;. </para> @@ -623,13 +619,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>sesam_settransaction</function></funcdef> - <paramdef>int <parameter>isolation_level</parameter></paramdef> - <paramdef>int <parameter>read_only</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>sesam_settransaction</methodname> + <methodparam><type>int</type><parameter>isolation_level</parameter></methodparam> + <methodparam><type>int</type><parameter>read_only</parameter></methodparam> + </methodsynopsis> <para> Returns: &true; if the values are valid, and the <function>settransaction</function> operation was successful, @@ -746,12 +740,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>sesam_commit</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>sesam_commit</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns: &true; on success, &false; on errors @@ -799,12 +791,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>sesam_rollback</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>sesam_rollback</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns: &true; on success, &false; on errors @@ -849,12 +839,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>sesam_execimm</function></funcdef> - <paramdef>string <parameter>query</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>sesam_execimm</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> <para> Returns: A SESAM "result identifier" on success, or &false; on error. @@ -908,15 +896,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>sesam_query</function></funcdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>bool - <parameter><optional>scrollable</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>sesam_query</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>scrollable</parameter></methodparam> + </methodsynopsis> <para> Returns: A SESAM "result identifier" on success, or &false; on error. @@ -1025,12 +1009,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>sesam_num_fields</function></funcdef> - <paramdef>string <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>sesam_num_fields</methodname> + <methodparam><type>string</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> After calling <function>sesam_query</function> with a "select type" query, this function gives you the number of columns in the @@ -1061,13 +1043,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>sesam_field_name</function></funcdef> - <paramdef>string <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter>index</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>sesam_field_name</methodname> + <methodparam><type>string</type><parameter>result_id</parameter></methodparam> + <methodparam><type>int</type><parameter>index</parameter></methodparam> + </methodsynopsis> <para> Returns the name of a field (i.e., the column name) in the result set, or &false; on error. @@ -1098,12 +1078,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>sesam_diagnostic</function></funcdef> + <methodsynopsis> + <type>array</type><methodname>sesam_diagnostic</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns an associative array of status and return codes for the last SQL query/statement/command. Elements of the array are: @@ -1248,17 +1226,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>sesam_fetch_result</function></funcdef> - <paramdef>string - <parameter>result_id</parameter> - </paramdef> - <paramdef>int - <parameter><optional>max_rows</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>sesam_fetch_result</methodname> + <methodparam><type>string</type><parameter>result_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>max_rows</parameter></methodparam> + </methodsynopsis> <para> Returns a mixed array with the query result entries, optionally limited to a maximum of <parameter>max_rows</parameter> rows. @@ -1347,14 +1319,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>sesam_affected_rows</function></funcdef> - <paramdef>string - <parameter>result_id</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>sesam_affected_rows</methodname> + <methodparam><type>string</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> <parameter>result_id</parameter> is a valid result id returned by <function>sesam_query</function>. @@ -1398,12 +1366,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>sesam_errormsg</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>sesam_errormsg</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns the SESAM error message associated with the most recent SESAM error. @@ -1432,12 +1398,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>sesam_field_array</function></funcdef> - <paramdef>string <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>sesam_field_array</methodname> + <methodparam><type>string</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> <parameter>result_id</parameter> is a valid result id returned by <function>sesam_query</function>. @@ -1623,18 +1587,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>sesam_fetch_row</function></funcdef> - <paramdef>string <parameter>result_id</parameter></paramdef> - <paramdef>int - <parameter><optional>whence</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>offset</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>sesam_fetch_row</methodname> + <methodparam><type>string</type><parameter>result_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>whence</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam> + </methodsynopsis> <para> Returns an array that corresponds to the fetched row, or &false; if there are no more rows. @@ -1802,18 +1760,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>sesam_fetch_array</function></funcdef> - <paramdef>string <parameter>result_id</parameter></paramdef> - <paramdef>int - <parameter><optional>whence</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>offset</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>sesam_fetch_array</methodname> + <methodparam><type>string</type><parameter>result_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>whence</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam> + </methodsynopsis> <para> Returns an array that corresponds to the fetched row, or &false; if there are no more rows. @@ -1926,16 +1878,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>sesam_seek_row</function></funcdef> - <paramdef>string <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter>whence</parameter></paramdef> - <paramdef>int - <parameter><optional>offset</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>sesam_seek_row</methodname> + <methodparam><type>string</type><parameter>result_id</parameter></methodparam> + <methodparam><type>int</type><parameter>whence</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam> + </methodsynopsis> <para> <parameter>result_id</parameter> is a valid result id (select type queries only, and only if a "scrollable" cursor was @@ -2026,12 +1974,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>sesam_free_result</function></funcdef> - <paramdef>string <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>sesam_free_result</methodname> + <methodparam><type>string</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> Releases resources for the query associated with <parameter>result_id</parameter>. Returns @@ -2061,3 +2007,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/session.xml diff -u phpdoc/en/functions/session.xml:1.79 phpdoc/en/functions/session.xml:1.80 --- phpdoc/en/functions/session.xml:1.79 Mon Jan 28 03:21:59 2002 +++ phpdoc/en/functions/session.xml Sat Feb 2 10:36:09 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.79 $ --> +<!-- $Revision: 1.80 $ --> <reference id="ref.session"> <title>Session handling functions</title> <titleabbrev>Sessions</titleabbrev> @@ -440,12 +440,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>session_start</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>session_start</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <simpara> <function>session_start</function> creates a session (or resumes the current one based on the session id being passed via a GET @@ -490,12 +488,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>session_destroy</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>session_destroy</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <simpara> <function>session_destroy</function> destroys all of the data associated with the current session. It does not unset any of @@ -557,14 +553,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>session_name</function></funcdef> - <paramdef>string - <parameter><optional>name</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>session_name</methodname> + <methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> <para> <function>session_name</function> returns the name of the current session. If <parameter>name</parameter> is specified, the name of @@ -605,14 +597,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>session_module_name</function></funcdef> - <paramdef>string - <parameter><optional>module</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>session_module_name</methodname> + <methodparam choice="opt"><type>string</type><parameter>module</parameter></methodparam> + </methodsynopsis> <para> <function>session_module_name</function> returns the name of the current session module. If <parameter>module</parameter> is @@ -628,14 +616,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>session_save_path</function></funcdef> - <paramdef>string - <parameter><optional>path</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>session_save_path</methodname> + <methodparam choice="opt"><type>string</type><parameter>path</parameter></methodparam> + </methodsynopsis> <para> <function>session_save_path</function> returns the path of the current directory used to save session data. If <parameter>path</parameter> @@ -659,12 +643,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>session_id</function></funcdef> - <paramdef>string <parameter><optional>id</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>session_id</methodname> + <methodparam choice="opt"><type>string</type><parameter>id</parameter></methodparam> + </methodsynopsis> <para> <function>session_id</function> returns the session id for the current session. If <parameter>id</parameter> is specified, it @@ -687,14 +669,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>session_register</function></funcdef> - <paramdef>mixed <parameter>name</parameter></paramdef> - <paramdef>mixed - <parameter><optional>...</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>session_register</methodname> + <methodparam><type>mixed</type><parameter>name</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam> + </methodsynopsis> <para> <function>session_register</function> accepts a variable number of arguments, any of which can be either a string holding the name of a @@ -781,12 +760,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>session_unregister</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>session_unregister</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> <para> <function>session_unregister</function> unregisters (forgets) the global variable named <parameter>name</parameter> from the @@ -833,12 +810,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>session_unset</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>session_unset</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> The <function>session_unset</function> function free's all session variables currently registered. @@ -863,12 +838,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>session_is_registered</function></funcdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>session_is_registered</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> <para> <function>session_is_registered</function> returns &true; if there is a variable with the name <parameter>name</parameter> @@ -903,14 +876,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef> - array <function>session_get_cookie_params</function> - </funcdef> + <methodsynopsis> + <type>array</type><methodname>session_get_cookie_params</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> The <function>session_get_cookie_params</function> function returns an array with the current session cookie information, the array contains @@ -951,20 +920,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>session_set_cookie_params</function></funcdef> - <paramdef> - int <parameter>lifetime</parameter> - </paramdef> - <paramdef> - string <parameter><optional>path</optional></parameter> - </paramdef> - <paramdef> - string <parameter><optional>domain</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>session_set_cookie_params</methodname> + <methodparam><type>int</type><parameter>lifetime</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>path</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>domain</parameter></methodparam> + </methodsynopsis> <para> Set cookie parameters defined in the php.ini file. The effect of this function only lasts for the duration of the script. @@ -979,12 +940,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>session_decode</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>session_decode</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> <para> <function>session_decode</function> decodes the session data in <parameter>data</parameter>, setting variables stored in the @@ -1002,12 +961,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>session_encode</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>session_encode</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> <function>session_encode</function> returns a string with the contents of the current session encoded within. @@ -1024,20 +981,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>session_set_save_handler</function> - </funcdef> - <paramdef>string - <parameter>open</parameter></paramdef><paramdef>string - <parameter>close</parameter></paramdef><paramdef>string - <parameter>read</parameter></paramdef><paramdef>string - <parameter>write</parameter></paramdef><paramdef>string - <parameter>destroy</parameter></paramdef><paramdef>string - <parameter>gc</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>session_set_save_handler</methodname> + <methodparam><type>string</type><parameter>open</parameter></methodparam><methodparam><type>string</type><parameter>close</parameter></methodparam><methodparam><type>string</type><parameter>read</parameter></methodparam><methodparam><type>string</type><parameter>write</parameter></methodparam><methodparam><type>string</type><parameter>destroy</parameter></methodparam><methodparam><type>string</type><parameter>gc</parameter></methodparam> + </methodsynopsis> <para> <function>session_set_save_handler</function> sets the user-level session storage functions which are used for storing and @@ -1156,14 +1103,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>session_cache_limiter</function></funcdef> - <paramdef>string - <parameter><optional>cache_limiter</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>session_cache_limiter</methodname> + <methodparam choice="opt"><type>string</type><parameter>cache_limiter</parameter></methodparam> + </methodsynopsis> <para> <function>session_cache_limiter</function> returns the name of the current cache limiter. If <parameter>cache_limiter</parameter> is @@ -1223,12 +1166,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>session_cache_expire</function></funcdef> - <paramdef>int <parameter><optional>new_cache_expire</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>session_cache_expire</methodname> + <methodparam choice="opt"><type>int</type><parameter>new_cache_expire</parameter></methodparam> + </methodsynopsis> <para> <function>session_cache_expire</function> returns current cache expire. If <parameter>new_cache_expire</parameter> is given, the current @@ -1244,12 +1185,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>session_write_close</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>session_write_close</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> End the current session and store session data. </para> @@ -1279,12 +1218,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>session_readonly</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>session_readonly</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Read in session data without locking the session data. Changing session data is not possible, but frameset performance will be improved. @@ -1314,3 +1251,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/shmop.xml diff -u phpdoc/en/functions/shmop.xml:1.14 phpdoc/en/functions/shmop.xml:1.15 --- phpdoc/en/functions/shmop.xml:1.14 Fri Jan 18 17:52:48 2002 +++ phpdoc/en/functions/shmop.xml Sat Feb 2 10:36:09 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.14 $ --> +<!-- $Revision: 1.15 $ --> <reference id="ref.shmop"> <title>Shared Memory Functions</title> <titleabbrev>shmop</titleabbrev> @@ -74,15 +74,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>shmop_open</function></funcdef> - <paramdef>int <parameter>key</parameter></paramdef> - <paramdef>string <parameter>flags</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - <paramdef>int <parameter>size</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>shmop_open</methodname> + <methodparam><type>int</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>flags</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + <methodparam><type>int</type><parameter>size</parameter></methodparam> + </methodsynopsis> <para> <function>shmop_open</function> can create or open a shared memory block. </para> @@ -157,14 +155,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>shmop_read</function></funcdef> - <paramdef>int <parameter>shmid</parameter></paramdef> - <paramdef>int <parameter>start</parameter></paramdef> - <paramdef>int <parameter>count</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>shmop_read</methodname> + <methodparam><type>int</type><parameter>shmid</parameter></methodparam> + <methodparam><type>int</type><parameter>start</parameter></methodparam> + <methodparam><type>int</type><parameter>count</parameter></methodparam> + </methodsynopsis> <para> <function>shmop_read</function> will read a string from shared memory block. </para> @@ -199,14 +195,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>shmop_write</function></funcdef> - <paramdef>int <parameter>shmid</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>int <parameter>offset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>shmop_write</methodname> + <methodparam><type>int</type><parameter>shmid</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>int</type><parameter>offset</parameter></methodparam> + </methodsynopsis> <para> <function>shmop_write</function> will write a string into shared memory block. </para> @@ -243,12 +237,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>shmop_size</function></funcdef> - <paramdef>int <parameter>shmid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>shmop_size</methodname> + <methodparam><type>int</type><parameter>shmid</parameter></methodparam> + </methodsynopsis> <para> <function>shmop_size</function> is used to get the size, in bytes of the shared memory block. @@ -285,12 +277,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>shmop_delete</function></funcdef> - <paramdef>int <parameter>shmid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>shmop_delete</methodname> + <methodparam><type>int</type><parameter>shmid</parameter></methodparam> + </methodsynopsis> <para> <function>shmop_delete</function> is used to delete a shared memory block. </para> @@ -325,12 +315,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>shmop_close</function></funcdef> - <paramdef>int <parameter>shmid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>shmop_close</methodname> + <methodparam><type>int</type><parameter>shmid</parameter></methodparam> + </methodsynopsis> <para> <function>shmop_close</function> is used to close a shared memory block. </para> @@ -377,3 +365,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/snmp.xml diff -u phpdoc/en/functions/snmp.xml:1.20 phpdoc/en/functions/snmp.xml:1.21 --- phpdoc/en/functions/snmp.xml:1.20 Sun Dec 16 07:27:47 2001 +++ phpdoc/en/functions/snmp.xml Sat Feb 2 10:36:09 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.20 $ --> +<!-- $Revision: 1.21 $ --> <reference id="ref.snmp"> <title>SNMP functions</title> <titleabbrev>SNMP</titleabbrev> @@ -38,16 +38,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>snmpget</function></funcdef> - <paramdef>string <parameter>hostname</parameter></paramdef> - <paramdef>string <parameter>community</parameter></paramdef> - <paramdef>string <parameter>object_id</parameter></paramdef> - <paramdef>int <parameter><optional>timeout</optional></parameter></paramdef> - <paramdef>int <parameter><optional>retries</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>snmpget</methodname> + <methodparam><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam><type>string</type><parameter>community</parameter></methodparam> + <methodparam><type>string</type><parameter>object_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> + </methodsynopsis> <para> Returns SNMP object value on success and &false; on error.</para> @@ -79,18 +77,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>snmpset</function></funcdef> - <paramdef>string <parameter>hostname</parameter></paramdef> - <paramdef>string <parameter>community</parameter></paramdef> - <paramdef>string <parameter>object_id</parameter></paramdef> - <paramdef>string <parameter>type</parameter></paramdef> - <paramdef>mixed <parameter>value</parameter></paramdef> - <paramdef>int <parameter><optional>timeout</optional></parameter></paramdef> - <paramdef>int <parameter><optional>retries</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>snmpset</methodname> + <methodparam><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam><type>string</type><parameter>community</parameter></methodparam> + <methodparam><type>string</type><parameter>object_id</parameter></methodparam> + <methodparam><type>string</type><parameter>type</parameter></methodparam> + <methodparam><type>mixed</type><parameter>value</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> + </methodsynopsis> <para> Sets the specified SNMP object value, returning &true; on success @@ -113,18 +109,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>snmpwalk</function></funcdef> - <paramdef>string <parameter>hostname</parameter></paramdef> - <paramdef>string <parameter>community</parameter></paramdef> - <paramdef>string <parameter>object_id</parameter></paramdef> - <paramdef>int <parameter><optional>timeout</optional></parameter> - </paramdef> - <paramdef>int <parameter><optional>retries</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>snmpwalk</methodname> + <methodparam><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam><type>string</type><parameter>community</parameter></methodparam> + <methodparam><type>string</type><parameter>object_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> + </methodsynopsis> <para> Returns an array of SNMP object values starting from the @@ -176,18 +168,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>snmpwalkoid</function></funcdef> - <paramdef>string <parameter>hostname</parameter></paramdef> - <paramdef>string <parameter>community</parameter></paramdef> - <paramdef>string <parameter>object_id</parameter></paramdef> - <paramdef>int <parameter><optional>timeout</optional></parameter> - </paramdef> - <paramdef>int <parameter><optional>retries</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>snmpwalkoid</methodname> + <methodparam><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam><type>string</type><parameter>community</parameter></methodparam> + <methodparam><type>string</type><parameter>object_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> + </methodsynopsis> <para> Returns an associative array with object ids and their respective @@ -245,12 +233,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>snmp_get_quick_print</function></funcdef> + <methodsynopsis> + <type>bool</type><methodname>snmp_get_quick_print</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns the current value stored in the UCD Library for quick_print. @@ -289,12 +275,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>snmp_set_quick_print</function></funcdef> - <paramdef>bool <parameter>quick_print</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>snmp_set_quick_print</methodname> + <methodparam><type>bool</type><parameter>quick_print</parameter></methodparam> + </methodsynopsis> <para> Sets the value of quick_print within the UCD SNMP library. When this @@ -351,16 +335,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>snmprealwalk</function></funcdef> - <paramdef>string <parameter>host</parameter></paramdef> - <paramdef>string <parameter>community</parameter></paramdef> - <paramdef>string <parameter>object_id</parameter></paramdef> - <paramdef>int <parameter><optional>timeout</optional></parameter></paramdef> - <paramdef>int <parameter><optional>retries</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>snmprealwalk</methodname> + <methodparam><type>string</type><parameter>host</parameter></methodparam> + <methodparam><type>string</type><parameter>community</parameter></methodparam> + <methodparam><type>string</type><parameter>object_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>retries</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -389,3 +371,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/sockets.xml diff -u phpdoc/en/functions/sockets.xml:1.31 phpdoc/en/functions/sockets.xml:1.32 --- phpdoc/en/functions/sockets.xml:1.31 Fri Feb 1 16:19:23 2002 +++ phpdoc/en/functions/sockets.xml Sat Feb 2 10:36:09 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.31 $ --> +<!-- $Revision: 1.32 $ --> <reference id="ref.sockets"> <title>Socket functions</title> <titleabbrev>Sockets</titleabbrev> @@ -175,12 +175,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>socket_accept</function></funcdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>socket_accept</methodname> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> After the socket <parameter>socket</parameter> has been created @@ -230,16 +228,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>socket_bind</function></funcdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - <paramdef>string <parameter>address</parameter></paramdef> - <paramdef>int - <parameter><optional>port</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>socket_bind</methodname> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + <methodparam><type>string</type><parameter>address</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>socket_bind</function> binds the name given in @@ -284,12 +278,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>soclet_close</function></funcdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>soclet_close</methodname> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>socket_close</function> closes the file (or socket) descriptor @@ -323,16 +315,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>socket_connect</function></funcdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - <paramdef>string <parameter>address</parameter></paramdef> - <paramdef>int - <parameter><optional>port</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>socket_connect</methodname> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + <methodparam><type>string</type><parameter>address</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Initiates a connection using the socket descriptor @@ -376,13 +364,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>socket_listen</function></funcdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - <paramdef>int <parameter>backlog</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>socket_listen</methodname> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + <methodparam><type>int</type><parameter>backlog</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> After the socket <parameter>socket</parameter> has been created @@ -421,14 +407,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>socket_read</function></funcdef> - <paramdef>resource <parameter>socket_des</parameter></paramdef> - <paramdef>int <parameter>length</parameter></paramdef> - <paramdef>int <parameter><optional>type</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>socket_read</methodname> + <methodparam><type>resource</type><parameter>socket_des</parameter></methodparam> + <methodparam><type>int</type><parameter>length</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> The function <function>socket_read</function> reads from socket @@ -474,14 +458,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>socket_create</function></funcdef> - <paramdef>int <parameter>domain</parameter></paramdef> - <paramdef>int <parameter>type</parameter></paramdef> - <paramdef>int <parameter>protocol</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>socket_create</methodname> + <methodparam><type>int</type><parameter>domain</parameter></methodparam> + <methodparam><type>int</type><parameter>type</parameter></methodparam> + <methodparam><type>int</type><parameter>protocol</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> Creates a communication endpoint (a socket), and returns a @@ -533,12 +515,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>socket_strerror</function></funcdef> - <paramdef>int <parameter>errno</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>socket_strerror</methodname> + <methodparam><type>int</type><parameter>errno</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> <function>socket_strerror</function> takes as its @@ -594,14 +574,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>socket_write</function></funcdef> - <paramdef>resource <parameter>socket_des</parameter></paramdef> - <paramdef>string <parameter>&amp;buffer</parameter></paramdef> - <paramdef>int <parameter>length</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>socket_write</methodname> + <methodparam><type>resource</type><parameter>socket_des</parameter></methodparam> + <methodparam><type>string</type><parameter>&amp;buffer</parameter></methodparam> + <methodparam><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> The function <function>socket_write</function> writes to the socket @@ -629,12 +607,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>socket_fd_alloc</function></funcdef> + <methodsynopsis> + <type>resource</type><methodname>socket_fd_alloc</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -649,12 +625,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>socket_fd_free</function></funcdef> - <paramdef>resource <parameter>set</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>socket_fd_free</methodname> + <methodparam><type>resource</type><parameter>set</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -669,13 +643,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>socket_fd_set</function></funcdef> - <paramdef>resource <parameter>set</parameter></paramdef> - <paramdef>mixed <parameter>socket</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>socket_fd_set</methodname> + <methodparam><type>resource</type><parameter>set</parameter></methodparam> + <methodparam><type>mixed</type><parameter>socket</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -690,13 +662,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>socket_fd_clear</function></funcdef> - <paramdef>resource <parameter>set</parameter></paramdef> - <paramdef>mixed <parameter>socket</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>socket_fd_clear</methodname> + <methodparam><type>resource</type><parameter>set</parameter></methodparam> + <methodparam><type>mixed</type><parameter>socket</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -711,13 +681,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>socket_fd_isset</function></funcdef> - <paramdef>resource <parameter>set</parameter></paramdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>socket_fd_isset</methodname> + <methodparam><type>resource</type><parameter>set</parameter></methodparam> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -732,12 +700,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>socket_fd_zero</function></funcdef> - <paramdef>resource <parameter>set</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>socket_fd_zero</methodname> + <methodparam><type>resource</type><parameter>set</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -752,18 +718,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>socket_select</function></funcdef> - <paramdef>resource <parameter>read_fd</parameter></paramdef> - <paramdef>resource <parameter>write_fd</parameter></paramdef> - <paramdef>resource <parameter>except_fd</parameter></paramdef> - <paramdef>int <parameter>tv_sec</parameter></paramdef> - <paramdef>int - <parameter><optional>tv_usec</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>socket_select</methodname> + <methodparam><type>resource</type><parameter>read_fd</parameter></methodparam> + <methodparam><type>resource</type><parameter>write_fd</parameter></methodparam> + <methodparam><type>resource</type><parameter>except_fd</parameter></methodparam> + <methodparam><type>int</type><parameter>tv_sec</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>tv_usec</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -778,15 +740,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>socket_create_listen</function></funcdef> - <paramdef>int <parameter>port</parameter></paramdef> - <paramdef>int - <parameter><optional>backlog</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>socket_create_listen</methodname> + <methodparam><type>int</type><parameter>port</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>backlog</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -801,12 +759,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>socket_set_nonblock</function></funcdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>socket_set_nonblock</methodname> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -821,16 +777,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>socket_getsockname</function></funcdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - <paramdef>string <parameter>&amp;addr</parameter></paramdef> - <paramdef>int - <parameter><optional>&amp;port</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>socket_getsockname</methodname> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + <methodparam><type>string</type><parameter>&amp;addr</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>&amp;port</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -845,16 +797,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>socket_getpeername</function></funcdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - <paramdef>string <parameter>&amp;addr</parameter></paramdef> - <paramdef>int - <parameter><optional>&amp;port</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>socket_getpeername</methodname> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + <methodparam><type>string</type><parameter>&amp;addr</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>&amp;port</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -869,15 +817,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>socket_iovec_alloc</function></funcdef> - <paramdef>int <parameter>num_vectors</parameter></paramdef> - <paramdef>int - <parameter><optional></optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>socket_iovec_alloc</methodname> + <methodparam><type>int</type><parameter>num_vectors</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter/></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -892,13 +836,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>socket_iovec_fetch</function></funcdef> - <paramdef>resource <parameter>iovec</parameter></paramdef> - <paramdef>int <parameter>iovec_position</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>socket_iovec_fetch</methodname> + <methodparam><type>resource</type><parameter>iovec</parameter></methodparam> + <methodparam><type>int</type><parameter>iovec_position</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -913,14 +855,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>socket_iovec_set</function></funcdef> - <paramdef>resource <parameter>iovec</parameter></paramdef> - <paramdef>int <parameter>iovec_position</parameter></paramdef> - <paramdef>string <parameter>new_val</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>socket_iovec_set</methodname> + <methodparam><type>resource</type><parameter>iovec</parameter></methodparam> + <methodparam><type>int</type><parameter>iovec_position</parameter></methodparam> + <methodparam><type>string</type><parameter>new_val</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -935,13 +875,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>socket_iovec_add</function></funcdef> - <paramdef>resource <parameter>iovec</parameter></paramdef> - <paramdef>int <parameter>iov_len</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>socket_iovec_add</methodname> + <methodparam><type>resource</type><parameter>iovec</parameter></methodparam> + <methodparam><type>int</type><parameter>iov_len</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -956,13 +894,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>socket_iovec_delete</function></funcdef> - <paramdef>resource <parameter>iovec</parameter></paramdef> - <paramdef>int <parameter>iov_pos</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>socket_iovec_delete</methodname> + <methodparam><type>resource</type><parameter>iovec</parameter></methodparam> + <methodparam><type>int</type><parameter>iov_pos</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -977,12 +913,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>socket_iovec_free</function></funcdef> - <paramdef>resource <parameter>iovec</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>socket_iovec_free</methodname> + <methodparam><type>resource</type><parameter>iovec</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -997,13 +931,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>socket_readv</function></funcdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - <paramdef>resource <parameter>iovec_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>socket_readv</methodname> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + <methodparam><type>resource</type><parameter>iovec_id</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1018,13 +950,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>socket_writev</function></funcdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - <paramdef>resource <parameter>iovec_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>socket_writev</methodname> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + <methodparam><type>resource</type><parameter>iovec_id</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1039,14 +969,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>socket_recv</function></funcdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - <paramdef>int <parameter>len</parameter></paramdef> - <paramdef>int <parameter>flags</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>socket_recv</methodname> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + <methodparam><type>int</type><parameter>len</parameter></methodparam> + <methodparam><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1061,15 +989,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>socket_send</function></funcdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - <paramdef>string <parameter>buf</parameter></paramdef> - <paramdef>int <parameter>len</parameter></paramdef> - <paramdef>int <parameter>flags</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>socket_send</methodname> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + <methodparam><type>string</type><parameter>buf</parameter></methodparam> + <methodparam><type>int</type><parameter>len</parameter></methodparam> + <methodparam><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1084,19 +1010,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>socket_recvfrom</function></funcdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - <paramdef>string <parameter>&amp;buf</parameter></paramdef> - <paramdef>int <parameter>len</parameter></paramdef> - <paramdef>int <parameter>flags</parameter></paramdef> - <paramdef>string <parameter>&amp;name</parameter></paramdef> - <paramdef>int - <parameter><optional>&amp;port</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>socket_recvfrom</methodname> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + <methodparam><type>string</type><parameter>&amp;buf</parameter></methodparam> + <methodparam><type>int</type><parameter>len</parameter></methodparam> + <methodparam><type>int</type><parameter>flags</parameter></methodparam> + <methodparam><type>string</type><parameter>&amp;name</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>&amp;port</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1111,19 +1033,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>socket_sendto</function></funcdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - <paramdef>string <parameter>buf</parameter></paramdef> - <paramdef>int <parameter>len</parameter></paramdef> - <paramdef>int <parameter>flags</parameter></paramdef> - <paramdef>string <parameter>addr</parameter></paramdef> - <paramdef>int - <parameter><optional>port</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>socket_sendto</methodname> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + <methodparam><type>string</type><parameter>buf</parameter></methodparam> + <methodparam><type>int</type><parameter>len</parameter></methodparam> + <methodparam><type>int</type><parameter>flags</parameter></methodparam> + <methodparam><type>string</type><parameter>addr</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1138,20 +1056,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>socket_recvmsg</function></funcdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - <paramdef>resource <parameter>iovec</parameter></paramdef> - <paramdef>array <parameter>&amp;control</parameter></paramdef> - <paramdef>int <parameter>&amp;controllen</parameter></paramdef> - <paramdef>int <parameter>&amp;flags</parameter></paramdef> - <paramdef>string <parameter>&amp;addr</parameter></paramdef> - <paramdef>int - <parameter><optional>&amp;port</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>socket_recvmsg</methodname> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + <methodparam><type>resource</type><parameter>iovec</parameter></methodparam> + <methodparam><type>array</type><parameter>&amp;control</parameter></methodparam> + <methodparam><type>int</type><parameter>&amp;controllen</parameter></methodparam> + <methodparam><type>int</type><parameter>&amp;flags</parameter></methodparam> + <methodparam><type>string</type><parameter>&amp;addr</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>&amp;port</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1166,18 +1080,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>socket_sendmsg</function></funcdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - <paramdef>resource <parameter>iovec</parameter></paramdef> - <paramdef>int <parameter>flags</parameter></paramdef> - <paramdef>string <parameter>addr</parameter></paramdef> - <paramdef>int - <parameter><optional>port</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>socket_sendmsg</methodname> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + <methodparam><type>resource</type><parameter>iovec</parameter></methodparam> + <methodparam><type>int</type><parameter>flags</parameter></methodparam> + <methodparam><type>string</type><parameter>addr</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1192,14 +1102,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>socket_getopt</function></funcdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - <paramdef>int <parameter>level</parameter></paramdef> - <paramdef>int <parameter>optname</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>socket_getopt</methodname> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + <methodparam><type>int</type><parameter>level</parameter></methodparam> + <methodparam><type>int</type><parameter>optname</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1214,15 +1122,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>socket_setopt</function></funcdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - <paramdef>int <parameter>level</parameter></paramdef> - <paramdef>int <parameter>optname</parameter></paramdef> - <paramdef>int <parameter></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>socket_setopt</methodname> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + <methodparam><type>int</type><parameter>level</parameter></methodparam> + <methodparam><type>int</type><parameter>optname</parameter></methodparam> + <methodparam><type>int</type><parameter/></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1237,15 +1143,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>socket_create_pair</function></funcdef> - <paramdef>int <parameter>domain</parameter></paramdef> - <paramdef>int <parameter>type</parameter></paramdef> - <paramdef>int <parameter>protocol</parameter></paramdef> - <paramdef>array <parameter>&amp;fd</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>socket_create_pair</methodname> + <methodparam><type>int</type><parameter>domain</parameter></methodparam> + <methodparam><type>int</type><parameter>type</parameter></methodparam> + <methodparam><type>int</type><parameter>protocol</parameter></methodparam> + <methodparam><type>array</type><parameter>&amp;fd</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1260,15 +1164,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>socket_shutdown</function></funcdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - <paramdef>int - <parameter><optional>how</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>socket_shutdown</methodname> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>how</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1283,12 +1183,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>socket_last_error</function></funcdef> - <paramdef>resource <parameter>socket</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>socket_last_error</methodname> + <methodparam><type>resource</type><parameter>socket</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -1318,3 +1216,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/strings.xml diff -u phpdoc/en/functions/strings.xml:1.157 phpdoc/en/functions/strings.xml:1.158 --- phpdoc/en/functions/strings.xml:1.157 Sun Jan 27 07:02:50 2002 +++ phpdoc/en/functions/strings.xml Sat Feb 2 10:36:09 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.157 $ --> +<!-- $Revision: 1.158 $ --> <reference id="ref.strings"> <title>String functions</title> <titleabbrev>Strings</titleabbrev> @@ -26,13 +26,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>addcslashes</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>string <parameter>charlist</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>addcslashes</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam><type>string</type><parameter>charlist</parameter></methodparam> + </methodsynopsis> <para> Returns a string with backslashes before characters that are listed in <parameter>charlist</parameter> parameter. It escapes @@ -105,12 +103,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>addslashes</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>addslashes</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> Returns a string with backslashes before characters that need to be quoted in database queries etc. These characters are @@ -140,12 +136,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>bin2hex</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>bin2hex</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> Returns an ASCII string containing the hexadecimal representation of <parameter>str</parameter>. The conversion is done byte-wise @@ -184,12 +178,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>chr</function></funcdef> - <paramdef>int <parameter>ascii</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>chr</methodname> + <methodparam><type>int</type><parameter>ascii</parameter></methodparam> + </methodsynopsis> <para> Returns a one-character string containing the character specified by <parameter>ascii</parameter>. @@ -225,18 +217,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>chunk_split</function></funcdef> - <paramdef>string <parameter>body</parameter></paramdef> - <paramdef>int - <parameter><optional>chunklen</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>end</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>chunk_split</methodname> + <methodparam><type>string</type><parameter>body</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>chunklen</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>end</parameter></methodparam> + </methodsynopsis> <para> Can be used to split a string into smaller chunks which is useful for e.g. converting <link @@ -271,14 +257,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>convert_cyr_string</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>string <parameter>from</parameter></paramdef> - <paramdef>string <parameter>to</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>convert_cyr_string</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam><type>string</type><parameter>from</parameter></methodparam> + <methodparam><type>string</type><parameter>to</parameter></methodparam> + </methodsynopsis> <para> This function returns the given string converted from one Cyrillic character set to another. The <parameter>from</parameter> @@ -330,17 +314,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>count_chars</function></funcdef> - <paramdef>string <parameter>string</parameter></paramdef> - <paramdef>int - <parameter> - <optional>mode</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>count_chars</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter> + mode + </parameter></methodparam> + </methodsynopsis> <para> Counts the number of occurrences of every byte-value (0..255) in <parameter>string</parameter> and returns it in various ways. @@ -388,12 +368,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>crc32</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>crc32</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> Generates the cyclic redundancy checksum polynomial of 32-bit lengths of the <parameter>str</parameter>. This is usually used @@ -412,15 +390,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>crypt</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>string - <parameter><optional>salt</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>crypt</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>salt</parameter></methodparam> + </methodsynopsis> <para> <function>crypt</function> will return an encrypted string using the standard Unix <abbrev>DES</abbrev>-based encryption algorithm or @@ -525,15 +499,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef><function>echo</function></funcdef> - <paramdef>string <parameter>arg1</parameter></paramdef> - <paramdef>string - <parameter><optional>argn</optional>...</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <methodname>echo</methodname> + <methodparam><type>string</type><parameter>arg1</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>argn...</parameter></methodparam> + </methodsynopsis> <simpara> Outputs all parameters. </simpara> @@ -615,16 +585,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>explode</function></funcdef> - <paramdef>string <parameter>separator</parameter></paramdef> - <paramdef>string <parameter>string</parameter></paramdef> - <paramdef>int - <parameter><optional>limit</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>explode</methodname> + <methodparam><type>string</type><parameter>separator</parameter></methodparam> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>limit</parameter></methodparam> + </methodsynopsis> <para> Returns an array of strings, each of which is a substring of <parameter>string</parameter> formed by splitting it on @@ -691,17 +657,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string - <function>get_html_translation_table</function> - </funcdef> - <paramdef>int <parameter>table</parameter></paramdef> - <paramdef>int - <parameter><optional>quote_style</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>get_html_translation_table</methodname> + <methodparam><type>int</type><parameter>table</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>quote_style</parameter></methodparam> + </methodsynopsis> <para> <function>get_html_translation_table</function> will return the translation table that is used internally for @@ -762,15 +722,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>get_meta_tags</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>int - <parameter><optional>use_include_path</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>get_meta_tags</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>use_include_path</parameter></methodparam> + </methodsynopsis> <para> Opens <parameter>filename</parameter> and parses it line by line for &lt;meta> tags of the form @@ -811,15 +767,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>hebrev</function></funcdef> - <paramdef>string <parameter>hebrew_text</parameter></paramdef> - <paramdef>int - <parameter><optional>max_chars_per_line</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>hebrev</methodname> + <methodparam><type>string</type><parameter>hebrew_text</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>max_chars_per_line</parameter></methodparam> + </methodsynopsis> <para> The optional parameter <parameter>max_chars_per_line</parameter> indicates maximum number of characters per line will be @@ -840,15 +792,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>hebrevc</function></funcdef> - <paramdef>string <parameter>hebrew_text</parameter></paramdef> - <paramdef>int - <parameter><optional>max_chars_per_line</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>hebrevc</methodname> + <methodparam><type>string</type><parameter>hebrew_text</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>max_chars_per_line</parameter></methodparam> + </methodsynopsis> <para> This function is similar to <function>hebrev</function> with the difference that it converts newlines (\n) to "&lt;br&gt;\n". The @@ -871,18 +819,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>htmlentities</function></funcdef> - <paramdef>string <parameter>string</parameter></paramdef> - <paramdef>int - <parameter><optional>quote_style</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>charset</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>htmlentities</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>quote_style</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam> + </methodsynopsis> <para> This function is identical to <function>htmlspecialchars</function> in all ways, except that @@ -922,18 +864,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>htmlspecialchars</function></funcdef> - <paramdef>string <parameter>string</parameter></paramdef> - <paramdef>int - <parameter><optional>quote_style</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>charset</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>htmlspecialchars</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>quote_style</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam> + </methodsynopsis> <para> Certain characters have special significance in HTML, and should be represented by HTML entities if they are to preserve their @@ -1019,13 +955,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>implode</function></funcdef> - <paramdef>string <parameter>glue</parameter></paramdef> - <paramdef>array <parameter>pieces</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>implode</methodname> + <methodparam><type>string</type><parameter>glue</parameter></methodparam> + <methodparam><type>array</type><parameter>pieces</parameter></methodparam> + </methodsynopsis> <para> Returns a string containing a string representation of all the array elements in the same order, with the glue string between @@ -1061,13 +995,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>join</function></funcdef> - <paramdef>string <parameter>glue</parameter></paramdef> - <paramdef>array <parameter>pieces</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>join</methodname> + <methodparam><type>string</type><parameter>glue</parameter></methodparam> + <methodparam><type>array</type><parameter>pieces</parameter></methodparam> + </methodsynopsis> <simpara> <function>join</function> is an alias to <function>implode</function>, and is identical in every way. @@ -1088,27 +1020,25 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>levenshtein</function></funcdef> - <paramdef>string <parameter>str1</parameter></paramdef> - <paramdef>string <parameter>str2</parameter></paramdef> - </funcprototype> - <funcprototype> - <funcdef>int <function>levenshtein</function></funcdef> - <paramdef>string <parameter>str1</parameter></paramdef> - <paramdef>string <parameter>str2</parameter></paramdef> - <paramdef>int <parameter>cost_ins</parameter></paramdef> - <paramdef>int <parameter>cost_rep</parameter></paramdef> - <paramdef>int <parameter>cost_del</parameter></paramdef> - </funcprototype> - <funcprototype> - <funcdef>int <function>levenshtein</function></funcdef> - <paramdef>string <parameter>str1</parameter></paramdef> - <paramdef>string <parameter>str2</parameter></paramdef> - <paramdef>function <parameter>cost</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>levenshtein</methodname> + <methodparam><type>string</type><parameter>str1</parameter></methodparam> + <methodparam><type>string</type><parameter>str2</parameter></methodparam> + </methodsynopsis> + <methodsynopsis> + <type>int</type><methodname>levenshtein</methodname> + <methodparam><type>string</type><parameter>str1</parameter></methodparam> + <methodparam><type>string</type><parameter>str2</parameter></methodparam> + <methodparam><type>int</type><parameter>cost_ins</parameter></methodparam> + <methodparam><type>int</type><parameter>cost_rep</parameter></methodparam> + <methodparam><type>int</type><parameter>cost_del</parameter></methodparam> + </methodsynopsis> + <methodsynopsis> + <type>int</type><methodname>levenshtein</methodname> + <methodparam><type>string</type><parameter>str1</parameter></methodparam> + <methodparam><type>string</type><parameter>str2</parameter></methodparam> + <methodparam><type>function</type><parameter>cost</parameter></methodparam> + </methodsynopsis> <para> This function returns the Levenshtein-Distance between the two argument strings or -1, if one of the argument strings @@ -1213,12 +1143,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>localeconv</function></funcdef> + <methodsynopsis> + <type>array</type><methodname>localeconv</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Returns an associative array containing localized numeric and monetary formatting information. @@ -1427,19 +1355,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string - <function>ltrim</function> - </funcdef> - <paramdef>string - <parameter>str</parameter> - </paramdef> - <paramdef>string - <parameter><optional>charlist</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ltrim</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>charlist</parameter></methodparam> + </methodsynopsis> <note> <simpara> The second parameter was added in PHP 4.1.0 @@ -1530,12 +1450,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>md5</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>md5</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> Calculates the MD5 hash of <parameter>str</parameter> using the <ulink url="&url.rfc;rfc1321.html">RSA Data Security, Inc. @@ -1555,12 +1473,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>md5_file</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>md5_file</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Calculates the MD5 hash of the specified <parameter>filename</parameter> using the @@ -1584,12 +1500,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>metaphone</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>metaphone</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> Calculates the metaphone key of <parameter>str</parameter>. </para> @@ -1618,12 +1532,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>nl2br</function></funcdef> - <paramdef>string <parameter>string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>nl2br</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> <para> Returns <parameter>string</parameter> with '&lt;br /&gt;' inserted before all newlines. @@ -1651,12 +1563,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ord</function></funcdef> - <paramdef>string <parameter>string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>ord</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> <para> Returns the ASCII value of the first character of <parameter>string</parameter>. This function complements @@ -1689,16 +1599,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>parse_str</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>array - <parameter><optional>arr</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>parse_str</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>arr + </parameter></methodparam> + </methodsynopsis> <para> Parses <parameter>str</parameter> as if it were the query string passed via an URL and sets variables in the current scope. If @@ -1738,12 +1644,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef><function>print</function></funcdef> - <paramdef>string <parameter>arg</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <methodname>print</methodname> + <methodparam><type>string</type><parameter>arg</parameter></methodparam> + </methodsynopsis> <simpara> Outputs <parameter>arg</parameter>. &return.success; </simpara> @@ -1805,15 +1709,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>printf</function></funcdef> - <paramdef>string <parameter>format</parameter></paramdef> - <paramdef>mixed - <parameter><optional>args</optional></parameter>... - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>printf</methodname> + <methodparam><type>string</type><parameter>format</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>args</parameter></methodparam> + </methodsynopsis> <simpara> Produces output according to <parameter>format</parameter>, which is described in the documentation for <function>sprintf</function>. @@ -1835,14 +1735,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string - <function>quoted_printable_decode</function> - </funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>quoted_printable_decode</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <simpara> This function returns an 8-bit binary string corresponding to the decoded quoted printable string. This function is similar to @@ -1859,12 +1755,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>quotemeta</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>quotemeta</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> Returns a version of str with a backslash character (<literal>\</literal>) before every character that is among @@ -1887,12 +1781,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>str_rot13</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>str_rot13</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> This function performs the ROT13 encoding on the <parameter>str</parameter> argument and returns the resulting @@ -1914,19 +1806,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string - <function>rtrim</function> - </funcdef> - <paramdef>string - <parameter>str</parameter> - </paramdef> - <paramdef>string - <parameter><optional>charlist</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>rtrim</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>charlist</parameter></methodparam> + </methodsynopsis> <note> <simpara> The second parameter was added in PHP 4.1.0 @@ -2019,16 +1903,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>sscanf</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>string <parameter>format</parameter></paramdef> - <paramdef>string - <parameter><optional>var1</optional></parameter>... - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>sscanf</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam><type>string</type><parameter>format</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>var1</parameter></methodparam> + </methodsynopsis> <para> The function <function>sscanf</function> is the input analog of <function>printf</function>. <function>sscanf</function> reads @@ -2081,13 +1961,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>setlocale</function></funcdef> - <paramdef>mixed <parameter>category</parameter></paramdef> - <paramdef>string <parameter>locale</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>setlocale</methodname> + <methodparam><type>mixed</type><parameter>category</parameter></methodparam> + <methodparam><type>string</type><parameter>locale</parameter></methodparam> + </methodsynopsis> <para> <parameter>Category</parameter> is a named constant (or string) specifying the category of the functions affected by the locale @@ -2172,16 +2050,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>similar_text</function></funcdef> - <paramdef>string <parameter>first</parameter></paramdef> - <paramdef>string <parameter>second</parameter></paramdef> - <paramdef>float - <parameter><optional>percent</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>similar_text</methodname> + <methodparam><type>string</type><parameter>first</parameter></methodparam> + <methodparam><type>string</type><parameter>second</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>percent</parameter></methodparam> + </methodsynopsis> <para> This calculates the similarity between two strings as described in Oliver [1993]. Note that this implementation does not use a @@ -2206,12 +2080,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>soundex</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>soundex</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> Calculates the soundex key of <parameter>str</parameter>. </para> @@ -2256,15 +2128,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>sprintf</function></funcdef> - <paramdef>string <parameter>format</parameter></paramdef> - <paramdef>mixed - <parameter><optional>args</optional></parameter>... - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>sprintf</methodname> + <methodparam><type>string</type><parameter>format</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>args</parameter></methodparam> + </methodsynopsis> <simpara> Returns a string produced according to the formatting string <parameter>format</parameter>. @@ -2466,14 +2334,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>strncasecmp</function></funcdef> - <paramdef>string <parameter>str1</parameter></paramdef> - <paramdef>string <parameter>str2</parameter></paramdef> - <paramdef>int <parameter>len</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>strncasecmp</methodname> + <methodparam><type>string</type><parameter>str1</parameter></methodparam> + <methodparam><type>string</type><parameter>str2</parameter></methodparam> + <methodparam><type>int</type><parameter>len</parameter></methodparam> + </methodsynopsis> <para> This function is similar to <function>strcasecmp</function>, with the difference that you can specify the (upper limit of the) @@ -2505,13 +2371,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>strcasecmp</function></funcdef> - <paramdef>string <parameter>str1</parameter></paramdef> - <paramdef>string <parameter>str2</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>strcasecmp</methodname> + <methodparam><type>string</type><parameter>str1</parameter></methodparam> + <methodparam><type>string</type><parameter>str2</parameter></methodparam> + </methodsynopsis> <para> Returns &lt; 0 if <parameter>str1</parameter> is less than <parameter>str2</parameter>; &gt; 0 if <parameter>str1</parameter> @@ -2548,13 +2412,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>strchr</function></funcdef> - <paramdef>string <parameter>haystack</parameter></paramdef> - <paramdef>string <parameter>needle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>strchr</methodname> + <methodparam><type>string</type><parameter>haystack</parameter></methodparam> + <methodparam><type>string</type><parameter>needle</parameter></methodparam> + </methodsynopsis> <para> This function is an alias for <function>strstr</function>, and is identical in every way. @@ -2569,13 +2431,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>strcmp</function></funcdef> - <paramdef>string <parameter>str1</parameter></paramdef> - <paramdef>string <parameter>str2</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>strcmp</methodname> + <methodparam><type>string</type><parameter>str1</parameter></methodparam> + <methodparam><type>string</type><parameter>str2</parameter></methodparam> + </methodsynopsis> <simpara> Returns &lt; 0 if <parameter>str1</parameter> is less than <parameter>str2</parameter>; &gt; 0 if <parameter>str1</parameter> @@ -2601,13 +2461,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>strcoll</function></funcdef> - <paramdef>string <parameter>str1</parameter></paramdef> - <paramdef>string <parameter>str2</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>strcoll</methodname> + <methodparam><type>string</type><parameter>str1</parameter></methodparam> + <methodparam><type>string</type><parameter>str2</parameter></methodparam> + </methodsynopsis> <simpara> Returns &lt; 0 if <parameter>str1</parameter> is less than <parameter>str2</parameter>; &gt; 0 if @@ -2640,13 +2498,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>strcspn</function></funcdef> - <paramdef>string <parameter>str1</parameter></paramdef> - <paramdef>string <parameter>str2</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>strcspn</methodname> + <methodparam><type>string</type><parameter>str1</parameter></methodparam> + <methodparam><type>string</type><parameter>str2</parameter></methodparam> + </methodsynopsis> <simpara> Returns the length of the initial segment of <parameter>str1</parameter> which does <emphasis>not</emphasis> @@ -2665,15 +2521,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>strip_tags</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>string - <parameter><optional>allowable_tags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>strip_tags</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>allowable_tags</parameter></methodparam> + </methodsynopsis> <para> This function tries to return a string with all HTML and PHP tags stripped from a given <parameter>str</parameter>. It errors on @@ -2722,12 +2574,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>stripcslashes</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>stripcslashes</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> Returns a string with backslashes stripped off. Recognizes C-like <literal>\n</literal>, <literal>\r</literal> ..., octal @@ -2748,12 +2598,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>stripslashes</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>stripslashes</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> Returns a string with backslashes stripped off. (<literal>\'</literal> becomes <literal>'</literal> and so on.) @@ -2774,13 +2622,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>stristr</function></funcdef> - <paramdef>string <parameter>haystack</parameter></paramdef> - <paramdef>string <parameter>needle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>stristr</methodname> + <methodparam><type>string</type><parameter>haystack</parameter></methodparam> + <methodparam><type>string</type><parameter>needle</parameter></methodparam> + </methodsynopsis> <para> Returns all of <parameter>haystack</parameter> from the first occurrence of <parameter>needle</parameter> to the end. @@ -2809,12 +2655,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>strlen</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>strlen</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> Returns the length of <parameter>string</parameter>. </para> @@ -2830,13 +2674,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>strnatcmp</function></funcdef> - <paramdef>string <parameter>str1</parameter></paramdef> - <paramdef>string <parameter>str2</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>strnatcmp</methodname> + <methodparam><type>string</type><parameter>str1</parameter></methodparam> + <methodparam><type>string</type><parameter>str2</parameter></methodparam> + </methodsynopsis> <para> This function implements a comparison algorithm that orders alphanumeric strings in the way a human being would, this is @@ -2916,13 +2758,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>strnatcasecmp</function></funcdef> - <paramdef>string <parameter>str1</parameter></paramdef> - <paramdef>string <parameter>str2</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>strnatcasecmp</methodname> + <methodparam><type>string</type><parameter>str1</parameter></methodparam> + <methodparam><type>string</type><parameter>str2</parameter></methodparam> + </methodsynopsis> <para> This function implements a comparison algorithm that orders alphanumeric strings in the way a human being would. The @@ -2958,14 +2798,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>strncmp</function></funcdef> - <paramdef>string <parameter>str1</parameter></paramdef> - <paramdef>string <parameter>str2</parameter></paramdef> - <paramdef>int <parameter>len</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>strncmp</methodname> + <methodparam><type>string</type><parameter>str1</parameter></methodparam> + <methodparam><type>string</type><parameter>str2</parameter></methodparam> + <methodparam><type>int</type><parameter>len</parameter></methodparam> + </methodsynopsis> <para> This function is similar to <function>strcmp</function>, with the difference that you can specify the (upper limit of the) number @@ -3002,19 +2840,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>str_pad</function></funcdef> - <paramdef>string <parameter>input</parameter></paramdef> - <paramdef>int <parameter>pad_length</parameter></paramdef> - <paramdef>string - <parameter><optional>pad_string</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>pad_type</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>str_pad</methodname> + <methodparam><type>string</type><parameter>input</parameter></methodparam> + <methodparam><type>int</type><parameter>pad_length</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>pad_string</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>pad_type</parameter></methodparam> + </methodsynopsis> <para> This functions returns the <parameter>input</parameter> string padded on the left, the right, or both sides to the specified @@ -3059,16 +2891,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>strpos</function></funcdef> - <paramdef>string <parameter>haystack</parameter></paramdef> - <paramdef>string <parameter>needle</parameter></paramdef> - <paramdef>int - <parameter><optional>offset</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>strpos</methodname> + <methodparam><type>string</type><parameter>haystack</parameter></methodparam> + <methodparam><type>string</type><parameter>needle</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam> + </methodsynopsis> <para> Returns the numeric position of the first occurrence of <parameter>needle</parameter> in the @@ -3131,13 +2959,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>strrchr</function></funcdef> - <paramdef>string <parameter>haystack</parameter></paramdef> - <paramdef>string <parameter>needle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>strrchr</methodname> + <methodparam><type>string</type><parameter>haystack</parameter></methodparam> + <methodparam><type>string</type><parameter>needle</parameter></methodparam> + </methodsynopsis> <para> This function returns the portion of <parameter>haystack</parameter> which starts at the last @@ -3182,13 +3008,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>str_repeat</function></funcdef> - <paramdef>string <parameter>input</parameter></paramdef> - <paramdef>int <parameter>multiplier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>str_repeat</methodname> + <methodparam><type>string</type><parameter>input</parameter></methodparam> + <methodparam><type>int</type><parameter>multiplier</parameter></methodparam> + </methodsynopsis> <para> Returns <parameter>input_str</parameter> repeated <parameter>multiplier</parameter> times. @@ -3218,12 +3042,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>strrev</function></funcdef> - <paramdef>string <parameter>string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>strrev</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> <para> Returns <parameter>string</parameter>, reversed. <example> @@ -3249,13 +3071,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>strrpos</function></funcdef> - <paramdef>string <parameter>haystack</parameter></paramdef> - <paramdef>char <parameter>needle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>strrpos</methodname> + <methodparam><type>string</type><parameter>haystack</parameter></methodparam> + <methodparam><type>char</type><parameter>needle</parameter></methodparam> + </methodsynopsis> <para> Returns the numeric position of the last occurrence of <parameter>needle</parameter> in the @@ -3312,13 +3132,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>strspn</function></funcdef> - <paramdef>string <parameter>str1</parameter></paramdef> - <paramdef>string <parameter>str2</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>strspn</methodname> + <methodparam><type>string</type><parameter>str1</parameter></methodparam> + <methodparam><type>string</type><parameter>str2</parameter></methodparam> + </methodsynopsis> <simpara> Returns the length of the initial segment of <parameter>str1</parameter> which consists entirely of characters @@ -3349,13 +3167,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>strstr</function></funcdef> - <paramdef>string <parameter>haystack</parameter></paramdef> - <paramdef>string <parameter>needle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>strstr</methodname> + <methodparam><type>string</type><parameter>haystack</parameter></methodparam> + <methodparam><type>string</type><parameter>needle</parameter></methodparam> + </methodsynopsis> <para> Returns all of <parameter>haystack</parameter> from the first occurrence of <parameter>needle</parameter> to the end. @@ -3401,13 +3217,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>strtok</function></funcdef> - <paramdef>string <parameter>arg1</parameter></paramdef> - <paramdef>string <parameter>arg2</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>strtok</methodname> + <methodparam><type>string</type><parameter>arg1</parameter></methodparam> + <methodparam><type>string</type><parameter>arg2</parameter></methodparam> + </methodsynopsis> <para> <function>strtok</function> splits a string (<parameter>arg1</parameter>) into smaller strings (tokens), with each token being delimited by any @@ -3493,12 +3307,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>strtolower</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>strtolower</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> Returns <parameter>string</parameter> with all alphabetic characters converted to lowercase. @@ -3533,12 +3345,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>strtoupper</function></funcdef> - <paramdef>string <parameter>string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>strtoupper</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> <para> Returns <parameter>string</parameter> with all alphabetic characters converted to uppercase. @@ -3575,14 +3385,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>str_replace</function></funcdef> - <paramdef>mixed <parameter>search</parameter></paramdef> - <paramdef>mixed <parameter>replace</parameter></paramdef> - <paramdef>mixed <parameter>subject</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>str_replace</methodname> + <methodparam><type>mixed</type><parameter>search</parameter></methodparam> + <methodparam><type>mixed</type><parameter>replace</parameter></methodparam> + <methodparam><type>mixed</type><parameter>subject</parameter></methodparam> + </methodsynopsis> <para> This function returns a string or an array with all occurences of <parameter>search</parameter> in <parameter>subject</parameter> @@ -3648,14 +3456,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>strtr</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>string <parameter>from</parameter></paramdef> - <paramdef>string <parameter>to</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>strtr</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam><type>string</type><parameter>from</parameter></methodparam> + <methodparam><type>string</type><parameter>to</parameter></methodparam> + </methodsynopsis> <para> This function returns a copy of <parameter>str</parameter>, translating all occurrences of each character in @@ -3715,16 +3521,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>substr</function></funcdef> - <paramdef>string <parameter>string</parameter></paramdef> - <paramdef>int <parameter>start</parameter></paramdef> - <paramdef>int - <parameter><optional>length</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>substr</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + <methodparam><type>int</type><parameter>start</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> <para> Substr returns the portion of <parameter>string</parameter> specified by the <parameter>start</parameter> and @@ -3805,13 +3607,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>substr_count</function></funcdef> - <paramdef>string <parameter>haystack</parameter></paramdef> - <paramdef>string <parameter>needle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>substr_count</methodname> + <methodparam><type>string</type><parameter>haystack</parameter></methodparam> + <methodparam><type>string</type><parameter>needle</parameter></methodparam> + </methodsynopsis> <para> <function>substr_count</function> returns the number of times the <parameter>needle</parameter> substring occurs in the @@ -3838,17 +3638,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>substr_replace</function></funcdef> - <paramdef>string <parameter>string</parameter></paramdef> - <paramdef>string <parameter>replacement</parameter></paramdef> - <paramdef>int <parameter>start</parameter></paramdef> - <paramdef>int - <parameter><optional>length</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>substr_replace</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + <methodparam><type>string</type><parameter>replacement</parameter></methodparam> + <methodparam><type>int</type><parameter>start</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> <para> <function>substr_replace</function> replaces a copy of <parameter>string</parameter> delimited by the @@ -3920,19 +3716,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string - <function>trim</function> - </funcdef> - <paramdef>string - <parameter>str</parameter> - </paramdef> - <paramdef>string - <parameter><optional>charlist</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>trim</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>charlist</parameter></methodparam> + </methodsynopsis> <note> <simpara> The optional <parameter>charlist</parameter> parameter was @@ -4024,12 +3812,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ucfirst</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ucfirst</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> Returns a string with the first character of <parameter>str</parameter> capitalized, if that character is @@ -4069,12 +3855,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>ucwords</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>ucwords</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> Returns a string with the first character of each word in <parameter>str</parameter> capitalized, if that character is @@ -4115,15 +3899,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>vprintf</function></funcdef> - <paramdef>string <parameter>format</parameter></paramdef> - <paramdef>array - <parameter>args</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>vprintf</methodname> + <methodparam><type>string</type><parameter>format</parameter></methodparam> + <methodparam><type>array</type><parameter>args</parameter></methodparam> + </methodsynopsis> <simpara> Display array values as a formatted string according to <parameter>format</parameter> (which is described in the documentation @@ -4147,15 +3927,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>vsprintf</function></funcdef> - <paramdef>string <parameter>format</parameter></paramdef> - <paramdef>array - <parameter>args</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>vsprintf</methodname> + <methodparam><type>string</type><parameter>format</parameter></methodparam> + <methodparam><type>array</type><parameter>args</parameter></methodparam> + </methodsynopsis> <simpara> Return array values as a formatted string according to <parameter>format</parameter> (which is described in the documentation @@ -4182,21 +3958,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>wordwrap</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>int - <parameter><optional>width</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>break</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>cut</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>wordwrap</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>width</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>break</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>cut</parameter></methodparam> + </methodsynopsis> <para> Returns a string with <parameter>str</parameter> wrapped at the column number specified by the (optional) @@ -4288,12 +4056,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>nl_langinfo</function></funcdef> - <paramdef>int <parameter>item</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>nl_langinfo</methodname> + <methodparam><type>int</type><parameter>item</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -4322,3 +4088,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/swf.xml diff -u phpdoc/en/functions/swf.xml:1.26 phpdoc/en/functions/swf.xml:1.27 --- phpdoc/en/functions/swf.xml:1.26 Wed Dec 12 15:47:30 2001 +++ phpdoc/en/functions/swf.xml Sat Feb 2 10:36:10 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.26 $ --> +<!-- $Revision: 1.27 $ --> <reference id="ref.swf"> <title>Shockwave Flash functions</title> <titleabbrev>SWF</titleabbrev> @@ -95,34 +95,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_openfile</function> - </funcdef> - <paramdef>string - <parameter>filename</parameter> - </paramdef> - <paramdef>float - <parameter>width</parameter> - </paramdef> - <paramdef>float - <parameter>height</parameter> - </paramdef> - <paramdef>float - <parameter>framerate</parameter> - </paramdef> - <paramdef>float - <parameter>r</parameter> - </paramdef> - <paramdef>float - <parameter>g</parameter> - </paramdef> - <paramdef>float - <parameter>b</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_openfile</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>float</type><parameter>width</parameter></methodparam> + <methodparam><type>float</type><parameter>height</parameter></methodparam> + <methodparam><type>float</type><parameter>framerate</parameter></methodparam> + <methodparam><type>float</type><parameter>r</parameter></methodparam> + <methodparam><type>float</type><parameter>g</parameter></methodparam> + <methodparam><type>float</type><parameter>b</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_openfile</function> function opens a new file named <parameter>filename</parameter> with a width of @@ -149,18 +131,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_closefile</function> - </funcdef> - <paramdef>int - <parameter> - <optional>return_file</optional> - </parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_closefile</methodname> + <methodparam choice="opt"><type>int</type><parameter> + return_file + </parameter></methodparam> + </methodsynopsis> <para> Close a file that was opened by the <function>swf_openfile</function> function. If the @@ -254,16 +230,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_labelframe</function> - </funcdef> - <paramdef>string - <parameter>name</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_labelframe</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> <para> Label the current frame with the name given by the <parameter>name</parameter> parameter. @@ -278,14 +248,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_showframe</function> - </funcdef> + <methodsynopsis> + <type>void</type><methodname>swf_showframe</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> The swf_showframe function will output the current frame. </para> @@ -299,16 +265,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_setframe</function> - </funcdef> - <paramdef>int - <parameter>framenumber</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_setframe</methodname> + <methodparam><type>int</type><parameter>framenumber</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_setframe</function> changes the active frame to the frame specified by <parameter>framenumber</parameter>. @@ -323,14 +283,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>swf_getframe</function> - </funcdef> + <methodsynopsis> + <type>int</type><methodname>swf_getframe</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> The <function>swf_getframe</function> function gets the number of the current frame. @@ -347,25 +303,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_mulcolor</function> - </funcdef> - <paramdef>float - <parameter>r</parameter> - </paramdef> - <paramdef>float - <parameter>g</parameter> - </paramdef> - <paramdef>float - <parameter>b</parameter> - </paramdef> - <paramdef>float - <parameter>a</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_mulcolor</methodname> + <methodparam><type>float</type><parameter>r</parameter></methodparam> + <methodparam><type>float</type><parameter>g</parameter></methodparam> + <methodparam><type>float</type><parameter>b</parameter></methodparam> + <methodparam><type>float</type><parameter>a</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_mulcolor</function> function sets the global multiply color to the <parameter>rgba</parameter> color @@ -394,25 +338,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_addcolor</function> - </funcdef> - <paramdef>float - <parameter>r</parameter> - </paramdef> - <paramdef>float - <parameter>g</parameter> - </paramdef> - <paramdef>float - <parameter>b</parameter> - </paramdef> - <paramdef>float - <parameter>a</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_addcolor</methodname> + <methodparam><type>float</type><parameter>r</parameter></methodparam> + <methodparam><type>float</type><parameter>g</parameter></methodparam> + <methodparam><type>float</type><parameter>b</parameter></methodparam> + <methodparam><type>float</type><parameter>a</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_addcolor</function> function sets the global add color to the <parameter>rgba</parameter> color specified. @@ -439,19 +371,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_placeobject</function> - </funcdef> - <paramdef>int - <parameter>objid</parameter> - </paramdef> - <paramdef>int - <parameter>depth</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_placeobject</methodname> + <methodparam><type>int</type><parameter>objid</parameter></methodparam> + <methodparam><type>int</type><parameter>depth</parameter></methodparam> + </methodsynopsis> <para> Places the object specified by <parameter>objid</parameter> in the current frame at a depth of <parameter>depth</parameter>. @@ -479,19 +403,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_modifyobject</function> - </funcdef> - <paramdef>int - <parameter>depth</parameter> - </paramdef> - <paramdef>int - <parameter>how</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_modifyobject</methodname> + <methodparam><type>int</type><parameter>depth</parameter></methodparam> + <methodparam><type>int</type><parameter>how</parameter></methodparam> + </methodsynopsis> <para> Updates the position and/or color of the object at the specified depth, <parameter>depth</parameter>. The parameter @@ -516,16 +432,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_removeobject</function> - </funcdef> - <paramdef>int - <parameter>depth</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_removeobject</methodname> + <methodparam><type>int</type><parameter>depth</parameter></methodparam> + </methodsynopsis> <para> Removes the object at the depth specified by <parameter>depth</parameter>. @@ -540,14 +450,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>swf_nextid</function> - </funcdef> + <methodsynopsis> + <type>int</type><methodname>swf_nextid</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> The <function>swf_nextid</function> function returns the next available object id. @@ -564,14 +470,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_startdoaction</function> - </funcdef> + <methodsynopsis> + <type>void</type><methodname>swf_startdoaction</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> The <function>swf_startdoaction</function> function starts the description of an action list for the current frame. This must @@ -587,16 +489,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_actiongotoframe</function> - </funcdef> - <paramdef>int - <parameter>framenumber</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_actiongotoframe</methodname> + <methodparam><type>int</type><parameter>framenumber</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_actionGotoFrame</function> function will go to the frame specified by <parameter>framenumber</parameter>, play @@ -612,19 +508,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_actiongeturl</function> - </funcdef> - <paramdef>string - <parameter>url</parameter> - </paramdef> - <paramdef>string - <parameter>target</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_actiongeturl</methodname> + <methodparam><type>string</type><parameter>url</parameter></methodparam> + <methodparam><type>string</type><parameter>target</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_actionGetUrl</function> function gets the URL specified by the parameter <parameter>url</parameter> with the @@ -640,14 +528,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_actionnextframe</function> - </funcdef> + <methodsynopsis> + <type>void</type><methodname>swf_actionnextframe</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Go foward one frame. </para> @@ -661,14 +545,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_actionprevframe</function> - </funcdef> + <methodsynopsis> + <type>void</type><methodname>swf_actionprevframe</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> </refsect1> </refentry> @@ -681,14 +561,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_actionplay</function> - </funcdef> + <methodsynopsis> + <type>void</type><methodname>swf_actionplay</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Start playing the flash movie from the current frame. </para> @@ -704,14 +580,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_actionstop</function> - </funcdef> + <methodsynopsis> + <type>void</type><methodname>swf_actionstop</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Stop playing the flash movie at the current frame. </para> @@ -727,14 +599,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_actiontogglequality</function> - </funcdef> + <methodsynopsis> + <type>void</type><methodname>swf_actiontogglequality</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Toggle the flash movie between high and low quality. </para> @@ -750,19 +618,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_actionwaitforframe</function> - </funcdef> - <paramdef>int - <parameter>framenumber</parameter> - </paramdef> - <paramdef>int - <parameter>skipcount</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_actionwaitforframe</methodname> + <methodparam><type>int</type><parameter>framenumber</parameter></methodparam> + <methodparam><type>int</type><parameter>skipcount</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_actionWaitForFrame</function> function will check to see if the frame, specified by the @@ -781,16 +641,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_actionsettarget</function> - </funcdef> - <paramdef>string - <parameter>target</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_actionsettarget</methodname> + <methodparam><type>string</type><parameter>target</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_actionSetTarget</function> function sets the context for all actions. You can use this to control other flash @@ -808,16 +662,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_actiongotolabel</function> - </funcdef> - <paramdef>string - <parameter>label</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_actiongotolabel</methodname> + <methodparam><type>string</type><parameter>label</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_actionGotoLabel</function> function displays the frame with the label given by the @@ -833,14 +681,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_enddoaction</function> - </funcdef> + <methodsynopsis> + <type>void</type><methodname>swf_enddoaction</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Ends the current action started by the <function>swf_startdoaction</function> function. @@ -855,31 +699,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_defineline</function> - </funcdef> - <paramdef>int - <parameter>objid</parameter> - </paramdef> - <paramdef>float - <parameter>x1</parameter> - </paramdef> - <paramdef>float - <parameter>y1</parameter> - </paramdef> - <paramdef>float - <parameter>x2</parameter> - </paramdef> - <paramdef>float - <parameter>y2</parameter> - </paramdef> - <paramdef>float - <parameter>width</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_defineline</methodname> + <methodparam><type>int</type><parameter>objid</parameter></methodparam> + <methodparam><type>float</type><parameter>x1</parameter></methodparam> + <methodparam><type>float</type><parameter>y1</parameter></methodparam> + <methodparam><type>float</type><parameter>x2</parameter></methodparam> + <methodparam><type>float</type><parameter>y2</parameter></methodparam> + <methodparam><type>float</type><parameter>width</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_defineline</function> defines a line starting from the x coordinate given by <parameter>x1</parameter> and the @@ -899,31 +727,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_definerect</function> - </funcdef> - <paramdef>int - <parameter>objid</parameter> - </paramdef> - <paramdef>float - <parameter>x1</parameter> - </paramdef> - <paramdef>float - <parameter>y1</parameter> - </paramdef> - <paramdef>float - <parameter>x2</parameter> - </paramdef> - <paramdef>float - <parameter>y2</parameter> - </paramdef> - <paramdef>float - <parameter>width</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_definerect</methodname> + <methodparam><type>int</type><parameter>objid</parameter></methodparam> + <methodparam><type>float</type><parameter>x1</parameter></methodparam> + <methodparam><type>float</type><parameter>y1</parameter></methodparam> + <methodparam><type>float</type><parameter>x2</parameter></methodparam> + <methodparam><type>float</type><parameter>y2</parameter></methodparam> + <methodparam><type>float</type><parameter>width</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_definerect</function> defines a rectangle with an upper left hand coordinate given by the x, @@ -946,25 +758,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_definepoly</function> - </funcdef> - <paramdef>int - <parameter>objid</parameter> - </paramdef> - <paramdef>array - <parameter>coords</parameter> - </paramdef> - <paramdef>int - <parameter>npoints</parameter> - </paramdef> - <paramdef>float - <parameter>width</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_definepoly</methodname> + <methodparam><type>int</type><parameter>objid</parameter></methodparam> + <methodparam><type>array</type><parameter>coords</parameter></methodparam> + <methodparam><type>int</type><parameter>npoints</parameter></methodparam> + <methodparam><type>float</type><parameter>width</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_definepoly</function> function defines a polygon given an array of x, y coordinates (the coordinates are @@ -985,16 +785,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_startshape</function> - </funcdef> - <paramdef>int - <parameter>objid</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_startshape</methodname> + <methodparam><type>int</type><parameter>objid</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_startshape</function> function starts a complex shape, with an object id given by the @@ -1010,28 +804,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_shapelinesolid</function> - </funcdef> - <paramdef>float - <parameter>r</parameter> - </paramdef> - <paramdef>float - <parameter>g</parameter> - </paramdef> - <paramdef>float - <parameter>b</parameter> - </paramdef> - <paramdef>float - <parameter>a</parameter> - </paramdef> - <paramdef>float - <parameter>width</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_shapelinesolid</methodname> + <methodparam><type>float</type><parameter>r</parameter></methodparam> + <methodparam><type>float</type><parameter>g</parameter></methodparam> + <methodparam><type>float</type><parameter>b</parameter></methodparam> + <methodparam><type>float</type><parameter>a</parameter></methodparam> + <methodparam><type>float</type><parameter>width</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_shapeLineSolid</function> function sets the current line style to the color of the @@ -1049,14 +829,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_shapefilloff</function> - </funcdef> + <methodsynopsis> + <type>void</type><methodname>swf_shapefilloff</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> The <function>swf_shapeFillOff</function> function turns off filling for the current shape. @@ -1073,25 +849,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_shapefillsolid</function> - </funcdef> - <paramdef>float - <parameter>r</parameter> - </paramdef> - <paramdef>float - <parameter>g</parameter> - </paramdef> - <paramdef>float - <parameter>b</parameter> - </paramdef> - <paramdef>float - <parameter>a</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_shapefillsolid</methodname> + <methodparam><type>float</type><parameter>r</parameter></methodparam> + <methodparam><type>float</type><parameter>g</parameter></methodparam> + <methodparam><type>float</type><parameter>b</parameter></methodparam> + <methodparam><type>float</type><parameter>a</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_shapeFillSolid</function> function sets the current fill style to solid, and then sets the fill color to the @@ -1109,16 +873,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_shapefillbitmapclip</function> - </funcdef> - <paramdef>int - <parameter>bitmapid</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_shapefillbitmapclip</methodname> + <methodparam><type>int</type><parameter>bitmapid</parameter></methodparam> + </methodsynopsis> <para> Sets the fill to bitmap clipped, empty spaces will be filled by the bitmap given by the <parameter>bitmapid</parameter> @@ -1136,16 +894,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_shapefillbitmaptile</function> - </funcdef> - <paramdef>int - <parameter>bitmapid</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_shapefillbitmaptile</methodname> + <methodparam><type>int</type><parameter>bitmapid</parameter></methodparam> + </methodsynopsis> <para> Sets the fill to bitmap tile, empty spaces will be filled by the bitmap given by the <parameter>bitmapid</parameter> parameter @@ -1161,19 +913,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_shapemoveto</function> - </funcdef> - <paramdef>float - <parameter>x</parameter> - </paramdef> - <paramdef>float - <parameter>y</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_shapemoveto</methodname> + <methodparam><type>float</type><parameter>x</parameter></methodparam> + <methodparam><type>float</type><parameter>y</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_shapeMoveTo</function> function moves the current position to the x coordinate given by the @@ -1190,19 +934,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_shapelineto</function> - </funcdef> - <paramdef>float - <parameter>x</parameter> - </paramdef> - <paramdef>float - <parameter>y</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_shapelineto</methodname> + <methodparam><type>float</type><parameter>x</parameter></methodparam> + <methodparam><type>float</type><parameter>y</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_shapeLineTo</function> draws a line to the x,y coordinates given by the <parameter>x</parameter> parameter &amp; the @@ -1221,25 +957,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_shapecurveto</function> - </funcdef> - <paramdef>float - <parameter>x1</parameter> - </paramdef> - <paramdef>float - <parameter>y1</parameter> - </paramdef> - <paramdef>float - <parameter>x2</parameter> - </paramdef> - <paramdef>float - <parameter>y2</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_shapecurveto</methodname> + <methodparam><type>float</type><parameter>x1</parameter></methodparam> + <methodparam><type>float</type><parameter>y1</parameter></methodparam> + <methodparam><type>float</type><parameter>x2</parameter></methodparam> + <methodparam><type>float</type><parameter>y2</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_shapecurveto</function> function draws a quadratic bezier curve from the x coordinate given by @@ -1260,31 +984,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_shapecurveto3</function> - </funcdef> - <paramdef>float - <parameter>x1</parameter> - </paramdef> - <paramdef>float - <parameter>y1</parameter> - </paramdef> - <paramdef>float - <parameter>x2</parameter> - </paramdef> - <paramdef>float - <parameter>y2</parameter> - </paramdef> - <paramdef>float - <parameter>x3</parameter> - </paramdef> - <paramdef>float - <parameter>y3</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_shapecurveto3</methodname> + <methodparam><type>float</type><parameter>x1</parameter></methodparam> + <methodparam><type>float</type><parameter>y1</parameter></methodparam> + <methodparam><type>float</type><parameter>x2</parameter></methodparam> + <methodparam><type>float</type><parameter>y2</parameter></methodparam> + <methodparam><type>float</type><parameter>x3</parameter></methodparam> + <methodparam><type>float</type><parameter>y3</parameter></methodparam> + </methodsynopsis> <para> Draw a cubic bezier curve using the x,y coordinate pairs <parameter>x1</parameter>, <parameter>y1</parameter> and @@ -1305,28 +1013,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_shapearc</function> - </funcdef> - <paramdef>float - <parameter>x</parameter> - </paramdef> - <paramdef>float - <parameter>y</parameter> - </paramdef> - <paramdef>float - <parameter>r</parameter> - </paramdef> - <paramdef>float - <parameter>ang1</parameter> - </paramdef> - <paramdef>float - <parameter>ang2</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_shapearc</methodname> + <methodparam><type>float</type><parameter>x</parameter></methodparam> + <methodparam><type>float</type><parameter>y</parameter></methodparam> + <methodparam><type>float</type><parameter>r</parameter></methodparam> + <methodparam><type>float</type><parameter>ang1</parameter></methodparam> + <methodparam><type>float</type><parameter>ang2</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_shapeArc</function> function draws a circular arc from angle A given by the <parameter>ang1</parameter> @@ -1348,14 +1042,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_endshape</function> - </funcdef> + <methodsynopsis> + <type>void</type><methodname>swf_endshape</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> The <function>swf_endshape</function> completes the definition of the current shape. @@ -1372,19 +1062,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_definefont</function> - </funcdef> - <paramdef>int - <parameter>fontid</parameter> - </paramdef> - <paramdef>string - <parameter>fontname</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_definefont</methodname> + <methodparam><type>int</type><parameter>fontid</parameter></methodparam> + <methodparam><type>string</type><parameter>fontname</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_definefont</function> function defines a font given by the <parameter>fontname</parameter> parameter and gives @@ -1402,16 +1084,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_setfont</function> - </funcdef> - <paramdef>int - <parameter>fontid</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_setfont</methodname> + <methodparam><type>int</type><parameter>fontid</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_setfont</function> sets the current font to the value given by the <parameter>fontid</parameter> parameter. @@ -1426,16 +1102,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_fontsize</function> - </funcdef> - <paramdef>float - <parameter>size</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_fontsize</methodname> + <methodparam><type>float</type><parameter>size</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_fontsize</function> function changes the font size to the value given by the <parameter>size</parameter> @@ -1451,16 +1121,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_fontslant</function> - </funcdef> - <paramdef>float - <parameter>slant</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_fontslant</methodname> + <methodparam><type>float</type><parameter>slant</parameter></methodparam> + </methodsynopsis> <para> Set the current font slant to the angle indicated by the <parameter>slant</parameter> parameter. Positive values create a @@ -1476,16 +1140,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_fonttracking</function> - </funcdef> - <paramdef>float - <parameter>tracking</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_fonttracking</methodname> + <methodparam><type>float</type><parameter>tracking</parameter></methodparam> + </methodsynopsis> <para> Set the font tracking to the value specified by the <parameter>tracking</parameter> parameter. This function is used @@ -1505,14 +1163,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array - <function>swf_getfontinfo</function> - </funcdef> + <methodsynopsis> + <type>array</type><methodname>swf_getfontinfo</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> The <function>swf_getfontinfo</function> function returns an associative array with the following parameters: @@ -1539,22 +1193,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_definetext</function> - </funcdef> - <paramdef>int - <parameter>objid</parameter> - </paramdef> - <paramdef>string - <parameter>str</parameter> - </paramdef> - <paramdef>int - <parameter>docenter</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_definetext</methodname> + <methodparam><type>int</type><parameter>objid</parameter></methodparam> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam><type>int</type><parameter>docenter</parameter></methodparam> + </methodsynopsis> <para> Define a text string (the <parameter>str</parameter> parameter) using the current font and font size. The @@ -1572,16 +1216,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float - <function>swf_textwidth</function> - </funcdef> - <paramdef>string - <parameter>str</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>swf_textwidth</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_textwidth</function> function gives the width of the string, <parameter>str</parameter>, in pixels, using the @@ -1597,19 +1235,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_definebitmap</function> - </funcdef> - <paramdef>int - <parameter>objid</parameter> - </paramdef> - <paramdef>string - <parameter>image_name</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_definebitmap</methodname> + <methodparam><type>int</type><parameter>objid</parameter></methodparam> + <methodparam><type>string</type><parameter>image_name</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_definebitmap</function> function defines a bitmap given a GIF, JPEG, RGB or FI image. The image will be @@ -1625,16 +1255,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array - <function>swf_getbitmapinfo</function> - </funcdef> - <paramdef>int - <parameter>bitmapid</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>swf_getbitmapinfo</methodname> + <methodparam><type>int</type><parameter>bitmapid</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_getbitmapinfo</function> function returns an array of information about a bitmap given by the @@ -1668,16 +1292,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_startsymbol</function> - </funcdef> - <paramdef>int - <parameter>objid</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_startsymbol</methodname> + <methodparam><type>int</type><parameter>objid</parameter></methodparam> + </methodsynopsis> <para> Define an object id as a symbol. Symbols are tiny flash movies that can be played simultaneously. The @@ -1694,14 +1312,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_endsymbol</function> - </funcdef> + <methodsynopsis> + <type>void</type><methodname>swf_endsymbol</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> The <function>swf_endsymbol</function> function ends the definition of a symbol that was started by the @@ -1717,19 +1331,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_startbutton</function> - </funcdef> - <paramdef>int - <parameter>objid</parameter> - </paramdef> - <paramdef>int - <parameter>type</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_startbutton</methodname> + <methodparam><type>int</type><parameter>objid</parameter></methodparam> + <methodparam><type>int</type><parameter>type</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_startbutton</function> function starts off the definition of a button. The <parameter>type</parameter> @@ -1750,22 +1356,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_addbuttonrecord</function> - </funcdef> - <paramdef>int - <parameter>states</parameter> - </paramdef> - <paramdef>int - <parameter>shapeid</parameter> - </paramdef> - <paramdef>int - <parameter>depth</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_addbuttonrecord</methodname> + <methodparam><type>int</type><parameter>states</parameter></methodparam> + <methodparam><type>int</type><parameter>shapeid</parameter></methodparam> + <methodparam><type>int</type><parameter>depth</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_addbuttonrecord</function> function allows you to define the specifics of using a button. The first parameter, @@ -1805,16 +1401,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_oncondition</function> - </funcdef> - <paramdef>int - <parameter>transition</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_oncondition</methodname> + <methodparam><type>int</type><parameter>transition</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_onCondition</function> function describes a transition that will trigger an action list. There are several @@ -1923,14 +1513,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_endbutton</function> - </funcdef> + <methodsynopsis> + <type>void</type><methodname>swf_endbutton</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> The <function>swf_endButton</function> function ends the definition of the current button. @@ -1945,25 +1531,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_viewport</function> - </funcdef> - <paramdef>float - <parameter>xmin</parameter> - </paramdef> - <paramdef>float - <parameter>xmax</parameter> - </paramdef> - <paramdef>float - <parameter>ymin</parameter> - </paramdef> - <paramdef>float - <parameter>ymax</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_viewport</methodname> + <methodparam><type>float</type><parameter>xmin</parameter></methodparam> + <methodparam><type>float</type><parameter>xmax</parameter></methodparam> + <methodparam><type>float</type><parameter>ymin</parameter></methodparam> + <methodparam><type>float</type><parameter>ymax</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_viewport</function> function selects an area for future drawing for <parameter>xmin</parameter> to @@ -1984,31 +1558,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_ortho</function> - </funcdef> - <paramdef>float - <parameter>xmin</parameter> - </paramdef> - <paramdef>float - <parameter>xmax</parameter> - </paramdef> - <paramdef>float - <parameter>ymin</parameter> - </paramdef> - <paramdef>float - <parameter>ymax</parameter> - </paramdef> - <paramdef>float - <parameter>zmin</parameter> - </paramdef> - <paramdef>float - <parameter>zmax</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_ortho</methodname> + <methodparam><type>float</type><parameter>xmin</parameter></methodparam> + <methodparam><type>float</type><parameter>xmax</parameter></methodparam> + <methodparam><type>float</type><parameter>ymin</parameter></methodparam> + <methodparam><type>float</type><parameter>ymax</parameter></methodparam> + <methodparam><type>float</type><parameter>zmin</parameter></methodparam> + <methodparam><type>float</type><parameter>zmax</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_ortho</function> funcion defines a orthographic mapping of user coordinates onto the current viewport. @@ -2026,25 +1584,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_ortho2</function> - </funcdef> - <paramdef>float - <parameter>xmin</parameter> - </paramdef> - <paramdef>float - <parameter>xmax</parameter> - </paramdef> - <paramdef>float - <parameter>ymin</parameter> - </paramdef> - <paramdef>float - <parameter>ymax</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_ortho2</methodname> + <methodparam><type>float</type><parameter>xmin</parameter></methodparam> + <methodparam><type>float</type><parameter>xmax</parameter></methodparam> + <methodparam><type>float</type><parameter>ymin</parameter></methodparam> + <methodparam><type>float</type><parameter>ymax</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_ortho2</function> function defines a two dimensional orthographic mapping of user coordinates onto the @@ -2064,25 +1610,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_perspective</function> - </funcdef> - <paramdef>float - <parameter>fovy</parameter> - </paramdef> - <paramdef>float - <parameter>aspect</parameter> - </paramdef> - <paramdef>float - <parameter>near</parameter> - </paramdef> - <paramdef>float - <parameter>far</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_perspective</methodname> + <methodparam><type>float</type><parameter>fovy</parameter></methodparam> + <methodparam><type>float</type><parameter>aspect</parameter></methodparam> + <methodparam><type>float</type><parameter>near</parameter></methodparam> + <methodparam><type>float</type><parameter>far</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_perspective</function> function defines a perspective projection transformation. The @@ -2112,25 +1646,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_polarview</function> - </funcdef> - <paramdef>float - <parameter>dist</parameter> - </paramdef> - <paramdef>float - <parameter>azimuth</parameter> - </paramdef> - <paramdef>float - <parameter>incidence</parameter> - </paramdef> - <paramdef>float - <parameter>twist</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_polarview</methodname> + <methodparam><type>float</type><parameter>dist</parameter></methodparam> + <methodparam><type>float</type><parameter>azimuth</parameter></methodparam> + <methodparam><type>float</type><parameter>incidence</parameter></methodparam> + <methodparam><type>float</type><parameter>twist</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_polarview</function> function defines the viewer's position in polar coordinates. The @@ -2156,34 +1678,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_lookat</function> - </funcdef> - <paramdef>float - <parameter>view_x</parameter> - </paramdef> - <paramdef>float - <parameter>view_y</parameter> - </paramdef> - <paramdef>float - <parameter>view_z</parameter> - </paramdef> - <paramdef>float - <parameter>reference_x</parameter> - </paramdef> - <paramdef>float - <parameter>reference_y</parameter> - </paramdef> - <paramdef>float - <parameter>reference_z</parameter> - </paramdef> - <paramdef>float - <parameter>twist</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_lookat</methodname> + <methodparam><type>float</type><parameter>view_x</parameter></methodparam> + <methodparam><type>float</type><parameter>view_y</parameter></methodparam> + <methodparam><type>float</type><parameter>view_z</parameter></methodparam> + <methodparam><type>float</type><parameter>reference_x</parameter></methodparam> + <methodparam><type>float</type><parameter>reference_y</parameter></methodparam> + <methodparam><type>float</type><parameter>reference_z</parameter></methodparam> + <methodparam><type>float</type><parameter>twist</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_lookat</function> function defines a viewing transformation by giving the viewing position (the parameters @@ -2207,14 +1711,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_pushmatrix</function> - </funcdef> + <methodsynopsis> + <type>void</type><methodname>swf_pushmatrix</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> The <function>swf_pushmatrix</function> function pushes the current transformation matrix back onto the stack. @@ -2231,14 +1731,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_popmatrix</function> - </funcdef> + <methodsynopsis> + <type>void</type><methodname>swf_popmatrix</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> The <function>swf_popmatrix</function> function pushes the current transformation matrix back onto the stack. @@ -2253,22 +1749,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_scale</function> - </funcdef> - <paramdef>float - <parameter>x</parameter> - </paramdef> - <paramdef>float - <parameter>y</parameter> - </paramdef> - <paramdef>float - <parameter>z</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_scale</methodname> + <methodparam><type>float</type><parameter>x</parameter></methodparam> + <methodparam><type>float</type><parameter>y</parameter></methodparam> + <methodparam><type>float</type><parameter>z</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_scale</function> scales the x coordinate of the curve by the value of the <parameter>x</parameter> parameter, the @@ -2286,22 +1772,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_translate</function> - </funcdef> - <paramdef>float - <parameter>x</parameter> - </paramdef> - <paramdef>float - <parameter>y</parameter> - </paramdef> - <paramdef>float - <parameter>z</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_translate</methodname> + <methodparam><type>float</type><parameter>x</parameter></methodparam> + <methodparam><type>float</type><parameter>y</parameter></methodparam> + <methodparam><type>float</type><parameter>z</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_translate</function> function translates the current transformation by the <parameter>x</parameter>, @@ -2318,19 +1794,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_rotate</function> - </funcdef> - <paramdef>float - <parameter>angle</parameter> - </paramdef> - <paramdef>string - <parameter>axis</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_rotate</methodname> + <methodparam><type>float</type><parameter>angle</parameter></methodparam> + <methodparam><type>string</type><parameter>axis</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_rotate</function> rotates the current transformation by the angle given by the @@ -2351,16 +1819,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void - <function>swf_posround</function> - </funcdef> - <paramdef>int - <parameter>round</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>swf_posround</methodname> + <methodparam><type>int</type><parameter>round</parameter></methodparam> + </methodsynopsis> <para> The <function>swf_posround</function> function enables or disables the rounding of the translation when objects are placed @@ -2394,3 +1856,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/sybase.xml diff -u phpdoc/en/functions/sybase.xml:1.21 phpdoc/en/functions/sybase.xml:1.22 --- phpdoc/en/functions/sybase.xml:1.21 Sun Jan 27 07:02:50 2002 +++ phpdoc/en/functions/sybase.xml Sat Feb 2 10:36:10 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.21 $ --> +<!-- $Revision: 1.22 $ --> <reference id="ref.sybase"> <title>Sybase functions</title> <titleabbrev>Sybase</titleabbrev> @@ -11,13 +11,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>sybase_affected_rows</function></funcdef> - <paramdef>int <parameter><optional>link_identifier</optional> - </parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>sybase_affected_rows</methodname> + <methodparam choice="opt"><type>int</type><parameter>link_identifier + </parameter></methodparam> + </methodsynopsis> <para> Returns: The number of affected rows by the last query. </para> @@ -48,12 +46,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>sybase_close</function></funcdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>sybase_close</methodname> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns: &true; on success, &false; on error </para> @@ -84,15 +80,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>sybase_connect</function></funcdef> - <paramdef>string <parameter>servername</parameter></paramdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>string <parameter><optional>charset</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>sybase_connect</methodname> + <methodparam><type>string</type><parameter>servername</parameter></methodparam> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam> + </methodsynopsis> <para> Returns: A positive Sybase link identifier on success, or &false; on error. </para> @@ -124,13 +118,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>sybase_data_seek</function></funcdef> - <paramdef>int <parameter>result_identifier</parameter></paramdef> - <paramdef>int <parameter>row_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>sybase_data_seek</methodname> + <methodparam><type>int</type><parameter>result_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>row_number</parameter></methodparam> + </methodsynopsis> <para> Returns: &true; on success, &false; on failure </para> <para> @@ -151,12 +143,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>sybase_fetch_array</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>sybase_fetch_array</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> Returns: An array that corresponds to the fetched row, or &false; if there are no more rows. </para> @@ -186,15 +176,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>sybase_fetch_field</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - <paramdef>int - <parameter><optional>field_offset</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>sybase_fetch_field</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> <para> Returns an object containing field information. </para> @@ -240,12 +226,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>sybase_fetch_object</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>sybase_fetch_object</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> Returns: An object with properties that correspond to the fetched row, or &false; if there are no more rows. </para> @@ -274,12 +258,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>sybase_fetch_row</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>sybase_fetch_row</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> Returns: An array that corresponds to the fetched row, or &false; if there are no more rows. </para> @@ -311,13 +293,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>sybase_field_seek</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - <paramdef>int <parameter>field_offset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>sybase_field_seek</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> <para> Seeks to the specified field offset. If the next call to <function>sybase_fetch_field</function> won't include a field @@ -335,12 +315,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>sybase_free_result</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>sybase_free_result</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> <function>sybase_free_result</function> only needs to be called if you are worried about using too much memory while your script @@ -359,12 +337,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>sybase_get_last_message</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>sybase_get_last_message</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> <function>sybase_get_last_message</function> returns the last message reported by the server. @@ -379,12 +355,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>sybase_min_client_severity</function></funcdef> - <paramdef>int <parameter>severity</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>sybase_min_client_severity</methodname> + <methodparam><type>int</type><parameter>severity</parameter></methodparam> + </methodsynopsis> <para> <function>sybase_min_client_severity</function> sets the minimum client severity level. @@ -408,12 +382,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>sybase_min_error_severity</function></funcdef> - <paramdef>int <parameter>severity</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>sybase_min_error_severity</methodname> + <methodparam><type>int</type><parameter>severity</parameter></methodparam> + </methodsynopsis> <para> <function>sybase_min_error_severity</function> sets the minimum error severity level. @@ -431,12 +403,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>sybase_min_message_severity</function></funcdef> - <paramdef>int <parameter>severity</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>sybase_min_message_severity</methodname> + <methodparam><type>int</type><parameter>severity</parameter></methodparam> + </methodsynopsis> <para> <function>sybase_min_message_severity</function> sets the minimum message severity level. @@ -454,12 +424,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>sybase_min_server_severity</function></funcdef> - <paramdef>int <parameter>severity</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>sybase_min_server_severity</methodname> + <methodparam><type>int</type><parameter>severity</parameter></methodparam> + </methodsynopsis> <para> <function>sybase_min_server_severity</function> sets the minimum server severity level. @@ -483,12 +451,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>sybase_num_fields</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>sybase_num_fields</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> <function>sybase_num_fields</function> returns the number of fields in a result set. @@ -510,12 +476,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>sybase_num_rows</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>sybase_num_rows</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> <function>sybase_num_rows</function> returns the number of rows in a result set. @@ -536,15 +500,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>sybase_pconnect</function></funcdef> - <paramdef>string <parameter>servername</parameter></paramdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>string <parameter><optional>charset</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>sybase_pconnect</methodname> + <methodparam><type>string</type><parameter>servername</parameter></methodparam> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam> + </methodsynopsis> <para> Returns: A positive Sybase persistent link identifier on success, or &false; on error</para> @@ -575,13 +537,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>sybase_query</function></funcdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>sybase_query</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns: A positive Sybase result identifier on success, or &false; on error. </para> @@ -608,14 +568,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>sybase_result</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - <paramdef>int <parameter>row</parameter></paramdef> - <paramdef>mixed <parameter>field</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>sybase_result</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>row</parameter></methodparam> + <methodparam><type>mixed</type><parameter>field</parameter></methodparam> + </methodsynopsis> <para> Returns: The contents of the cell at the row and offset in the specified Sybase result set. </para> @@ -652,13 +610,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>sybase_select_db</function></funcdef> - <paramdef>string <parameter>database_name</parameter></paramdef> - <paramdef>int <parameter>link_identifier</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>sybase_select_db</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> <para> Returns: &true; on success, &false; on error </para> <para> @@ -703,3 +659,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/uodbc.xml diff -u phpdoc/en/functions/uodbc.xml:1.29 phpdoc/en/functions/uodbc.xml:1.30 --- phpdoc/en/functions/uodbc.xml:1.29 Sun Dec 16 07:27:47 2001 +++ phpdoc/en/functions/uodbc.xml Sat Feb 2 10:36:10 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.29 $ --> +<!-- $Revision: 1.30 $ --> <reference id="ref.odbc"> <title>Unified ODBC functions</title> <titleabbrev>ODBC</titleabbrev> @@ -49,13 +49,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_autocommit</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - <paramdef>int <parameter><optional>OnOff</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_autocommit</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>OnOff</parameter></methodparam> + </methodsynopsis> <para> Without the <parameter>OnOff</parameter> parameter, this function returns auto-commit status for @@ -87,13 +85,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_binmode</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_binmode</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> (ODBC SQL types affected: BINARY, VARBINARY, LONGVARBINARY) </para> @@ -197,12 +193,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>odbc_close</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>odbc_close</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + </methodsynopsis> <para> <function>odbc_close</function> will close down the connection to the database server associated with the given connection @@ -224,12 +218,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>odbc_close_all</function></funcdef> + <methodsynopsis> + <type>void</type><methodname>odbc_close_all</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> <function>odbc_close_all</function> will close down all connections to database server(s). @@ -250,12 +242,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_commit</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_commit</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + </methodsynopsis> <para> Returns: &true; on success, &false; on failure. All pending transactions on @@ -271,15 +261,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_connect</function></funcdef> - <paramdef>string <parameter>dsn</parameter></paramdef> - <paramdef>string <parameter>user</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>int <parameter><optional>cursor_type</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_connect</methodname> + <methodparam><type>string</type><parameter>dsn</parameter></methodparam> + <methodparam><type>string</type><parameter>user</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>cursor_type</parameter></methodparam> + </methodsynopsis> <para> Returns an ODBC connection id or 0 (&false;) on error. @@ -340,12 +328,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>odbc_cursor</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>odbc_cursor</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> odbc_cursor will return a cursorname for the given result_id. </para> @@ -359,13 +345,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_do</function></funcdef> - <paramdef>int <parameter>conn_id</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_do</methodname> + <methodparam><type>int</type><parameter>conn_id</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> <para> <function>odbc_do</function> will execute a query on the given connection. @@ -380,12 +364,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>odbc_error</function></funcdef> - <paramdef>int <parameter><optional>connection_id</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>odbc_error</methodname> + <methodparam choice="opt"><type>int</type><parameter>connection_id</parameter></methodparam> + </methodsynopsis> <simpara> Returns a six-digit ODBC state, or an empty string if there has been no errors. If <parameter>connection_id</parameter> is @@ -406,12 +388,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>odbc_errormsg</function></funcdef> - <paramdef>int <parameter><optional>connection_id</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>odbc_errormsg</methodname> + <methodparam choice="opt"><type>int</type><parameter>connection_id</parameter></methodparam> + </methodsynopsis> <simpara> Returns a string containing the last ODBC error message, or an empty string if there has been no errors. If @@ -433,13 +413,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_exec</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - <paramdef>string <parameter>query_string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_exec</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + <methodparam><type>string</type><parameter>query_string</parameter></methodparam> + </methodsynopsis> <para> Returns &false; on error. Returns an ODBC result identifier if the SQL command was executed successfully. @@ -466,14 +444,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_execute</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>array - <parameter><optional>parameters_array</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_execute</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>parameters_array</parameter></methodparam> + </methodsynopsis> <para> Executes a statement prepared with <function>odbc_prepare</function>. Returns @@ -492,14 +467,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_fetch_into</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter><optional>rownumber</optional></parameter></paramdef> - <paramdef>array <parameter>result_array</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_fetch_into</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>rownumber</parameter></methodparam> + <methodparam><type>array</type><parameter>result_array</parameter></methodparam> + </methodsynopsis> <para> Returns the number of columns in the result; &false; on error. @@ -558,14 +531,12 @@ <para> Future: In PHP 4.1, this function will be moved to the following format: - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_fetch_into</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>array <parameter>result_array</parameter></paramdef> - <paramdef>int <parameter><optional>rownumber</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_fetch_into</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam><type>array</type><parameter>result_array</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>rownumber</parameter></methodparam> + </methodsynopsis> Please note, that <parameter>rownumber</parameter> will be optional, while <parameter>result_array</parameter> is not. </para> @@ -579,13 +550,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_fetch_row</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter><optional>row_number</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_fetch_row</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>row_number</parameter></methodparam> + </methodsynopsis> <para> If <function>odbc_fetch_row</function> was succesful (there was a row), &true; is returned. If there are no more @@ -626,13 +595,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>odbc_fetch_array</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - <paramdef>int <parameter><optional>rownumber</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>odbc_fetch_array</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>rownumber</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -648,12 +615,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>odbc_next_result</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>odbc_next_result</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -669,13 +634,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>object <function>odbc_fetch_object</function></funcdef> - <paramdef>int <parameter>result</parameter></paramdef> - <paramdef>int <parameter><optional>rownumber</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>object</type><methodname>odbc_fetch_object</methodname> + <methodparam><type>int</type><parameter>result</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>rownumber</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -689,13 +652,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>odbc_field_name</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter>field_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>odbc_field_name</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam><type>int</type><parameter>field_number</parameter></methodparam> + </methodsynopsis> <para> <function>odbc_field_name</function> will return the name of the field occupying the given column number in the given ODBC result @@ -712,13 +673,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_field_num</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>string <parameter>field_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_field_num</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam><type>string</type><parameter>field_name</parameter></methodparam> + </methodsynopsis> <para> <function>odbc_field_num</function> will return the number of the column slot that corresponds to the named field in the given ODBC @@ -735,13 +694,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>odbc_field_type</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter>field_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>odbc_field_type</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam><type>int</type><parameter>field_number</parameter></methodparam> + </methodsynopsis> <para> <function>odbc_field_type</function> will return the SQL type of the field referecend by number in the given ODBC result @@ -757,13 +714,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_field_len</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter>field_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_field_len</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam><type>int</type><parameter>field_number</parameter></methodparam> + </methodsynopsis> <para> <function>odbc_field_len</function> will return the length of the field referecend by number in the given ODBC result @@ -783,13 +738,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>odbc_field_precision</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter>field_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>odbc_field_precision</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam><type>int</type><parameter>field_number</parameter></methodparam> + </methodsynopsis> <para> <function>odbc_field_precision</function> will return the precision of the field referecend by number in the given ODBC result @@ -809,13 +762,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>odbc_field_scale</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter>field_number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>odbc_field_scale</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam><type>int</type><parameter>field_number</parameter></methodparam> + </methodsynopsis> <para> <function>odbc_field_precision</function> will return the scale of the field referecend by number in the given ODBC result @@ -831,12 +782,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_free_result</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_free_result</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> Always returns &true;. </para> @@ -869,13 +818,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_longreadlen</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>int <parameter>length</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_longreadlen</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> <para> (ODBC SQL types affected: LONG, LONGVARBINARY) The number of bytes returned to PHP is controled by the parameter length. If it @@ -898,12 +845,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_num_fields</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_num_fields</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> <function>odbc_num_fields</function> will return the number of fields (columns) in an ODBC result. This function will return -1 @@ -920,15 +865,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_pconnect</function></funcdef> - <paramdef>string <parameter>dsn</parameter></paramdef> - <paramdef>string <parameter>user</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>int <parameter><optional>cursor_type</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_pconnect</methodname> + <methodparam><type>string</type><parameter>dsn</parameter></methodparam> + <methodparam><type>string</type><parameter>user</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>cursor_type</parameter></methodparam> + </methodsynopsis> <para> Returns an ODBC connection id or 0 (&false;) on error. This function is much like @@ -963,13 +906,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_prepare</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - <paramdef>string <parameter>query_string</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_prepare</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + <methodparam><type>string</type><parameter>query_string</parameter></methodparam> + </methodsynopsis> <para> Returns &false; on error. </para> @@ -988,12 +929,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_num_rows</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_num_rows</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> <para> <function>odbc_num_rows</function> will return the number of rows in an ODBC result. This function will return -1 on error. For @@ -1017,13 +956,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>odbc_result</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>mixed <parameter>field</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>odbc_result</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam><type>mixed</type><parameter>field</parameter></methodparam> + </methodsynopsis> <para> Returns the contents of the field. </para> @@ -1079,13 +1016,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_result_all</function></funcdef> - <paramdef>int <parameter>result_id</parameter></paramdef> - <paramdef>string <parameter><optional>format</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_result_all</methodname> + <methodparam><type>int</type><parameter>result_id</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>format</parameter></methodparam> + </methodsynopsis> <para> Returns the number of rows in the result or &false; on error. @@ -1107,12 +1042,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_rollback</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_rollback</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + </methodsynopsis> <para> Rolls back all pending statements on <parameter>connection_id</parameter>. Returns @@ -1132,15 +1065,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_setoption</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - <paramdef>int <parameter>function</parameter></paramdef> - <paramdef>int <parameter>option</parameter></paramdef> - <paramdef>int <parameter>param</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_setoption</methodname> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>int</type><parameter>function</parameter></methodparam> + <methodparam><type>int</type><parameter>option</parameter></methodparam> + <methodparam><type>int</type><parameter>param</parameter></methodparam> + </methodsynopsis> <para> This function allows fiddling with the ODBC options for a particular connection or query result. It was written to help @@ -1212,16 +1143,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_tables</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - <paramdef>string <parameter><optional>qualifier</optional></parameter></paramdef> - <paramdef>string <parameter><optional>owner</optional></parameter></paramdef> - <paramdef>string <parameter><optional>name</optional></parameter></paramdef> - <paramdef>string <parameter><optional>types</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_tables</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>qualifier</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>owner</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>types</parameter></methodparam> + </methodsynopsis> <para> Lists all tables in the requested range. Returns an ODBC result identifier or &false; on failure. @@ -1309,15 +1238,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_tableprivileges</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - <paramdef>string <parameter><optional>qualifier</optional></parameter></paramdef> - <paramdef>string <parameter><optional>owner</optional></parameter></paramdef> - <paramdef>string <parameter><optional>name</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_tableprivileges</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>qualifier</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>owner</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> <para> Lists tables in the requested range and the privileges associated with each table. Returns an ODBC result identifier or @@ -1357,16 +1284,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_columns</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - <paramdef>string <parameter><optional>qualifier</optional></parameter></paramdef> - <paramdef>string <parameter><optional>owner</optional></parameter></paramdef> - <paramdef>string <parameter><optional>table_name</optional></parameter></paramdef> - <paramdef>string <parameter><optional>column_name</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_columns</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>qualifier</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>owner</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>table_name</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>column_name</parameter></methodparam> + </methodsynopsis> <para> Lists all columns in the requested range. Returns an ODBC result identifier or &false; on failure. @@ -1416,16 +1341,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_columnprivileges</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - <paramdef>string <parameter><optional>qualifier</optional></parameter></paramdef> - <paramdef>string <parameter><optional>owner</optional></parameter></paramdef> - <paramdef>string <parameter><optional>table_name</optional></parameter></paramdef> - <paramdef>string <parameter><optional>column_name</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_columnprivileges</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>qualifier</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>owner</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>table_name</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>column_name</parameter></methodparam> + </methodsynopsis> <para> Lists columns and associated privileges for the given table. Returns an ODBC result identifier or &false; on @@ -1465,13 +1388,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_gettypeinfo</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - <paramdef>int <parameter><optional>data_type</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_gettypeinfo</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>data_type</parameter></methodparam> + </methodsynopsis> <para> Retrieves information about data types supported by the data source. Returns an ODBC result identifier or @@ -1514,15 +1435,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_primarykeys</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - <paramdef>string <parameter>qualifier</parameter></paramdef> - <paramdef>string <parameter>owner</parameter></paramdef> - <paramdef>string <parameter>table</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_primarykeys</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + <methodparam><type>string</type><parameter>qualifier</parameter></methodparam> + <methodparam><type>string</type><parameter>owner</parameter></methodparam> + <methodparam><type>string</type><parameter>table</parameter></methodparam> + </methodsynopsis> <para> Returns the column names that comprise the primary key for a table. Returns an ODBC result identifier or @@ -1553,18 +1472,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_foreignkeys</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - <paramdef>string <parameter>pk_qualifier</parameter></paramdef> - <paramdef>string <parameter>pk_owner</parameter></paramdef> - <paramdef>string <parameter>pk_table</parameter></paramdef> - <paramdef>string <parameter>fk_qualifier</parameter></paramdef> - <paramdef>string <parameter>fk_owner</parameter></paramdef> - <paramdef>string <parameter>fk_table</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_foreignkeys</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + <methodparam><type>string</type><parameter>pk_qualifier</parameter></methodparam> + <methodparam><type>string</type><parameter>pk_owner</parameter></methodparam> + <methodparam><type>string</type><parameter>pk_table</parameter></methodparam> + <methodparam><type>string</type><parameter>fk_qualifier</parameter></methodparam> + <methodparam><type>string</type><parameter>fk_owner</parameter></methodparam> + <methodparam><type>string</type><parameter>fk_table</parameter></methodparam> + </methodsynopsis> <para> <function>odbc_foreignkeys</function> retrieves information about foreign keys. Returns an ODBC result identifier or @@ -1621,15 +1538,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_procedures</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - <paramdef>string <parameter><optional>qualifier</optional></parameter></paramdef> - <paramdef>string <parameter><optional>owner</optional></parameter></paramdef> - <paramdef>string <parameter><optional>name</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_procedures</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>qualifier</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>owner</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> <para> Lists all procedures in the requested range. Returns an ODBC result identifier or &false; on failure. @@ -1664,16 +1579,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_procedurecolumns</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - <paramdef>string <parameter><optional>qualifier</optional></parameter></paramdef> - <paramdef>string <parameter><optional>owner</optional></parameter></paramdef> - <paramdef>string <parameter><optional>proc</optional></parameter></paramdef> - <paramdef>string <parameter><optional>column</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_procedurecolumns</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>qualifier</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>owner</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>proc</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>column</parameter></methodparam> + </methodsynopsis> <para> Returns the list of input and output parameters, as well as the columns that make up the result set for the specified procedures. Returns @@ -1720,18 +1633,16 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_specialcolumns</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - <paramdef>int <parameter>type</parameter></paramdef> - <paramdef>string <parameter>qualifier</parameter></paramdef> - <paramdef>string <parameter>owner</parameter></paramdef> - <paramdef>string <parameter>table</parameter></paramdef> - <paramdef>int <parameter>scope</parameter></paramdef> - <paramdef>int <parameter>nullable</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_specialcolumns</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + <methodparam><type>int</type><parameter>type</parameter></methodparam> + <methodparam><type>string</type><parameter>qualifier</parameter></methodparam> + <methodparam><type>string</type><parameter>owner</parameter></methodparam> + <methodparam><type>string</type><parameter>table</parameter></methodparam> + <methodparam><type>int</type><parameter>scope</parameter></methodparam> + <methodparam><type>int</type><parameter>nullable</parameter></methodparam> + </methodsynopsis> <simpara> When the type argument is SQL_BEST_ROWID, <function>odbc_specialcolumns</function> returns the @@ -1774,17 +1685,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>odbc_statistics</function></funcdef> - <paramdef>int <parameter>connection_id</parameter></paramdef> - <paramdef>string <parameter>qualifier</parameter></paramdef> - <paramdef>string <parameter>owner</parameter></paramdef> - <paramdef>string <parameter>table_name</parameter></paramdef> - <paramdef>int <parameter>unique</parameter></paramdef> - <paramdef>int <parameter>accuracy</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>odbc_statistics</methodname> + <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> + <methodparam><type>string</type><parameter>qualifier</parameter></methodparam> + <methodparam><type>string</type><parameter>owner</parameter></methodparam> + <methodparam><type>string</type><parameter>table_name</parameter></methodparam> + <methodparam><type>int</type><parameter>unique</parameter></methodparam> + <methodparam><type>int</type><parameter>accuracy</parameter></methodparam> + </methodsynopsis> <para> Get statistics about a table and it's indexes. Returns an ODBC result identifier or &false; on failure. @@ -1836,3 +1745,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/url.xml diff -u phpdoc/en/functions/url.xml:1.25 phpdoc/en/functions/url.xml:1.26 --- phpdoc/en/functions/url.xml:1.25 Thu Dec 20 17:19:32 2001 +++ phpdoc/en/functions/url.xml Sat Feb 2 10:36:10 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.25 $ --> +<!-- $Revision: 1.26 $ --> <reference id="ref.url"> <title>URL Functions</title> <titleabbrev>URLs</titleabbrev> @@ -11,12 +11,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>base64_decode</function></funcdef> - <paramdef>string <parameter>encoded_data</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>base64_decode</methodname> + <methodparam><type>string</type><parameter>encoded_data</parameter></methodparam> + </methodsynopsis> <para> <function>base64_decode</function> decodes <parameter>encoded_data</parameter> and returns the original @@ -36,12 +34,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>base64_encode</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>base64_encode</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> <para> <function>base64_encode</function> returns <parameter>data</parameter> encoded with base64. This encoding @@ -67,12 +63,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>parse_url</function></funcdef> - <paramdef>string <parameter>url</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>parse_url</methodname> + <methodparam><type>string</type><parameter>url</parameter></methodparam> + </methodsynopsis> <para> This function returns an associative array returning any of the various components of the URL that are present. This includes the @@ -92,12 +86,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>rawurldecode</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>rawurldecode</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> Returns a string in which the sequences with percent (<literal>%</literal>) signs followed by two hex digits have been @@ -125,12 +117,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>rawurlencode</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>rawurlencode</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> Returns a string in which all non-alphanumeric characters except <screen>-_.</screen> have been replaced with a percent @@ -177,12 +167,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>urldecode</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>urldecode</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> Decodes any <literal>%<replaceable>##</replaceable></literal> encoding in the given string. The decoded string is returned. @@ -217,12 +205,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>urlencode</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>urlencode</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <para> Returns a string in which all non-alphanumeric characters except <literal>-_.</literal> have been replaced with a percent @@ -299,3 +285,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/var.xml diff -u phpdoc/en/functions/var.xml:1.91 phpdoc/en/functions/var.xml:1.92 --- phpdoc/en/functions/var.xml:1.91 Sun Jan 27 07:02:50 2002 +++ phpdoc/en/functions/var.xml Sat Feb 2 10:36:10 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.91 $ --> +<!-- $Revision: 1.92 $ --> <reference id="ref.variables"> <title>Variable Functions</title> <titleabbrev>Variables</titleabbrev> @@ -40,12 +40,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>empty</function></funcdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>empty</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> <note> <para> <function>empty</function> is a language construct. @@ -99,12 +97,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>float <function>floatval</function></funcdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>float</type><methodname>floatval</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> <simpara> Returns the <type>float</type> value of <parameter>var</parameter>. </simpara> @@ -137,12 +133,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>gettype</function></funcdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>gettype</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> <para> Returns the type of the PHP variable <parameter>var</parameter>. @@ -226,12 +220,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>get_defined_vars</function></funcdef> + <methodsynopsis> + <type>array</type><methodname>get_defined_vars</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This function returns an multidimensional array containing a list of all defined variables, be them environment, server or user-defined @@ -277,12 +269,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>get_resource_type</function></funcdef> - <paramdef>resource <parameter>handle</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>get_resource_type</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> <para> This function returns a string representing the type of the <type>resource</type> passed to it. If the paramater is not a @@ -316,15 +306,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>import_request_variables</function></funcdef> - <paramdef>string <parameter>types</parameter></paramdef> - <paramdef>string - <parameter><optional>prefix</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>import_request_variables</methodname> + <methodparam><type>string</type><parameter>types</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>prefix</parameter></methodparam> + </methodsynopsis> <simpara> Imports GET/POST/Cookie variables into the global scope. It is useful if you disabled @@ -375,15 +361,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>intval</function></funcdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - <paramdef>int - <parameter><optional>base</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>intval</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>base</parameter></methodparam> + </methodsynopsis> <simpara> Returns the <type>integer</type> value of <parameter>var</parameter>, using the specified base for the conversion (the default is @@ -416,12 +398,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>is_array</function></funcdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_array</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if <parameter>var</parameter> is an <type>array</type>, &false; otherwise. @@ -446,16 +426,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool - <function>is_bool</function> - </funcdef> - <paramdef>mixed - <parameter>var</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_bool</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if the <parameter>var</parameter> parameter is a <type>boolean</type>. @@ -492,12 +466,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>is_float</function></funcdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_float</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> <simpara> Returns &true; if <parameter>var</parameter> is a <type>float</type>, &false; otherwise. @@ -529,12 +501,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>is_int</function></funcdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_int</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> <simpara> Returns &true; if <parameter>var</parameter> is an <type>integer</type> &false; otherwise. @@ -593,12 +563,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>is_null</function></funcdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_null</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if <parameter>var</parameter> is <type>null</type>, &false; otherwise. @@ -625,12 +593,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>is_numeric</function></funcdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_numeric</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if <parameter>var</parameter> is a number or a numeric string, &false; otherwise. @@ -654,12 +620,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>is_object</function></funcdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_object</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if <parameter>var</parameter> is an <type>object</type>, &false; otherwise. @@ -697,16 +661,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool - <function>is_resource</function> - </funcdef> - <paramdef>mixed - <parameter>var</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_resource</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> <para> <function>is_resource</function> returns &true; if the variable given by the <parameter>var</parameter> parameter is a @@ -728,16 +686,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool - <function>is_scalar</function> - </funcdef> - <paramdef>mixed - <parameter>var</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_scalar</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> <para> <function>is_scalar</function> returns &true; if the variable given by the <parameter>var</parameter> parameter is a scalar, @@ -810,12 +762,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>is_string</function></funcdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_string</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if <parameter>var</parameter> is a <type>string</type>, &false; otherwise. @@ -839,12 +789,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>boolean <function>isset</function></funcdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>boolean</type><methodname>isset</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> <simpara> Returns &true; if <parameter>var</parameter> exists; &false; otherwise. @@ -886,12 +834,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>print_r</function></funcdef> - <paramdef>mixed <parameter>expression</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>print_r</methodname> + <methodparam><type>mixed</type><parameter>expression</parameter></methodparam> + </methodsynopsis> <simpara> <function>print_r</function> displays information about a variable in a way that's readable by humans. If given a <type>string</type>, @@ -967,12 +913,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>serialize</function></funcdef> - <paramdef>mixed <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>serialize</methodname> + <methodparam><type>mixed</type><parameter>value</parameter></methodparam> + </methodsynopsis> <simpara> <function>serialize</function> returns a string containing a byte-stream representation of <parameter>value</parameter> that @@ -1049,13 +993,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>settype</function></funcdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - <paramdef>string <parameter>type</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>settype</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + <methodparam><type>string</type><parameter>type</parameter></methodparam> + </methodsynopsis> <para> Set the type of variable <parameter>var</parameter> to <parameter>type</parameter>. @@ -1134,12 +1076,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>strval</function></funcdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>strval</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + </methodsynopsis> <simpara> Returns the <type>string</type> value of <parameter>var</parameter>. See the documentation on <type>string</type> for more information @@ -1167,12 +1107,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>unserialize</function></funcdef> - <paramdef>string <parameter>str</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>unserialize</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> <simpara> <function>unserialize</function> takes a single serialized variable (see <function>serialize</function>) and converts it @@ -1260,14 +1198,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>unset</function></funcdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - <paramdef>mixed <parameter><optional>var</optional></parameter></paramdef> - <paramdef><parameter><optional>...</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>unset</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>var</parameter></methodparam> + <methodparam choice="opt"><parameter>...</parameter></methodparam> + </methodsynopsis> <para> <function>unset</function> destroys the specified variables. Note that in PHP 3, <function>unset</function> will always return &true; @@ -1425,14 +1361,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>var_dump</function></funcdef> - <paramdef>mixed <parameter>expression</parameter></paramdef> - <paramdef>mixed <parameter><optional>expression</optional></parameter></paramdef> - <paramdef><parameter><optional>...</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>var_dump</methodname> + <methodparam><type>mixed</type><parameter>expression</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>expression</parameter></methodparam> + <methodparam choice="opt"><parameter>...</parameter></methodparam> + </methodsynopsis> <simpara> This function returns structured information about one or more expressions that includes its type and value. Arrays are explored @@ -1496,13 +1430,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>var_export</function></funcdef> - <paramdef>mixed <parameter>expression</parameter></paramdef> - <paramdef>int <parameter><optional>return</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>var_export</methodname> + <methodparam><type>mixed</type><parameter>expression</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>return</parameter></methodparam> + </methodsynopsis> <simpara> This function returns structured information about the variable that is passed to this function. It is similar to <function>var_dump</function> @@ -1563,14 +1495,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>is_callable</function></funcdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - <paramdef>bool <parameter><optional>syntax_only</optional></parameter></paramdef> - <paramdef>string <parameter><optional>callable_name</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>is_callable</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>syntax_only</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>callable_name</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -1600,3 +1530,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/vpopmail.xml diff -u phpdoc/en/functions/vpopmail.xml:1.1 phpdoc/en/functions/vpopmail.xml:1.2 --- phpdoc/en/functions/vpopmail.xml:1.1 Sat Dec 15 09:54:58 2001 +++ phpdoc/en/functions/vpopmail.xml Sat Feb 2 10:36:10 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <reference id="ref.vpopmail"> <title>vpopmail functions</title> <titleabbrev>vpopmail functions</titleabbrev> @@ -17,15 +17,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>vpopmail_add_domain</function></funcdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>dir</parameter></paramdef> - <paramdef>int <parameter>uid</parameter></paramdef> - <paramdef>int <parameter>gid</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>vpopmail_add_domain</methodname> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>dir</parameter></methodparam> + <methodparam><type>int</type><parameter>uid</parameter></methodparam> + <methodparam><type>int</type><parameter>gid</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -40,12 +38,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>vpopmail_del_domain</function></funcdef> - <paramdef>string <parameter>domain</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>vpopmail_del_domain</methodname> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -60,13 +56,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>vpopmail_add_alias_domain</function></funcdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>aliasdomain</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>vpopmail_add_alias_domain</methodname> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>aliasdomain</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -81,22 +75,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>vpopmail_add_domain_ex</function></funcdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>passwd</parameter></paramdef> - <paramdef>string - <parameter><optional>quota</optional></parameter> - </paramdef> - <paramdef>string - <parameter><optional>bounce</optional></parameter> - </paramdef> - <paramdef>bool - <parameter><optional>apop</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>vpopmail_add_domain_ex</methodname> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>passwd</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>quota</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>bounce</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>apop</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -111,12 +97,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>vpopmail_del_domain_ex</function></funcdef> - <paramdef>string <parameter>domain</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>vpopmail_del_domain_ex</methodname> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -131,13 +115,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>vpopmail_add_alias_domain_ex</function></funcdef> - <paramdef>string <parameter>olddomain</parameter></paramdef> - <paramdef>string <parameter>newdomain</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>vpopmail_add_alias_domain_ex</methodname> + <methodparam><type>string</type><parameter>olddomain</parameter></methodparam> + <methodparam><type>string</type><parameter>newdomain</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -152,20 +134,14 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>vpopmail_add_user</function></funcdef> - <paramdef>string <parameter>user</parameter></paramdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>string - <parameter><optional>gecos</optional></parameter> - </paramdef> - <paramdef>bool - <parameter><optional>apop</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>vpopmail_add_user</methodname> + <methodparam><type>string</type><parameter>user</parameter></methodparam> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>gecos</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>apop</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -180,13 +156,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>vpopmail_del_user</function></funcdef> - <paramdef>string <parameter>user</parameter></paramdef> - <paramdef>string <parameter>domain</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>vpopmail_del_user</methodname> + <methodparam><type>string</type><parameter>user</parameter></methodparam> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -201,14 +175,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>vpopmail_passwd</function></funcdef> - <paramdef>string <parameter>user</parameter></paramdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>vpopmail_passwd</methodname> + <methodparam><type>string</type><parameter>user</parameter></methodparam> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -223,14 +195,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>vpopmail_set_user_quota</function></funcdef> - <paramdef>string <parameter>user</parameter></paramdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>quota</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>vpopmail_set_user_quota</methodname> + <methodparam><type>string</type><parameter>user</parameter></methodparam> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>quota</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -245,17 +215,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>vpopmail_auth_user</function></funcdef> - <paramdef>string <parameter>user</parameter></paramdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>string - <parameter><optional>apop</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>vpopmail_auth_user</methodname> + <methodparam><type>string</type><parameter>user</parameter></methodparam> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>apop</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -270,14 +236,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>vpopmail_alias_add</function></funcdef> - <paramdef>string <parameter>user</parameter></paramdef> - <paramdef>string <parameter>domain</parameter></paramdef> - <paramdef>string <parameter>alias</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>vpopmail_alias_add</methodname> + <methodparam><type>string</type><parameter>user</parameter></methodparam> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + <methodparam><type>string</type><parameter>alias</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -292,13 +256,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>vpopmail_alias_del</function></funcdef> - <paramdef>string <parameter>user</parameter></paramdef> - <paramdef>string <parameter>domain</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>vpopmail_alias_del</methodname> + <methodparam><type>string</type><parameter>user</parameter></methodparam> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -313,12 +275,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>vpopmail_alias_del_domain</function></funcdef> - <paramdef>string <parameter>domain</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>vpopmail_alias_del_domain</methodname> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -333,13 +293,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>vpopmail_alias_get</function></funcdef> - <paramdef>string <parameter>alias</parameter></paramdef> - <paramdef>string <parameter>domain</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>vpopmail_alias_get</methodname> + <methodparam><type>string</type><parameter>alias</parameter></methodparam> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -354,12 +312,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>vpopmail_alias_get_all</function></funcdef> - <paramdef>string <parameter>domain</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>vpopmail_alias_get_all</methodname> + <methodparam><type>string</type><parameter>domain</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -374,12 +330,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>vpopmail_error</function></funcdef> + <methodsynopsis> + <type>string</type><methodname>vpopmail_error</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -409,4 +363,5 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/w32api.xml diff -u phpdoc/en/functions/w32api.xml:1.1 phpdoc/en/functions/w32api.xml:1.2 --- phpdoc/en/functions/w32api.xml:1.1 Sat Dec 15 09:54:58 2001 +++ phpdoc/en/functions/w32api.xml Sat Feb 2 10:36:10 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <reference id="ref.w32api"> <title>W32api functions</title> <titleabbrev>W32api functions</titleabbrev> @@ -17,12 +17,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>w32api_set_call_method</function></funcdef> - <paramdef>int <parameter>method</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>w32api_set_call_method</methodname> + <methodparam><type>int</type><parameter>method</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -37,13 +35,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>w32api_register_function</function></funcdef> - <paramdef>string <parameter>libary</parameter></paramdef> - <paramdef>string <parameter>function_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>w32api_register_function</methodname> + <methodparam><type>string</type><parameter>libary</parameter></methodparam> + <methodparam><type>string</type><parameter>function_name</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -58,12 +54,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>w32api_invoke_function</function></funcdef> - <paramdef>string <parameter>funcname</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>w32api_invoke_function</methodname> + <methodparam><type>string</type><parameter>funcname</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -78,14 +72,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>w32api_deftype</function></funcdef> - <paramdef>string <parameter>typename</parameter></paramdef> - <paramdef>string <parameter>member1_type</parameter></paramdef> - <paramdef>string <parameter>member1_name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>w32api_deftype</methodname> + <methodparam><type>string</type><parameter>typename</parameter></methodparam> + <methodparam><type>string</type><parameter>member1_type</parameter></methodparam> + <methodparam><type>string</type><parameter>member1_name</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -100,14 +92,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>w32api_init_dtype</function></funcdef> - <paramdef>string <parameter>typename</parameter></paramdef> - <paramdef>mixed <parameter>val1</parameter></paramdef> - <paramdef>mixed <parameter>val2</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>w32api_init_dtype</methodname> + <methodparam><type>string</type><parameter>typename</parameter></methodparam> + <methodparam><type>mixed</type><parameter>val1</parameter></methodparam> + <methodparam><type>mixed</type><parameter>val2</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -137,4 +127,5 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/wddx.xml diff -u phpdoc/en/functions/wddx.xml:1.18 phpdoc/en/functions/wddx.xml:1.19 --- phpdoc/en/functions/wddx.xml:1.18 Wed Jan 2 20:57:48 2002 +++ phpdoc/en/functions/wddx.xml Sat Feb 2 10:36:10 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.18 $ --> +<!-- $Revision: 1.19 $ --> <reference id="ref.wddx"> <title>WDDX Functions</title> <titleabbrev>WDDX</titleabbrev> @@ -92,15 +92,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string - <function>wddx_serialize_value</function></funcdef> - <paramdef>mixed <parameter>var</parameter></paramdef> - <paramdef>string - <parameter><optional>comment</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>wddx_serialize_value</methodname> + <methodparam><type>mixed</type><parameter>var</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>comment</parameter></methodparam> + </methodsynopsis> <para> <function>wddx_serialize_value</function> is used to create a WDDX packet from a single given value. It takes the value @@ -118,15 +114,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>wddx_serialize_vars</function></funcdef> - <paramdef>mixed <parameter>var_name</parameter></paramdef> - <paramdef>mixed - <parameter><optional>...</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>wddx_serialize_vars</methodname> + <methodparam><type>mixed</type><parameter>var_name</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam> + </methodsynopsis> <para> <function>wddx_serialize_vars</function> is used to create a WDDX packet with a structure that contains the serialized @@ -179,13 +171,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>wddx_packet_start</function></funcdef> - <paramdef>string - <parameter><optional>comment</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>wddx_packet_start</methodname> + <methodparam choice="opt"><type>string</type><parameter>comment</parameter></methodparam> + </methodsynopsis> <para> Use <function>wddx_packet_start</function> to start a new WDDX packet for incremental addition of variables. It takes an @@ -203,12 +192,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>wddx_packet_end</function></funcdef> - <paramdef>int <parameter>packet_id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>wddx_packet_end</methodname> + <methodparam><type>int</type><parameter>packet_id</parameter></methodparam> + </methodsynopsis> <para> <function>wddx_packet_end</function> ends the WDDX packet specified by the <parameter>packet_id</parameter> and returns the @@ -226,16 +213,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef><function>wddx_add_vars</function></funcdef> - <paramdef>int <parameter>packet_id</parameter></paramdef> - <paramdef>mixed <parameter>name_var</parameter></paramdef> - <paramdef>mixed - <parameter><optional>...</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <methodname>wddx_add_vars</methodname> + <methodparam><type>int</type><parameter>packet_id</parameter></methodparam> + <methodparam><type>mixed</type><parameter>name_var</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam> + </methodsynopsis> <para> <function>wddx_add_vars</function> is used to serialize passed variables and add the result to the packet specified by the @@ -253,12 +236,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>wddx_deserialize</function></funcdef> - <paramdef>string <parameter>packet</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>wddx_deserialize</methodname> + <methodparam><type>string</type><parameter>packet</parameter></methodparam> + </methodsynopsis> <para> <function>wddx_deserialize</function> takes a <parameter>packet</parameter> string and deserializes it. It @@ -289,3 +270,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/xml.xml diff -u phpdoc/en/functions/xml.xml:1.25 phpdoc/en/functions/xml.xml:1.26 --- phpdoc/en/functions/xml.xml:1.25 Thu Dec 20 18:59:02 2001 +++ phpdoc/en/functions/xml.xml Sat Feb 2 10:36:10 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.25 $ --> +<!-- $Revision: 1.26 $ --> <reference id="ref.xml"> <title>XML parser functions</title> <titleabbrev>XML</titleabbrev> @@ -581,14 +581,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>xml_parser_create</function></funcdef> - <paramdef>string - <parameter><optional>encoding</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xml_parser_create</methodname> + <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> <para> <variablelist> <varlistentry> @@ -620,13 +616,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>xml_set_object</function></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>object <parameter>&amp;object</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>xml_set_object</methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + <methodparam><type>object</type><parameter>&amp;object</parameter></methodparam> + </methodsynopsis> <para> This function allows to use <parameter>parser</parameter> inside <parameter>object</parameter>. All callback functions could be @@ -679,20 +673,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>xml_set_element_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string - <parameter>startElementHandler</parameter> - </paramdef> - <paramdef>string - <parameter>endElementHandler</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xml_set_element_handler</methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>startElementHandler</parameter></methodparam> + <methodparam><type>string</type><parameter>endElementHandler</parameter></methodparam> + </methodsynopsis> <para> Sets the element handler functions for the XML parser <parameter>parser</parameter>. @@ -705,14 +691,12 @@ <para> The function named by <parameter>startElementHandler</parameter> must accept three parameters: - <funcsynopsis> - <funcprototype> - <funcdef><replaceable>startElementHandler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>array <parameter>attribs</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <methodname><replaceable>startElementHandler</replaceable></methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>array</type><parameter>attribs</parameter></methodparam> + </methodsynopsis> <variablelist> <varlistentry> <term><parameter>parser</parameter></term> @@ -761,13 +745,11 @@ <para> The function named by <parameter>endElementHandler</parameter> must accept two parameters: - <funcsynopsis> - <funcprototype> - <funcdef><replaceable>endElementHandler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <methodname><replaceable>endElementHandler</replaceable></methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> <variablelist> <varlistentry> <term><parameter>parser</parameter></term> @@ -812,15 +794,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>xml_set_character_data_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>handler</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xml_set_character_data_handler</methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>handler</parameter></methodparam> + </methodsynopsis> <para> Sets the character data handler function for the XML parser <parameter>parser</parameter>. <parameter>handler</parameter> is @@ -830,13 +808,11 @@ <para> The function named by <parameter>handler</parameter> must accept two parameters: - <funcsynopsis> - <funcprototype> - <funcdef><replaceable>handler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <methodname><replaceable>handler</replaceable></methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> <variablelist> <varlistentry> <term><parameter>parser</parameter></term> @@ -879,15 +855,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>xml_set_processing_instruction_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>handler</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xml_set_processing_instruction_handler</methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>handler</parameter></methodparam> + </methodsynopsis> <para> Sets the processing instruction (PI) handler function for the XML parser <parameter>parser</parameter>. @@ -913,14 +885,12 @@ <para> The function named by <parameter>handler</parameter> must accept three parameters: - <funcsynopsis> - <funcprototype> - <funcdef><replaceable>handler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>target</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <methodname><replaceable>handler</replaceable></methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>target</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> <variablelist> <varlistentry> <term><parameter>parser</parameter></term> <listitem><simpara> @@ -960,15 +930,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>xml_set_default_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>handler</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xml_set_default_handler</methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>handler</parameter></methodparam> + </methodsynopsis> <para> Sets the default handler function for the XML parser <parameter>parser</parameter>. <parameter>handler</parameter> is @@ -978,13 +944,11 @@ <para> The function named by <parameter>handler</parameter> must accept two parameters: - <funcsynopsis> - <funcprototype> - <funcdef><replaceable>handler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <methodname><replaceable>handler</replaceable></methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> <variablelist> <varlistentry> <term> @@ -1034,15 +998,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>xml_set_unparsed_entity_decl_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>handler</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xml_set_unparsed_entity_decl_handler</methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>handler</parameter></methodparam> + </methodsynopsis> <para> Sets the unparsed entity declaration handler function for the XML parser <parameter>parser</parameter>. @@ -1065,17 +1025,15 @@ </para> <para> The function named by <parameter>handler</parameter> must accept six parameters: - <funcsynopsis> - <funcprototype> - <funcdef><replaceable>handler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>entityName</parameter></paramdef> - <paramdef>string <parameter>base</parameter></paramdef> - <paramdef>string <parameter>systemId</parameter></paramdef> - <paramdef>string <parameter>publicId</parameter></paramdef> - <paramdef>string <parameter>notationName</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <methodname><replaceable>handler</replaceable></methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>entityName</parameter></methodparam> + <methodparam><type>string</type><parameter>base</parameter></methodparam> + <methodparam><type>string</type><parameter>systemId</parameter></methodparam> + <methodparam><type>string</type><parameter>publicId</parameter></methodparam> + <methodparam><type>string</type><parameter>notationName</parameter></methodparam> + </methodsynopsis> <variablelist> <varlistentry> <term><parameter>parser</parameter></term> @@ -1150,15 +1108,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>xml_set_notation_decl_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>handler</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xml_set_notation_decl_handler</methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>handler</parameter></methodparam> + </methodsynopsis> <para> Sets the notation declaration handler function for the XML parser <parameter>parser</parameter>. <parameter>handler</parameter> is @@ -1177,16 +1131,14 @@ <para> The function named by <parameter>handler</parameter> must accept five parameters: - <funcsynopsis> - <funcprototype> - <funcdef><replaceable>handler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>notationName</parameter></paramdef> - <paramdef>string <parameter>base</parameter></paramdef> - <paramdef>string <parameter>systemId</parameter></paramdef> - <paramdef>string <parameter>publicId</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <methodname><replaceable>handler</replaceable></methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>notationName</parameter></methodparam> + <methodparam><type>string</type><parameter>base</parameter></methodparam> + <methodparam><type>string</type><parameter>systemId</parameter></methodparam> + <methodparam><type>string</type><parameter>publicId</parameter></methodparam> + </methodsynopsis> <variablelist> <varlistentry> <term> @@ -1264,15 +1216,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>xml_set_external_entity_ref_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>handler</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xml_set_external_entity_ref_handler</methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>handler</parameter></methodparam> + </methodsynopsis> <para> Sets the notation declaration handler function for the XML parser <parameter>parser</parameter>. <parameter>handler</parameter> is @@ -1287,18 +1235,14 @@ value is returned), the XML parser will stop parsing and <function>xml_get_error_code</function> will return <systemitem class="constant">XML_ERROR_EXTERNAL_ENTITY_HANDLING</systemitem>. - <funcsynopsis> - <funcprototype> - <funcdef>int <replaceable>handler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string - <parameter>openEntityNames</parameter> - </paramdef> - <paramdef>string <parameter>base</parameter></paramdef> - <paramdef>string <parameter>systemId</parameter></paramdef> - <paramdef>string <parameter>publicId</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname><replaceable>handler</replaceable></methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>openEntityNames</parameter></methodparam> + <methodparam><type>string</type><parameter>base</parameter></methodparam> + <methodparam><type>string</type><parameter>systemId</parameter></methodparam> + <methodparam><type>string</type><parameter>publicId</parameter></methodparam> + </methodsynopsis> <variablelist> <varlistentry> <term><parameter>parser</parameter></term> @@ -1374,16 +1318,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>xml_parse</function></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>int - <parameter><optional>isFinal</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xml_parse</methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>isFinal</parameter></methodparam> + </methodsynopsis> <para> <variablelist> <varlistentry> @@ -1441,12 +1381,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>xml_get_error_code</function></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xml_get_error_code</methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + </methodsynopsis> <para> <variablelist> <varlistentry> @@ -1475,12 +1413,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>xml_error_string</function></funcdef> - <paramdef>int <parameter>code</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>xml_error_string</methodname> + <methodparam><type>int</type><parameter>code</parameter></methodparam> + </methodsynopsis> <para> <variablelist> <varlistentry> @@ -1507,14 +1443,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>xml_get_current_line_number</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xml_get_current_line_number</methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + </methodsynopsis> <para> <variablelist> <varlistentry> @@ -1544,14 +1476,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>xml_get_current_column_number</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xml_get_current_column_number</methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + </methodsynopsis> <para> <variablelist> <varlistentry> @@ -1581,14 +1509,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>xml_get_current_byte_index</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xml_get_current_byte_index</methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + </methodsynopsis> <para> <variablelist> <varlistentry> @@ -1616,15 +1540,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>xml_parse_into_struct</function></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>array <parameter>&amp;values</parameter></paramdef> - <paramdef>array <parameter>&amp;index</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xml_parse_into_struct</methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam><type>array</type><parameter>&amp;values</parameter></methodparam> + <methodparam><type>array</type><parameter>&amp;index</parameter></methodparam> + </methodsynopsis> <para> This function parses an XML file into 2 parallel array structures, one (<parameter>index</parameter>) containing pointers @@ -1840,12 +1762,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>xml_parser_free</function></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>xml_parser_free</methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + </methodsynopsis> <para> <variablelist> <varlistentry> @@ -1872,14 +1792,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>xml_parser_set_option</function></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>int <parameter>option</parameter></paramdef> - <paramdef>mixed <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xml_parser_set_option</methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + <methodparam><type>int</type><parameter>option</parameter></methodparam> + <methodparam><type>mixed</type><parameter>value</parameter></methodparam> + </methodsynopsis> <para> <variablelist> <varlistentry> @@ -1961,15 +1879,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed - <function>xml_parser_get_option</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>int <parameter>option</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>xml_parser_get_option</methodname> + <methodparam><type>int</type><parameter>parser</parameter></methodparam> + <methodparam><type>int</type><parameter>option</parameter></methodparam> + </methodsynopsis> <para> <variablelist> <varlistentry> @@ -2015,12 +1929,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>utf8_decode</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>utf8_decode</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> <para> This function decodes <parameter>data</parameter>, assumed to be <literal>UTF-8</literal> encoded, to <literal>ISO-8859-1</literal>. @@ -2039,12 +1951,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>utf8_encode</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>utf8_encode</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> <para> This function encodes the string <parameter>data</parameter> to <literal>UTF-8</literal>, and returns the encoded version. @@ -2107,13 +2017,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>xml_parser_create_ns</function></funcdef> - <paramdef>string <parameter><optional>encoding</optional></parameter></paramdef> - <paramdef>string <parameter><optional>sep</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xml_parser_create_ns</methodname> + <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>sep</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2131,13 +2039,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>xml_set_end_namespace_decl_handler</function></funcdef> - <paramdef>int <parameter>pind</parameter></paramdef> - <paramdef>string <parameter>hdl</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xml_set_end_namespace_decl_handler</methodname> + <methodparam><type>int</type><parameter>pind</parameter></methodparam> + <methodparam><type>string</type><parameter>hdl</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2156,13 +2062,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>xml_set_start_namespace_decl_handler</function></funcdef> - <paramdef>int <parameter>pind</parameter></paramdef> - <paramdef>string <parameter>hdl</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xml_set_start_namespace_decl_handler</methodname> + <methodparam><type>int</type><parameter>pind</parameter></methodparam> + <methodparam><type>string</type><parameter>hdl</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -2193,3 +2097,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/xmlrpc.xml diff -u phpdoc/en/functions/xmlrpc.xml:1.3 phpdoc/en/functions/xmlrpc.xml:1.4 --- phpdoc/en/functions/xmlrpc.xml:1.3 Fri Dec 28 07:44:29 2001 +++ phpdoc/en/functions/xmlrpc.xml Sat Feb 2 10:36:11 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <reference id="ref.xmlrpc"> <title>XMLRPC functions</title> <titleabbrev>XMLRPC function</titleabbrev> @@ -18,13 +18,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>xmlrpc_encode_request</function></funcdef> - <paramdef>string <parameter>method</parameter></paramdef> - <paramdef>mixed <parameter>params</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>xmlrpc_encode_request</methodname> + <methodparam><type>string</type><parameter>method</parameter></methodparam> + <methodparam><type>mixed</type><parameter>params</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -39,12 +37,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>xmlrpc_encode</function></funcdef> - <paramdef>mixed <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>xmlrpc_encode</methodname> + <methodparam><type>mixed</type><parameter>value</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -59,16 +55,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>xmlrpc_decode_request</function></funcdef> - <paramdef>string <parameter>xml</parameter></paramdef> - <paramdef>string <parameter>method</parameter></paramdef> - <paramdef>string - <parameter><optional>encoding</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>xmlrpc_decode_request</methodname> + <methodparam><type>string</type><parameter>xml</parameter></methodparam> + <methodparam><type>string</type><parameter>method</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -83,15 +75,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>xmlrpc_decode</function></funcdef> - <paramdef>string <parameter>xml</parameter></paramdef> - <paramdef>string - <parameter><optional>encoding</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>xmlrpc_decode</methodname> + <methodparam><type>string</type><parameter>xml</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -106,12 +94,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>xmlrpc_server_create</function></funcdef> + <methodsynopsis> + <type>resource</type><methodname>xmlrpc_server_create</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -126,12 +112,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>xmlrpc_server_destroy</function></funcdef> - <paramdef>resource <parameter>server</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>xmlrpc_server_destroy</methodname> + <methodparam><type>resource</type><parameter>server</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -146,14 +130,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>xmlrpc_server_register_method</function></funcdef> - <paramdef>resource <parameter>server</parameter></paramdef> - <paramdef>string <parameter>method_name</parameter></paramdef> - <paramdef>string <parameter>function</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>xmlrpc_server_register_method</methodname> + <methodparam><type>resource</type><parameter>server</parameter></methodparam> + <methodparam><type>string</type><parameter>method_name</parameter></methodparam> + <methodparam><type>string</type><parameter>function</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -168,13 +150,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>xmlrpc_server_register_introspection_callback</function></funcdef> - <paramdef>resource <parameter>server</parameter></paramdef> - <paramdef>string <parameter>function</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>xmlrpc_server_register_introspection_callback</methodname> + <methodparam><type>resource</type><parameter>server</parameter></methodparam> + <methodparam><type>string</type><parameter>function</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -189,17 +169,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>xmlrpc_server_call_method</function></funcdef> - <paramdef>resource <parameter>server</parameter></paramdef> - <paramdef>string <parameter>xml</parameter></paramdef> - <paramdef>mixed <parameter>user_data</parameter></paramdef> - <paramdef>array - <parameter><optional>output_options</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>xmlrpc_server_call_method</methodname> + <methodparam><type>resource</type><parameter>server</parameter></methodparam> + <methodparam><type>string</type><parameter>xml</parameter></methodparam> + <methodparam><type>mixed</type><parameter>user_data</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>output_options</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -214,13 +190,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>xmlrpc_server_add_introspection_data</function></funcdef> - <paramdef>resource <parameter>server</parameter></paramdef> - <paramdef>array <parameter>desc</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xmlrpc_server_add_introspection_data</methodname> + <methodparam><type>resource</type><parameter>server</parameter></methodparam> + <methodparam><type>array</type><parameter>desc</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -235,12 +209,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>xmlrpc_parse_method_descriptions</function></funcdef> - <paramdef>string <parameter>xml</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>xmlrpc_parse_method_descriptions</methodname> + <methodparam><type>string</type><parameter>xml</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -255,13 +227,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>xmlrpc_set_type</function></funcdef> - <paramdef>string <parameter>value</parameter></paramdef> - <paramdef>string <parameter>type</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>xmlrpc_set_type</methodname> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + <methodparam><type>string</type><parameter>type</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -276,12 +246,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>xmlrpc_get_type</function></funcdef> - <paramdef>mixed <parameter>value</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>xmlrpc_get_type</methodname> + <methodparam><type>mixed</type><parameter>value</parameter></methodparam> + </methodsynopsis> &warn.experimental.func; <para> &warn.undocumented.func; @@ -311,4 +279,5 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/xslt.xml diff -u phpdoc/en/functions/xslt.xml:1.30 phpdoc/en/functions/xslt.xml:1.31 --- phpdoc/en/functions/xslt.xml:1.30 Fri Jan 18 16:32:33 2002 +++ phpdoc/en/functions/xslt.xml Sat Feb 2 10:36:11 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.30 $ --> +<!-- $Revision: 1.31 $ --> <reference id="ref.xslt"> <title>XSLT functions</title> <titleabbrev>XSLT</titleabbrev> @@ -65,13 +65,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>xslt_set_log</function></funcdef> - <paramdef>resource <parameter>xh</parameter></paramdef> - <paramdef>mixed <parameter>log</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>xslt_set_log</methodname> + <methodparam><type>resource</type><parameter>xh</parameter></methodparam> + <methodparam><type>mixed</type><parameter>log</parameter></methodparam> + </methodsynopsis> <para> <variablelist> <varlistentry> @@ -134,12 +132,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>xslt_create</function></funcdef> + <methodsynopsis> + <type>resource</type><methodname>xslt_create</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> Create and return a new XSLT processor resource for manipulation by the other XSLT functions. @@ -154,14 +150,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>xslt_errno</function></funcdef> - <paramdef> - resource <parameter>xh</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>xslt_errno</methodname> + <methodparam><type>resource</type><parameter>xh</parameter></methodparam> + </methodsynopsis> <para> Return an error code describing the last error that occured on the passed XSLT processor. @@ -176,14 +168,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed <function>xslt_error</function></funcdef> - <paramdef> - resource <parameter>xh</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>xslt_error</methodname> + <methodparam><type>resource</type><parameter>xh</parameter></methodparam> + </methodsynopsis> <para> Return a string describing the last error that occured on the passed XSLT processor. @@ -223,14 +211,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>xslt_free</function></funcdef> - <paramdef> - resource <parameter>xh</parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>xslt_free</methodname> + <methodparam><type>resource</type><parameter>xh</parameter></methodparam> + </methodsynopsis> <para> Free the XSLT processor identified by the given handle. </para> @@ -244,19 +228,15 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>mixed - <function>xslt_process</function> - </funcdef> - <paramdef>resource <parameter>xh</parameter></paramdef> - <paramdef>string <parameter>xml</parameter></paramdef> - <paramdef>string <parameter>xsl</parameter></paramdef> - <paramdef>string <parameter><optional>result</optional></parameter></paramdef> - <paramdef>array <parameter><optional>arguments</optional></parameter></paramdef> - <paramdef>array <parameter><optional>parameters</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>mixed</type><methodname>xslt_process</methodname> + <methodparam><type>resource</type><parameter>xh</parameter></methodparam> + <methodparam><type>string</type><parameter>xml</parameter></methodparam> + <methodparam><type>string</type><parameter>xsl</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>result</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>arguments</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>parameters</parameter></methodparam> + </methodsynopsis> <para> The XSLT process function is the crux of the new XSLT extension, it allows you to perform an XSLT transformation using almost any type of input source visa-vi the concept @@ -403,13 +383,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>xslt_set_sax_handler</function></funcdef> - <paramdef>resource <parameter>xh</parameter></paramdef> - <paramdef>array <parameter>handlers</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>xslt_set_sax_handler</methodname> + <methodparam><type>resource</type><parameter>xh</parameter></methodparam> + <methodparam><type>array</type><parameter>handlers</parameter></methodparam> + </methodsynopsis> <para> Set SAX handlers on the resource handle given by <parameter>xh</parameter>. SAX handlers should be a two dimensional array @@ -451,13 +429,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>xslt_set_scheme_handler</function></funcdef> - <paramdef>resource <parameter>xh</parameter></paramdef> - <paramdef>array <parameter>handlers</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>xslt_set_scheme_handler</methodname> + <methodparam><type>resource</type><parameter>xh</parameter></methodparam> + <methodparam><type>array</type><parameter>handlers</parameter></methodparam> + </methodsynopsis> <para> Set Scheme handlers on the resource handle given by <parameter>xh</parameter>. Scheme handlers should be an array with the @@ -486,13 +462,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>xslt_set_error_handler</function></funcdef> - <paramdef>resource <parameter>xh</parameter></paramdef> - <paramdef>mixed <parameter>handler</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>xslt_set_error_handler</methodname> + <methodparam><type>resource</type><parameter>xh</parameter></methodparam> + <methodparam><type>mixed</type><parameter>handler</parameter></methodparam> + </methodsynopsis> <para> Set an error handler function for the XSLT processor given by <parameter>xh</parameter>, this function will be called whenever an error occurs in the XSLT transformation @@ -508,13 +482,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>xslt_set_base</function></funcdef> - <paramdef>resource <parameter>xh</parameter></paramdef> - <paramdef>string <parameter>uri</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>xslt_set_base</methodname> + <methodparam><type>resource</type><parameter>xh</parameter></methodparam> + <methodparam><type>string</type><parameter>uri</parameter></methodparam> + </methodsynopsis> <para> Sets the base URI for all XSLT transformations, the base URI is used with Xpath instructions to resolve document() and other commands which @@ -530,13 +502,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>xslt_set_encoding</function></funcdef> - <paramdef>resource <parameter>xh</parameter></paramdef> - <paramdef>string <parameter>encoding</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>xslt_set_encoding</methodname> + <methodparam><type>resource</type><parameter>xh</parameter></methodparam> + <methodparam><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> <para> Set the output encoding for the XSLT transformations. When using the Sablotron backend this option is only available when you compile @@ -554,13 +524,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>xslt_set_sax_handlers</function></funcdef> - <paramdef>resource <parameter>processor</parameter></paramdef> - <paramdef>array <parameter>handlers</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>xslt_set_sax_handlers</methodname> + <methodparam><type>resource</type><parameter>processor</parameter></methodparam> + <methodparam><type>array</type><parameter>handlers</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -578,13 +546,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>xslt_set_scheme_handlers</function></funcdef> - <paramdef>resource <parameter>processor</parameter></paramdef> - <paramdef>array <parameter>handlers</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>xslt_set_scheme_handlers</methodname> + <methodparam><type>resource</type><parameter>processor</parameter></methodparam> + <methodparam><type>array</type><parameter>handlers</parameter></methodparam> + </methodsynopsis> <para> &warn.undocumented.func; </para> @@ -614,3 +580,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/yaz.xml diff -u phpdoc/en/functions/yaz.xml:1.23 phpdoc/en/functions/yaz.xml:1.24 --- phpdoc/en/functions/yaz.xml:1.23 Wed Dec 12 15:47:34 2001 +++ phpdoc/en/functions/yaz.xml Sat Feb 2 10:36:11 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.23 $ --> +<!-- $Revision: 1.24 $ --> <reference id="ref.yaz"> <title>YAZ functions</title> <titleabbrev>YAZ</titleabbrev> @@ -133,12 +133,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yaz_addinfo</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>yaz_addinfo</methodname> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + </methodsynopsis> <para> Returns additional error message for target (last request). An empty string is returned if last operation was a success or if no @@ -154,12 +152,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yaz_close</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>yaz_close</methodname> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + </methodsynopsis> <para> Closes the Z-association given by <parameter>id</parameter>. The <parameter>id</parameter> is a target ID as returned by a @@ -177,17 +173,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yaz_connect</function></funcdef> - <paramdef>string - <parameter>zurl</parameter> - </paramdef> - <paramdef>mixed - <parameter><optional>options</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>yaz_connect</methodname> + <methodparam><type>string</type><parameter>zurl</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>options</parameter></methodparam> + </methodsynopsis> <para> This function returns a positive ID on success; zero on failure. @@ -260,12 +250,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yaz_errno</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>yaz_errno</methodname> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + </methodsynopsis> <para> Returns error for target (last request). A positive value is returned if the target returned a diagnostic code; a value of @@ -289,12 +277,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>yaz_error</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>yaz_error</methodname> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + </methodsynopsis> <para> Returns error message for target (last request). An empty string is returned if last operation was a success. @@ -314,12 +300,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yaz_hits</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>yaz_hits</methodname> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + </methodsynopsis> <para> <function>yaz_hits</function> returns number of hits for last search. @@ -336,13 +320,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yaz_element</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - <paramdef>string <parameter>elementset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>yaz_element</methodname> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>string</type><parameter>elementset</parameter></methodparam> + </methodsynopsis> <para> This function is used in conjunction with <function>yaz_search</function> and <function>yaz_present</function> @@ -365,13 +347,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yaz_database</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - <paramdef>string <parameter>databases</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>yaz_database</methodname> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>string</type><parameter>databases</parameter></methodparam> + </methodsynopsis> <para> This function specifies one or more databases to be used in search, retrieval, etc. - overriding databases specified in call to @@ -397,14 +377,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yaz_range</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - <paramdef>int <parameter>start</parameter></paramdef> - <paramdef>int <parameter>number</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>yaz_range</methodname> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>int</type><parameter>start</parameter></methodparam> + <methodparam><type>int</type><parameter>number</parameter></methodparam> + </methodsynopsis> <para> This function is used in conjunction with <function>yaz_search</function> to specify the maximum number of @@ -426,14 +404,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yaz_record</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - <paramdef>int <parameter>pos</parameter></paramdef> - <paramdef>string <parameter>type</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>yaz_record</methodname> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>int</type><parameter>pos</parameter></methodparam> + <methodparam><type>string</type><parameter>type</parameter></methodparam> + </methodsynopsis> <para> Returns record at position or empty string if no record exists at given position. @@ -458,14 +434,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yaz_search</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - <paramdef>string <parameter>type</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>yaz_search</methodname> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>string</type><parameter>type</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> <para> <function>yaz_search</function> prepares for a search on the target with given id. The type represents the query type - only @@ -566,12 +540,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yaz_present</function></funcdef> + <methodsynopsis> + <type>int</type><methodname>yaz_present</methodname> <void/> - </funcprototype> - </funcsynopsis> + </methodsynopsis> <para> This function prepares for retrieval of records after a successful search. The <function>yaz_range</function> should @@ -590,13 +562,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yaz_syntax</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - <paramdef>string <parameter>syntax</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>yaz_syntax</methodname> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>string</type><parameter>syntax</parameter></methodparam> + </methodsynopsis> <para> The syntax is specified as an OID (Object Identifier) in a raw dot-notation (like <literal>1.2.840.10003.5.10</literal>) or @@ -615,17 +585,13 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yaz_scan</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - <paramdef>string <parameter>type</parameter></paramdef> - <paramdef>string <parameter>startterm</parameter></paramdef> - <paramdef>array - <parameter><optional>flags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>yaz_scan</methodname> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>string</type><parameter>type</parameter></methodparam> + <methodparam><type>string</type><parameter>startterm</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>flags</parameter></methodparam> + </methodsynopsis> <para> This function prepares for a Z39.50 Scan Request. Argument <parameter>id</parameter> specifies target ID. Starting term @@ -692,15 +658,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>yaz_scan_result</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - <paramdef>array &amp; - <parameter><optional>result</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>yaz_scan_result</methodname> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam choice="opt"><type>array &amp;</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> Given a target ID this function returns and array with terms as received from the target in the last Scan Response. @@ -724,13 +686,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yaz_ccl_conf</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - <paramdef>array <parameter>config</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>yaz_ccl_conf</methodname> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>array</type><parameter>config</parameter></methodparam> + </methodsynopsis> <para> This function configures the CCL query parser for a target with definitions of access points (CCL qualifiers) and their @@ -773,14 +733,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yaz_ccl_parse</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>array &amp;<parameter>result</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>yaz_ccl_parse</methodname> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam><type>array &amp;</type><parameter>result</parameter></methodparam> + </methodsynopsis> <para> This function invokes the CCL parser. It converts a given CCL FIND query to an RPN query which may be passed to the @@ -811,12 +769,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yaz_itemorder</function></funcdef> - <paramdef>array <parameter>args</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>yaz_itemorder</methodname> + <methodparam><type>array</type><parameter>args</parameter></methodparam> + </methodsynopsis> <para> This function prepares for an Extended Services request using the Profile for the Use of Z39.50 Item Order Extended Service to @@ -938,14 +894,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yaz_wait</function></funcdef> - <paramdef> - <parameter><optional>array options</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>yaz_wait</methodname> + <methodparam choice="opt"><type></type><parameter>array options</parameter></methodparam> + </methodsynopsis> <para> This function carries out networked (blocked) activity for outstanding requests which have been prepared by the functions @@ -977,13 +929,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>yaz_sort</function></funcdef> - <paramdef>int <parameter>id</parameter></paramdef> - <paramdef>string <parameter>criteria</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>yaz_sort</methodname> + <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>string</type><parameter>criteria</parameter></methodparam> + </methodsynopsis> <para> This function sets sorting criteria and enables Z39.50 Sort. Use this function together with <function>yaz_search</function> @@ -1062,3 +1012,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/zip.xml diff -u phpdoc/en/functions/zip.xml:1.16 phpdoc/en/functions/zip.xml:1.17 --- phpdoc/en/functions/zip.xml:1.16 Wed Dec 12 15:47:34 2001 +++ phpdoc/en/functions/zip.xml Sat Feb 2 10:36:11 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.16 $ --> +<!-- $Revision: 1.17 $ --> <reference id="ref.zip"> <title>Zip File Functions (Read Only Access)</title> <titleabbrev>Zip</titleabbrev> @@ -83,12 +83,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>zip_close</function></funcdef> - <paramdef>resource <parameter>zip</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>zip_close</methodname> + <methodparam><type>resource</type><parameter>zip</parameter></methodparam> + </methodsynopsis> <para> Closes a zip file archive. The parameter <parameter>zip</parameter> must be a zip archive previously @@ -111,12 +109,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>zip_entry_close</function></funcdef> - <paramdef>resource <parameter>zip_entry</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>void</type><methodname>zip_entry_close</methodname> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + </methodsynopsis> <para> Closes a directory entry specified by <parameter>zip_entry</parameter>. The parameter @@ -140,13 +136,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int - <function>zip_entry_compressedsize</function></funcdef> - <paramdef>resource <parameter>zip_entry</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>zip_entry_compressedsize</methodname> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + </methodsynopsis> <para> Returns the compressed size of the directory entry specified by <parameter>zip_entry</parameter>. The parameter @@ -169,14 +162,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string - <function>zip_entry_compressionmethod</function> - </funcdef> - <paramdef>resource <parameter>zip_entry</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>zip_entry_compressionmethod</methodname> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + </methodsynopsis> <para> Returns the compression method of the directory entry specified by <parameter>zip_entry</parameter>. The parameter @@ -199,12 +188,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>zip_entry_filesize</function></funcdef> - <paramdef>resource <parameter>zip_entry</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>zip_entry_filesize</methodname> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + </methodsynopsis> <para> Returns the actual size of the directory entry specified by <parameter>zip_entry</parameter>. The parameter @@ -225,12 +212,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>zip_entry_name</function></funcdef> - <paramdef>resource <parameter>zip_entry</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>zip_entry_name</methodname> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + </methodsynopsis> <para> Returns the name of the directory entry specified by <parameter>zip_entry</parameter>. The parameter @@ -251,16 +236,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>zip_entry_open</function></funcdef> - <paramdef>resource <parameter>zip</parameter></paramdef> - <paramdef>resource <parameter>zip_entry</parameter></paramdef> - <paramdef>string - <parameter><optional>mode</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>zip_entry_open</methodname> + <methodparam><type>resource</type><parameter>zip</parameter></methodparam> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>mode</parameter></methodparam> + </methodsynopsis> <para> Opens a directory entry in a zip file for reading. The parameter <parameter>zip</parameter> is a valid resource handle returned by @@ -304,15 +285,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>zip_entry_read</function></funcdef> - <paramdef>resource <parameter>zip_entry</parameter></paramdef> - <paramdef>int - <parameter><optional>length</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>zip_entry_read</methodname> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> <para> Reads up to <parameter>length</parameter> bytes from an open directory entry. If <parameter>length</parameter> is not @@ -346,12 +323,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>zip_open</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>zip_open</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> <para> Opens a new zip archive for reading. The <parameter>filename</parameter> parameter is the filename of the @@ -377,12 +352,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>resource <function>zip_read</function></funcdef> - <paramdef>resource <parameter>zip</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>resource</type><methodname>zip_read</methodname> + <methodparam><type>resource</type><parameter>zip</parameter></methodparam> + </methodsynopsis> <para> Reads the next entry in a zip file archive. The parameter <parameter>zip</parameter> must be a zip archive previously @@ -423,3 +396,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> + Index: phpdoc/en/functions/zlib.xml diff -u phpdoc/en/functions/zlib.xml:1.21 phpdoc/en/functions/zlib.xml:1.22 --- phpdoc/en/functions/zlib.xml:1.21 Wed Dec 12 15:47:34 2001 +++ phpdoc/en/functions/zlib.xml Sat Feb 2 10:36:11 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.21 $ --> +<!-- $Revision: 1.22 $ --> <reference id="ref.zlib"> <title>Zlib Compression Functions</title> <titleabbrev>Zlib</titleabbrev> @@ -89,12 +89,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gzclose</function></funcdef> - <paramdef>int <parameter>zp</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gzclose</methodname> + <methodparam><type>int</type><parameter>zp</parameter></methodparam> + </methodsynopsis> <para> The gz-file pointed to by zp is closed. </para> @@ -115,12 +113,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gzeof</function></funcdef> - <paramdef>int <parameter>zp</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gzeof</methodname> + <methodparam><type>int</type><parameter>zp</parameter></methodparam> + </methodsynopsis> <para> Returns &true; if the gz-file pointer is at EOF or an error occurs; otherwise returns &false;. @@ -139,15 +135,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>gzfile</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>int - <parameter><optional>use_include_path</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>array</type><methodname>gzfile</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>use_include_path</parameter></methodparam> + </methodsynopsis> <para> Identical to <function>readgzfile</function>, except that <function>gzfile</function> returns the file in an array. @@ -171,12 +163,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>gzgetc</function></funcdef> - <paramdef>int <parameter>zp</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>gzgetc</methodname> + <methodparam><type>int</type><parameter>zp</parameter></methodparam> + </methodsynopsis> <para> Returns a string containing a single (uncompressed) character read from the file pointed to by zp. Returns &false; on EOF (as @@ -200,13 +190,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>gzgets</function></funcdef> - <paramdef>int <parameter>zp</parameter></paramdef> - <paramdef>int <parameter>length</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>gzgets</methodname> + <methodparam><type>int</type><parameter>zp</parameter></methodparam> + <methodparam><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> <para> Returns a (uncompressed) string of up to length - 1 bytes read from the file pointed to by fp. Reading ends when length - 1 @@ -236,16 +224,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>gzgetss</function></funcdef> - <paramdef>int <parameter>zp</parameter></paramdef> - <paramdef>int <parameter>length</parameter></paramdef> - <paramdef>string - <parameter><optional>allowable_tags</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>gzgetss</methodname> + <methodparam><type>int</type><parameter>zp</parameter></methodparam> + <methodparam><type>int</type><parameter>length</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>allowable_tags</parameter></methodparam> + </methodsynopsis> <para> Identical to <function>gzgets</function>, except that <function>gzgetss</function> attempts to strip any HTML and PHP @@ -275,16 +259,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gzopen</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>string <parameter>mode</parameter></paramdef> - <paramdef>int - <parameter><optional>use_include_path</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gzopen</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>string</type><parameter>mode</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>use_include_path</parameter></methodparam> + </methodsynopsis> <para> Opens a gzip (.gz) file for reading or writing. The mode parameter is as in <function>fopen</function> ("rb" or "wb") but @@ -337,12 +317,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gzpassthru</function></funcdef> - <paramdef>int <parameter>zp</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gzpassthru</methodname> + <methodparam><type>int</type><parameter>zp</parameter></methodparam> + </methodsynopsis> <para> Reads to EOF on the given gz-file pointer and writes the (uncompressed) results to standard output. @@ -368,16 +346,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gzputs</function></funcdef> - <paramdef>int <parameter>zp</parameter></paramdef> - <paramdef>string <parameter>str</parameter></paramdef> - <paramdef>int - <parameter><optional>length</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gzputs</methodname> + <methodparam><type>int</type><parameter>zp</parameter></methodparam> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> <para> <function>gzputs</function> is an alias to <function>gzwrite</function>, and is identical in every way. @@ -392,13 +366,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>gzread</function></funcdef> - <paramdef>int <parameter>zp</parameter></paramdef> - <paramdef>int <parameter>length</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>gzread</methodname> + <methodparam><type>int</type><parameter>zp</parameter></methodparam> + <methodparam><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> <simpara> <function>gzread</function> reads up to <parameter>length</parameter> bytes from the gz-file pointer @@ -434,12 +406,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gzrewind</function></funcdef> - <paramdef>int <parameter>zp</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gzrewind</methodname> + <methodparam><type>int</type><parameter>zp</parameter></methodparam> + </methodsynopsis> <para> Sets the file position indicator for zp to the beginning of the file stream. @@ -465,13 +435,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gzseek</function></funcdef> - <paramdef>int <parameter>zp</parameter></paramdef> - <paramdef>int <parameter>offset</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gzseek</methodname> + <methodparam><type>int</type><parameter>zp</parameter></methodparam> + <methodparam><type>int</type><parameter>offset</parameter></methodparam> + </methodsynopsis> <para> Sets the file position indicator for the file referenced by zp to offset bytes into the file stream. Equivalent to calling (in C) @@ -501,12 +469,10 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gztell</function></funcdef> - <paramdef>int <parameter>zp</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gztell</methodname> + <methodparam><type>int</type><parameter>zp</parameter></methodparam> + </methodsynopsis> <para> Returns the position of the file pointer referenced by <parameter>zp</parameter>; i.e., its offset into the file @@ -533,16 +499,12 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>gzwrite</function></funcdef> - <paramdef>int <parameter>zp</parameter></paramdef> - <paramdef>string <parameter>string</parameter></paramdef> - <paramdef>int - <parameter><optional>length</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>gzwrite</methodname> + <methodparam><type>int</type><parameter>zp</parameter></methodparam> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> <simpara> <function>gzwrite</function> writes the contents of <parameter>string</parameter> to the gz-file stream pointed to by @@ -573,15 +535,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>readgzfile</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>int - <parameter><optional>use_include_path</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>int</type><methodname>readgzfile</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>use_include_path</parameter></methodparam> + </methodsynopsis> <para> Reads a file, decompresses it and writes it to standard output. @@ -621,15 +579,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>gzcompress</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>int - <parameter><optional>level</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>gzcompress</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>level</parameter></methodparam> + </methodsynopsis> <para> This function returns a compressed version of the input <parameter>data</parameter> using the ZLIB data format, @@ -665,15 +619,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>gzuncompress</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>int - <parameter><optional>length</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>gzuncompress</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> <para> This function takes <parameter>data</parameter> compressed by <function>gzcompress</function> and returns the original @@ -698,15 +648,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>gzdeflate</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>int - <parameter><optional>level</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>gzdeflate</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>level</parameter></methodparam> + </methodsynopsis> <para> This function returns a compressed version of the input <parameter>data</parameter> using the DEFLATE data format, @@ -736,15 +682,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>gzinflate</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>int - <parameter><optional>length</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>gzinflate</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> <para> This function takes <parameter>data</parameter> compressed by <function>gzdeflate</function> and returns the original @@ -769,15 +711,11 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>gzencode</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>int - <parameter><optional>level</optional></parameter> - </paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>gzencode</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>level</parameter></methodparam> + </methodsynopsis> <para> This function returns a compressed version of the input <parameter>data</parameter> compatible with the output of @@ -841,3 +779,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> +
« previous php.doc (#969341803) next »