cvs: phpdoc(dev_docbook4) /en/functions apache.xml array.xml aspell.xml bc.xml bzip2.xml calendar.xml ccvs.xml classobj.xml com.xml cpdf.xml ctype.xml
curl.xml cybercash.xml cybermut.xml datetime.xml dba.xml dbase.xml dbm.xml dbplus.xml dbx.xml dir.xml domxml.xml errorfunc.xml exec.xml fbsql.xml
fdf.xml filepro.xml filesystem.xml ftp.xml funchand.xml gettext.xml gmp.xml http.xml hw.xml ibase.xml icap.xml iconv.xml ifx.xml image.xml imap.xml
info.xml ingres_ii.xml ircg.xml java.xml ldap.xml mail.xml math.xml mbstring.xml mcal.xml mcrypt.xml mhash.xml ming.xml misc.xml mnogosearch.xml
msql.xml mssql.xml mysql.xml network.xml nis.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 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 wddx.xml xml.xml xslt.xml yaz.xml zip.xml zlib.xml

From: Date: Mon, 12 Nov 2001 14:59:27 +0000
Subject: cvs: phpdoc(dev_docbook4) /en/functions apache.xml array.xml aspell.xml bc.xml bzip2.xml calendar.xml ccvs.xml classobj.xml com.xml cpdf.xml ctype.xml
curl.xml cybercash.xml cybermut.xml datetime.xml dba.xml dbase.xml dbm.xml dbplus.xml dbx.xml dir.xml domxml.xml errorfunc.xml exec.xml fbsql.xml
fdf.xml filepro.xml filesystem.xml ftp.xml funchand.xml gettext.xml gmp.xml http.xml hw.xml ibase.xml icap.xml iconv.xml ifx.xml image.xml imap.xml
info.xml ingres_ii.xml ircg.xml java.xml ldap.xml mail.xml math.xml mbstring.xml mcal.xml mcrypt.xml mhash.xml ming.xml misc.xml mnogosearch.xml
msql.xml mssql.xml mysql.xml network.xml nis.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 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 wddx.xml xml.xml xslt.xml yaz.xml zip.xml zlib.xml
Groups: php.doc 
Request: Send a blank email to phpdoc+get-969338764@lists.php.net to get a copy of this message
hholzgra Mon Nov 12 09:59:27 2001 EDT Modified files: (Branch: dev_docbook4) /phpdoc/en/functions apache.xml array.xml aspell.xml bc.xml bzip2.xml calendar.xml ccvs.xml classobj.xml com.xml cpdf.xml ctype.xml curl.xml cybercash.xml cybermut.xml datetime.xml dba.xml dbase.xml dbm.xml dbplus.xml dbx.xml dir.xml domxml.xml errorfunc.xml exec.xml fbsql.xml fdf.xml filepro.xml filesystem.xml ftp.xml funchand.xml gettext.xml gmp.xml http.xml hw.xml ibase.xml icap.xml iconv.xml ifx.xml image.xml imap.xml info.xml ingres_ii.xml ircg.xml java.xml ldap.xml mail.xml math.xml mbstring.xml mcal.xml mcrypt.xml mhash.xml ming.xml misc.xml mnogosearch.xml msql.xml mssql.xml mysql.xml network.xml nis.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 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 wddx.xml xml.xml xslt.xml yaz.xml zip.xml zlib.xml Log: sorry for all the whitespace changes, hope to have that fixed now with this latest autoconversion run applied i am down to less then 100 error messages with DocBook 4

Index: phpdoc/en/functions/apache.xml diff -u phpdoc/en/functions/apache.xml:1.16.2.1 phpdoc/en/functions/apache.xml:1.16.2.2 --- phpdoc/en/functions/apache.xml:1.16.2.1 Sun Nov 11 20:08:47 2001 +++ phpdoc/en/functions/apache.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.16.2.1 $ --> +<!-- $Revision: 1.16.2.2 $ --> <reference id="ref.apache"> <title>Apache-specific Functions</title> <titleabbrev>Apache</titleabbrev> @@ -14,12 +14,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>object</type><methodname>apache_lookup_uri</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </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,15 +65,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>apache_note</function> is an Apache-specific function which gets and sets values in a request's @@ -94,12 +94,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ascii2ebcdic</methodname> <methodparam><type>string</type><parameter>ascii_str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ascii2ebcdic</function> is an Apache-specific function which is available only on EBCDIC based operating systems (OS/390, BS2000). @@ -120,12 +120,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ebcdic2ascii</methodname> <methodparam><type>string</type><parameter>ebcdic_str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ebcdic2ascii</function> is an Apache-specific function which is available only on EBCDIC based operating systems (OS/390, BS2000). @@ -146,12 +146,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>getallheaders</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns an associative array of all the HTTP headers in the current request. @@ -198,12 +198,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>virtual</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>virtual</function> is an Apache-specific function which is equivalent to &lt;!--#include virtual...--&gt; in mod_include. Index: phpdoc/en/functions/array.xml diff -u phpdoc/en/functions/array.xml:1.112.2.2 phpdoc/en/functions/array.xml:1.112.2.3 --- phpdoc/en/functions/array.xml:1.112.2.2 Sun Nov 11 21:04:37 2001 +++ phpdoc/en/functions/array.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.112.2.2 $ --> +<!-- $Revision: 1.112.2.3 $ --> <reference id="ref.array"> <title>Array Functions</title> <titleabbrev>Arrays</titleabbrev> @@ -36,12 +36,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>array</methodname> <methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns an array of the parameters. The parameters can be given an index with the <literal>=&gt;</literal> operator. @@ -132,6 +132,53 @@ </refsect1> </refentry> + <refentry id="function.array-change-key-case"> + <refnamediv> + <refname>array_change_key_case</refname> + <refpurpose>Retuns an array with all string keys lowercased or uppercased</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <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 + be all lowercase or uppercase. The change depends + on the last optional <parameter>case</parameter> + parameter. You can pass two constants there, + <constant>CASE_UPPER</constant> and + <constant>CASE_LOWER</constant>. The default is + <constant>CASE_LOWER</constant>. The function will leave + number indices as is. + </para> + <para> + <example> + <title><function>array_change_key_case</function> example</title> + <programlisting role="php"> +$input_array = array("FirSt" => 1, "SecOnd" => 4); +print_r(array_change_key_case($input_array, CASE_UPPER); + </programlisting> + </example> + The printout of the above program will be: + <informalexample> + <programlisting> +Array +( + [FIRST] => 1 + [SECOND] => 2 +) + </programlisting> + </informalexample> + </para> + </refsect1> + </refentry> + <refentry id="function.array-chunk"> <refnamediv> <refname>array_chunk</refname> @@ -139,14 +186,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>array_chunk</function> splits the array into several arrays with <parameter>size</parameter> values @@ -227,12 +274,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>array_count_values</methodname> <methodparam><type>array</type><parameter>input</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>array_count_values</function> returns an array using the values of the <parameter>input</parameter> array as keys and @@ -257,14 +304,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>array_diff</function> returns an array containing all the values of <parameter>array1</parameter> @@ -291,21 +338,13 @@ Two elements are considered equal if and only if <literal>(string) $elem1 === (string) $elem2</literal>. In words: when the string representation is the same. - - -<!-- TODO: example of it... --> - - + <!-- TODO: example of it... --> </simpara> </note> <warning> <simpara> This was broken in PHP 4.0.4! - - -<!-- TODO: when exactly was this broken?... --> - - + <!-- TODO: when exactly was this broken?... --> </simpara> </warning> <para> @@ -323,13 +362,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>array_filter</function> returns an array containing all the elements of <parameter>input</parameter> @@ -377,12 +416,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>array_flip</methodname> <methodparam><type>array</type><parameter>trans</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>array_flip</function> returns an <type>array</type> in flip order, i.e. keys from <parameter>trans</parameter> become values and @@ -432,14 +471,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>array_fill</function> fills an array with <parameter>num</parameter> entries of the value of the @@ -475,14 +514,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>array_intersect</function> returns an array containing all the values of <parameter>array1</parameter> @@ -508,21 +547,13 @@ Two elements are considered equal if and only if <literal>(string) $elem1 === (string) $elem2</literal>. In words: when the string representation is the same. - - -<!-- TODO: example of it... --> - - + <!-- TODO: example of it... --> </simpara> </note> <warning> <simpara> This was broken in PHP 4.0.4! - - -<!-- TODO: when exactly was this broken?... --> - - + <!-- TODO: when exactly was this broken?... --> </simpara> </warning> <para> @@ -538,15 +569,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>array_keys</function> returns the keys, numeric and string, from the <parameter>input</parameter> array. @@ -610,14 +641,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>array_map</function> returns an array containing all the elements of <parameter>arr1</parameter> after applying the @@ -786,14 +817,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>array_merge</function> merges the elements of two or more arrays together so that the values of one are appended to @@ -832,14 +863,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>array_merge_recursive</function> merges the elements of two or more arrays together so that the values of one are appended @@ -880,15 +911,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>array_multisort</function> can be used to sort several arrays at once or a multi-dimensional array according by one of @@ -986,14 +1017,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>array_pad</function> returns a copy of the <parameter>input</parameter> padded to size specified by @@ -1032,12 +1063,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>array_pop</methodname> <methodparam><type>array</type><parameter>array</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>array_pop</function> pops and returns the last value of the <parameter>array</parameter>, shortening the @@ -1076,14 +1107,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>array_push</function> treats <parameter>array</parameter> as a stack, and pushes the passed @@ -1128,13 +1159,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -1176,13 +1207,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>array_reverse</function> takes input <parameter>array</parameter> and returns a new array with the @@ -1224,14 +1255,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>array_reduce</function> applies iteratively the <parameter>callback</parameter> function to the elements of the @@ -1284,12 +1315,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>array_shift</methodname> <methodparam><type>array</type><parameter>array</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>array_shift</function> shifts the first value of the <parameter>array</parameter> off and returns it, shortening the @@ -1325,16 +1356,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>array_slice</function> returns a sequence of elements from the <parameter>array</parameter> specified by the @@ -1385,8 +1416,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>array_splice</methodname> <methodparam><type>array</type><parameter>input</parameter></methodparam> <methodparam><type>int</type><parameter>offset</parameter></methodparam> @@ -1394,8 +1425,8 @@ <methodparam choice="opt"><type>array</type><parameter> replacement </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>array_splice</function> removes the elements designated by <parameter>offset</parameter> and @@ -1487,12 +1518,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>array_sum</methodname> <methodparam><type>array</type><parameter>arr</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>array_sum</function> returns the sum of values in an array as an integer or float. @@ -1521,12 +1552,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>array_unique</methodname> <methodparam><type>array</type><parameter>array</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>array_unique</function> takes input <parameter>array</parameter> and returns a new array @@ -1542,11 +1573,7 @@ Two elements are considered equal if and only if <literal>(string) $elem1 === (string) $elem2</literal>. In words: when the string representation is the same. - - -<!-- TODO: example of it... --> - - + <!-- TODO: example of it... --> </simpara> <simpara> The first element will be used. @@ -1555,11 +1582,7 @@ <warning> <simpara> This was broken in PHP 4.0.4! - - -<!-- TODO: when exactly was this broken?... --> - - + <!-- TODO: when exactly was this broken?... --> </simpara> </warning> <para> @@ -1610,16 +1633,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>array_unshift</function> prepends passed elements to the front of the <parameter>array</parameter>. Note that the list @@ -1658,12 +1681,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>array_values</methodname> <methodparam><type>array</type><parameter>input</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>array_values</function> returns all the values from the <parameter>input</parameter> array. @@ -1710,14 +1733,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>array_walk</methodname> <methodparam><type>array</type><parameter>arr</parameter></methodparam> <methodparam><type>string</type><parameter>func</parameter></methodparam> <methodparam choice="opt"><type>mixed</type><parameter>userdata</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Applies the user-defined function named by <parameter>func</parameter> to each element of <parameter>arr</parameter>. @@ -1796,13 +1819,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function sorts an array such that array indices maintain their correlation with the array elements they are associated @@ -1856,13 +1879,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function sorts an array such that array indices maintain their correlation with the array elements they are associated @@ -1918,13 +1941,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>compact</function> takes a variable number of parameters. Each parameter can be either a string containing the @@ -1975,12 +1998,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>count</methodname> <methodparam><type>mixed</type><parameter>var</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the number of elements in <parameter>var</parameter>, which is typically an <type>array</type> (since anything else will have @@ -2008,11 +2031,7 @@ <example> <title><function>count</function> example</title> <programlisting role="php"> - - -<!-- TODO: examples about count(null), count(false), count(object).. --> - - + <!-- TODO: examples about count(null), count(false), count(object).. --> $a[0] = 1; $a[1] = 3; $a[2] = 5; @@ -2048,12 +2067,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>current</methodname> <methodparam><type>array</type><parameter>array</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Every array has an internal pointer to its "current" element, which is initialized to the first element inserted into the @@ -2094,12 +2113,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>each</methodname> <methodparam><type>array</type><parameter>array</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the current key and value pair from the array <parameter>array</parameter> and advances the array cursor. This @@ -2191,12 +2210,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>end</methodname> <methodparam><type>array</type><parameter>array</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>end</function> advances <parameter>array</parameter>'s internal pointer to the last element, and returns that element. @@ -2218,14 +2237,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function is used to import variables from an array into the current symbol table. It takes associative array @@ -2371,14 +2390,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Searches <parameter>haystack</parameter> for <parameter>needle</parameter> and returns &true; @@ -2436,14 +2455,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Searches <parameter>haystack</parameter> for <parameter>needle</parameter> and returns the key if it is found in @@ -2468,12 +2487,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>key</methodname> <methodparam><type>array</type><parameter>array</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>key</function> returns the index element of the current array position. @@ -2484,6 +2503,43 @@ </refsect1> </refentry> + <refentry id="function.array-key-exists"> + <refnamediv> + <refname>array_key_exists</refname> + <refpurpose>Checks if the given key or index exists in the array</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <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. + <parameter>key</parameter> can be any value possible + for an array index. + </para> + <para> + <example> + <title><function>array_key_exists</function> example</title> + <programlisting role="php"> +$search_array = array("first" => 1, "second" => 4); +if (array_key_exists("first", $search_array)) { + echo "The 'first' element is in the array"; +} + </programlisting> + </example> + </para> + <para> + See also <function>isset</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.krsort"> <refnamediv> <refname>krsort</refname> @@ -2491,13 +2547,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Sorts an array by key in reverse order, maintaining key to data correlations. This is useful mainly for associative arrays. @@ -2546,13 +2602,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Sorts an array by key, maintaining key to data correlations. This is useful mainly for associative arrays. @@ -2608,12 +2664,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>list</methodname> <methodparam rep="repeat"><type>mixed</type><parameter>...</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Like <function>array</function>, this is not really a function, but a language construct. <function>list</function> is used to @@ -2658,12 +2714,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>natsort</methodname> <methodparam><type>array</type><parameter>array</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function implements a sort algorithm that orders alphanumeric strings in the way a human being would. This is @@ -2732,12 +2788,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>natcasesort</methodname> <methodparam><type>array</type><parameter>array</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function implements a sort algorithm that orders alphanumeric strings in the way a human being would. This is @@ -2771,12 +2827,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>next</methodname> <methodparam><type>array</type><parameter>array</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the array element in the next place that's pointed by the internal array pointer, or &false; if @@ -2815,12 +2871,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>pos</methodname> <methodparam><type>array</type><parameter>array</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> This is an alias for <function>current</function>. </simpara> @@ -2839,12 +2895,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>prev</methodname> <methodparam><type>array</type><parameter>array</parameter></methodparam> - - </methodsynopsis> + </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 @@ -2879,13 +2935,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>range</methodname> <methodparam><type>mixed</type><parameter>low</parameter></methodparam> <methodparam><type>mixed</type><parameter>high</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>range</function> returns an array of elements from <parameter>low</parameter> to <parameter>high</parameter>, @@ -2927,12 +2983,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>reset</methodname> <methodparam><type>array</type><parameter>array</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>reset</function> rewinds <parameter>array</parameter>'s internal pointer to the first element. @@ -2956,13 +3012,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function sorts an array in reverse order (highest to lowest). <example> @@ -3013,12 +3069,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>shuffle</methodname> <methodparam><type>array</type><parameter>array</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function shuffles (randomizes the order of the elements in) an array. You must use <function>srand</function> to seed this @@ -3050,12 +3106,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>sizeof</methodname> <methodparam><type>mixed</type><parameter>var</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>sizeof</function> function is an alias for <function>count</function>. @@ -3073,13 +3129,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function sorts an array. Elements will be arranged from lowest to highest when this function has completed. @@ -3159,13 +3215,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function sorts an array such that array indices maintain their correlation with the array elements they are associated @@ -3198,13 +3254,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function will sort the keys of an array using a user-supplied comparison function. If the array you wish to sort @@ -3261,13 +3317,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function will sort an array by its values using a user-supplied comparison function. If the array you wish to sort Index: phpdoc/en/functions/aspell.xml diff -u phpdoc/en/functions/aspell.xml:1.17.2.2 phpdoc/en/functions/aspell.xml:1.17.2.3 --- phpdoc/en/functions/aspell.xml:1.17.2.2 Sun Nov 11 21:04:37 2001 +++ phpdoc/en/functions/aspell.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.17.2.2 $ --> +<!-- $Revision: 1.17.2.3 $ --> <reference id="ref.aspell"> <title>Aspell functions [deprecated]</title> <titleabbrev>Aspell</titleabbrev> @@ -30,18 +30,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> - -<!-- TODO: personal??? --> - - + <!-- TODO: personal??? --> <simpara> <function>aspell_new</function> opens up a new dictionary and returns the dictionary link identifier for use in other aspell @@ -65,13 +61,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> <function>aspell_check</function> checks the spelling of a word and returns &true; if the spelling is correct, &false; if not. @@ -102,13 +98,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -138,13 +134,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> <function>aspell_suggest</function> returns an array of possible spellings for the given word. Index: phpdoc/en/functions/bc.xml diff -u phpdoc/en/functions/bc.xml:1.16.2.1 phpdoc/en/functions/bc.xml:1.16.2.2 --- phpdoc/en/functions/bc.xml:1.16.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/bc.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.16.2.1 $ --> +<!-- $Revision: 1.16.2.2 $ --> <reference id="ref.bc"> <title>BCMath Arbitrary Precision Mathematics Functions</title> <titleabbrev>BC math</titleabbrev> @@ -30,14 +30,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Adds the <parameter>left operand</parameter> to the <parameter>right operand</parameter> and returns the sum in a @@ -58,14 +58,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Compares the <parameter>left operand</parameter> to the <parameter>right operand</parameter> and returns the result as an @@ -88,14 +88,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Divides the <parameter>left operand</parameter> by the <parameter>right operand</parameter> and returns the result. The @@ -117,13 +117,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Get the modulus of the <parameter>left operand</parameter> using <parameter>modulus</parameter>. @@ -141,14 +141,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Multiply the <parameter>left operand</parameter> by the <parameter>right operand</parameter> and returns the result. The @@ -170,14 +170,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Raise <parameter>x</parameter> to the power <parameter>y</parameter>. The optional @@ -199,12 +199,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>bcscale</methodname> <methodparam><type>int</type><parameter>scale</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function sets the default scale parameter for all subsequent bc math functions that do not explicitly specify a scale @@ -222,13 +222,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Return the square root of the <parameter>operand</parameter>. The optional <parameter>scale</parameter> parameter sets the @@ -249,14 +249,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Subtracts the <parameter>right operand</parameter> from the <parameter>left operand</parameter> and returns the result in a Index: phpdoc/en/functions/bzip2.xml diff -u phpdoc/en/functions/bzip2.xml:1.11.2.1 phpdoc/en/functions/bzip2.xml:1.11.2.2 --- phpdoc/en/functions/bzip2.xml:1.11.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/bzip2.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.11.2.1 $ --> +<!-- $Revision: 1.11.2.2 $ --> <reference id="ref.bzip2"> <title>Bzip2 Compression Functions</title> <titleabbrev>Bzip2</titleabbrev> @@ -63,12 +63,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>bzclose</methodname> <methodparam><type>int</type><parameter>bz</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Closes the bzip2 file referenced by the pointer <parameter>bz</parameter>. </para> @@ -93,14 +93,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>bzcompress</function> compresses the <parameter>source</parameter> string and returns it as bzip2 @@ -146,13 +146,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>bzdecompress</function> decompresses the <parameter>source</parameter> string containing bzip2 encoded @@ -196,12 +196,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>bzerrno</methodname> <methodparam><type>int</type><parameter>bz</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the error number of any bzip2 error returned by the file pointer <parameter>bz</parameter>. @@ -220,12 +220,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>bzerror</methodname> <methodparam><type>int</type><parameter>bz</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the error number and error string, in an associative array, of any bzip2 error returned by the file pointer @@ -257,12 +257,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>bzerrstr</methodname> <methodparam><type>int</type><parameter>bz</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the error string of any bzip2 error returned by the file pointer <parameter>bz</parameter>. @@ -281,12 +281,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>bzflush</methodname> <methodparam><type>int</type><parameter>bz</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Forces a write of all buffered bzip2 data for the file pointer <parameter>bz</parameter>. @@ -308,13 +308,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>bzopen</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> <methodparam><type>string</type><parameter>mode</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Opens a bzip2 (.bz2) file for reading or writing. <parameter>filename</parameter> is the name of the file to @@ -354,13 +354,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>bzread</function> reads up to <parameter>length</parameter> bytes from the bzip2 file pointer @@ -396,14 +396,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>bzwrite</function> writes the contents of the string <parameter>data</parameter> to the bzip2 file stream pointed to Index: phpdoc/en/functions/calendar.xml diff -u phpdoc/en/functions/calendar.xml:1.16.2.1 phpdoc/en/functions/calendar.xml:1.16.2.2 --- phpdoc/en/functions/calendar.xml:1.16.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/calendar.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.16.2.1 $ --> +<!-- $Revision: 1.16.2.2 $ --> <reference id="ref.calendar"> <title>Calendar functions</title> <titleabbrev>Calendar</titleabbrev> @@ -32,12 +32,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>jdtogregorian</methodname> <methodparam><type>int</type><parameter>julianday</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Converts Julian Day Count to a string containing the Gregorian date in the format of "month/day/year". @@ -54,14 +54,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Valid Range for Gregorian Calendar 4714 B.C. to 9999 A.D.</para> <para> @@ -96,12 +96,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>jdtojulian</methodname> <methodparam><type>int</type><parameter>julianday</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Converts Julian Day Count to a string containing the Julian Calendar Date in the format of "month/day/year". @@ -118,14 +118,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Valid Range for Julian Calendar 4713 B.C. to 9999 A.D. </para> @@ -149,12 +149,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>jdtojewish</methodname> <methodparam><type>int</type><parameter>julianday</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Converts a Julian Day Count the the Jewish Calendar. </para> @@ -170,14 +170,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Valid Range Although this software can handle dates all the way back to the year 1 (3761 B.C.), such use may not be meaningful. @@ -200,12 +200,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>jdtofrench</methodname> <methodparam><type>int</type><parameter>juliandaycount</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Converts a Julian Day Count to the French Republican Calendar. </para> @@ -222,14 +222,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Converts a date from the French Republican Calendar to a Julian Day Count. @@ -250,13 +250,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>jdmonthname</methodname> <methodparam><type>int</type><parameter>julianday</parameter></methodparam> <methodparam><type>int</type><parameter>mode</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a string containing a month name. <parameter>mode</parameter> tells this function which calendar to @@ -310,13 +310,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>jddayofweek</methodname> <methodparam><type>int</type><parameter>julianday</parameter></methodparam> <methodparam><type>int</type><parameter>mode</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the day of the week. Can return a string or an int depending on the mode. @@ -366,12 +366,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>easter_date</methodname> <methodparam><type>int</type><parameter>year</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the UNIX timestamp corresponding to midnight on Easter of the given year. If no year is specified, the current year is @@ -426,12 +426,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>easter_days</methodname> <methodparam><type>int</type><parameter>year</parameter></methodparam> - - </methodsynopsis> + </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 @@ -483,12 +483,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>unixtojd</methodname> <methodparam choice="opt"><type>int</type><parameter>timestamp</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Return the Julian Day for a UNIX <parameter>timestamp</parameter> (seconds since 1.1.1970), or for the current day if no @@ -512,12 +512,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>jdtounix</methodname> <methodparam><type>int</type><parameter>jday</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function will return a UNIX timestamp corresponding to the Julian Day given in <parameter>jday</parameter> or &false; if Index: phpdoc/en/functions/ccvs.xml diff -u phpdoc/en/functions/ccvs.xml:1.7.2.2 phpdoc/en/functions/ccvs.xml:1.7.2.3 --- phpdoc/en/functions/ccvs.xml:1.7.2.2 Sun Nov 11 21:04:37 2001 +++ phpdoc/en/functions/ccvs.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.7.2.2 $ --> +<!-- $Revision: 1.7.2.3 $ --> <!-- CCVS Documentation by Brendan W. McAdams <brendan@plexmedia.com> @@ -60,12 +60,12 @@ </refnamediv> <refsect1> <title/> - <methodsynopsis> - - <type/><methodname/> - <methodparam><type/><parameter/></methodparam> - - </methodsynopsis> + + <methodsynopsis> + <type></type><methodname/> + <methodparam><type></type><parameter/></methodparam> + </methodsynopsis> + </refsect1> </refentry> Index: phpdoc/en/functions/classobj.xml diff -u phpdoc/en/functions/classobj.xml:1.26.2.1 phpdoc/en/functions/classobj.xml:1.26.2.2 --- phpdoc/en/functions/classobj.xml:1.26.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/classobj.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.26.2.1 $ --> +<!-- $Revision: 1.26.2.2 $ --> <reference id="ref.classobj"> <title>Class/Object Functions</title> <titleabbrev>Classes/Objects</titleabbrev> @@ -173,14 +173,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Calls a the method referred by <parameter>method_name</parameter> from the user defined <parameter>obj</parameter> object, using the paramaters @@ -209,15 +209,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Calls a the method referred by <parameter>method_name</parameter> from the user defined <parameter>obj</parameter> object. An example of usage @@ -268,12 +268,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>class_exists</methodname> <methodparam><type>string</type><parameter>class_name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns &true; if the class given by <parameter>class_name</parameter> has been defined, @@ -289,12 +289,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>get_class</methodname> <methodparam><type>object</type><parameter>obj</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns the name of the class of which the object <parameter>obj</parameter> is an instance. @@ -319,12 +319,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>get_class_methods</methodname> <methodparam><type>string</type><parameter>class_name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns an array of method names defined for the class specified by <parameter>class_name</parameter>. @@ -401,12 +401,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>get_class_vars</methodname> <methodparam><type>string</type><parameter>class_name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function will return an associative array of default properties of the class. The resulting array elements are in the @@ -472,12 +472,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>get_declared_classes</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns an array of the names of the declared classes in the current script. @@ -507,12 +507,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>get_object_vars</methodname> <methodparam><type>object</type><parameter>obj</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns an associative array of defined object properties for the specified object <parameter>obj</parameter>. If variables @@ -579,12 +579,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>get_parent_class</methodname> <methodparam><type>object</type><parameter>obj</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns the name of the parent class to the class of which the object <parameter>obj</parameter> @@ -607,13 +607,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>is_subclass_of</methodname> <methodparam><type>object</type><parameter>obj</parameter></methodparam> <methodparam><type>string</type><parameter>superclass</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns &true; if the object <parameter>obj</parameter>, belongs to a class which is a subclass of @@ -632,13 +632,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function returns &true; if the method given by <parameter>method_name</parameter> has been defined for the given Index: phpdoc/en/functions/com.xml diff -u phpdoc/en/functions/com.xml:1.22.2.1 phpdoc/en/functions/com.xml:1.22.2.2 --- phpdoc/en/functions/com.xml:1.22.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/com.xml Mon Nov 12 09:59:18 2001 @@ -1,15 +1,26 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.22.2.1 $ --> -<reference id="ref.com"> - <title>COM support functions for Windows</title> - <titleabbrev>COM</titleabbrev> - - <partintro> - <simpara> - COM functions are only available on the Windows version of - PHP. These functions have been added in PHP 4. - </simpara> - </partintro> +<!-- $Revision: 1.22.2.2 $ --> +<reference id="ref.com"> + <title>COM support functions for Windows</title> + <titleabbrev>COM</titleabbrev> + <partintro> + <simpara>COM is a technology which allows the reuse of code written in any + language (by any language) using a standard calling convention and hiding + behind APIs the implementation details such as what machine the Component is + stored on and the executable which houses it. It can be thought of as a super + Remote Procedure Call (RPC) mechanism with some basic object roots. It + separates implementation from interface.</simpara> + <simpara>COM encourages versioning, separation of implementation from + interface and hiding the implementation details such as executable location and + the language it was written in.</simpara> + <simpara>COM functions are only available on the Windows version of + PHP.</simpara> + <simpara>For further information on COM read the + <ulink url="http://www.microsoft.com/Com/resources/comdocs.asp">COM + specification</ulink>or perhaps take a look at Don Box's + <ulink url="http://www.developmentor.com/dbox/yacl.htm"> Yet Another COM + Libracy (YACL)</ulink> </simpara> + </partintro> <refentry id="class.com"> <refnamediv> @@ -28,14 +39,14 @@ </refsect1> <refsect1 id="class.com.constructor"> <title>Methods</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> COM class constructor. Parameters: <variablelist> @@ -157,14 +168,14 @@ </refsect1> <refsect1 id="class.variant.constructor"> <title>Methods</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> VARIANT class constructor. Parameters: <variablelist> @@ -216,8 +227,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>com_load</methodname> <methodparam><type>string</type><parameter>module name</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter> @@ -226,8 +237,8 @@ <methodparam choice="opt"><type>int</type><parameter> codepage </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>com_load</function> creates a new COM component and returns a reference to it. Returns &false; on @@ -249,16 +260,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>com_invoke</function> invokes a method of the COM component referenced by @@ -278,13 +289,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function is an alias for <function>com_get</function>. </para> @@ -300,13 +311,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the value of the <parameter>property</parameter> of the COM component referenced by <parameter>com_object</parameter>. @@ -324,14 +335,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function is an alias for <function>com_set</function>. </para> @@ -347,14 +358,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function is an alias for <function>com_set</function>. </para> @@ -370,14 +381,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Sets the value of the <parameter>property</parameter> of the COM component referenced by <parameter>com_object</parameter>. @@ -395,12 +406,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>com_addref</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Increases the components reference counter. </para> @@ -416,12 +427,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>com_release</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Decreases the components reference counter. </para> Index: phpdoc/en/functions/cpdf.xml diff -u phpdoc/en/functions/cpdf.xml:1.32.2.1 phpdoc/en/functions/cpdf.xml:1.32.2.2 --- phpdoc/en/functions/cpdf.xml:1.32.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/cpdf.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.32.2.1 $ --> +<!-- $Revision: 1.32.2.2 $ --> <reference id="ref.cpdf"> <title>ClibPDF functions</title> <titleabbrev>ClibPDF</titleabbrev> @@ -185,8 +185,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -196,8 +196,8 @@ <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> + </methodsynopsis> + <para> The <function>cpdf_add_annotation</function> adds a note with the lower left corner at (<parameter>llx</parameter>, @@ -220,13 +220,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_add_outline</function> function adds a bookmark with text <parameter>text</parameter> that points to the current page. @@ -258,8 +258,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -268,8 +268,8 @@ <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> + </methodsynopsis> + <para> The <function>cpdf_arc</function> function draws an arc with center at point @@ -297,12 +297,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>cpdf_begin_text</methodname> <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>cpdf_begin_text</function> function starts a text section. It must be ended with <function>cpdf_end_text</function>. @@ -331,16 +331,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_circle</function> function draws a circle with center at point @@ -366,12 +366,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>cpdf_clip</methodname> <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>cpdf_clip</function> function clips all drawing to the current path. @@ -386,12 +386,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>cpdf_close</methodname> <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>cpdf_close</function> function closes the pdf document. This should be the last function even after @@ -411,12 +411,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>cpdf_closepath</methodname> <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>cpdf_closepath</function> function closes the current path. @@ -431,12 +431,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>cpdf_closepath_fill_stroke</methodname> <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>cpdf_closepath_fill_stroke</function> function closes, fills the interior of the current path with the current fill color and @@ -461,12 +461,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>cpdf_closepath_stroke</methodname> <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>cpdf_closepath_stroke</function> function is a combination of <function>cpdf_closepath</function> and @@ -486,13 +486,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_continue_text</function> function outputs the string in <parameter>text</parameter> in the next line. @@ -513,8 +513,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -524,8 +524,8 @@ <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> + </methodsynopsis> + <para> The <function>cpdf_curveto</function> function draws a Bezier curve from the current point to the point @@ -556,12 +556,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>cpdf_end_text</methodname> <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>cpdf_end_text</function> function ends a text section which was started with <function>cpdf_begin_text</function>. @@ -590,12 +590,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>cpdf_fill</methodname> <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>cpdf_fill</function> function fills the interior of the current path with the current fill color. @@ -618,12 +618,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>cpdf_fill_stroke</methodname> <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> - - </methodsynopsis> + </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. @@ -647,12 +647,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>cpdf_finalize</methodname> <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>cpdf_finalize</function> function ends the document. You still have to call <function>cpdf_close</function> @@ -670,13 +670,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_finalize_page</function> function ends the page with page number <parameter>page number</parameter>. @@ -698,16 +698,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_global_set_document_limits</function> function sets several document limits. This function has to be called before @@ -727,8 +727,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -740,8 +740,8 @@ <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> + </methodsynopsis> + <para> The <function>cpdf_import_jpeg</function> function opens an image stored in the file with the name <parameter>file @@ -769,15 +769,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_lineto</function> function draws a line from the current point to the point with coordinates @@ -804,15 +804,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_moveto</function> function set the current point to the coordinates <parameter>x-coor</parameter> and @@ -834,12 +834,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>cpdf_newpath</methodname> <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>cpdf_newpath</function> starts a new path on the document given by the <parameter>pdf document</parameter> @@ -855,13 +855,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_open</function> function opens a new pdf document. The first parameter turns document compression @@ -900,12 +900,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>cpdf_output_buffer</methodname> <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>cpdf_output_buffer</function> function outputs the pdf document to stdout. The document has to be created in memory which @@ -925,8 +925,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -934,8 +934,8 @@ <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> + </methodsynopsis> + <para> The <function>cpdf_page_init</function> function starts a new page with height <parameter>height</parameter> and width @@ -961,8 +961,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -972,8 +972,8 @@ <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> + </methodsynopsis> + <para> The <function>cpdf_place_inline_image</function> function places an image created with the php image functions on the page at @@ -1000,8 +1000,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -1009,8 +1009,8 @@ <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> + </methodsynopsis> + <para> The <function>cpdf_rect</function> function draws a rectangle with its lower left corner at point @@ -1034,12 +1034,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>cpdf_restore</methodname> <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>cpdf_restore</function> function restores the enviroment saved with <function>cpdf_save</function>. It works @@ -1069,15 +1069,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_rlineto</function> function draws a line from the current point to the relative point with coordinates @@ -1104,15 +1104,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_rmoveto</function> function set the current point relative to the coordinates <parameter>x-coor</parameter> and @@ -1137,13 +1137,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_rotate</function> function set the rotation in degress to <parameter>angle</parameter>. @@ -1158,12 +1158,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>cpdf_save</methodname> <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>cpdf_save</function> function saves the current enviroment. It works like the postscript command gsave. Very @@ -1183,13 +1183,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_save_to_file</function> function outputs the pdf document into a file if it has been created in memory. @@ -1212,14 +1212,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_scale</function> function set the scaling factor in both directions. @@ -1234,13 +1234,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_set_char_spacing</function> function sets the spacing between characters. @@ -1259,12 +1259,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>cpdf_set_creator</methodname> <methodparam><type>string</type><parameter>creator</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>cpdf_set_creator</function> function sets the creator of a pdf document. @@ -1284,13 +1284,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_set_current_page</function> function set the page on which all operations are performed. One can switch between pages @@ -1309,15 +1309,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_set_font</function> function sets the current font face, font size and encoding. Currently only @@ -1343,13 +1343,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_set_horiz_scaling</function> function sets the horizontal scaling to <parameter>scale</parameter> percent. @@ -1364,12 +1364,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>cpdf_set_keywords</methodname> <methodparam><type>string</type><parameter>keywords</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>cpdf_set_keywords</function> function sets the keywords of a pdf document. @@ -1389,13 +1389,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_set_leading</function> function sets the distance between text lines. This will be used if text is output by @@ -1414,14 +1414,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_set_page_animation</function> function set the transition between following pages. @@ -1464,12 +1464,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>cpdf_set_subject</methodname> <methodparam><type>string</type><parameter>subject</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>cpdf_set_subject</function> function sets the subject of a pdf document. @@ -1489,13 +1489,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_set_text_matrix</function> function sets a matrix which describes a transformation applied on the current @@ -1511,15 +1511,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_set_text_pos</function> function sets the position of text for the next <function>cpdf_show</function> @@ -1545,13 +1545,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_set_text_rendering</function> function determines how text is rendered. @@ -1573,13 +1573,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_set_text_rise</function> function sets the text rising to <parameter>value</parameter> units. @@ -1594,12 +1594,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>cpdf_set_title</methodname> <methodparam><type>string</type><parameter>title</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>cpdf_set_title</function> function sets the title of a pdf document. @@ -1619,13 +1619,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_set_word_spacing</function> function sets the spacing between words. @@ -1644,14 +1644,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_setdash</function> function set the dash pattern <parameter>white</parameter> white units and @@ -1668,13 +1668,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_setflat</function> function set the flatness to a value between 0 and 100. @@ -1689,13 +1689,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_setgray_stroke</function> function sets the current drawing and filling color to the given gray value. @@ -1714,13 +1714,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_setgray_fill</function> function sets the current gray value to fill a path. @@ -1738,13 +1738,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_setgray_stroke</function> function sets the current drawing color to the given gray value. @@ -1762,13 +1762,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_setlinecap</function> function set the linecap parameter between a value of 0 and 2. 0 = butt end, 1 = round, @@ -1784,13 +1784,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_setlinejoin</function> function set the linejoin parameter between a value of 0 and 2. 0 = miter, 1 = @@ -1806,13 +1806,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_setlinewidth</function> function set the line width to <parameter>width</parameter>. @@ -1827,13 +1827,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_setmiterlimit</function> function set the miter limit to a value greater or equal than 1. @@ -1848,15 +1848,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_setrgbcolor_stroke</function> function sets the current drawing and filling color to the given rgb color value. @@ -1875,15 +1875,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_setrgbcolor_fill</function> function sets the current rgb color value to fill a path. @@ -1902,15 +1902,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_setrgbcolor_stroke</function> function sets the current drawing color to the given rgb color value. @@ -1929,13 +1929,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_show</function> function outputs the string in <parameter>text</parameter> at the current position. @@ -1955,16 +1955,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_show_xy</function> function outputs the string <parameter>text</parameter> at position with coordinates @@ -1995,13 +1995,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_stringwidth</function> function returns the width of the string in <parameter>text</parameter>. It requires @@ -2020,12 +2020,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>cpdf_stroke</methodname> <methodparam><type>int</type><parameter>pdf document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>cpdf_stroke</function> function draws a line along current path. @@ -2044,8 +2044,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -2054,8 +2054,8 @@ <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> + </methodsynopsis> + <para> The <function>cpdf_text</function> function outputs the string <parameter>text</parameter> at position with coordinates @@ -2087,15 +2087,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>cpdf_translate</function> function set the origin of coordinate system to the point (<parameter>x-coor</parameter>, Index: phpdoc/en/functions/ctype.xml diff -u phpdoc/en/functions/ctype.xml:1.12.2.1 phpdoc/en/functions/ctype.xml:1.12.2.2 --- phpdoc/en/functions/ctype.xml:1.12.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/ctype.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.12.2.1 $ --> +<!-- $Revision: 1.12.2.2 $ --> <reference id="ref.ctype"> <title>Character type functions</title> <titleabbrev>ctype</titleabbrev> @@ -47,12 +47,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>ctype_alnum</methodname> <methodparam><type>string</type><parameter>c</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> See also <function>setlocale</function>. @@ -67,12 +67,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>ctype_alpha</methodname> <methodparam><type>string</type><parameter>c</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> </para> @@ -86,12 +86,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>ctype_cntrl</methodname> <methodparam><type>string</type><parameter>c</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> </para> @@ -105,12 +105,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>ctype_digit</methodname> <methodparam><type>string</type><parameter>c</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> </para> @@ -124,12 +124,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>ctype_lower</methodname> <methodparam><type>string</type><parameter>c</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> </para> @@ -143,12 +143,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>ctype_graph</methodname> <methodparam><type>string</type><parameter>c</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> </para> @@ -162,12 +162,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>ctype_print</methodname> <methodparam><type>string</type><parameter>c</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> </para> @@ -184,12 +184,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>ctype_punct</methodname> <methodparam><type>string</type><parameter>c</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> </para> @@ -203,12 +203,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>ctype_space</methodname> <methodparam><type>string</type><parameter>c</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> </para> @@ -222,12 +222,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>ctype_upper</methodname> <methodparam><type>string</type><parameter>c</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> </para> @@ -243,12 +243,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>ctype_xdigit</methodname> <methodparam><type>string</type><parameter>c</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> </para> Index: phpdoc/en/functions/curl.xml diff -u phpdoc/en/functions/curl.xml:1.17.2.1 phpdoc/en/functions/curl.xml:1.17.2.2 --- phpdoc/en/functions/curl.xml:1.17.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/curl.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.17.2.1 $ --> +<!-- $Revision: 1.17.2.2 $ --> <reference id="ref.curl"> <title>CURL, Client URL Library Functions</title> <titleabbrev>CURL</titleabbrev> @@ -67,14 +67,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>curl_init</methodname> <methodparam choice="opt"><type>string</type><parameter> url </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>curl_init</function> will initialize a new session and return a CURL handle for use with the @@ -116,14 +116,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>curl_setopt</function> function will set options for a CURL session identified by the <parameter>ch</parameter> @@ -451,12 +451,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>curl_exec</methodname> <methodparam><type>int</type><parameter>ch</parameter></methodparam> - - </methodsynopsis> + </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 @@ -473,12 +473,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>curl_close</methodname> <methodparam><type>int</type><parameter>ch</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This functions closes a CURL session and frees all ressources. The CURL handle, <parameter>ch</parameter>, is also deleted. @@ -493,12 +493,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>curl_version</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>curl_version</function> function returns a string containing the current CURL version. Index: phpdoc/en/functions/cybercash.xml diff -u phpdoc/en/functions/cybercash.xml:1.9.2.1 phpdoc/en/functions/cybercash.xml:1.9.2.2 --- phpdoc/en/functions/cybercash.xml:1.9.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/cybercash.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.9.2.1 $ --> +<!-- $Revision: 1.9.2.2 $ --> <reference id="ref.cybercash"> <title>Cybercash payment functions</title> <titleabbrev>Cybercash</titleabbrev> @@ -19,14 +19,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The function returns an associative array with the elements "errcode" and, if "errcode" is &false;, "outbuff" (string), @@ -42,14 +42,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The function returns an associative array with the elements "errcode" and, if "errcode" is &false;, "outbuff" (string), @@ -65,12 +65,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>cybercash_base64_encode</methodname> <methodparam><type>string</type><parameter>inbuff</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> </para> </refsect1> @@ -83,12 +83,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>cybercash_base64_decode</methodname> <methodparam><type>string</type><parameter>inbuff</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> </para> </refsect1> Index: phpdoc/en/functions/cybermut.xml diff -u phpdoc/en/functions/cybermut.xml:1.9.2.1 phpdoc/en/functions/cybermut.xml:1.9.2.2 --- phpdoc/en/functions/cybermut.xml:1.9.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/cybermut.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.9.2.1 $ --> +<!-- $Revision: 1.9.2.2 $ --> <reference id="ref.cybermut"> <title>Cr&eacute;dit Mutuel CyberMUT functions</title> <titleabbrev>CyberMUT</titleabbrev> @@ -49,8 +49,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -64,8 +64,8 @@ <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> + </methodsynopsis> + <para> <function>cynermut_creerformulairecm</function> is used to generate the HTML form of request for payment. @@ -116,8 +116,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -127,8 +127,8 @@ <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> + </methodsynopsis> + <para> <function>cybermut_testmac</function> is used to make sure that there was not data diddling contained in the received message of confirmation. @@ -189,12 +189,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>cybermut_creerreponsecm</methodname> <methodparam><type>string</type><parameter>phrase</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>cybermut_creerreponsecm</function> returns a string containing delivery aknowledgement message. Index: phpdoc/en/functions/datetime.xml diff -u phpdoc/en/functions/datetime.xml:1.51.2.1 phpdoc/en/functions/datetime.xml:1.51.2.2 --- phpdoc/en/functions/datetime.xml:1.51.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/datetime.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.51.2.1 $ --> +<!-- $Revision: 1.51.2.2 $ --> <reference id="ref.datetime"> <title>Date and Time functions</title> <titleabbrev>Date/time</titleabbrev> @@ -11,14 +11,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</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> + </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 @@ -53,15 +53,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns a string formatted according to the given format string using the given integer <parameter>timestamp</parameter> or the current local time @@ -337,12 +337,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>getdate</methodname> <methodparam choice="opt"><type>int</type><parameter>timestamp</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns an associative array containing the date information of the <parameter>timestamp</parameter>, or the current local time if @@ -423,12 +423,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>gettimeofday</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> This is an interface to gettimeofday(2). It returns an associative array containing the data returned from the system @@ -466,13 +466,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Identical to the <function>date</function> function except that the time returned is Greenwich Mean Time (GMT). For example, when @@ -500,8 +500,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>gmmktime</methodname> <methodparam><type>int</type><parameter>hour</parameter></methodparam> <methodparam><type>int</type><parameter>minute</parameter></methodparam> @@ -510,8 +510,8 @@ <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> + </methodsynopsis> + <para> Identical to <function>mktime</function> except the passed parameters represents a GMT date. @@ -528,13 +528,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Behaves the same as <function>strftime</function> except that the time returned is Greenwich Mean Time (GMT). For example, when run @@ -563,8 +563,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>localtime</methodname> <methodparam choice="opt"><type>int</type><parameter> timestamp @@ -572,8 +572,8 @@ <methodparam choice="opt"><type>bool</type><parameter> is_associative </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>localtime</function> function returns an array identical to that of the structure returned by the C function @@ -646,12 +646,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>microtime</methodname> <void/> - - </methodsynopsis> + </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 @@ -695,8 +695,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mktime</methodname> <methodparam><type>int</type><parameter>hour</parameter></methodparam> <methodparam><type>int</type><parameter>minute</parameter></methodparam> @@ -705,8 +705,8 @@ <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> + </methodsynopsis> + <para> <emphasis>Warning:</emphasis> Note the strange order of arguments, which differs from the order of arguments in a regular @@ -791,15 +791,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns a string formatted according to the given format string using the given <parameter>timestamp</parameter> or the current @@ -1033,12 +1033,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>time</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the current time measured in the number of seconds since the Unix Epoch (January 1 1970 00:00:00 GMT). @@ -1059,13 +1059,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The function expects to be given a string containing an english date format and will try to parse that format into a UNIX Index: phpdoc/en/functions/dba.xml diff -u phpdoc/en/functions/dba.xml:1.16.2.1 phpdoc/en/functions/dba.xml:1.16.2.2 --- phpdoc/en/functions/dba.xml:1.16.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/dba.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.16.2.1 $ --> +<!-- $Revision: 1.16.2.2 $ --> <reference id="ref.dba"> <title>Database (dbm-style) abstraction layer functions</title> <titleabbrev>dba</titleabbrev> @@ -176,12 +176,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>dba_close</methodname> <methodparam><type>int</type><parameter>handle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>dba_close</function> closes the established database and frees all resources specified by @@ -208,13 +208,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>dba_delete</function> deletes the entry specified by <parameter>key</parameter> from the database specified with @@ -247,13 +247,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>dba_exists</function> checks whether the specified <parameter>key</parameter> exists in the database specified by @@ -285,13 +285,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>dba_fetch</function> fetches the data specified by <parameter>key</parameter> from the database specified with @@ -324,12 +324,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>dba_firstkey</methodname> <methodparam><type>int</type><parameter>handle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>dba_firstkey</function> returns the first key of the database specified by <parameter>handle</parameter> and resets @@ -359,14 +359,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>dba_insert</function> inserts the entry described with <parameter>key</parameter> and <parameter>value</parameter> into the @@ -404,12 +404,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>dba_nextkey</methodname> <methodparam><type>int</type><parameter>handle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>dba_nextkey</function> returns the next key of the database specified by <parameter>handle</parameter> and advances the internal @@ -438,15 +438,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>dba_popen</function> establishes a persistent database instance @@ -488,15 +488,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>dba_open</function> establishes a database instance for <parameter>path</parameter> with <parameter>mode</parameter> using @@ -537,12 +537,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>dba_optimize</methodname> <methodparam><type>int</type><parameter>handle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>dba_optimize</function> optimizes the underlying database specified by <parameter>handle</parameter>. @@ -569,14 +569,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>dba_replace</function> replaces or inserts the entry described with <parameter>key</parameter> and <parameter>value</parameter> into the @@ -611,12 +611,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>dba_sync</methodname> <methodparam><type>int</type><parameter>handle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>dba_sync</function> synchronizes the database specified by <parameter>handle</parameter>. This will probably trigger a physical write Index: phpdoc/en/functions/dbase.xml diff -u phpdoc/en/functions/dbase.xml:1.12.2.1 phpdoc/en/functions/dbase.xml:1.12.2.2 --- phpdoc/en/functions/dbase.xml:1.12.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/dbase.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.12.2.1 $ --> +<!-- $Revision: 1.12.2.2 $ --> <reference id="ref.dbase"> <title>dBase functions</title> <titleabbrev>dBase</titleabbrev> @@ -37,13 +37,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <parameter>fields</parameter> parameter is an array of arrays, each array describing the format of one field in the @@ -133,13 +133,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The flags correspond to those for the open() system call. (Typically 0 means read-only, 1 means write-only, and 2 means @@ -160,12 +160,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>dbase_close</methodname> <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Closes the database associated with <parameter>dbase_identifier</parameter>. @@ -180,12 +180,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>dbase_pack</methodname> <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Packs the specified database (permanently deleting all records marked for deletion using @@ -201,13 +201,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Adds the data in the <parameter>record</parameter> to the database. If the number of items in the supplied record isn't @@ -224,14 +224,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> Replaces the data associated with the record <parameter>record_number</parameter> with the data in the @@ -255,13 +255,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Marks <parameter>record</parameter> to be deleted from the database. To actually remove the record from the database, you @@ -277,13 +277,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the data from <parameter>record</parameter> in an array. The array is indexed starting at 0, and includes an @@ -307,13 +307,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the data from <parameter>record</parameter> in an associative array. The array also includes an associative member @@ -336,12 +336,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dbase_numfields</methodname> <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the number of fields (columns) in the specified database. Field numbers are between 0 and dbase_numfields($db)-1, @@ -369,12 +369,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dbase_numrecords</methodname> <methodparam><type>int</type><parameter>dbase_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the number of records (rows) in the specified database. Record numbers are between 1 and dbase_numrecords($db), Index: phpdoc/en/functions/dbm.xml diff -u phpdoc/en/functions/dbm.xml:1.13.2.1 phpdoc/en/functions/dbm.xml:1.13.2.2 --- phpdoc/en/functions/dbm.xml:1.13.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/dbm.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.13.2.1 $ --> +<!-- $Revision: 1.13.2.2 $ --> <reference id="ref.dbm"> <title>DBM Functions</title> <titleabbrev>DBM</titleabbrev> @@ -37,13 +37,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dbmopen</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> <methodparam><type>string</type><parameter>flags</parameter></methodparam> - - </methodsynopsis> + </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 @@ -80,12 +80,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>dbmclose</methodname> <methodparam><type>int</type><parameter>dbm_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Unlocks and closes the specified database. </para> @@ -101,13 +101,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns &true; if there is a value associated with the <parameter>key</parameter>. @@ -124,13 +124,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the value associated with <parameter>key</parameter>. </para> @@ -146,14 +146,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Adds the value to the database with the specified key. </para> @@ -174,14 +174,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Replaces the value for the specified key in the database. </para> @@ -201,13 +201,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Deletes the value for <parameter>key</parameter> in the database. </para> @@ -226,12 +226,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>dbmfirstkey</methodname> <methodparam><type>int</type><parameter>dbm_identifier</parameter></methodparam> - - </methodsynopsis> + </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, @@ -248,13 +248,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the next key after <parameter>key</parameter>. By calling <function>dbmfirstkey</function> followed by successive @@ -283,12 +283,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>dblist</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + </refsect1> </refentry> Index: phpdoc/en/functions/dbplus.xml diff -u phpdoc/en/functions/dbplus.xml:1.17.2.1 phpdoc/en/functions/dbplus.xml:1.17.2.2 --- phpdoc/en/functions/dbplus.xml:1.17.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/dbplus.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.17.2.1 $ --> +<!-- $Revision: 1.17.2.2 $ --> <reference id="ref.dbplus"> <title>DB++ Functions</title> <titleabbrev>DB++</titleabbrev> @@ -285,13 +285,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> This function will add a tuple to a relation. The @@ -318,14 +318,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_aql</function> will execute an AQL @@ -354,12 +354,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>dbplus_chdir</methodname> <methodparam choice="opt"><type>string</type><parameter>newdir</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_chdir</function> will change the virtual current @@ -381,12 +381,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dbplus_close</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Calling <function>dbplus_close</function> will close a relation @@ -402,13 +402,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_curr</function> will read the data for the @@ -440,12 +440,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>dbplus_errcode</methodname> <methodparam><type>int</type><parameter>errno</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_errcode</function> returns a cleartext error @@ -463,12 +463,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dbplus_errno</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_errno</function> will return the error code @@ -487,14 +487,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_find</function> will place a constraint on the @@ -529,13 +529,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_curr</function> will read the data for the first @@ -565,12 +565,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dbplus_flush</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_flush</function> will write all changes applied @@ -592,12 +592,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dbplus_freealllocks</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_freeaalllocks</function> will free all tuple locks @@ -618,13 +618,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_freelock</function> will release a write lock on @@ -646,12 +646,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dbplus_freerlocks</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_freerlocks</function> will free all tuple locks held @@ -672,13 +672,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_getlock</function> will request a write lock on @@ -701,13 +701,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_getunique</function> will obtain a number @@ -731,14 +731,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Not implemented yet. @@ -753,13 +753,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_curr</function> will read the data for the last @@ -789,12 +789,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dbplus_lockrel</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_lockrel</function> will request a write lock @@ -811,13 +811,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dbplus_next</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> <methodparam><type>array</type><parameter/></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_curr</function> will read the data for the next @@ -847,12 +847,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>resource</type><methodname>dbplus_open</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> The relation file <parameter>name</parameter> will be opened. @@ -877,13 +877,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_curr</function> will read the data for the next @@ -913,15 +913,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_rchperm</function> will change access @@ -939,14 +939,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_rcreate</function> will create a new relation @@ -976,14 +976,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_rcrtexact</function> will create an exact but @@ -1003,14 +1003,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_rcrtexact</function> will create an empty copy @@ -1030,12 +1030,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dbplus_resolve</methodname> <methodparam><type>string</type><parameter>relation_name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_resolve</function> will try to resolve the given @@ -1057,13 +1057,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_rkeys</function> will replace the current @@ -1083,13 +1083,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Not implemented yet. @@ -1104,12 +1104,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>resource</type><methodname>dbplus_ropen</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_ropen</function> will open the relation @@ -1129,13 +1129,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_rquery</function> performs a local (raw) AQL @@ -1153,13 +1153,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_rrename</function> will change the name of @@ -1177,14 +1177,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_rsecindex</function> will create a new secondary @@ -1206,12 +1206,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dbplus_runlink</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_unlink</function> will close and remove the @@ -1227,12 +1227,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dbplus_rzap</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_rzap</function> will remove all tuples from @@ -1248,12 +1248,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dbplus_savepos</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Not implemented yet. @@ -1268,13 +1268,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Not implemented yet. @@ -1289,13 +1289,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Not implemented yet. @@ -1310,14 +1310,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Not implemented yet. @@ -1332,13 +1332,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> A db++ server will prepare a TCL interpreter for each client @@ -1367,14 +1367,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_tremove</function> removes @@ -1394,12 +1394,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dbplus_undo</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Not implemented yet. @@ -1414,12 +1414,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dbplus_undoprepare</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Not implemented yet. @@ -1434,12 +1434,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dbplus_unlockrel</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_unlockrel</function> will release a write lock @@ -1455,12 +1455,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dbplus_unselect</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Calling <function>dbplus_unselect</function> will remove a @@ -1477,14 +1477,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_update</function> replaces the tuple given by @@ -1503,12 +1503,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dbplus_xlockrel</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_xlockrel</function> will request an exclusive @@ -1528,12 +1528,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dbplus_xunlockrel</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>dbplus_xunlockrel</function> will release an exclusive Index: phpdoc/en/functions/dbx.xml diff -u phpdoc/en/functions/dbx.xml:1.20.2.1 phpdoc/en/functions/dbx.xml:1.20.2.2 --- phpdoc/en/functions/dbx.xml:1.20.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/dbx.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.20.2.1 $ --> +<!-- $Revision: 1.20.2.2 $ --> <reference id="ref.dbx"> <title>dbx functions</title> <titleabbrev>dbx</titleabbrev> @@ -37,12 +37,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>dbx_close</methodname> <methodparam><type>dbx_link_object</type><parameter>link_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Returns &true; on success, @@ -77,8 +77,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -86,8 +86,8 @@ <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> + </methodsynopsis> + &warn.experimental.func; <para> Returns: a dbx_link_object on success, &false; @@ -188,12 +188,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>dbx_error</methodname> <methodparam><type>dbx_link_object</type><parameter>link_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Returns a string containing the error-message from the last @@ -237,14 +237,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Returns a dbx_result_object or 1 on success (a result object is @@ -382,13 +382,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Returns &true; on success, @@ -427,15 +427,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Returns 0 if row_a[$columnname_or_index] is equal to Index: phpdoc/en/functions/dir.xml diff -u phpdoc/en/functions/dir.xml:1.24.2.1 phpdoc/en/functions/dir.xml:1.24.2.2 --- phpdoc/en/functions/dir.xml:1.24.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/dir.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.24.2.1 $ --> +<!-- $Revision: 1.24.2.2 $ --> <reference id="ref.dir"> <title>Directory functions</title> <titleabbrev>Directories</titleabbrev> @@ -22,12 +22,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>chroot</methodname> <methodparam><type>string</type><parameter>directory</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Changes the root directory of the current process to <parameter>directory</parameter>. Returns &false; if unable to @@ -51,12 +51,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>chdir</methodname> <methodparam><type>string</type><parameter>directory</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Changes PHP's current directory to <parameter>directory</parameter>. Returns &false; if unable to @@ -72,12 +72,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>object</type><methodname>dir</methodname> <methodparam><type>string</type><parameter>directory</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> A pseudo-object oriented mechanism for reading a directory. The given <parameter>directory</parameter> is opened. Two properties @@ -110,12 +110,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>closedir</methodname> <methodparam><type>resource</type><parameter>dir_handle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Closes the directory stream indicated by <parameter>dir_handle</parameter>. The stream must have previously @@ -131,12 +131,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>getcwd</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the current working directory. </para> @@ -150,12 +150,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>resource</type><methodname>opendir</methodname> <methodparam><type>string</type><parameter>path</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a directory handle to be used in subsequent <function>closedir</function>, <function>readdir</function>, and @@ -196,12 +196,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>readdir</methodname> <methodparam><type>resource</type><parameter>dir_handle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the filename of the next file from the directory. The filenames are not returned in any particular order. @@ -254,12 +254,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>rewinddir</methodname> <methodparam><type>resource</type><parameter>dir_handle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Resets the directory stream indicated by <parameter>dir_handle</parameter> to the beginning of the Index: phpdoc/en/functions/domxml.xml diff -u phpdoc/en/functions/domxml.xml:1.24.2.2 phpdoc/en/functions/domxml.xml:1.24.2.3 --- phpdoc/en/functions/domxml.xml:1.24.2.2 Sun Nov 11 21:04:37 2001 +++ phpdoc/en/functions/domxml.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.24.2.2 $ --> +<!-- $Revision: 1.24.2.3 $ --> <reference id="ref.domxml"> <title>DOM XML functions</title> <titleabbrev>DOM XML</titleabbrev> @@ -348,14 +348,8 @@ </partintro> - - -<!-- class Dom document --> - - - - -<!-- has member functions + <!-- class Dom document --> + <!-- has member functions array root([int doc_handle]) returns array of root nodes of this document. Array elements are objects of class "Dom node" having properties of @@ -386,11 +380,7 @@ dumps document into string. --> - - - - -<!-- class Dom node + <!-- class Dom node object lastchild([int node]) returns Dom node object @@ -416,29 +406,15 @@ creates a named Dom node object. --> - - - - -<!-- class Dom Attribute + <!-- class Dom Attribute name --> - - - - -<!-- class Dom Namespace - --> - - - - - -<!-- class Dtd + <!-- class Dom Namespace --> - + <!-- class Dtd + --> <refentry id="function.xmldoc"> <refnamediv> @@ -447,12 +423,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>object</type><methodname>xmldoc</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> The function parses the XML document in @@ -472,12 +448,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>object</type><methodname>xmldocfile</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> The function parses the XML document in the file named @@ -500,12 +476,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>object</type><methodname>xmltree</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> The function parses the XML document in @@ -529,12 +505,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>object</type><methodname>domxml_root</methodname> <methodparam><type>object</type><parameter>doc</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>domxml_root</function> takes one argument, an object of class @@ -594,13 +570,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Adds a root element node to a dom document and returns the new node. @@ -632,12 +608,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>domxml_dumpmem</methodname> <methodparam><type>resource</type><parameter>doc</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Creates an XML document from the dom representation. This function @@ -659,12 +635,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>domxml_attributes</methodname> <methodparam><type>resource</type><parameter>node</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Returns all attributes of a node as array of objects of type @@ -682,13 +658,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Returns the attribute with name <parameter>name</parameter> of the given @@ -708,14 +684,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Sets an attribute with name <parameter>name</parameter> of the given @@ -751,12 +727,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>domxml_children</methodname> <methodparam><type>object</type><parameter>doc|node</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Returns all children of a node as an array of nodes. @@ -791,13 +767,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Adds a new child of type element to a node and returns it. @@ -814,12 +790,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>object</type><methodname>domxml_new_xmldoc</methodname> <methodparam><type>string</type><parameter>version</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Creates a new dom document from scratch and returns it. @@ -839,12 +815,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>object</type><methodname>xpath_new_context</methodname> <methodparam><type>object</type><parameter>dom document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> </para> @@ -863,12 +839,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>xpath_eval</methodname> <methodparam><type>object</type><parameter>xpath context</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> </para> Index: phpdoc/en/functions/errorfunc.xml diff -u phpdoc/en/functions/errorfunc.xml:1.19.2.1 phpdoc/en/functions/errorfunc.xml:1.19.2.2 --- phpdoc/en/functions/errorfunc.xml:1.19.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/errorfunc.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.19.2.1 $ --> +<!-- $Revision: 1.19.2.2 $ --> <reference id="ref.errorfunc"> <title>Error Handling and Logging Functions</title> <titleabbrev>Errors and Logging</titleabbrev> @@ -31,15 +31,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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, @@ -132,12 +132,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>error_reporting</methodname> <methodparam choice="opt"><type>int</type><parameter>level</parameter></methodparam> - - </methodsynopsis> + </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 @@ -272,12 +272,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>restore_error_handler</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Used after changing the error handler function using <function>set_error_handler</function>, to revert to the previous error @@ -300,12 +300,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>set_error_handler</methodname> <methodparam><type>string</type><parameter>error_handler</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Sets a user function (<parameter>error_handler</parameter>) to handle errors in a script. Returns the previously defined error handler (if @@ -477,13 +477,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -525,13 +525,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This is an alias for the function <function>trigger_error</function>. </para> Index: phpdoc/en/functions/exec.xml diff -u phpdoc/en/functions/exec.xml:1.21.2.1 phpdoc/en/functions/exec.xml:1.21.2.2 --- phpdoc/en/functions/exec.xml:1.21.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/exec.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.21.2.1 $ --> +<!-- $Revision: 1.21.2.2 $ --> <reference id="ref.exec"> <title>Program Execution functions</title> <titleabbrev>Program Execution</titleabbrev> @@ -20,12 +20,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>escapeshellarg</methodname> <methodparam><type>string</type><parameter>arg</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>escapeshellarg</function> adds single quotes around a string and quotes/escapes any existing single quotes allowing you to pass a @@ -57,12 +57,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>escapeshellcmd</methodname> <methodparam><type>string</type><parameter>command</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>escapeshellcmd</function> escapes any characters in a string that might be used to trick a shell command into executing @@ -96,15 +96,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>exec</function> executes the given <parameter>command</parameter>, however it does not output @@ -158,13 +158,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>passthru</function> function is similar to the <function>exec</function> function in that it executes a @@ -202,13 +202,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>system</function> is just like the C version of the function in that it executes the given Index: phpdoc/en/functions/fbsql.xml diff -u phpdoc/en/functions/fbsql.xml:1.31.2.1 phpdoc/en/functions/fbsql.xml:1.31.2.2 --- phpdoc/en/functions/fbsql.xml:1.31.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/fbsql.xml Mon Nov 12 09:59:18 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.31.2.1 $ --> +<!-- $Revision: 1.31.2.2 $ --> <reference id="ref.fbsql"> <title>FrontBase Functions</title> <titleabbrev>FrontBase</titleabbrev> @@ -35,14 +35,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>fbsql_affected_rows</methodname> <methodparam choice="opt"><type>int</type><parameter> link_identifier </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>fbsql_affected_rows</function> returns the number of rows affected by the last INSERT, UPDATE or DELETE query @@ -87,15 +87,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>fbsql_autocommit</function> returns the current autocommit status. if the optional OnOff parameter is @@ -122,8 +122,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -133,8 +133,8 @@ <methodparam choice="opt"><type>int</type><parameter> link_identifier </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>fbsql_change_user</function> changes the logged in user of the current active connection, or the connection given by the @@ -153,14 +153,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>boolean</type><methodname>fbsql_close</methodname> <methodparam choice="opt"><type>resource</type><parameter> link_identifier </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: &true; on success, &false; on error. </para> @@ -200,14 +200,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>fbsql_commit</methodname> <methodparam choice="opt"><type>resource</type><parameter> link_identifier </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: &true; on success, &false; on failure. </para> @@ -231,8 +231,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>resource</type><methodname>fbsql_connect</methodname> <methodparam choice="opt"><type>string</type><parameter> hostname @@ -244,8 +244,8 @@ <methodparam choice="opt"><type>string</type><parameter> password </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a positive FrontBase link identifier on success, or an error message on failure. @@ -296,15 +296,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>fbsql_create_db</function> attempts to create a new database on the server associated with the specified link @@ -337,15 +337,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: A resource handle to the newly created blob. </para> @@ -388,15 +388,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: A resource handle to the newly created CLOB. </para> @@ -441,15 +441,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: The database password for the database represented by the link identifier. @@ -478,13 +478,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: &true; on success, &false; on failure. </para> @@ -540,16 +540,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: A positive FrontBase result identifier to the query result, or &false; on error. @@ -575,15 +575,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: An integer value with the current status. </para> @@ -654,15 +654,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: &true; on success, &false; on failure. </para> @@ -684,14 +684,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>fbsql_errno</methodname> <methodparam choice="opt"><type>resource</type><parameter> link_identifier </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the error number from the last fbsql function, or <literal>0</literal> (zero) if no error occurred. @@ -734,14 +734,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>fbsql_error</methodname> <methodparam choice="opt"><type>resource</type><parameter> link_identifier </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the error text from the last fbsql function, or <literal>''</literal> (the empty string) if no error occurred. @@ -784,15 +784,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array that corresponds to the fetched row, or &false; if there are no more rows. @@ -859,12 +859,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>fbsql_fetch_assoc</methodname> <methodparam><type>resource</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns an associative array that corresponds to the fetched row, or &false; if there are no more rows.</para> @@ -919,15 +919,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an object containing field information. </para> @@ -1011,12 +1011,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>fbsql_fetch_lengths</methodname> <methodparam choice="opt"><type>resource</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: An array that corresponds to the lengths of each field in the last row fetched by <function>fbsql_fetch_row</function>, @@ -1043,15 +1043,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an object with properties that correspond to the fetched row, or &false; if there are no more rows. @@ -1102,12 +1102,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>fbsql_fetch_row</methodname> <methodparam><type>resource</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: An array that corresponds to the fetched row, or &false; if there are no more rows. @@ -1142,13 +1142,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>fbsql_field_flags</function> returns the field flags of the specified field. The flags are reported as a single word @@ -1167,13 +1167,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>fbsql_field_name</function> returns the name of the specified field index. <parameter>result</parameter> must be a @@ -1226,13 +1226,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>fbsql_field_len</function> returns the length of the specified field. @@ -1249,13 +1249,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Seeks to the specified field offset. If the next call to <function>fbsql_fetch_field</function> doesn't include a field @@ -1277,13 +1277,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the name of the table that the specifed field is in. @@ -1300,13 +1300,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>fbsql_field_type</function> is similar to the <function>fbsql_field_name</function> function. The arguments are @@ -1352,12 +1352,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>fbsql_free_result</methodname> <methodparam><type>int</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>fbsql_free_result</function> will free all memory associated with the result identifier <parameter>result</parameter>. @@ -1380,14 +1380,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>fbsql_insert_id</methodname> <methodparam choice="opt"><type>resource</type><parameter> link_identifier </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>fbsql_insert_id</function> returns the ID generated for an column defined as DEFAULT UNIQUE by the previous INSERT query @@ -1421,14 +1421,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>resource</type><methodname>fbsql_list_dbs</methodname> <methodparam choice="opt"><type>resource</type><parameter> link_identifier </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>fbsql_list_dbs</function> will return a result pointer containing the databases available from the current fbsql @@ -1475,16 +1475,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>fbsql_list_fields</function> retrieves information about the given tablename. Arguments are the database name and @@ -1537,15 +1537,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>fbsql_list_tables</function> takes a database name and returns a result pointer much like the @@ -1565,12 +1565,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>fbsql_next_result</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> When sending more than one SQL statement to the server or executing a stored procedure with multiple results will cause the @@ -1608,12 +1608,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>fbsql_num_fields</methodname> <methodparam><type>resource</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>fbsql_num_fields</function> returns the number of fields in a result set. @@ -1635,12 +1635,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>fbsql_num_rows</methodname> <methodparam><type>resource</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>fbsql_num_rows</function> returns the number of rows in a result set. This command is only valid for SELECT statements. @@ -1681,14 +1681,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: A positive FrontBase persistent link identifier on success, or &false; on error. @@ -1732,13 +1732,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>fbsql_query</function> sends a query to the currently active database on the server that's associated with the @@ -1829,15 +1829,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: A string containing the BLOB specified by blob_handle. </para> @@ -1889,15 +1889,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: A string containing the CLOB specified by clob_handle. </para> @@ -1949,16 +1949,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>fbsql_result</function> returns the contents of one cell from a FrontBase result set. The field argument can be the @@ -1996,14 +1996,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>fbsql_rollback</methodname> <methodparam choice="opt"><type>resource</type><parameter> link_identifier </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: &true; on success, &false; on failure. </para> @@ -2028,13 +2028,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: &true; on success, &false; on error. </para> @@ -2085,15 +2085,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: &true; on success, &false; on error. </para> @@ -2132,15 +2132,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: &true; on success, &false; on failure. </para> @@ -2161,15 +2161,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: &true; on success, &false; on failure. </para> @@ -2190,13 +2190,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>fbsql_tablename</function> takes a result pointer returned by the <function>fbsql_list_tables</function> function @@ -2229,14 +2229,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>fbsql_warnings</methodname> <methodparam choice="opt"><type>bool</type><parameter> OnOff </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if warnings is turned on otherwise &false;. </para> Index: phpdoc/en/functions/fdf.xml diff -u phpdoc/en/functions/fdf.xml:1.21.2.1 phpdoc/en/functions/fdf.xml:1.21.2.2 --- phpdoc/en/functions/fdf.xml:1.21.2.1 Sun Nov 11 20:08:48 2001 +++ phpdoc/en/functions/fdf.xml Mon Nov 12 09:59:20 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.21.2.1 $ --> +<!-- $Revision: 1.21.2.2 $ --> <reference id="ref.fdf"> <title>Forms Data Format functions</title> <titleabbrev>FDF</titleabbrev> @@ -103,12 +103,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>fdf_open</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>fdf_open</function> function opens a file with form data. This file must contain the data as returned @@ -149,12 +149,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>fdf_close</methodname> <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>fdf_close</function> function closes the FDF document.</para> @@ -171,12 +171,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>fdf_create</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>fdf_create</function> creates a new FDF document. This function is needed if one would like to @@ -215,12 +215,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>fdf_save</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>fdf_save</function> function saves a FDF document. @@ -244,13 +244,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>fdf_get_value</function> function returns the value of a field.</para> @@ -268,15 +268,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>fdf_set_value</function> function sets the value of a field. The last parameter determines if the field value @@ -296,13 +296,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>fdf_next_field_name</methodname> <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>fieldname</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>fdf_next_field_name</function> function returns the name of the field after the field in @@ -323,16 +323,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>fdf_set_ap</function> function sets the appearance of a field (i.e. the value of the /AP key). @@ -349,13 +349,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>fdf_set_status</function> sets the value of the /STATUS key.</para> @@ -373,12 +373,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>fdf_get_status</methodname> <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>fdf_get_status</function> returns the value of the /STATUS key.</para> @@ -396,13 +396,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -423,12 +423,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>fdf_get_file</methodname> <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>fdf_set_file</function> returns the value of the /F key.</para> @@ -446,15 +446,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>fdf_set_flags</function> sets certain flags of the given field <parameter>fieldname</parameter>. @@ -472,16 +472,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>fdf_set_opt</function> sets options of the given field <parameter>fieldname</parameter>. @@ -499,16 +499,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>fdf_set_submit_form_action</function> sets a submit form action for the given field <parameter>fieldname</parameter>. @@ -526,15 +526,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>fdf_set_javascript_action</function> sets a javascript action for the given field <parameter>fieldname</parameter>. @@ -552,13 +552,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>fdf_set_encoding</function> sets the character encoding in FDF document <parameter>fdf_document</parameter>. Index: phpdoc/en/functions/filepro.xml diff -u phpdoc/en/functions/filepro.xml:1.12.2.1 phpdoc/en/functions/filepro.xml:1.12.2.2 --- phpdoc/en/functions/filepro.xml:1.12.2.1 Sun Nov 11 20:08:49 2001 +++ phpdoc/en/functions/filepro.xml Mon Nov 12 09:59:20 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.12.2.1 $ --> +<!-- $Revision: 1.12.2.2 $ --> <reference id="ref.filepro"> <title>filePro functions</title> <titleabbrev>filePro</titleabbrev> @@ -19,12 +19,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>filepro</methodname> <methodparam><type>string</type><parameter>directory</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This reads and verifies the map file, storing the field count and info.</para> @@ -42,12 +42,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>filepro_fieldname</methodname> <methodparam><type>int</type><parameter>field_number</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the name of the field corresponding to <parameter>field_number</parameter>.</para> </refsect1> @@ -60,12 +60,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>filepro_fieldtype</methodname> <methodparam><type>int</type><parameter>field_number</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the edit type of the field corresponding to <parameter>field_number</parameter>.</para> </refsect1> @@ -78,12 +78,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>filepro_fieldwidth</methodname> <methodparam><type>int</type><parameter>field_number</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the width of the field corresponding to <parameter>field_number</parameter>.</para> </refsect1> @@ -96,13 +96,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the data from the specified location in the database.</para> &note.sm.uidcheck; @@ -116,12 +116,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>filepro_fieldcount</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the number of fields (columns) in the opened filePro database. @@ -138,12 +138,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>filepro_rowcount</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the number of rows in the opened filePro database.</para> &note.sm.uidcheck; Index: phpdoc/en/functions/filesystem.xml diff -u phpdoc/en/functions/filesystem.xml:1.85.2.1 phpdoc/en/functions/filesystem.xml:1.85.2.2 --- phpdoc/en/functions/filesystem.xml:1.85.2.1 Sun Nov 11 20:08:50 2001 +++ phpdoc/en/functions/filesystem.xml Mon Nov 12 09:59:20 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.85.2.1 $ --> +<!-- $Revision: 1.85.2.2 $ --> <reference id="ref.filesystem"> <title>Filesystem functions</title> <titleabbrev>Filesystem</titleabbrev> @@ -13,13 +13,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Given a string containing a path to a file, this function will return the base name of the file. @@ -60,13 +60,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>chgrp</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> <methodparam><type>mixed</type><parameter>group</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Attempts to change the group of the file <parameter>filename</parameter> to @@ -96,13 +96,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>chmod</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> <methodparam><type>int</type><parameter>mode</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Attempts to change the mode of the file specified by <parameter>filename</parameter> to that given in @@ -143,13 +143,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>chown</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> <methodparam><type>mixed</type><parameter>user</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Attempts to change the owner of the file filename to user user. Only the superuser may change the owner of a file. @@ -176,12 +176,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>clearstatcache</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Invoking the <systemitem>stat</systemitem> or <systemitem>lstat</systemitem> system call on most systems is @@ -225,13 +225,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>copy</methodname> <methodparam><type>string</type><parameter>source</parameter></methodparam> <methodparam><type>string</type><parameter>dest</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Makes a copy of a file. Returns &true; if the copy succeeded, &false; otherwise. @@ -257,12 +257,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>delete</methodname> <methodparam><type>string</type><parameter>file</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This is a dummy manual entry to satisfy those people who are looking for <function>unlink</function> or @@ -282,12 +282,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>dirname</methodname> <methodparam><type>string</type><parameter>path</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Given a string containing a path to a file, this function will return the name of the directory.</para> @@ -311,19 +311,19 @@ </refsect1> </refentry> - <refentry id="function.diskfreespace"> + <refentry id="function.disk-free-space"> <refnamediv> - <refname>diskfreespace</refname> + <refname>disk_free_space</refname> <refpurpose>Returns available space in directory</refpurpose> </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - - <type>float</type><methodname>diskfreespace</methodname> + + <methodsynopsis> + <type>float</type><methodname>disk_free_space</methodname> <methodparam><type>string</type><parameter>directory</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Given a string containing a directory, this function will return the number of bytes available on the corresponding filesystem or @@ -331,9 +331,9 @@ </para> <para> <example> - <title><function>diskfreespace</function> example</title> + <title><function>disk_free_space</function> example</title> <programlisting role="php"> -$df = diskfreespace("/"); // $df contains the number of bytes +$df = disk_free_space("/"); // $df contains the number of bytes // available on "/" </programlisting> </example> @@ -341,6 +341,27 @@ </refsect1> </refentry> + <refentry id="function.diskfreespace"> + <refnamediv> + <refname>diskfreespace</refname> + <refpurpose>Alias of <function>disk_free_space</function></refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <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>. + Use that function instead. + </para> + </refsect1> + </refentry> + <refentry id="function.disk-total-space"> <refnamediv> <refname>disk_total_space</refname> @@ -348,12 +369,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>float</type><methodname>disk_total_space</methodname> <methodparam><type>string</type><parameter>directory</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Given a string containing a directory, this function will return the total number of bytes on the corresponding filesystem or disk @@ -378,12 +399,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>fclose</methodname> <methodparam><type>int</type><parameter>fp</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The file pointed to by <parameter>fp</parameter> is closed. </para> @@ -406,12 +427,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>feof</methodname> <methodparam><type>int</type><parameter>fp</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if the file pointer is at EOF or an error occurs; otherwise returns &false;. @@ -431,12 +452,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>fflush</methodname> <methodparam><type>int</type><parameter>fp</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function forces a write of all buffered output to the to the resource pointed to by the file handle @@ -458,12 +479,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>fgetc</methodname> <methodparam><type>int</type><parameter>fp</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a string containing a single character read from the file pointed to by fp. Returns &false; on EOF. @@ -490,16 +511,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> Similar to <function>fgets</function> except that <function>fgetcsv</function> parses the line it reads for fields @@ -554,13 +575,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>fgets</methodname> <methodparam><type>int</type><parameter>fp</parameter></methodparam> <methodparam><type>int</type><parameter>length</parameter></methodparam> - - </methodsynopsis> + </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 @@ -615,16 +636,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Identical to <function>fgets</function>, except that fgetss attempts to strip any HTML and PHP tags from the text it @@ -655,13 +676,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Identical to <function>readfile</function>, except that <function>file</function> returns the file in an array. Each @@ -704,12 +725,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>file_exists</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns &true; if the file specified by <parameter>filename</parameter> exists; &false; otherwise. @@ -733,12 +754,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>fileatime</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </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. @@ -771,12 +792,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>filectime</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </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. @@ -812,12 +833,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>filegroup</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </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 @@ -846,12 +867,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>fileinode</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the inode number of the file, or &false; in case of an error.</para> @@ -878,12 +899,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>filemtime</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </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. @@ -912,12 +933,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>fileowner</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </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 @@ -946,12 +967,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>fileperms</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the permissions on the file, or &false; in case of an error. </para> @@ -973,12 +994,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>filesize</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the size of the file, or &false; in case of an error. </para> @@ -1000,12 +1021,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>filetype</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the type of the file. Possible values are fifo, char, dir, block, link, file, and unknown.</para> <para> Returns &false; @@ -1029,16 +1050,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> PHP supports a portable way of locking complete files in an advisory way (which means all accessing programs have to use the @@ -1112,16 +1133,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> If <parameter>filename</parameter> begins with "http://" (not case sensitive), an HTTP 1.0 connection is opened to the @@ -1263,12 +1284,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>fpassthru</methodname> <methodparam><type>int</type><parameter>fp</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Reads to EOF on the given file pointer and writes the results to standard output. @@ -1304,16 +1325,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>fputs</function> is an alias to <function>fwrite</function>, and is identical in every way. Note @@ -1330,13 +1351,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>fread</methodname> <methodparam><type>int</type><parameter>fp</parameter></methodparam> <methodparam><type>int</type><parameter>length</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>fread</function> reads up to <parameter>length</parameter> bytes from the file pointer @@ -1389,14 +1410,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The function <function>fscanf</function> is similar to <function>sscanf</function>, but it takes its input from a file @@ -1443,14 +1464,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Sets the file position indicator for the file referenced by <parameter>fp</parameter>.The new position, measured in bytes @@ -1500,12 +1521,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>fstat</methodname> <methodparam><type>int</type><parameter>fp</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Gathers the statistics of the file opened by the file pointer fp. This function is similar to the @@ -1545,12 +1566,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ftell</methodname> <methodparam><type>int</type><parameter>fp</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the position of the file pointer referenced by fp; i.e., its offset into the file stream. @@ -1579,13 +1600,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ftruncate</methodname> <methodparam><type>int</type><parameter>fp</parameter></methodparam> <methodparam><type>int</type><parameter>size</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Takes the filepointer, fp, and truncates the file to length, size. This function returns &true; on success and &false; on failure. @@ -1600,16 +1621,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> <function>fwrite</function> writes the contents of <parameter>string</parameter> to the file stream pointed to by @@ -1649,13 +1670,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> Output using <function>fwrite</function> is normally buffered at 8K. This means that if there are two processess wanting to write @@ -1701,12 +1722,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>is_dir</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if the filename exists and is a directory. </para> @@ -1732,12 +1753,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>is_executable</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if the filename exists and is executable. </para> @@ -1765,12 +1786,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>is_file</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if the filename exists and is a regular file. </para> @@ -1794,12 +1815,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>is_link</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if the filename exists and is a symbolic link. </para> @@ -1832,12 +1853,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>is_readable</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if the filename exists and is readable. </para> @@ -1867,12 +1888,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>is_writable</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if the filename exists and is writable. The filename argument may be a directory name allowing you to check @@ -1904,12 +1925,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>is_writeable</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This is an alias for <function>is_writable</function> </para> @@ -1923,12 +1944,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>is_uploaded_file</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function is available only in versions of PHP 3 after PHP @@ -1965,13 +1986,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>link</methodname> <methodparam><type>string</type><parameter>target</parameter></methodparam> <methodparam><type>string</type><parameter>link</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>link</function> creates a hard link.</para> <para> @@ -1994,12 +2015,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>linkinfo</methodname> <methodparam><type>string</type><parameter>path</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>linkinfo</function> returns the st_dev field of the UNIX C stat structure returned by the lstat system call. This @@ -2027,13 +2048,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mkdir</methodname> <methodparam><type>string</type><parameter>pathname</parameter></methodparam> <methodparam><type>int</type><parameter>mode</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Attempts to create the directory specified by pathname. </para> @@ -2064,13 +2085,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function is available only in versions of PHP 3 after PHP @@ -2116,6 +2137,108 @@ </refsect1> </refentry> + <refentry id="function.parse-ini-file"> + <refnamediv> + <refname>parse_ini_file</refname> + <refpurpose>Parse a configuration file</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <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>, + and returns the settings in it in an associative array. + By setting the last <parameter>process_sections</parameter> + parameter to &true;, you get a multidimensional array, with + the section names and settings included. The default + for <parameter>process_sections</parameter> is &false; + </para> + <note> + <para> + This function has nothing to do with the + <filename>php.ini</filename> file. It is already processed, + the time you run your script. This function can be used to + read in your own application's configuration files. + </para> + </note> + <para> + The structure of the ini file is similar to that of + the <filename>php.ini</filename>'s. + </para> + <para> + <example> + <title>Contents of sample.ini</title> + <programlisting> +; This is a sample configuration file +; Comments start with ';', as in php.ini + +[first_section] +one = 1 +five = 5 + +[second_section] +path = /usr/local/bin + </programlisting> + </example> + </para> + <para> + <example> + <title><function>parse_ini_file</function> example</title> + <programlisting> + +&lt;?php + +// Parse without sections +$ini_array = parse_ini_file("sample.ini"); +print_r($ini_array); + +// Parse with sections +$ini_array = parse_ini_file("sample.ini", TRUE); +print_r($ini_array); + +?> + + </programlisting> + </example> + </para> + <para> + Would produce: + <informalexample> + <programlisting> +Array +( + [one] => 1 + [five] => 5 + [path] => /usr/local/bin +) +Array +( + [first_section] => Array + ( + [one] => 1 + [five] => 5 + ) + + [second_section] => Array + ( + [path] => /usr/local/bin + ) + +) + </programlisting> + </informalexample> + </para> + </refsect1> + </refentry> <refentry id="function.pathinfo"> <refnamediv> @@ -2124,12 +2247,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>pathinfo</methodname> <methodparam><type>string</type><parameter>path</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pathinfo</function> returns an associative array containing information about <parameter>path</parameter>. The @@ -2171,7 +2294,6 @@ </refsect1> </refentry> - <refentry id="function.pclose"> <refnamediv> <refname>pclose</refname> @@ -2179,12 +2301,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pclose</methodname> <methodparam><type>int</type><parameter>fp</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Closes a file pointer to a pipe opened by <function>popen</function>. @@ -2210,13 +2332,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>popen</methodname> <methodparam><type>string</type><parameter>command</parameter></methodparam> <methodparam><type>string</type><parameter>mode</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Opens a pipe to a process executed by forking the command given by command. @@ -2252,15 +2374,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Reads a file and writes it to standard output. </para> @@ -2310,12 +2432,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>readlink</methodname> <methodparam><type>string</type><parameter>path</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>readlink</function> does the same as the readlink C function and returns the contents of the symbolic link path or 0 @@ -2341,13 +2463,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>rename</methodname> <methodparam><type>string</type><parameter>oldname</parameter></methodparam> <methodparam><type>string</type><parameter>newname</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Attempts to rename <parameter>oldname</parameter> to <parameter>newname</parameter>. @@ -2365,12 +2487,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>rewind</methodname> <methodparam><type>int</type><parameter>fp</parameter></methodparam> - - </methodsynopsis> + </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> @@ -2392,12 +2514,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>rmdir</methodname> <methodparam><type>string</type><parameter>dirname</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Attempts to remove the directory named by pathname. The directory must be empty, and the relevant permissions must permit. @@ -2419,12 +2541,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>stat</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Gathers the statistics of the file named by filename. </para> @@ -2471,12 +2593,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>lstat</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Gathers the statistics of the file or symbolic link named by filename. This function is identical to the @@ -2519,12 +2641,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>realpath</methodname> <methodparam><type>string</type><parameter>path</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>realpath</function> expands all symbolic links and resolves references to '/./', '/../' and extra '/' characters in @@ -2550,13 +2672,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>symlink</methodname> <methodparam><type>string</type><parameter>target</parameter></methodparam> <methodparam><type>string</type><parameter>link</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>symlink</function> creates a symbolic link from the existing <parameter>target</parameter> with @@ -2582,13 +2704,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>tempnam</methodname> <methodparam><type>string</type><parameter>dir</parameter></methodparam> <methodparam><type>string</type><parameter>prefix</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Creates a unique temporary filename in the specified directory. If the directory does not exist, <function>tempnam</function> may @@ -2635,12 +2757,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>tmpfile</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Creates a temporary file with an unique name in write mode, returning a file handle similar to the one returned by @@ -2667,15 +2789,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Attempts to set the modification time of the file named by filename to the value given by time. If the option time is not @@ -2708,12 +2830,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>umask</methodname> <methodparam><type>int</type><parameter>mask</parameter></methodparam> - - </methodsynopsis> + </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, @@ -2738,12 +2860,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>unlink</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Deletes <parameter>filename</parameter>. Similar to the Unix C unlink() function. Index: phpdoc/en/functions/ftp.xml diff -u phpdoc/en/functions/ftp.xml:1.25.2.1 phpdoc/en/functions/ftp.xml:1.25.2.2 --- phpdoc/en/functions/ftp.xml:1.25.2.1 Sun Nov 11 20:08:50 2001 +++ phpdoc/en/functions/ftp.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.25.2.1 $ --> +<!-- $Revision: 1.25.2.2 $ --> <reference id="ref.ftp"> <title>FTP functions</title> <titleabbrev>FTP</titleabbrev> @@ -67,14 +67,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ftp_connect</methodname> <methodparam><type>string</type><parameter>host</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>port </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a FTP stream on success, &false; on error. </para> @@ -95,14 +95,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ftp_login</methodname> <methodparam><type>int</type><parameter>ftp_stream</parameter></methodparam> <methodparam><type>string</type><parameter>username</parameter></methodparam> <methodparam><type>string</type><parameter>password</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Logs in the given FTP stream. </para> @@ -119,12 +119,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>ftp_pwd</methodname> <methodparam><type>int</type><parameter>ftp_stream</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the current directory, or &false; on error. </para> @@ -138,12 +138,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ftp_cdup</methodname> <methodparam><type>int</type><parameter>ftp_stream</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Changes to the parent directory. </para> @@ -160,13 +160,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ftp_chdir</methodname> <methodparam><type>int</type><parameter>ftp_stream</parameter></methodparam> <methodparam><type>string</type><parameter>directory</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Changes to the specified <parameter>directory</parameter>. </para> @@ -182,13 +182,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>ftp_mkdir</methodname> <methodparam><type>int</type><parameter>ftp_stream</parameter></methodparam> <methodparam><type>string</type><parameter>directory</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Creates the specified <parameter>directory</parameter>. </para> @@ -204,13 +204,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ftp_rmdir</methodname> <methodparam><type>int</type><parameter>ftp_stream</parameter></methodparam> <methodparam><type>string</type><parameter>directory</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Removes the specified <parameter>directory</parameter>. </para> @@ -226,13 +226,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>ftp_nlist</methodname> <methodparam><type>int</type><parameter>ftp_stream</parameter></methodparam> <methodparam><type>string</type><parameter>directory</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns an array of filenames on success, &false; on error. </para> @@ -248,13 +248,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>ftp_rawlist</methodname> <methodparam><type>int</type><parameter>ftp_stream</parameter></methodparam> <methodparam><type>string</type><parameter>directory</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ftp_rawlist</function> executes the FTP LIST command, and returns the result as an array. Each array element corresponds @@ -274,12 +274,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>ftp_systype</methodname> <methodparam><type>int</type><parameter>ftp_stream</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the remote system type, or &false; on error. </para> @@ -293,13 +293,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ftp_pasv</methodname> <methodparam><type>int</type><parameter>ftp_stream</parameter></methodparam> <methodparam><type>int</type><parameter>pasv</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ftp_pasv</function> turns on passive mode if the <parameter>pasv</parameter> parameter is &true; (it turns off @@ -320,15 +320,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ftp_get</methodname> <methodparam><type>int</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> + </methodsynopsis> + <para> <function>ftp_get</function> retrieves <parameter>remote_file</parameter> from the FTP server, and saves it to <parameter>local_file</parameter> @@ -350,15 +350,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ftp_fget</methodname> <methodparam><type>int</type><parameter>ftp_stream</parameter></methodparam> <methodparam><type>int</type><parameter>fp</parameter></methodparam> <methodparam><type>string</type><parameter>remote_file</parameter></methodparam> <methodparam><type>int</type><parameter>mode</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ftp_fget</function> retrieves <parameter>remote_file</parameter> from the FTP server, and writes it to the given file pointer, @@ -379,15 +379,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ftp_put</methodname> <methodparam><type>int</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> + </methodsynopsis> + <para> <function>ftp_put</function> stores <parameter>local_file</parameter> on the FTP server, as <parameter>remote_file</parameter>. The transfer @@ -415,15 +415,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ftp_fput</methodname> <methodparam><type>int</type><parameter>ftp_stream</parameter></methodparam> <methodparam><type>string</type><parameter>remote_file</parameter></methodparam> <methodparam><type>int</type><parameter>fp</parameter></methodparam> <methodparam><type>int</type><parameter>mode</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ftp_fput</function> uploads the data from the file pointer <parameter>fp</parameter> until end of file. The results are stored @@ -444,13 +444,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ftp_size</methodname> <methodparam><type>int</type><parameter>ftp_stream</parameter></methodparam> <methodparam><type>string</type><parameter>remote_file</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ftp_size</function> returns the size of a file. If an error occurs, of if the file does not exist, -1 is returned. Not @@ -468,13 +468,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ftp_mdtm</methodname> <methodparam><type>int</type><parameter>ftp_stream</parameter></methodparam> <methodparam><type>string</type><parameter>remote_file</parameter></methodparam> - - </methodsynopsis> + </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 @@ -499,14 +499,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>boolean</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> + </methodsynopsis> + <para> <function>ftp_rename</function> renames the file or directory currently named <parameter>from</parameter> to the new name @@ -525,13 +525,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ftp_delete</methodname> <methodparam><type>int</type><parameter>ftp_stream</parameter></methodparam> <methodparam><type>string</type><parameter>path</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ftp_delete</function> deletes the file specified by <parameter>path</parameter> from the FTP server. @@ -549,13 +549,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ftp_site</methodname> <methodparam><type>int</type><parameter>ftp_stream</parameter></methodparam> <methodparam><type>string</type><parameter>cmd</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ftp_site</function> sends the command specified by <parameter>cmd</parameter> to the FTP server. SITE commands @@ -576,12 +576,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ftp_quit</methodname> <methodparam><type>int</type><parameter>ftp_stream</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ftp_quit</function> closes <parameter>ftp_stream</parameter>. </para> Index: phpdoc/en/functions/funchand.xml diff -u phpdoc/en/functions/funchand.xml:1.19.2.1 phpdoc/en/functions/funchand.xml:1.19.2.2 --- phpdoc/en/functions/funchand.xml:1.19.2.1 Sun Nov 11 20:08:50 2001 +++ phpdoc/en/functions/funchand.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.19.2.1 $ --> +<!-- $Revision: 1.19.2.2 $ --> <reference id="ref.funchand"> <title>Function Handling functions</title> <titleabbrev>Functions</titleabbrev> @@ -20,13 +20,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Call a user defined function given by <parameter>function_name</parameter>, with @@ -75,14 +75,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Call a user defined function given by the <parameter>function_name</parameter> parameter. Take the @@ -113,13 +113,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Creates an anonymous function from the parameters passed, and returns a unique name for it. Usually the @@ -259,12 +259,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>func_get_arg</methodname> <methodparam><type>int</type><parameter>arg_num</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns the argument which is at the <parameter>arg_num</parameter>'th offset into a user-defined @@ -317,12 +317,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>func_get_args</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns an array in which each element is the corresponding member of the current user-defined function's argument @@ -373,12 +373,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>func_num_args</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns the number of arguments passed into the current user-defined function. <function>func_num_args</function> will @@ -422,12 +422,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>function_exists</methodname> <methodparam><type>string</type><parameter>function_name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Checks the list of defined functions for <parameter>function_name</parameter>. Returns &true; if the given @@ -459,12 +459,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>get_defined_functions</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns an multidimensional array containing a list of all defined functions, both built-in (internal) and user-defined. The @@ -527,12 +527,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>register_shutdown_function</methodname> <methodparam><type>string</type><parameter>func</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Registers the function named by <parameter>func</parameter> to be executed when script processing is complete.</simpara> @@ -556,13 +556,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> Registers the function named by <parameter>func</parameter> to be executed when a <link linkend="control-structures.declare">tick</link> is @@ -579,13 +579,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> De-registers the function named by <parameter>func</parameter> so it is no longer executed when a <link linkend="control-structures.declare">tick</link> is Index: phpdoc/en/functions/gettext.xml diff -u phpdoc/en/functions/gettext.xml:1.13.2.1 phpdoc/en/functions/gettext.xml:1.13.2.2 --- phpdoc/en/functions/gettext.xml:1.13.2.1 Sun Nov 11 20:08:50 2001 +++ phpdoc/en/functions/gettext.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.13.2.1 $ --> +<!-- $Revision: 1.13.2.2 $ --> <reference id="ref.gettext"> <title>Gettext</title> <titleabbrev>gettext</titleabbrev> @@ -19,13 +19,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>bindtextdomain</methodname> <methodparam><type>string</type><parameter>domain</parameter></methodparam> <methodparam><type>string</type><parameter>directory</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>bindtextdomain</function> function sets the path for a domain. @@ -39,14 +39,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function allows you to override the current domain for a single message lookup. It also allows you to specify a category. @@ -61,13 +61,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>dgettext</methodname> <methodparam><type>string</type><parameter>domain</parameter></methodparam> <methodparam><type>string</type><parameter>message</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>dgettext</function> function allows you to override the current domain for a single message lookup. @@ -82,12 +82,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>gettext</methodname> <methodparam><type>string</type><parameter>message</parameter></methodparam> - - </methodsynopsis> + </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 @@ -121,12 +121,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>textdomain</methodname> <methodparam><type>string</type><parameter>text_domain</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function sets the domain to search within when calls are made to <function>gettext</function>, usually the named after an Index: phpdoc/en/functions/gmp.xml diff -u phpdoc/en/functions/gmp.xml:1.16.2.1 phpdoc/en/functions/gmp.xml:1.16.2.2 --- phpdoc/en/functions/gmp.xml:1.16.2.1 Sun Nov 11 20:08:50 2001 +++ phpdoc/en/functions/gmp.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.16.2.1 $ --> +<!-- $Revision: 1.16.2.2 $ --> <reference id="ref.gmp"> <title>GMP functions</title> <titleabbrev>GMP</titleabbrev> @@ -75,12 +75,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>resource</type><methodname>gmp_init</methodname> <methodparam><type>mixed</type><parameter>number</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Creates a GMP number from an integer or string. String representation can be decimal or hexadecimal. In the latter case, @@ -118,12 +118,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>gmp_intval</methodname> <methodparam><type>resource</type><parameter>gmpnumber</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function allows to convert GMP number to integer. <warning> @@ -144,13 +144,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Convert GMP number to string representation in base <parameter>base</parameter>. The default base is 10. Allowed @@ -177,13 +177,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Add two GMP numbers. The result will be a GMP number representing the sum of the arguments. @@ -198,13 +198,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Subtracts <parameter>b</parameter> from <parameter>a</parameter> and returns the result. @@ -219,13 +219,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Multiplies <parameter>a</parameter> by <parameter>b</parameter> and returns the result. @@ -240,14 +240,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Divides <parameter>a</parameter> by <parameter>b</parameter> and returns the integer result. The result rounding is defined by the @@ -291,14 +291,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Calculates remainder of the integer division of <parameter>n</parameter> by <parameter>d</parameter>. The @@ -323,14 +323,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The function divides <parameter>n</parameter> by <parameter>d</parameter> and returns array, with the first @@ -369,13 +369,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function is an alias to <function>gmp_div_q</function>. </para> @@ -389,13 +389,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Calculates <parameter>n</parameter> modulo <parameter>d</parameter>. The result is always non-negative, the @@ -411,13 +411,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Divides <parameter>n</parameter> by <parameter>d</parameter>, using fast "exact division" algorithm. This function produces @@ -434,13 +434,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns a positive value if <literal>a > b</literal>, zero if <literal>a = b</literal> and negative value if <literal>a &lt; @@ -456,12 +456,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>resource</type><methodname>gmp_neg</methodname> <methodparam><type>resource</type><parameter>a</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns -<parameter>a</parameter>. </para> @@ -475,12 +475,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>resource</type><methodname>gmp_abs</methodname> <methodparam><type>resource</type><parameter>a</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns absolute value of <parameter>a</parameter>. </para> @@ -494,12 +494,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>gmp_sign</methodname> <methodparam><type>resource</type><parameter>a</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Return sign of <parameter>a</parameter> - 1 if <parameter>a</parameter> is positive and -1 if it's negative. @@ -514,12 +514,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>resource</type><methodname>gmp_fact</methodname> <methodparam><type>int</type><parameter>a</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Calculates factorial (<literal>a!</literal>) of <parameter>a</parameter>. </para> @@ -533,12 +533,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>resource</type><methodname>gmp_sqrt</methodname> <methodparam><type>resource</type><parameter>a</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Calculates square root of <parameter>a</parameter>. </para> @@ -552,12 +552,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>gmp_sqrtrm</methodname> <methodparam><type>resource</type><parameter>a</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns array where first element is the integer square root of <parameter>a</parameter> (see also @@ -575,12 +575,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>gmp_perfect_square</methodname> <methodparam><type>resource</type><parameter>a</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if <parameter>a</parameter> is a perfect square, &false; otherwise. @@ -599,13 +599,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Raise <parameter>base</parameter> into power <parameter>exp</parameter>. The case of 0^0 yields @@ -621,14 +621,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Calculate (<parameter>base</parameter> raised into power <parameter>exp</parameter>) modulo <parameter>mod</parameter>. If @@ -644,13 +644,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> If this function returns 0, <parameter>a</parameter> is definitely not prime. If it returns 1, then @@ -673,13 +673,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Calculate greatest common divisor of <parameter>a</parameter> and <parameter>b</parameter>. The result is always positive even if @@ -695,13 +695,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -717,13 +717,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Computes the inverse of <parameter>a</parameter> modulo <parameter>b</parameter>. Returns &false; if an inverse does not @@ -739,13 +739,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Compute the <ulink url="&url.symbole-legendre;"> @@ -763,13 +763,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Computes <ulink url="http://www.utm.edu/research/primes/glossary/JacobiSymbol.html"> @@ -787,12 +787,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>resource</type><methodname>gmp_random</methodname> <methodparam><type>int</type><parameter>limiter</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Generate a random number. The number will be up to <parameter>limiter</parameter> words long. If @@ -809,13 +809,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Calculates logical AND of two GMP numbers. </para> @@ -829,13 +829,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Calculates logical inclusive OR of two GMP numbers. </para> @@ -849,13 +849,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Calculates logical exclusive OR (XOR) of two GMP numbers. </para> @@ -869,14 +869,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Sets bit <parameter>index</parameter> in <parameter>a</parameter>. <parameter>set_clear</parameter> @@ -893,13 +893,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Clears (sets to 0) bit <parameter>index</parameter> in <parameter>a</parameter>. @@ -914,13 +914,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Scans <parameter>a</parameter>, starting with bit <parameter>start</parameter>, towards more significant bits, @@ -937,13 +937,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Scans <parameter>a</parameter>, starting with bit <parameter>start</parameter>, towards more significant bits, @@ -960,12 +960,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>gmp_popcount</methodname> <methodparam><type>resource</type><parameter>a</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Return the population count of <parameter>a</parameter>. </para> @@ -979,13 +979,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the hamming distance between <parameter>a</parameter> and <parameter>b</parameter>. Both operands should be non-negative. Index: phpdoc/en/functions/http.xml diff -u phpdoc/en/functions/http.xml:1.32.2.1 phpdoc/en/functions/http.xml:1.32.2.2 --- phpdoc/en/functions/http.xml:1.32.2.1 Sun Nov 11 20:08:50 2001 +++ phpdoc/en/functions/http.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.32.2.1 $ --> +<!-- $Revision: 1.32.2.2 $ --> <reference id="ref.http"> <title>HTTP functions</title> <titleabbrev>HTTP</titleabbrev> @@ -18,13 +18,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>header</function> is used to send raw <acronym>HTTP</acronym> headers. See the <ulink url="&spec.http1.1;">HTTP/1.1 specification</ulink> for more @@ -201,12 +201,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>headers_sent</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns &true; if the HTTP headers have already been sent, &false; otherwise. @@ -224,8 +224,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -233,8 +233,8 @@ <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> + </methodsynopsis> + <para> <function>setcookie</function> defines a cookie to be sent along with the rest of the header information. Cookies must be sent Index: phpdoc/en/functions/hw.xml diff -u phpdoc/en/functions/hw.xml:1.20.2.1 phpdoc/en/functions/hw.xml:1.20.2.2 --- phpdoc/en/functions/hw.xml:1.20.2.1 Sun Nov 11 20:08:50 2001 +++ phpdoc/en/functions/hw.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.20.2.1 $ --> +<!-- $Revision: 1.20.2.2 $ --> <reference id="ref.hyperwave"> <title>Hyperwave functions</title> <titleabbrev>Hyperwave</titleabbrev> @@ -374,12 +374,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>strin</type><methodname>hw_array2objrec</methodname> <methodparam><type>array</type><parameter>object_array</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Converts an <parameter>object_array</parameter> into an object record. Multiple attributes like 'Title' in different languages are treated @@ -398,13 +398,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array of object ids. Each id belongs to a child of the collection with ID @@ -420,13 +420,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array of object records. Each object record belongs to a child of the collection with ID @@ -442,12 +442,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>hw_close</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &false; if connection is not a valid connection index, otherwise &true;. Closes down the connection to a Hyperwave server @@ -463,15 +463,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Opens a connection to a Hyperwave server and returns a connection index on success, or &false; if the connection @@ -498,14 +498,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Copies the objects with object ids as specified in the second parameter to the collection @@ -527,13 +527,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Deletes the object with the given object id in the second parameter. It will delete all instances of the object. @@ -554,13 +554,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an th object id of the document to which <parameter>anchorID</parameter> belongs. @@ -575,13 +575,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an th object record of the document to which <parameter>anchorID</parameter> belongs. @@ -596,12 +596,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>hw_document_attributes</methodname> <methodparam><type>int</type><parameter>hw_document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the object record of the document. </para> @@ -623,12 +623,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>hw_document_bodytag</methodname> <methodparam><type>int</type><parameter>hw_document</parameter></methodparam> - - </methodsynopsis> + </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. @@ -651,12 +651,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>hw_document_content</methodname> <methodparam><type>int</type><parameter>hw_document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the content of the document. If the document is an HTML document the content is everything after the BODY tag. Information @@ -677,13 +677,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -708,12 +708,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>hw_document_size</methodname> <methodparam><type>int</type><parameter>hw_document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the size in bytes of the document.</para> <para> @@ -734,12 +734,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>hw_errormsg</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a string containing the last error message or 'No Error'. If &false; is returned, this function failed. @@ -755,13 +755,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Uploads the text document to the server. The object record of the document may not be modified while the document @@ -788,12 +788,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>hw_error</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the last error number. If the return value is 0 no error has occurred. The error relates to the last command. @@ -808,12 +808,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>hw_free_document</methodname> <methodparam><type>int</type><parameter>hw_document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Frees the memory occupied by the Hyperwave document. </para> @@ -827,13 +827,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an indexed array of object ids. Each object id belongs to a parent of the object with ID <parameter>objectID</parameter>. @@ -848,13 +848,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -871,13 +871,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array of object ids. Each object ID belongs to a child collection of the collection with ID @@ -897,13 +897,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array of object records. Each object records belongs to a child collection of the collection with ID @@ -924,13 +924,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns a remote document. Remote documents in Hyperwave notation are documents retrieved from an external source. Common remote @@ -958,13 +958,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the children of a remote document. Children of a remote document are remote documents itself. @@ -998,13 +998,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -1022,14 +1022,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the object record for the object with ID <parameter>objectID</parameter> if the second parameter is an integer. @@ -1073,13 +1073,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the object record for the object with ID <parameter>objectID</parameter>. @@ -1100,16 +1100,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the document with object ID <parameter>objectID</parameter>. If the document @@ -1166,14 +1166,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Searches for objects on the whole server and returns an array of object ids. The maximum number of matches is limited to @@ -1196,14 +1196,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Searches for objects on the whole server and returns an array of object records. The maximum number of matches is limited to @@ -1226,15 +1226,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Searches for objects in collection with ID <parameter>objectID</parameter> and returns an array of @@ -1258,15 +1258,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Searches for objects in collection with ID <parameter>objectID</parameter> and returns an array of @@ -1291,13 +1291,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns array of object ids for child documents of a collection. </para> @@ -1315,13 +1315,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array of object records for child documents of a collection.</para> <para> @@ -1338,13 +1338,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array of object ids with anchors of the document with object ID <parameter>objectID</parameter>. @@ -1359,13 +1359,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array of object records with anchors of the document with object ID <parameter>objectID</parameter>. @@ -1380,15 +1380,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Moves the objects with object ids as specified in the second parameter from the collection with id <parameter>source id</parameter> @@ -1415,13 +1415,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Identifies as user with <parameter>username</parameter> and <parameter>password</parameter>. Identification @@ -1442,15 +1442,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Checks whether a set of objects (documents or collections) specified by the <parameter>object_id_array</parameter> is part of @@ -1475,12 +1475,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>hw_info</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns information about the current connection. The returned string has the following format: &lt;Serverstring&gt;, &lt;Host&gt;, @@ -1497,14 +1497,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Inserts a new collection with attributes as in <parameter>object_array</parameter> into @@ -1520,15 +1520,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Inserts a new document with attributes as in <parameter>object_record</parameter> into collection with object ID @@ -1552,14 +1552,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Uploads a document into the collection with <parameter>parent_id</parameter>. @@ -1583,14 +1583,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Inserts an object into the server. The object can be any valid hyperwave object. See the HG-CSP documentation @@ -1618,14 +1618,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Maps a global object id on any hyperwave server, even those you did not connect to with <function>hw_connect</function>, @@ -1652,16 +1652,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This command allows to remove, add, or modify individual attributes of an object record. The object is specified by the Object ID @@ -1813,14 +1813,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns a new Hyperwave document with document data set to <parameter>document_data</parameter> and object record set to @@ -1846,15 +1846,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Converts an <parameter>object_record</parameter> into an object array. The keys of the resulting array are the attributes names. @@ -1884,12 +1884,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>hw_output_document</methodname> <methodparam><type>int</type><parameter>hw_document</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Prints the document without the BODY tag. </para> @@ -1907,15 +1907,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns a connection index on success, or &false; if the connection could not be made. Opens a persistent connection to a Hyperwave @@ -1940,13 +1940,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the Hyperwave document with object ID <parameter>objectID</parameter>. If the document @@ -1970,12 +1970,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>hw_root</methodname> <methodparam><parameter/></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the object ID of the hyperroot collection. Currently this is always 0. The child collection of the hyperroot is the root @@ -1991,13 +1991,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Unlocks a document, so other users regain access. </para> @@ -2014,12 +2014,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>hw_who</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </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, @@ -2036,12 +2036,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>hw_getusername</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the username of the connection. </para> Index: phpdoc/en/functions/ibase.xml diff -u phpdoc/en/functions/ibase.xml:1.32.2.1 phpdoc/en/functions/ibase.xml:1.32.2.2 --- phpdoc/en/functions/ibase.xml:1.32.2.1 Sun Nov 11 20:08:50 2001 +++ phpdoc/en/functions/ibase.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.32.2.1 $ --> +<!-- $Revision: 1.32.2.2 $ --> <reference id="ref.ibase"> <title>InterBase functions</title> <titleabbrev>InterBase</titleabbrev> @@ -36,8 +36,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -46,8 +46,8 @@ <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> + </methodsynopsis> + <para> Establishes a connection to an InterBase server. The <parameter>database</parameter> argument @@ -118,8 +118,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -128,8 +128,8 @@ <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> + </methodsynopsis> + <para> <function>ibase_pconnect</function> acts very much like <function>ibase_connect</function> with two major differences. @@ -176,12 +176,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ibase_close</methodname> <methodparam choice="opt"><type>int</type><parameter>connection_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Closes the link to an InterBase database that's associated with a connection id returned from <function>ibase_connect</function>. @@ -199,14 +199,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> Performs a query on an InterBase database, returning a result identifier for use with <function>ibase_fetch_row</function>, @@ -233,12 +233,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>ibase_fetch_row</methodname> <methodparam><type>int</type><parameter>result_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns the next row specified by the result identifier obtained using the <function>ibase_query</function>. @@ -253,12 +253,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>object</type><methodname>ibase_fetch_object</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Fetches a row as a pseudo-object from a <parameter>result_id</parameter> obtained either by @@ -293,13 +293,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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, @@ -331,12 +331,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ibase_free_result</methodname> <methodparam><type>int</type><parameter>result_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Free's a result set the has been created by <function>ibase_query</function>. @@ -354,13 +354,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> Prepare a query for later binding of parameter placeholders and execution (via <function>ibase_execute</function>). @@ -375,13 +375,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Execute a query prepared by <function>ibase_prepare</function>. This is a lot more effective than using <function>ibase_query</function> @@ -415,13 +415,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Begins a transaction. </para> @@ -435,13 +435,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Commits transaction <parameter>trans_number</parameter> which was created with <function>ibase_trans</function>. @@ -456,13 +456,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Rolls back transaction <parameter>trans_number</parameter> which was created with <function>ibase_trans</function>. @@ -479,12 +479,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ibase_free_query</methodname> <methodparam><type>int</type><parameter>query</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Free a query prepared by <function>ibase_prepare</function>. </simpara> @@ -500,13 +500,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Sets the format of timestamp, date or time type columns returned from queries. Internally, the columns are formatted by c-function @@ -555,12 +555,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ibase_num_fields</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns an integer containing the number of fields in a result set. @@ -605,12 +605,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>ibase_errmsg</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns a string containing an error message. </simpara> Index: phpdoc/en/functions/icap.xml diff -u phpdoc/en/functions/icap.xml:1.13.2.1 phpdoc/en/functions/icap.xml:1.13.2.2 --- phpdoc/en/functions/icap.xml:1.13.2.1 Sun Nov 11 20:08:50 2001 +++ phpdoc/en/functions/icap.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.13.2.1 $ --> +<!-- $Revision: 1.13.2.2 $ --> <reference id="ref.icap"> <title>ICAP Functions</title> <titleabbrev>ICAP</titleabbrev> @@ -19,15 +19,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an ICAP stream on success, &false; on error.</para> <para> @@ -46,13 +46,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Closes the given icap stream. </para> @@ -66,14 +66,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>icap_fetch_event</function> fetches an event from the calendar stream specified by <parameter>event_id</parameter>. @@ -168,14 +168,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array of event ID's that are between the two given datetimes. @@ -231,13 +231,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>icap_store_event</function> Stores an event into an ICAP calendar. An event object consists of: @@ -327,13 +327,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>icap_delete_event</methodname> <methodparam><type>int</type><parameter>sream_id</parameter></methodparam> <methodparam><type>int</type><parameter>uid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>icap_delete_event</function> deletes the calendar event specified by the <parameter>uid</parameter>. @@ -351,13 +351,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>icap_snooze</function> turns on an alarm for a calendar event specified by the <parameter>uid</parameter>. @@ -378,14 +378,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array of event ID's that has an alarm going off at the given datetime. Index: phpdoc/en/functions/iconv.xml diff -u phpdoc/en/functions/iconv.xml:1.8.2.1 phpdoc/en/functions/iconv.xml:1.8.2.2 --- phpdoc/en/functions/iconv.xml:1.8.2.1 Sun Nov 11 20:08:50 2001 +++ phpdoc/en/functions/iconv.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.8.2.1 $ --> +<!-- $Revision: 1.8.2.2 $ --> <reference id="ref.iconv"> <title>iconv functions</title> <titleabbrev>iconv</titleabbrev> @@ -31,14 +31,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> It converts the string <parameter>string</parameter> encoded in <parameter>in_charset</parameter> to the string encoded in @@ -65,12 +65,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>iconv_get_encoding</methodname> <methodparam choice="opt"><type>string</type><parameter>type</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> It returns the current settings of <function>ob_iconv_handler</function> as array or @@ -93,13 +93,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> It changes the value of <parameter>type</parameter> to <parameter>charset</parameter> and returns &true; in success or @@ -131,13 +131,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> It converts the string encoded in <parameter>internal_encoding</parameter> to Index: phpdoc/en/functions/ifx.xml diff -u phpdoc/en/functions/ifx.xml:1.21.2.1 phpdoc/en/functions/ifx.xml:1.21.2.2 --- phpdoc/en/functions/ifx.xml:1.21.2.1 Sun Nov 11 20:08:50 2001 +++ phpdoc/en/functions/ifx.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.21.2.1 $ --> +<!-- $Revision: 1.21.2.2 $ --> <reference id="ref.ifx"> <title>Informix functions</title> <titleabbrev>Informix</titleabbrev> @@ -171,8 +171,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ifx_connect</methodname> <methodparam choice="opt"><type>string</type><parameter>database </parameter></methodparam> @@ -180,8 +180,8 @@ </parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>password </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a connection identifier on success, or &false; on error. @@ -226,14 +226,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: A positive Informix persistent link identifier on success, or &false; on error @@ -272,12 +272,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ifx_close</methodname> <methodparam choice="opt"><type>int</type><parameter>link_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: always &true;. </para> @@ -318,8 +318,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -327,8 +327,8 @@ <methodparam choice="opt"><type>mixed</type><parameter> blobidarray </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: A positive Informix result identifier on success, or &false; on error. @@ -429,15 +429,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns a integer <parameter>result_id</parameter> for use by <function>ifx_do</function>. Sets @@ -490,12 +490,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ifx_do</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; on success, &false; on error. </para> @@ -523,12 +523,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>ifx_error</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> The Informix error codes (SQLSTATE &amp; SQLCODE) formatted as follows : @@ -583,12 +583,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>ifx_errormsg</methodname> <methodparam choice="opt"><type>int</type><parameter>errorcode</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the Informix error message associated with the most recent Informix error, or, when the optional @@ -613,12 +613,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ifx_affected_rows</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <parameter>result_id</parameter> is a valid result id returned by <function>ifx_query</function> or @@ -671,12 +671,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>ifx_getsqlca</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <parameter>result_id</parameter> is a valid result id returned by <function>ifx_query</function> or @@ -722,13 +722,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an associative array that corresponds to the fetched row, or &false; if there are no more rows. @@ -802,13 +802,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the number of rows fetched or &false; on error. </para> @@ -849,12 +849,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>ifx_fieldtypes</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns an associative array with fieldnames as key and the SQL fieldtypes as data for query with @@ -884,12 +884,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>ifx_fieldproperties</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns an associative array with fieldnames as key and the SQL fieldproperties as data for a query with @@ -925,12 +925,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ifx_num_fields</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the number of columns in query for <parameter>result_id</parameter> or &false; on error @@ -949,12 +949,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ifx_num_rows</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Gives the number of rows fetched so far for a query with <parameter>result_id</parameter> after a @@ -971,12 +971,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ifx_free_result</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Releases resources for the query associated with <parameter>result_id</parameter>. Returns &false; on error. @@ -991,12 +991,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ifx_create_char</methodname> <methodparam><type>string</type><parameter>param</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Creates an char object. <parameter>param</parameter> should be the char content. @@ -1011,12 +1011,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ifx_free_char</methodname> <methodparam><type>int</type><parameter>bid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Deletes the charobject for the given char object-id <parameter>bid</parameter>. Returns &false; on error otherwise @@ -1032,13 +1032,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Updates the content of the char object for the given char object <parameter>bid</parameter>. <parameter>content</parameter> is a @@ -1054,12 +1054,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ifx_get_char</methodname> <methodparam><type>int</type><parameter>bid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the content of the char object for the given char object-id <parameter>bid</parameter>. @@ -1074,14 +1074,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Creates an blob object. </para> @@ -1109,12 +1109,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ifx_copy_blob</methodname> <methodparam><type>int</type><parameter>bid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Duplicates the given blob object. <parameter>bid</parameter> is the ID of the blob object. @@ -1132,12 +1132,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ifx_free_blob</methodname> <methodparam><type>int</type><parameter>bid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Deletes the blobobject for the given blob object-id <parameter>bid</parameter>. Returns &false; on error otherwise @@ -1153,12 +1153,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ifx_get_blob</methodname> <methodparam><type>int</type><parameter>bid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the content of the blob object for the given blob object-id <parameter>bid</parameter>. @@ -1173,13 +1173,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <methodname>ifx_update_blob</methodname> <methodparam><type>int</type><parameter>bid</parameter></methodparam> <methodparam><type>string</type><parameter>content</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Updates the content of the blob object for the given blob object <parameter>bid</parameter>. <parameter>content</parameter> is a @@ -1195,12 +1195,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>ifx_blobinfile_mode</methodname> <methodparam><type>int</type><parameter>mode</parameter></methodparam> - - </methodsynopsis> + </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 @@ -1216,12 +1216,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>ifx_textasvarchar</methodname> <methodparam><type>int</type><parameter>mode</parameter></methodparam> - - </methodsynopsis> + </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 @@ -1237,12 +1237,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>ifx_byteasvarchar</methodname> <methodparam><type>int</type><parameter>mode</parameter></methodparam> - - </methodsynopsis> + </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 @@ -1260,12 +1260,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>ifx_nullformat</methodname> <methodparam><type>int</type><parameter>mode</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Sets the default return value of a NULL-value on a fetch row. Mode "0" returns "", and mode "1" returns "&null;". @@ -1280,12 +1280,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ifxus_create_slob</methodname> <methodparam><type>int</type><parameter>mode</parameter></methodparam> - - </methodsynopsis> + </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 = @@ -1303,12 +1303,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ifxus_free_slob</methodname> <methodparam><type>int</type><parameter>bid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Deletes the slob object. <parameter>bid</parameter> is the Id of the slob object. Returns &false; on error otherwise &true;. @@ -1323,12 +1323,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ifxus_close_slob</methodname> <methodparam><type>int</type><parameter>bid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Deletes the slob object on the given slob object-id <parameter>bid</parameter>. Return &false; on error otherwise @@ -1344,13 +1344,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Opens an slob object. <parameter>bid</parameter> should be an existing slob id. Modes: 1 = LO_RDONLY, 2 = LO_WRONLY, 4 = @@ -1368,12 +1368,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ifxus_tell_slob</methodname> <methodparam><type>long</type><parameter>bid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the current file or seek position of an open slob object <parameter>bid</parameter> should be an existing slob id. Return @@ -1389,14 +1389,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Sets the current file or seek position of an open slob object. <parameter>bid</parameter> should be an existing slob id. Modes: @@ -1414,13 +1414,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Reads nbytes of the slob object. <parameter>bid</parameter> is a existing slob id and <parameter>nbytes</parameter> is the number @@ -1436,13 +1436,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Writes a string into the slob object. <parameter>bid</parameter> is a existing slob id and <parameter>content</parameter> the Index: phpdoc/en/functions/image.xml diff -u phpdoc/en/functions/image.xml:1.60.2.2 phpdoc/en/functions/image.xml:1.60.2.3 --- phpdoc/en/functions/image.xml:1.60.2.2 Sun Nov 11 21:04:37 2001 +++ phpdoc/en/functions/image.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.60.2.2 $ --> +<!-- $Revision: 1.60.2.3 $ --> <reference id="ref.image"> <title>Image functions</title> <titleabbrev>Image</titleabbrev> @@ -36,30 +36,31 @@ <refentry id="function.getimagesize"> <refnamediv> <refname>GetImageSize</refname> - <refpurpose>Get the size of a GIF, JPEG, PNG or SWF image</refpurpose> + <refpurpose>Get the size of an image</refpurpose> </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>GetImageSize</function> function will determine the size of any <acronym>GIF</acronym>, <acronym>JPG</acronym>, - <acronym>PNG</acronym> or <acronym>SWF</acronym> image file and + <acronym>PNG</acronym>, <acronym>SWF</acronym>, + <acronym>PSD</acronym> or <acronym>BMP</acronym> image file and return the dimensions along with the file type and a height/width text string to be used inside a normal <acronym>HTML</acronym> <sgmltag>IMG</sgmltag> tag. </para> <para> - Returns an array with 4 elements. Index 0 contains the width of - the image in pixels. Index 1 contains the height. Index 2 a + Returns an array with 4 elements. Index 0 contains the width of + the image in pixels. Index 1 contains the height. Index 2 a flag indicating the type of the image. 1 = GIF, 2 = JPG, 3 = - PNG, 4 = SWF. Index 3 is a text string with the correct + PNG, 4 = SWF, 5 = PSD, 6 = BMP. Index 3 is a text string with the correct "height=xxx width=xxx" string that can be used directly in an IMG tag. <example> @@ -79,7 +80,7 @@ </example> </para> <para> - With <acronym>JPEG</acronym> images, two extras index are returned : + With <acronym>JPG</acronym> images, two extras index are returned : <literal>channel</literal> and <literal>bits</literal>. <literal>channel</literal> will be 3 for RGB pictures, and 4 for CMYK pictures. <literal>bits</literal> is the number of bits for each color. @@ -126,6 +127,46 @@ </refsect1> </refentry> + <refentry id="function.image2wbmp"> + <refnamediv> + <refname>Image2WBMP</refname> + <refpurpose>Output image to browser or file</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <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 + <parameter>im</parameter>. The <parameter>im</parameter> argument + is the return from the <function>ImageCreate</function> function. + </para> + <para> + The filename argument is optional, and if left off, the raw image + stream will be output directly. + By sending an <acronym>image/vnd.wap.wbmp</acronym> content-type + using <function>header</function>, you can create + a PHP script that outputs WBMP images directly. + <note> + <para> + WBMP support is only available in PHP if PHP was compiled + against GD-1.8 or later. + </para> + </note> + </para> + <para> + See also <function>ImageWBMP</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.imagealphablending"> <refnamediv> <refname>ImageAlphaBlending</refname> @@ -133,13 +174,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagealphablending</methodname> <methodparam><type>resource</type><parameter>im</parameter></methodparam> <methodparam><type>bool</type><parameter>blendmode</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ImageAlphaBlending</function> allows for two different modes of drawing on truecolor images. In blending mode, the @@ -166,8 +207,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagearc</methodname> <methodparam><type>int</type><parameter>im</parameter></methodparam> <methodparam><type>int</type><parameter>cx</parameter></methodparam> @@ -177,8 +218,8 @@ <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> + </methodsynopsis> + <para> <function>ImageArc</function> draws a partial ellipse centered at <parameter>cx</parameter>, <parameter>cy</parameter> (top left is @@ -199,8 +240,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagefilledarc</methodname> <methodparam><type>int</type><parameter>im</parameter></methodparam> <methodparam><type>int</type><parameter>cx</parameter></methodparam> @@ -211,8 +252,8 @@ <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> + </methodsynopsis> + <para> <function>ImageFilledArc</function> draws a partial ellipse centered at <parameter>cx</parameter>, <parameter>cy</parameter> (top left is @@ -250,8 +291,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imageellipse</methodname> <methodparam><type>resource</type><parameter>im</parameter></methodparam> <methodparam><type>int</type><parameter>cx</parameter></methodparam> @@ -259,8 +300,8 @@ <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> + </methodsynopsis> + <para> <function>ImageEllipse</function> draws an ellipse centered at <parameter>cx</parameter>, <parameter>cy</parameter> (top left is @@ -281,8 +322,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagefilledellipse</methodname> <methodparam><type>resource</type><parameter>im</parameter></methodparam> <methodparam><type>int</type><parameter>cx</parameter></methodparam> @@ -290,8 +331,8 @@ <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> + </methodsynopsis> + <para> <function>ImageFilledEllipse</function> draws an ellipse centered at <parameter>cx</parameter>, <parameter>cy</parameter> (top left is @@ -311,8 +352,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagechar</methodname> <methodparam><type>int</type><parameter>im</parameter></methodparam> <methodparam><type>int</type><parameter>font</parameter></methodparam> @@ -320,8 +361,8 @@ <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> + </methodsynopsis> + <para> <function>ImageChar</function> draws the first character of <parameter>c</parameter> in the image identified by @@ -344,8 +385,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagecharup</methodname> <methodparam><type>int</type><parameter>im</parameter></methodparam> <methodparam><type>int</type><parameter>font</parameter></methodparam> @@ -353,8 +394,8 @@ <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> + </methodsynopsis> + <para> <function>ImageCharUp</function> draws the character <parameter>c</parameter> vertically in the image identified by @@ -377,15 +418,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ImageColorAllocate</function> returns a color identifier representing the color composed of the given @@ -416,13 +457,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagecolordeallocate</methodname> <methodparam><type>int</type><parameter>im</parameter></methodparam> <methodparam><type>int</type><parameter>index</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>ImageColorDeAllocate</function> function de-allocates a color previously allocated with the @@ -444,14 +485,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the index of the color of the pixel at the specified location in the image. @@ -472,15 +513,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the index of the color in the palette of the image which is "closest" to the specified <acronym>RGB</acronym> value. @@ -505,16 +546,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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. @@ -535,15 +576,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the index of the specified color in the palette of the image. @@ -565,16 +606,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the index of the specified color+alpha in the palette of the image. @@ -601,15 +642,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function is guaranteed to return a color index for a requested color, either the exact color or the closest possible @@ -631,16 +672,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function is guaranteed to return a color index for a requested color, either the exact color or the closest possible @@ -664,14 +705,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>ImageGammaCorrect</function> function applies gamma correction to a gd image stream (<parameter>im</parameter>) given @@ -691,16 +732,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This sets the specified index in the palette to the specified color. This is useful for creating flood-fill-like effects in @@ -720,13 +761,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>imagecolorsforindex</methodname> <methodparam><type>int</type><parameter>im</parameter></methodparam> <methodparam><type>int</type><parameter>index</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This returns an associative array with red, green, and blue keys that contain the appropriate values for the specified color @@ -748,12 +789,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagecolorstotal</methodname> <methodparam><type>int</type><parameter>im</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This returns the number of colors in the specified image's palette. @@ -772,13 +813,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ImageColorTransparent</function> sets the transparent color in the <parameter>im</parameter> image to @@ -803,8 +844,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -814,8 +855,8 @@ <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> + </methodsynopsis> + <para> Copy a part of <parameter>src_im</parameter> onto <parameter>dst_im</parameter> starting at the x,y coordinates @@ -837,8 +878,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -849,8 +890,8 @@ <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> + </methodsynopsis> + <para> Copy a part of <parameter>src_im</parameter> onto <parameter>dst_im</parameter> starting at the x,y coordinates @@ -877,8 +918,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -889,8 +930,8 @@ <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> + </methodsynopsis> + <para> <function>ImageCopyMergeGray</function> copy a part of <parameter>src_im</parameter> onto <parameter>dst_im</parameter> starting at the x,y coordinates @@ -920,8 +961,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -933,8 +974,8 @@ <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> + </methodsynopsis> + <para> <function>ImageCopyResized</function> copies a rectangular portion of one image to another image. @@ -961,8 +1002,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -974,8 +1015,8 @@ <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> + </methodsynopsis> + <para> <function>ImageCopyResampled</function> copies a rectangular portion of one image to another image, smoothly interpolating pixel @@ -1005,13 +1046,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ImageCreate</function> returns an image identifier representing a blank image of size <parameter>x_size</parameter> @@ -1043,13 +1084,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ImageCreateTrueColor</function> returns an image identifier representing a black image of size <parameter>x_size</parameter> @@ -1065,14 +1106,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ImageTrueColorToPalette</function> converts a truecolor image to a palette image. The code for this function was originally drawn from @@ -1107,12 +1148,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagecreatefromgif</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ImageCreateFromGif</function> returns an image identifier representing the image obtained from the given filename. @@ -1160,12 +1201,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagecreatefromjpeg</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ImageCreateFromJPEG</function> returns an image identifier representing the image obtained from the given filename. @@ -1206,12 +1247,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagecreatefrompng</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ImageCreateFromPNG</function> returns an image identifier representing the image obtained from the given filename. @@ -1252,12 +1293,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagecreatefromwbmp</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ImageCreateFromWBMP</function> returns an image identifier representing the image obtained from the given filename. @@ -1287,6 +1328,12 @@ } </programlisting> </example> + <note> + <para> + WBMP support is only available in PHP if PHP was compiled + against GD-1.8 or later. + </para> + </note> </para> </refsect1> </refentry> @@ -1298,12 +1345,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagecreatefromstring</methodname> <methodparam><type>string</type><parameter>image</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ImageCreateFromString</function> returns an image identifier representing the image obtained from the given string. @@ -1311,6 +1358,46 @@ </refsect1> </refentry> + <refentry id="function.imagecreatefromxbm"> + <refnamediv> + <refname>ImageCreateFromXBM</refname> + <refpurpose>Create a new image from file or URL</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <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. + </para> + </refsect1> + </refentry> + + <refentry id="function.imagecreatefromxpm"> + <refnamediv> + <refname>ImageCreateFromXPM</refname> + <refpurpose>Create a new image from file or URL</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <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. + </para> + </refsect1> + </refentry> + <refentry id="function.imagedashedline"> <refnamediv> <refname>ImageDashedLine</refname> @@ -1318,8 +1405,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagedashedline</methodname> <methodparam><type>int</type><parameter>im</parameter></methodparam> <methodparam><type>int</type><parameter>x1</parameter></methodparam> @@ -1327,8 +1414,8 @@ <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> + </methodsynopsis> + <para> This function is deprecated. Use combination of <function>ImageSetStyle</function> and <function>ImageLine</function> @@ -1344,12 +1431,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagedestroy</methodname> <methodparam><type>int</type><parameter>im</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ImageDestroy</function> frees any memory associated with image <parameter>im</parameter>. <parameter>Im</parameter> @@ -1366,15 +1453,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ImageFill</function> performs a flood fill starting at coordinate <parameter>x</parameter>, <parameter>y</parameter> @@ -1391,15 +1478,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ImageFilledPolygon</function> creates a filled polygon in image <parameter>im</parameter>. @@ -1418,8 +1505,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagefilledrectangle</methodname> <methodparam><type>int</type><parameter>im</parameter></methodparam> <methodparam><type>int</type><parameter>x1</parameter></methodparam> @@ -1427,8 +1514,8 @@ <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> + </methodsynopsis> + <para> <function>ImageFilledRectangle</function> creates a filled rectangle of color <parameter>col</parameter> in image @@ -1448,16 +1535,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ImageFillToBorder</function> performs a flood fill whose border color is defined by <parameter>border</parameter>. @@ -1475,12 +1562,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagefontheight</methodname> <methodparam><type>int</type><parameter>font</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the pixel height of a character in the specified font. </para> @@ -1498,12 +1585,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagefontwidth</methodname> <methodparam><type>int</type><parameter>font</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the pixel width of a character in font. </para> @@ -1521,13 +1608,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ImageGIF</function> creates the <acronym>GIF</acronym> file in filename from the image <parameter>im</parameter>. The @@ -1617,13 +1704,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>ImagePNG</function> outputs a GD image stream (<parameter>im</parameter>) in PNG format to standard output @@ -1652,14 +1739,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ImageJPEG</function> creates the <acronym>JPEG</acronym> file in filename from the image @@ -1707,13 +1794,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> - - </methodsynopsis> + <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 @@ -1734,8 +1822,15 @@ </note> </para> <para> - See also <function>ImagePNG</function>, <function>ImageGIF</function>, - <function>ImageJPEG</function>, <function>ImageTypes</function>. + Using the optional <parameter>foreground</parameter> + parameter, you can set the foreground color. Use an + identifier obtained from <function>imagecolorallocate</function>. + The default foreground color is black. + </para> + <para> + See also <function>image2WBMP</function>, <function>ImagePNG</function>, + <function>ImageGIF</function>, <function>ImageJPEG</function>, + <function>ImageTypes</function>. </para> </refsect1> </refentry> @@ -1747,13 +1842,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -1777,8 +1872,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imageline</methodname> <methodparam><type>int</type><parameter>im</parameter></methodparam> <methodparam><type>int</type><parameter>x1</parameter></methodparam> @@ -1786,8 +1881,8 @@ <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> + </methodsynopsis> + <para> <function>ImageLine</function> draws a line from <parameter>x1</parameter>, <parameter>y1</parameter> to @@ -1808,12 +1903,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imageloadfont</methodname> <methodparam><type>string</type><parameter>file</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ImageLoadFont</function> loads a user-defined bitmap font and returns an identifier for the font (that is always @@ -1877,6 +1972,28 @@ </refsect1> </refentry> + <refentry id="function.imagepalettecopy"> + <refnamediv> + <refname>ImagePaletteCopy</refname> + <refpurpose>Copy the palette from one image to another</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <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 + to the <parameter>destination</parameter> image. + </para> + </refsect1> + </refentry> + <refentry id="function.imagepolygon"> <refnamediv> <refname>ImagePolygon</refname> @@ -1884,15 +2001,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ImagePolygon</function> creates a polygon in image id. <parameter>Points</parameter> is a PHP array containing the @@ -1916,8 +2033,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>imagepsbbox</methodname> <methodparam><type>string</type><parameter>text</parameter></methodparam> <methodparam><type>int</type><parameter>font</parameter></methodparam> @@ -1925,8 +2042,8 @@ <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> + </methodsynopsis> + <para> <parameter>Size</parameter> is expressed in pixels. </para> @@ -1991,9 +2108,7 @@ </refsect1> </refentry> - - -<!-- The function in t1lib which this function uses seems to be buggy... + <!-- The function in t1lib which this function uses seems to be buggy... Currently, just comment out everywhere in the docs and source until time permits to find a solution. @@ -2038,8 +2153,6 @@ </refsect1> </refentry> --> - - <refentry id="function.imagepsencodefont"> <refnamediv> @@ -2050,13 +2163,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Loads a character encoding vector from from a file and changes the fonts encoding vector to it. As a PostScript fonts default @@ -2083,12 +2196,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>imagepsfreefont</methodname> <methodparam><type>int</type><parameter>fontindex</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> See also <function>ImagePSLoadFont</function>. </para> @@ -2102,12 +2215,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagepsloadfont</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> In the case everything went right, a valid font index will be returned and can be used for further purposes. Otherwise the @@ -2146,13 +2259,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Extend or condense a font (<parameter>font_index</parameter>), if the value of the <parameter>extend</parameter> parameter is less @@ -2170,13 +2283,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Slant a font given by the <parameter>font_index</parameter> parameter with a slant of the value of the @@ -2194,8 +2307,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>imagepstext</methodname> <methodparam><type>int</type><parameter>image</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> @@ -2217,8 +2330,8 @@ <methodparam choice="opt"><type>int</type><parameter> antialias_steps </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <parameter>Size</parameter> is expressed in pixels. </para> @@ -2308,8 +2421,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagerectangle</methodname> <methodparam><type>int</type><parameter>im</parameter></methodparam> <methodparam><type>int</type><parameter>x1</parameter></methodparam> @@ -2317,8 +2430,8 @@ <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> + </methodsynopsis> + <para> <function>ImageRectangle</function> creates a rectangle of color col in image im starting at upper left coordinate x1, y1 and @@ -2335,15 +2448,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ImageSetPixel</function> draws a pixel at <parameter>x</parameter>, <parameter>y</parameter> (top left is @@ -2364,13 +2477,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagesetbrush</methodname> <methodparam><type>resource</type><parameter>im</parameter></methodparam> <methodparam><type>resource</type><parameter>brush</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ImageSetBrush</function> sets the brush image to be used by all line drawing functions (such as <function>ImageLine</function> @@ -2394,13 +2507,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagesetstyle</methodname> <methodparam><type>resource</type><parameter>im</parameter></methodparam> <methodparam><type>array</type><parameter>style</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ImageSetStyle</function> sets the style to be used by all line drawing functions (such as <function>ImageLine</function> @@ -2455,13 +2568,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagesettile</methodname> <methodparam><type>resource</type><parameter>im</parameter></methodparam> <methodparam><type>resource</type><parameter>tile</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ImageSetTile</function> sets the tile image to be used by all region filling functions (such as <function>ImageFill</function> @@ -2490,13 +2603,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>imagesetthickness</methodname> <methodparam><type>resource</type><parameter>im</parameter></methodparam> <methodparam><type>int</type><parameter>thickness</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ImageSetThickness</function> sets the thickness of the lines drawn when drawing rectangles, polygons, ellipses etc. etc. to @@ -2513,8 +2626,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagestring</methodname> <methodparam><type>int</type><parameter>im</parameter></methodparam> <methodparam><type>int</type><parameter>font</parameter></methodparam> @@ -2522,8 +2635,8 @@ <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> + </methodsynopsis> + <para> <function>ImageString</function> draws the string <parameter>s</parameter> in the image identified by @@ -2545,8 +2658,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagestringup</methodname> <methodparam><type>int</type><parameter>im</parameter></methodparam> <methodparam><type>int</type><parameter>font</parameter></methodparam> @@ -2554,8 +2667,8 @@ <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> + </methodsynopsis> + <para> <function>ImageStringUp</function> draws the string <parameter>s</parameter> vertically in the image identified by @@ -2577,12 +2690,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagesx</methodname> <methodparam><type>int</type><parameter>im</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ImageSX</function> returns the width of the image identified by <parameter>im</parameter>. @@ -2601,12 +2714,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagesy</methodname> <methodparam><type>int</type><parameter>im</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ImageSY</function> returns the height of the image identified by <parameter>im</parameter>. @@ -2627,15 +2740,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function calculates and returns the bounding box in pixels for a TrueType text. @@ -2742,8 +2855,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>imagettftext</methodname> <methodparam><type>int</type><parameter>im</parameter></methodparam> <methodparam><type>int</type><parameter>size</parameter></methodparam> @@ -2753,8 +2866,8 @@ <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> + </methodsynopsis> + <para> <function>ImageTTFText</function> draws the string <parameter>text</parameter> in the image identified by @@ -2836,12 +2949,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imagetypes</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns a bit-field corresponding to the image formats supported by the version of GD linked into PHP. The @@ -2861,6 +2974,84 @@ </refsect1> </refentry> + <refentry id="function.jpeg2wbmp"> + <refnamediv> + <refname>JPEG2WBMP</refname> + <refpurpose> + Convert JPEG image file to WBMP image file + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <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> + </methodsynopsis> + + <para> + Converts the <parameter>jpegname</parameter> JPEG file + to WBMP format, and saves it as <parameter>wbmpname</parameter>. + With the <parameter>d_height</parameter> and + <parameter>d_width</parameter> you specify the height + and width of the destination image. + </para> + <para> + <note> + <para> + WBMP support is only available in PHP if PHP was compiled + against GD-1.8 or later. + </para> + </note> + </para> + <para> + See also <function>png2wbmp</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.png2wbmp"> + <refnamediv> + <refname>PNG2WBMP</refname> + <refpurpose> + Convert PNG image file to WBMP image file + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <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> + </methodsynopsis> + + <para> + Converts the <parameter>pngname</parameter> PNG file + to WBMP format, and saves it as <parameter>wbmpname</parameter>. + With the <parameter>d_height</parameter> and + <parameter>d_width</parameter> you specify the height + and width of the destination image. + </para> + <para> + <note> + <para> + WBMP support is only available in PHP if PHP was compiled + against GD-1.8 or later. + </para> + </note> + </para> + <para> + See also <function>jpeg2wbmp</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.read-exif-data"> <refnamediv> <refname>read_exif_data</refname> @@ -2868,12 +3059,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>read_exif_data</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>read_exif_data</function> function reads the EXIF headers from a JPEG image file. It returns an associative Index: phpdoc/en/functions/imap.xml diff -u phpdoc/en/functions/imap.xml:1.52.2.1 phpdoc/en/functions/imap.xml:1.52.2.2 --- phpdoc/en/functions/imap.xml:1.52.2.1 Sun Nov 11 20:08:50 2001 +++ phpdoc/en/functions/imap.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.52.2.1 $ --> +<!-- $Revision: 1.52.2.2 $ --> <reference id="ref.imap"> <title>IMAP, POP3 and NNTP functions</title> <titleabbrev>IMAP</titleabbrev> @@ -90,12 +90,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>imap_8bit</methodname> <methodparam><type>string</type><parameter>string</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Convert an 8bit string to a quoted-printable string (according to <ulink url="&url.rfc;rfc2045.html">RFC2045</ulink>, section @@ -121,12 +121,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>imap_alerts</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns an array of all of the IMAP alert messages generated since the last <function>imap_alerts</function> call, @@ -147,15 +147,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns &true; on sucess, &false; on error. </para> @@ -204,12 +204,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>imap_base64</methodname> <methodparam><type>string</type><parameter>text</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>imap_base64</function> function decodes BASE-64 encoded text (see <ulink url="&url.rfc;rfc2045.html">RFC2045</ulink>, @@ -230,12 +230,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>imap_binary</methodname> <methodparam><type>string</type><parameter>string</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Convert an 8bit string to a base64 string (according to <ulink url="&url.rfc;rfc2045.html">RFC2045</ulink>, Section 6.8). </para> @@ -255,14 +255,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>imap_body</function> returns the body of the message, numbered <parameter> msg_number</parameter> in the current @@ -304,12 +304,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>object</type><methodname>imap_check</methodname> <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns information about the current mailbox. Returns &false; on failure. @@ -359,15 +359,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function causes a store to delete the specified flag to the flags set for the messages in the specified sequence. @@ -395,13 +395,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Close the imap stream. Takes an optional <parameter>flag</parameter> CL_EXPUNGE, which will silently @@ -418,13 +418,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>imap_createmailbox</function> creates a new mailbox specified by <parameter>mbox</parameter>. Names containing @@ -501,14 +501,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns &true;. </para> @@ -553,13 +553,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>imap_deletemailbox</function> deletes the specified mailbox (see <function>imap_open</function> for the format @@ -588,12 +588,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>imap_errors</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns an array of all of the IMAP error messages generated since the last <function>imap_errors</function> call, @@ -612,12 +612,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imap_expunge</methodname> <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>imap_expunge</function> deletes all the messages marked for deletion by <function>imap_delete</function>, @@ -639,14 +639,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function fetches mail headers for the given <parameter>sequence</parameter> and returns an overview of their @@ -763,15 +763,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -814,14 +814,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function causes a fetch of the complete, unfiltered <ulink url="&url.rfc;rfc2822.html">RFC2822</ulink> @@ -857,14 +857,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function fetches all the structured information for a given message. The optional <parameter>flags</parameter> parameter only @@ -1024,13 +1024,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -1082,14 +1082,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array of objects containing mailbox information. Each object has the attributes <parameter>name</parameter>, specifying @@ -1184,14 +1184,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function is identical to <function>imap_getmailboxes</function>, except that it only @@ -1208,16 +1208,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This is an alias to <function>imap_headerinfo</function> and is identical to this in any way. @@ -1232,16 +1232,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function returns an object of various header elements. </para> @@ -1346,12 +1346,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>imap_headers</methodname> <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns an array of string formatted with header info. One element per mail message. @@ -1370,12 +1370,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>imap_last_error</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns the full text of the last IMAP error message that occurred on the current page. The error stack is @@ -1394,14 +1394,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array containing the names of the mailboxes. See <function>imap_getmailboxes</function> for a description @@ -1437,14 +1437,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array of all the mailboxes that you have subscribed. This is almost identical to @@ -1464,8 +1464,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>imap_mail</methodname> <methodparam><type>string</type><parameter>to</parameter></methodparam> <methodparam><type>string</type><parameter>subject</parameter></methodparam> @@ -1474,8 +1474,8 @@ <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> + </methodsynopsis> + <para> This function is currently only available in PHP 3. </para> @@ -1492,13 +1492,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> </para> <para> @@ -1550,15 +1550,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns &true; on success and &false; on error. </para> @@ -1594,15 +1594,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Moves mail messages specified by <parameter>msglist</parameter> to specified mailbox. <parameter>msglist</parameter> is a range @@ -1632,12 +1632,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>object</type><methodname>imap_mailboxmsginfo</methodname> <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns information about the current mailbox. Returns &false; on failure. @@ -1731,12 +1731,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>imap_mime_header_decode</methodname> <methodparam><type>string</type><parameter>text</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>imap_mime_header_decode</function> function decodes MIME message header extensions that are non ASCII text @@ -1780,13 +1780,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function returns the message sequence number for the given UID. It is the inverse of <function>imap_uid</function>. @@ -1804,12 +1804,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imap_num_msg</methodname> <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Return the number of messages in the current mailbox. </para> @@ -1828,12 +1828,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imap_num_recent</methodname> <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the number of recent messages in the current mailbox. </para> @@ -1851,15 +1851,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -1983,12 +1983,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>imap_ping</methodname> <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if the stream is still alive, &false; otherwise. </para> @@ -2011,12 +2011,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>imap_qprint</methodname> <methodparam><type>string</type><parameter>string</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Convert a quoted-printable string to an 8 bit string (according to <ulink url="&url.rfc;rfc2045.html">RFC2045</ulink>, section @@ -2039,14 +2039,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function renames on old mailbox to new mailbox (see <function>imap_open</function> for the format of @@ -2071,14 +2071,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function reopens the specified stream to a new mailbox on an IMAP or NNTP server. @@ -2125,13 +2125,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function parses the address string as defined in <ulink url="&url.rfc;rfc2822.html">RFC2822</ulink> and @@ -2190,13 +2190,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function returns an object of various header elements, similar to <function>imap_header</function>, except without the @@ -2215,14 +2215,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns a properly formatted email address as defined in <ulink url="&url.rfc;rfc2822.html">RFC2822</ulink> @@ -2249,15 +2249,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array containing the names of the mailboxes that have <parameter>string</parameter> in the text of the mailbox. @@ -2280,14 +2280,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function performs a search on the mailbox currently opened in the given imap stream. <parameter>criteria</parameter> is a @@ -2440,14 +2440,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Sets an upper limit quota on a per mailbox basis. This function requires the <parameter>imap_stream</parameter> to have been opened @@ -2499,15 +2499,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function causes a store to add the specified flag to the flags set for the messages in the specified sequence. @@ -2552,15 +2552,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array of message numbers sorted by the given parameters. @@ -2604,14 +2604,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function returns an object containing status information. Valid flags are: @@ -2689,13 +2689,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Subscribe to a new mailbox. </para> @@ -2715,13 +2715,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function returns the UID for the given message sequence number. An UID is an unique identifier that will not change over @@ -2746,13 +2746,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function removes the deletion flag for a specified message, which is set by <function>imap_delete</function> or @@ -2771,13 +2771,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Unsubscribe from a specified mailbox. </para> @@ -2796,12 +2796,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>imap_utf7_decode</methodname> <methodparam><type>string</type><parameter>text</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Decodes modified UTF-7 <parameter>text</parameter> into 8bit data. </para> @@ -2825,12 +2825,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>imap_utf7_encode</methodname> <methodparam><type>string</type><parameter>data</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Converts 8bit <parameter>data</parameter> to modified UTF-7 text. This is needed to encode mailbox names that contain @@ -2853,12 +2853,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>imap_utf8</methodname> <methodparam><type>string</type><parameter>text</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Converts the given <parameter>text</parameter> to UTF8 (as defined in Index: phpdoc/en/functions/info.xml diff -u phpdoc/en/functions/info.xml:1.70.2.1 phpdoc/en/functions/info.xml:1.70.2.2 --- phpdoc/en/functions/info.xml:1.70.2.1 Sun Nov 11 20:08:50 2001 +++ phpdoc/en/functions/info.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.70.2.1 $ --> +<!-- $Revision: 1.70.2.2 $ --> <reference id="ref.info"> <title>PHP options &amp; information</title> <titleabbrev>PHP options/info</titleabbrev> @@ -11,12 +11,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>assert</methodname> <methodparam><type>string|bool</type><parameter>assertion</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>assert</function> will check the given <parameter>assertion</parameter> and take appropriate @@ -105,13 +105,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Using <function>assert_options</function> you may set the various <function>assert</function> control options or just query their @@ -179,12 +179,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>extension_loaded</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns &true; if the extension identified by <parameter>name</parameter> is loaded. You can see the names of @@ -208,12 +208,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>dl</methodname> <methodparam><type>string</type><parameter>library</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Loads the PHP extension defined in <parameter>library</parameter>. See also the @@ -231,12 +231,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>getenv</methodname> <methodparam><type>string</type><parameter>varname</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the value of the environment variable <parameter>varname</parameter>, or &false; on an error. @@ -274,12 +274,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>get_cfg_var</methodname> <methodparam><type>string</type><parameter>varname</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns the current value of the PHP configuration variable specified by <parameter>varname</parameter>, or &false; if an error @@ -308,23 +308,274 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>get_current_user</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns the name of the owner of the current PHP script. </simpara> <simpara> See also <function>getmyuid</function>, - <function>getmypid</function>, <function>getmyinode</function>, + <function>getmygid</function>, + <function>getmypid</function>, + <function>getmyinode</function>, and <function>getlastmod</function>. </simpara> </refsect1> </refentry> + <refentry id="function.get-defined-constants"> + <refnamediv> + <refname>get_defined_constants</refname> + <refpurpose> + Returns an associative array with the names of all the constants + and their values. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <methodsynopsis> + <type>array</type><methodname>get_defined_constants</methodname> + <void/> + </methodsynopsis> + + <para> + This function returns the names and values of all the constants + currently defined. This includes those created by extensions as + well as those created with the <function>define</function> + function. + </para> + <para> + For example the line below + <informalexample> + <programlisting> +print_r (get_defined_constants()); + </programlisting> + </informalexample> + will print a list like: + <informalexample> + <programlisting> +Array +( + [E_ERROR] =&gt; 1 + [E_WARNING] =&gt; 2 + [E_PARSE] =&gt; 4 + [E_NOTICE] =&gt; 8 + [E_CORE_ERROR] =&gt; 16 + [E_CORE_WARNING] =&gt; 32 + [E_COMPILE_ERROR] =&gt; 64 + [E_COMPILE_WARNING] =&gt; 128 + [E_USER_ERROR] =&gt; 256 + [E_USER_WARNING] =&gt; 512 + [E_USER_NOTICE] =&gt; 1024 + [E_ALL] =&gt; 2047 + [TRUE] =&gt; 1 +) + </programlisting> + </informalexample> + </para> + <para> + See also + <function>get_loaded_extensions</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.get-extension-funcs"> + <refnamediv> + <refname>get_extension_funcs</refname> + <refpurpose> + Returns an array with the names of the functions of a module + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <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>. + </para> + <para> + For example the lines below + <informalexample> + <programlisting> +print_r (get_extension_funcs (&quot;xml&quot;)); +print_r (get_extension_funcs (&quot;gd&quot;)); + </programlisting> + </informalexample> + will print a list of the functions in the modules + <varname>xml</varname> and <varname>gd</varname> respectively. + </para> + <para> + See also: <function>get_loaded_extensions</function> + </para> + </refsect1> + </refentry> + + <refentry id="function.getmygid"> + <refnamediv> + <refname>getmygid</refname> + <refpurpose>Get PHP script owner's GID</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <methodsynopsis> + <type>int</type><methodname>getmygid</methodname> + <void/> + </methodsynopsis> + + <simpara> + Returns the group ID of the current script, or &false; on error. + </simpara> + <simpara> + See also <function>getmyuid</function>, + <function>getmypid</function>, + <function>get_current_user</function>, + <function>getmyinode</function>, and + <function>getlastmod</function>. + </simpara> + </refsect1> + </refentry> + + <refentry id="function.get-included-files"> + <refnamediv> + <refname>get_included_files</refname> + <refpurpose> + Returns an array with the names of included or required files + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <methodsynopsis> + <type>array</type><methodname>get_included_files</methodname> + <void/> + </methodsynopsis> + + <para> + Returns an array of the names of all files that have been + included using <function>include</function>, + <function>include_once</function>, <function>require</function> + or <function>require_once</function>. + </para> + <para> + Files that are included or required multiple times only show up + once in the returned array. + </para> + <para> + <example> + <title><function>get_included_files</function> Example</title> + <programlisting role="php"> +&lt;?php + +include("test1.php"); +include_once("test2.php"); +require("test3.php"); +require_once("test4.php"); + +$included_files = get_included_files(); + +foreach($included_files as $filename) { + echo "$filename\n"; +} + +?&gt; + </programlisting> + </example> + will generate the following output: + <informalexample> + <programlisting> +test1.php +test2.php +test3.php +test4.php + </programlisting> + </informalexample> + </para> + <note> + <para> + In PHP 4.0.1pl2 and previous versions + <function>get_included_files</function> assumed that the + required files ended in the extension <literal>.php</literal>; + other extensions would not be returned. The array returned by + <function>get_included_files</function> was an associative array + and only listed files included by <function>include</function> + and <function>include_once</function>. + </para> + </note> + <para> + See also: <function>include</function>, + <function>include_once</function>, <function>require</function>, + <function>require_once</function> and + <function>get_required_files</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.get-loaded-extensions"> + <refnamediv> + <refname>get_loaded_extensions</refname> + <refpurpose> + Returns an array with the names of all modules compiled and + loaded + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <methodsynopsis> + <type>array</type><methodname>get_loaded_extensions</methodname> + <void/> + </methodsynopsis> + + <para> + This function returns the names of all the modules compiled and + loaded in the PHP interpreter. + </para> + <para> + For example the line below + <informalexample> + <programlisting> +print_r (get_loaded_extensions()); + </programlisting> + </informalexample> + will print a list like: + <informalexample> + <programlisting> +Array +( + [0] =&gt; xml + [1] =&gt; wddx + [2] =&gt; standard + [3] =&gt; session + [4] =&gt; posix + [5] =&gt; pgsql + [6] =&gt; pcre + [7] =&gt; gd + [8] =&gt; ftp + [9] =&gt; db + [10] =&gt; Calendar + [11] =&gt; bcmath +) + </programlisting> + </informalexample> + </para> + <para> + See also: <function>get_extension_funcs</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.get-magic-quotes-gpc"> <refnamediv> <refname>get_magic_quotes_gpc</refname> @@ -334,12 +585,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>long</type><methodname>get_magic_quotes_gpc</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns the current active configuration setting of <link linkend="ini.magic-quotes-gpc">magic_quotes_gpc</link>. @@ -362,12 +613,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>long</type><methodname>get_magic_quotes_runtime</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns the current active configuration setting of <link linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link>. @@ -387,12 +638,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>getlastmod</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the time of the last modification of the current page. The value returned is a Unix timestamp, suitable for @@ -408,6 +659,7 @@ <para> See alse <function>date</function>, <function>getmyuid</function>, + <function>getmygid</function>, <function>get_current_user</function>, <function>getmyinode</function>, and <function>getmypid</function>. @@ -422,26 +674,23 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>getmyinode</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the current script's inode, or &false; on error. </para> <para> - See also <function>getmyuid</function>, + See also <function>getmygid</function>, + <function>getmyuid</function>, <function>get_current_user</function>, <function>getmypid</function>, and <function>getlastmod</function>. </para> - <note> - <simpara> - This function is not supported on Windows systems. - </simpara> - </note> + &note.no-windows; </refsect1> </refentry> @@ -452,12 +701,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>getmypid</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the current PHP process ID, or &false; on error. </para> @@ -469,7 +718,8 @@ </para> </warning> <para> - See also <function>getmyuid</function>, + See also <function>getmygid</function>, + <function>getmyuid</function>, <function>get_current_user</function>, <function>getmyinode</function>, and <function>getlastmod</function>. @@ -484,17 +734,18 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>getmyuid</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns the user ID of the current script, or &false; on error. </simpara> <simpara> - See also <function>getmypid</function>, + See also <function>getmygid</function>, + <function>getmypid</function>, <function>get_current_user</function>, <function>getmyinode</function>, and <function>getlastmod</function>. @@ -502,6 +753,43 @@ </refsect1> </refentry> + <refentry id="function.get-required-files"> + <refnamediv> + <refname>get_required_files</refname> + <refpurpose> + Returns an array with the names of included or required files + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <methodsynopsis> + <type>array</type><methodname>get_required_files</methodname> + <void/> + </methodsynopsis> + + <para> + As of PHP 4.0.4, this function is an alias for + <function>get_included_files</function> + </para> + <para> + In PHP 4.0.1pl2 and previous versions + <function>get_required_files</function> assumed that the required + files ended in the extension <literal>.php</literal>, other + extensions would not be returned. The array returned by + <function>get_required_files</function> was an associative array + and only listed files included by <function>require</function> and + <function>require_once</function>. + </para> + <para> + See also: <function>require</function>, + <function>require_once</function>, <function>include</function>, + <function>include_once</function> and + <function>get_included_files</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.getrusage"> <refnamediv> <refname>getrusage</refname> @@ -509,12 +797,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>getrusage</methodname> <methodparam choice="opt"><type>int</type><parameter>who</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This is an interface to getrusage(2). It returns an associative array containing the data returned from the system call. If who @@ -544,13 +832,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Changes the value of a configuration option, returns &false; on failure, and the previous value of the @@ -577,12 +865,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>ini_get</methodname> <methodparam><type>string</type><parameter>varname</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the value of the configuration option on success, &false; on failure. @@ -603,12 +891,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>ini_get_all</methodname> <methodparam choice="opt"><type>string</type><parameter>extension</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns all the registered configuration options as an associative array. If optional <parameter>extension</parameter> parameter is set, returns @@ -630,12 +918,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>ini_restore</methodname> <methodparam><type>string</type><parameter>varname</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Restores a given configuration option to its original value. </para> @@ -655,13 +943,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Sets the value of the given configuration option. Returns the old value on success, &false; on failure. The configuration @@ -1035,12 +1323,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>phpcredits</methodname> <methodparam><type>int</type><parameter>flag</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function prints out the credits listing the PHP developers, modules, etc. It generates the appropriate HTML codes to insert @@ -1155,12 +1443,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>phpinfo</methodname> <methodparam choice="opt"><type>int</type><parameter>what</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Outputs a large amount of information about the current state of PHP. This includes information about PHP compilation options and @@ -1200,12 +1488,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>phpversion</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a string containing the version of the currently running PHP parser. @@ -1218,7 +1506,8 @@ </example> </para> <para> - See also <function>phpinfo</function>, + See also <function>version_compare</function>, + <function>phpinfo</function>, <function>phpcredits</function>, <function>php_logo_guid</function>, <function>zend_version</function>. @@ -1233,12 +1522,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>php_logo_guid</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> <note> <para> @@ -1263,12 +1552,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>php_sapi_name</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>php_sapi_name</function> returns a lowercase string which describes the type of interface between web server and PHP @@ -1299,12 +1588,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>php_uname</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>php_uname</function> returns a string with a description of the operating system PHP is built on. @@ -1329,12 +1618,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>putenv</methodname> <methodparam><type>string</type><parameter>setting</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Adds <parameter>setting</parameter> to the server environment. The environment variable will only exist for the duration of the current @@ -1388,12 +1677,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>long</type><methodname>set_magic_quotes_runtime</methodname> <methodparam><type>int</type><parameter>new_setting</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Set the current active configuration setting of <link linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link>. (0 for off, 1 for on) @@ -1412,12 +1701,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>set_time_limit</methodname> <methodparam><type>int</type><parameter>seconds</parameter></methodparam> - - </methodsynopsis> + </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 @@ -1452,285 +1741,85 @@ </refsect1> </refentry> - <refentry id="function.zend-logo-guid"> - <refnamediv> - <refname>zend_logo_guid</refname> - <refpurpose>Get the zend guid</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - - <type>string</type><methodname>zend_logo_guid</methodname> - <void/> - - </methodsynopsis> - <para> - <note> - <para> - This funcionality was added in PHP 4 Beta 4. - </para> - </note> - </para> - </refsect1> - </refentry> - - <refentry id="function.get-defined-constants"> + <refentry id="function.version-compare"> <refnamediv> - <refname>get_defined_constants</refname> - <refpurpose> - Returns an associative array with the names of all the constants - and their values. - </refpurpose> + <refname>version_compare</refname> + <refpurpose>Compares two "PHP-standardized" version number strings</refpurpose> </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - - <type>array</type><methodname>get_defined_constants</methodname> - <void/> - - </methodsynopsis> - <para> - This function returns the names and values of all the constants - currently defined. This includes those created by extensions as - well as those created with the <function>define</function> - function. + + <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 would like to write programs working + only on some versions of PHP. + </para> + <para> + <function>version_compare</function> returns -1 if + the first version is lower than the second, 0 if they + are equal, and +1 if the second is lower. + </para> + <para> + If you specify the third optional + <parameter>operator</parameter> argument, you + can test for a particular relationship. The possible + operators are: <literal>&lt;</literal>, + <literal>lt</literal>, <literal>&lt;=</literal>, + <literal>le</literal>, <literal>&gt;</literal>, + <literal>gt</literal>, <literal>&gt;=</literal>, + <literal>ge</literal>, <literal>==</literal>, + <literal>=</literal>, <literal>eq</literal>, + <literal>!=</literal>, <literal>&lt;&gt;</literal>, + <literal>ne</literal> respectively. Using + this argument, the function will return 1 if + the realtionship is the one specified by the + operator, 0 otherwise. </para> <para> - For example the line below - <informalexample> - <programlisting> -print_r (get_defined_constants()); - </programlisting> - </informalexample> - will print a list like: - <informalexample> - <programlisting> -Array -( - [E_ERROR] =&gt; 1 - [E_WARNING] =&gt; 2 - [E_PARSE] =&gt; 4 - [E_NOTICE] =&gt; 8 - [E_CORE_ERROR] =&gt; 16 - [E_CORE_WARNING] =&gt; 32 - [E_COMPILE_ERROR] =&gt; 64 - [E_COMPILE_WARNING] =&gt; 128 - [E_USER_ERROR] =&gt; 256 - [E_USER_WARNING] =&gt; 512 - [E_USER_NOTICE] =&gt; 1024 - [E_ALL] =&gt; 2047 - [TRUE] =&gt; 1 -) - </programlisting> - </informalexample> - </para> - <para> - See also - <function>get_loaded_extensions</function>. - </para> - </refsect1> - </refentry> + <example> + <title><function>version_compare</function> example</title> + <programlisting role="php"> +// prints -1 +echo version_compare("4.0.4", "4.0.6"); - <refentry id="function.get-loaded-extensions"> - <refnamediv> - <refname>get_loaded_extensions</refname> - <refpurpose> - Returns an array with the names of all modules compiled and - loaded - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - - <type>array</type><methodname>get_loaded_extensions</methodname> - <void/> - - </methodsynopsis> - <para> - This function returns the names of all the modules compiled and - loaded in the PHP interpreter. - </para> - <para> - For example the line below - <informalexample> - <programlisting> -print_r (get_loaded_extensions()); +// these all print 1 +echo version_compare("4.0.4", "4.0.6", "&lt;"); +echo version_compare("4.0.6", "4.0.6", "eq"); </programlisting> - </informalexample> - will print a list like: - <informalexample> - <programlisting> -Array -( - [0] =&gt; xml - [1] =&gt; wddx - [2] =&gt; standard - [3] =&gt; session - [4] =&gt; posix - [5] =&gt; pgsql - [6] =&gt; pcre - [7] =&gt; gd - [8] =&gt; ftp - [9] =&gt; db - [10] =&gt; Calendar - [11] =&gt; bcmath -) - </programlisting> - </informalexample> - </para> - <para> - See also: <function>get_extension_funcs</function>. - </para> - </refsect1> - </refentry> - - <refentry id="function.get-extension-funcs"> - <refnamediv> - <refname>get_extension_funcs</refname> - <refpurpose> - Returns an array with the names of the functions of a module - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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>. - </para> - <para> - For example the lines below - <informalexample> - <programlisting> -print_r (get_extension_funcs (&quot;xml&quot;)); -print_r (get_extension_funcs (&quot;gd&quot;)); - </programlisting> - </informalexample> - will print a list of the functions in the modules - <varname>xml</varname> and <varname>gd</varname> respectively. - </para> - <para> - See also: <function>get_loaded_extensions</function> - </para> - </refsect1> - </refentry> - - <refentry id="function.get-required-files"> - <refnamediv> - <refname>get_required_files</refname> - <refpurpose> - Returns an array with the names of included or required files - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - - <type>array</type><methodname>get_required_files</methodname> - <void/> - - </methodsynopsis> - <para> - As of PHP 4.0.4, this function is an alias for - <function>get_included_files</function> - </para> - <para> - In PHP 4.0.1pl2 and previous versions - <function>get_required_files</function> assumed that the required - files ended in the extension <literal>.php</literal>, other - extensions would not be returned. The array returned by - <function>get_required_files</function> was an associative array - and only listed files included by <function>require</function> and - <function>require_once</function>. - </para> - <para> - See also: <function>require</function>, - <function>require_once</function>, <function>include</function>, - <function>include_once</function> and - <function>get_included_files</function>. + </example> </para> </refsect1> </refentry> - <refentry id="function.get-included-files"> + <refentry id="function.zend-logo-guid"> <refnamediv> - <refname>get_included_files</refname> - <refpurpose> - Returns an array with the names of included or required files - </refpurpose> + <refname>zend_logo_guid</refname> + <refpurpose>Get the zend guid</refpurpose> </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - - <type>array</type><methodname>get_included_files</methodname> + + <methodsynopsis> + <type>string</type><methodname>zend_logo_guid</methodname> <void/> - - </methodsynopsis> - <para> - Returns an array of the names of all files that have been - included using <function>include</function>, - <function>include_once</function>, <function>require</function> - or <function>require_once</function>. - </para> - <para> - Files that are included or required multiple times only show up - once in the returned array. - </para> + </methodsynopsis> + <para> - <example> - <title><function>get_included_files</function> Example</title> - <programlisting role="php"> -&lt;?php - -include("test1.php"); -include_once("test2.php"); -require("test3.php"); -require_once("test4.php"); - -$included_files = get_included_files(); - -foreach($included_files as $filename) { - echo "$filename\n"; -} - -?&gt; - </programlisting> - </example> - will generate the following output: - <informalexample> - <programlisting> -test1.php -test2.php -test3.php -test4.php - </programlisting> - </informalexample> - </para> - <note> - <para> - In PHP 4.0.1pl2 and previous versions - <function>get_included_files</function> assumed that the - required files ended in the extension <literal>.php</literal>; - other extensions would not be returned. The array returned by - <function>get_included_files</function> was an associative array - and only listed files included by <function>include</function> - and <function>include_once</function>. - </para> - </note> - <para> - See also: <function>include</function>, - <function>include_once</function>, <function>require</function>, - <function>require_once</function> and - <function>get_required_files</function>. + <note> + <para> + This funcionality was added in PHP 4 Beta 4. + </para> + </note> </para> </refsect1> </refentry> @@ -1742,12 +1831,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>zend_version</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a string containing the version of the currently running PHP parser. Index: phpdoc/en/functions/ingres_ii.xml diff -u phpdoc/en/functions/ingres_ii.xml:1.13.2.1 phpdoc/en/functions/ingres_ii.xml:1.13.2.2 --- phpdoc/en/functions/ingres_ii.xml:1.13.2.1 Sun Nov 11 20:08:50 2001 +++ phpdoc/en/functions/ingres_ii.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.13.2.1 $ --> +<!-- $Revision: 1.13.2.2 $ --> <reference id="ref.ingres"> <title>Ingres II functions</title> <titleabbrev>Ingres II</titleabbrev> @@ -49,14 +49,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Returns a Ingres II link resource on success, or &false; on @@ -124,14 +124,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Returns a Ingres II link resource on success, or &false; on @@ -166,12 +166,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>ingres_close</methodname> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Returns &true; on success, or &false; on failure. @@ -201,13 +201,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Returns &true; on success, or &false; on failure. @@ -311,12 +311,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ingres_num_rows</methodname> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> For delete, insert or update queries, @@ -361,12 +361,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ingres_num_fields</methodname> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>ingres_num_fields</function> returns the number of @@ -390,13 +390,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>ingres_field_name</function> returns the name of a field @@ -426,13 +426,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>ingres_field_type</function> returns the type of a @@ -467,13 +467,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>ingres_field_nullable</function> returns &true; if the @@ -501,13 +501,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>ingres_field_length</function> returns the length of a @@ -537,13 +537,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>ingres_field_precision</function> returns the precision @@ -573,13 +573,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>ingres_field_scale</function> returns the scale of a @@ -609,13 +609,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>ingres_fetch_array</function> Returns an array that @@ -692,12 +692,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>ingres_fetch_row</methodname> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>ingres_fetch_row</function> returns an array that @@ -743,13 +743,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>ingres_fetch_object</function> Returns an object that @@ -807,12 +807,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>ingres_rollback</methodname> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>ingres_rollback</function> rolls back the currently @@ -839,12 +839,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>ingres_commit</methodname> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>ingres_commit</function> commits the currently open @@ -875,12 +875,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>ingres_autocommit</methodname> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>ingres_autocommit</function> is called before opening a Index: phpdoc/en/functions/ircg.xml diff -u phpdoc/en/functions/ircg.xml:1.14.2.1 phpdoc/en/functions/ircg.xml:1.14.2.2 --- phpdoc/en/functions/ircg.xml:1.14.2.1 Sun Nov 11 20:08:50 2001 +++ phpdoc/en/functions/ircg.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.14.2.1 $ --> +<!-- $Revision: 1.14.2.2 $ --> <reference id="ref.ircg"> <title>IRC Gateway Functions</title> <titleabbrev>IRC Gateway</titleabbrev> @@ -21,8 +21,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -30,8 +30,8 @@ <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> + </methodsynopsis> + <para> <function>ircg_pconnect</function> will try to establish a connection to an IRC server and return a connection resource @@ -79,12 +79,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>ircg_fetch_error_msg</methodname> <methodparam><type>resource</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ircg_fetch_error_msg</function> returns the error from the last called ircg function. @@ -118,12 +118,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>boolean</type><methodname>ircg_set_current</methodname> <methodparam><type>resource</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Select the current connection for output in this execution context. Every output sent from the server connected to by @@ -148,13 +148,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Join the channel <parameter>channel</parameter> on the server connected to by <parameter>connection</parameter>. @@ -171,13 +171,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Leave the channel <parameter>channel</parameter> on the server connected to by <parameter>connection</parameter>. @@ -194,15 +194,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ircg_msg</function> will send the message to a channel or user on the server connected to by @@ -229,14 +229,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function will send the <parameter>message</parameter> text to the user <parameter>nick</parameter> on the server connected @@ -256,13 +256,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Change your nickname on the given <parameter>connection</parameter> to the one given in @@ -283,14 +283,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Change the topic for channel <parameter>channel</parameter> on the server connected to by <parameter>connection</parameter> to @@ -308,15 +308,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set channel mode flags for <parameter>channel</parameter> on server connected to by <parameter>connection</parameter>. Mode flags @@ -341,12 +341,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>boolean</type><methodname>ircg_html_encode</methodname> <methodparam><type>string</type><parameter>html_string</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Encodes a HTML string <parameter>html_string</parameter> for output. This feature could be usable, e.g. if someone wants to @@ -364,13 +364,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Sends a query to the connected server <parameter>connection</parameter> to send information for the @@ -388,15 +388,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Kick user <parameter>nick</parameter> from <parameter>channel</parameter> on server connected to by @@ -416,13 +416,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function will add user <parameter>nick</parameter> to your ignore list on the server connected to by @@ -444,13 +444,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function remove user <parameter>nick</parameter> from your ignore list on the server connected to by @@ -471,13 +471,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ircg_disconnect</function> will close a <parameter>connection</parameter> to a server previously @@ -498,12 +498,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>boolean</type><methodname>ircg_is_conn_alive</methodname> <methodparam><type>resource</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ircg_is_conn_alive</function> returns &true; if <parameter>connection</parameter> is still alive and working or @@ -521,12 +521,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>boolean</type><methodname>ircg_lookup_format_messages</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Select the set of format strings to use for display of IRC messages and events. Sets may be registered with @@ -548,13 +548,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> With <function>ircg_register_format_messages</function> you can customize the way your IRC output looks like. You can even Index: phpdoc/en/functions/java.xml diff -u phpdoc/en/functions/java.xml:1.13.2.2 phpdoc/en/functions/java.xml:1.13.2.3 --- phpdoc/en/functions/java.xml:1.13.2.2 Sun Nov 11 21:04:37 2001 +++ phpdoc/en/functions/java.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.13.2.2 $ --> +<!-- $Revision: 1.13.2.3 $ --> <reference id="ref.java"> <title>Java</title> <titleabbrev>PHP / Java Integration</titleabbrev> @@ -117,12 +117,8 @@ Once a method is selected, the parameters are cooerced if necessary, possibly with a loss of data (example: double precision floating point numbers will be converted to boolean). - - -<!-- FIXME Why aren't java-doubles converted to PHP-floats? Is this + <!-- FIXME Why aren't java-doubles converted to PHP-floats? Is this correct? --> - - </simpara> </listitem> <listitem> @@ -175,12 +171,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>java_last_exception_clear</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + </refsect1> </refentry> @@ -191,12 +187,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>exception</type><methodname>java_last_exception_get</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> The following example demonstrates the usage of Java's exception handler from within PHP: Index: phpdoc/en/functions/ldap.xml diff -u phpdoc/en/functions/ldap.xml:1.35.2.1 phpdoc/en/functions/ldap.xml:1.35.2.2 --- phpdoc/en/functions/ldap.xml:1.35.2.1 Sun Nov 11 20:08:51 2001 +++ phpdoc/en/functions/ldap.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.35.2.1 $ --> +<!-- $Revision: 1.35.2.2 $ --> <reference id="ref.ldap"> <title>LDAP functions</title> <titleabbrev>LDAP</titleabbrev> @@ -209,14 +209,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> returns &true; on success and &false; on error. </para><para> @@ -271,14 +271,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Binds to the LDAP directory with specified RDN and password. Returns &true; on success and &false; on error.</para> @@ -297,12 +297,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ldap_close</methodname> <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; on success, &false; on error.</para> <para> @@ -325,15 +325,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> Returns &true; if <parameter>value</parameter> matches otherwise returns &false;. Returns -1 on error. </simpara> @@ -408,13 +408,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns a positive LDAP link identifier on success, or &false; on error.</para> @@ -443,13 +443,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns number of entries in the result or &false; on error.</para> <para> @@ -468,13 +468,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns &true; on success and &false; on error.</para> <para> @@ -491,12 +491,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>ldap_dn2ufn</methodname> <methodparam><type>string</type><parameter>dn</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ldap_dn2ufn</function> function is used to turn a DN into a more user-friendly form, stripping off type names.</para> @@ -513,12 +513,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>ldap_err2str</methodname> <methodparam><type>int</type><parameter>errno</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> returns string error message.</para> <para> @@ -554,12 +554,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ldap_errno</methodname> <methodparam><type>int</type><parameter>link_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> return the LDAP error number of the last LDAP command for this link.</para> @@ -609,12 +609,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>ldap_error</methodname> <methodparam><type>int</type><parameter>link_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> returns string error message.</para> <para> @@ -644,13 +644,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ldap_explode_dn</function> function is used to split the a DN returned by <function>ldap_get_dn</function> and breaks @@ -673,14 +673,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the first attribute in the entry on success and &false; on error. @@ -711,13 +711,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the result entry identifier for the first entry on success and &false; on error.</para> @@ -743,12 +743,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ldap_free_result</methodname> <methodparam><type>int</type><parameter>result_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; on success and &false; on error.</para> <para> @@ -773,13 +773,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns a complete entry information in a multi-dimensional array on success and &false; on error.</para> @@ -842,13 +842,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the DN of the result entry and &false; on error.</para> <para> @@ -865,13 +865,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns a complete result information in a multi-dimenasional array on success and &false; on error.</para> @@ -917,14 +917,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Sets <parameter>retval</parameter> to the value of the specified option, and returns &true; on success and &false; on error.</para> @@ -965,14 +965,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array of values for the attribute on success and &false; on error.</para> @@ -1038,14 +1038,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array of values for the attribute on success and &false; on error.</para> @@ -1077,8 +1077,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -1088,8 +1088,8 @@ <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> + </methodsynopsis> + <para> Returns a search result identifier or &false; on error.</para> <para> @@ -1145,14 +1145,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns &true; on success and &false; on error.</para> <para> @@ -1170,14 +1170,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> returns &true; on success and &false; on error.</para> <para> @@ -1195,14 +1195,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> returns &true; on success and &false; on error.</para> <para> @@ -1220,14 +1220,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> returns &true; on success and &false; on error.</para> <para> @@ -1245,14 +1245,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the next attribute in an entry on success and &false; on error.</para> @@ -1277,13 +1277,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns entry identifier for the next entry in the result whose entries are being read starting with @@ -1310,8 +1310,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -1321,8 +1321,8 @@ <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> + </methodsynopsis> + <para> Returns a search result identifier or &false; on error.</para> <para> @@ -1364,16 +1364,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The entry specified by <parameter>dn</parameter> is renamed/moved. The new RDN is specified by <parameter>newrdn</parameter> and the @@ -1399,8 +1399,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -1410,8 +1410,8 @@ <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> + </methodsynopsis> + <para> Returns a search result identifier or &false; on error.</para> <para> @@ -1552,14 +1552,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Sets the value of the specified option to be <parameter>newval</parameter>, and returns &true; on success and &false; @@ -1631,12 +1631,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ldap_unbind</methodname> <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; on success and &false; on error.</para> <para> Index: phpdoc/en/functions/mail.xml diff -u phpdoc/en/functions/mail.xml:1.32.2.1 phpdoc/en/functions/mail.xml:1.32.2.2 --- phpdoc/en/functions/mail.xml:1.32.2.1 Sun Nov 11 20:08:51 2001 +++ phpdoc/en/functions/mail.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.32.2.1 $ --> +<!-- $Revision: 1.32.2.2 $ --> <reference id="ref.mail"> <title>Mail functions</title> <titleabbrev>Mail</titleabbrev> @@ -67,8 +67,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>mail</methodname> <methodparam><type>string</type><parameter>to</parameter></methodparam> <methodparam><type>string</type><parameter>subject</parameter></methodparam> @@ -76,8 +76,8 @@ <methodparam choice="opt"><type>string</type><parameter>additional_headers</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>additional_parameters </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>mail</function> automatically mails the message specified in <parameter>message</parameter> to the receiver @@ -214,12 +214,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ezmlm_hash</methodname> <methodparam><type>string</type><parameter>addr</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>ezmlm_hash</function> calculates the hash value needed when keeping EZMLM mailing lists in a MySQL database. Index: phpdoc/en/functions/math.xml diff -u phpdoc/en/functions/math.xml:1.56.2.1 phpdoc/en/functions/math.xml:1.56.2.2 --- phpdoc/en/functions/math.xml:1.56.2.1 Sun Nov 11 20:08:51 2001 +++ phpdoc/en/functions/math.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.56.2.1 $ --> +<!-- $Revision: 1.56.2.2 $ --> <reference id="ref.math"> <title>Mathematical Functions</title> <titleabbrev>Math</titleabbrev> @@ -132,12 +132,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>abs</methodname> <methodparam><type>mixed</type><parameter>number</parameter></methodparam> - - </methodsynopsis> + </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>, @@ -154,17 +154,44 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>float</type><methodname>acos</methodname> <methodparam><type>float</type><parameter>arg</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> - Returns the arc cosine of arg in radians. + Returns the arc cosine of <parameter>arg</parameter> in radians. </para> <para> - See also <function>asin</function> and <function>atan</function>. + See also <function>acosh</function>, <function>asin</function> + and <function>atan</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.acosh"> + <refnamediv> + <refname>acosh</refname> + <refpurpose>Inverse hyperbolic cosine</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <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 + hyperbolic cosine is <parameter>arg</parameter>. + </para> + &note.no-windows; + <para> + See also <function>acos</function>, <function>asin</function> + and <function>atan</function>. </para> </refsect1> </refentry> @@ -176,17 +203,44 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>float</type><methodname>asin</methodname> <methodparam><type>float</type><parameter>arg</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the arc sine of arg in radians. </para> <para> - See also <function>acos</function> and <function>atan</function>. + See also <function>asinh</function>, <function>acos</function> + and <function>atan</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.asinh"> + <refnamediv> + <refname>asinh</refname> + <refpurpose>Inverse hyperbolic sine</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <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 + hyperbolic sine is <parameter>arg</parameter>. + </para> + &note.no-windows; + <para> + See also <function>asin</function>, <function>acos</function> + and <function>atan</function>. </para> </refsect1> </refentry> @@ -198,17 +252,44 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>float</type><methodname>atan</methodname> <methodparam><type>float</type><parameter>arg</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the arc tangent of arg in radians. </para> <para> - See also <function>asin</function> and <function>acos</function>. + See also <function>atanh</function>, <function>asin</function> + and <function>acos</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.atanh"> + <refnamediv> + <refname>atanh</refname> + <refpurpose>Inverse hyperbolic tangent</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <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 + hyperbolic tangent is <parameter>arg</parameter>. + </para> + &note.no-windows; + <para> + See also <function>atan</function>, <function>asin</function> + and <function>acos</function>. </para> </refsect1> </refentry> @@ -220,13 +301,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>float</type><methodname>atan2</methodname> <methodparam><type>float</type><parameter>y</parameter></methodparam> <methodparam><type>float</type><parameter>x</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> This function calculates the arc tangent of the two variables <parameter>x</parameter> and <parameter>y</parameter>. It is @@ -252,14 +333,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns a string containing <parameter>number</parameter> represented in base <parameter>tobase</parameter>. The base in @@ -287,12 +368,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>bindec</methodname> <methodparam><type>string</type><parameter>binary_string</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the decimal equivalent of the binary number represented by the binary_string argument. @@ -316,12 +397,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>float</type><methodname>ceil</methodname> <methodparam><type>float</type><parameter>value</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns the next highest integer value by rounding up <parameter>value</parameter> if necessary. @@ -343,12 +424,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>float</type><methodname>cos</methodname> <methodparam><type>float</type><parameter>arg</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the cosine of arg in radians. </para> @@ -358,6 +439,30 @@ </refsect1> </refentry> + <refentry id="function.cosh"> + <refnamediv> + <refname>cosh</refname> + <refpurpose>Hyperbolic cosine</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <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>. + </para> + <para> + See also <function>cos</function>, <function>acosh</function>, + <function>sin</function> and <function>tan</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.decbin"> <refnamediv> <refname>decbin</refname> @@ -365,12 +470,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>decbin</methodname> <methodparam><type>int</type><parameter>number</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a string containing a binary representation of the given number argument. The largest number that can be converted is @@ -389,12 +494,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>dechex</methodname> <methodparam><type>int</type><parameter>number</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a string containing a hexadecimal representation of the given number argument. The largest number that can @@ -413,12 +518,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>decoct</methodname> <methodparam><type>int</type><parameter>number</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a string containing an octal representation of the given number argument. The largest number that can be converted is @@ -439,12 +544,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>float</type><methodname>deg2rad</methodname> <methodparam><type>float</type><parameter>number</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function converts <parameter>number</parameter> from degrees to the radian equivalent. @@ -462,12 +567,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>float</type><methodname>exp</methodname> <methodparam><type>float</type><parameter>arg</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns e raised to the power of <parameter>arg</parameter>. </para> @@ -484,12 +589,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>float</type><methodname>floor</methodname> <methodparam><type>float</type><parameter>value</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns the next lowest integer value by rounding down <parameter>value</parameter> if neccessary. @@ -511,12 +616,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>getrandmax</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns the maximum value that can be returned by a call to <function>rand</function>. @@ -536,12 +641,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>hexdec</methodname> <methodparam><type>string</type><parameter>hex_string</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the decimal equivalent of the hexadecimal number represented by the hex_string argument. <function>hexdec</function> converts a @@ -578,12 +683,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>float</type><methodname>lcg_value</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> <function>lcg_value</function> returns a pseudo random number in the range of (0, 1). The function combines two CGs with periods @@ -600,12 +705,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>float</type><methodname>log</methodname> <methodparam><type>float</type><parameter>arg</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the natural logarithm of arg. </para> @@ -619,12 +724,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>float</type><methodname>log10</methodname> <methodparam><type>float</type><parameter>arg</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the base-10 logarithm of <parameter>arg</parameter>. </para> @@ -638,14 +743,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>max</function> returns the numerically highest of the parameter values. @@ -673,18 +778,18 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>min</function> returns the numerically lowest of the parameter values. @@ -715,17 +820,17 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mt_rand</methodname> <void/> - - + </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> + </methodsynopsis> + <simpara> Many random number generators of older libcs have dubious or unknown characteristics and are slow. By default, PHP uses the @@ -778,12 +883,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>mt_srand</methodname> <methodparam><type>int</type><parameter>seed</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Seeds the random number generator with <parameter>seed</parameter>. @@ -815,12 +920,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mt_getrandmax</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns the maximum value that can be returned by a call to <function>mt_rand</function>. @@ -841,15 +946,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>number_format</function> returns a formatted version of <parameter>number</parameter>. This function accepts either one, @@ -929,12 +1034,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>octdec</methodname> <methodparam><type>string</type><parameter>octal_string</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the decimal equivalent of the octal number represented by the octal_string argument. @@ -955,12 +1060,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>float</type><methodname>pi</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns an approximation of pi. </simpara> @@ -984,13 +1089,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>number</type><methodname>pow</methodname> <methodparam><type>number</type><parameter>base</parameter></methodparam> <methodparam><type>number</type><parameter>exp</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns <parameter>base</parameter> raised to the power of <parameter>exp</parameter>. If possible, this function will @@ -1037,12 +1142,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>float</type><methodname>rad2deg</methodname> <methodparam><type>float</type><parameter>number</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function converts <parameter>number</parameter> from radian to degrees. @@ -1060,17 +1165,17 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>rand</methodname> <void/> - - + </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> + </methodsynopsis> + <simpara> If called without the optional <parameter>min</parameter>, <parameter>max</parameter> arguments <function>rand</function> @@ -1108,13 +1213,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the rounded value of <parameter>val</parameter> to specified <parameter>precision</parameter> @@ -1163,12 +1268,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>float</type><methodname>sin</methodname> <methodparam><type>float</type><parameter>arg</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the sine of arg in radians. </para> @@ -1178,6 +1283,30 @@ </refsect1> </refentry> + <refentry id="function.sinh"> + <refnamediv> + <refname>sinh</refname> + <refpurpose>Hyperbolic sine</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <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>. + </para> + <para> + See also <function>sin</function>, <function>asinh</function>, + <function>cos</function> and <function>tan</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.sqrt"> <refnamediv> <refname>sqrt</refname> @@ -1185,12 +1314,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>float</type><methodname>sqrt</methodname> <methodparam><type>float</type><parameter>arg</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the square root of <parameter>arg</parameter>. </para> @@ -1204,12 +1333,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>srand</methodname> <methodparam><type>int</type><parameter>seed</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Seeds the random number generator with <parameter>seed</parameter>. @@ -1241,17 +1370,41 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>float</type><methodname>tan</methodname> <methodparam><type>float</type><parameter>arg</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the tangent of arg in radians. </para> <para> See also <function>sin</function> and <function>cos</function>. + </para> + </refsect1> + </refentry> + + <refentry id="function.tanh"> + <refnamediv> + <refname>tanh</refname> + <refpurpose>Hyperbolic tangent</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <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>. + </para> + <para> + See also <function>tan</function>, <function>atanh</function>, + <function>sin</function> and <function>cos</function>. </para> </refsect1> </refentry> Index: phpdoc/en/functions/mbstring.xml diff -u phpdoc/en/functions/mbstring.xml:1.15.2.1 phpdoc/en/functions/mbstring.xml:1.15.2.2 --- phpdoc/en/functions/mbstring.xml:1.15.2.1 Sun Nov 11 20:08:52 2001 +++ phpdoc/en/functions/mbstring.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.15.2.1 $ --> +<!-- $Revision: 1.15.2.2 $ --> <reference id="ref.mbstring"> <title>Multi-Byte String Functions</title> <titleabbrev> @@ -531,12 +531,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>mb_language</methodname> <methodparam choice="opt"><type>string</type><parameter>language</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_language</function> sets language. If @@ -577,13 +577,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_parse_str</function> parses GET/POST/COOKIE data and @@ -619,12 +619,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>mb_internal_encoding</methodname> <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_internal_encoding</function> sets internal character @@ -674,12 +674,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>mb_http_input</methodname> <methodparam choice="opt"><type>string</type><parameter>type</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <simpara> <function>mb_http_input</function> returns result of HTTP input @@ -711,12 +711,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>mb_http_output</methodname> <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> If <parameter>encoding</parameter> is set, @@ -749,12 +749,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>mb_detect_order</methodname> <methodparam choice="opt"><type>mixed</type><parameter>encoding-list</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_detect_order</function> sets automatic character @@ -845,12 +845,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>mb_substitute_character</methodname> <methodparam choice="opt"><type>mixed</type><parameter>substrchar</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_substitute_character</function> specifies @@ -914,13 +914,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_output_handler</function> is @@ -987,12 +987,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>mb_preferred_mime_name</methodname> <methodparam><type>string</type><parameter>encoding</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_preferred_mime_name</function> returns MIME @@ -1021,13 +1021,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_strlen</function> returns number of characters in @@ -1056,15 +1056,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_strpos</function> returns the numeric position of @@ -1112,14 +1112,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_strrpos</function> returns the numeric position of @@ -1160,15 +1160,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_substr</function> returns the portion of @@ -1206,15 +1206,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_strcut</function> returns the portion of @@ -1253,13 +1253,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_strwidth</function> returns width of string @@ -1300,16 +1300,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_strimwidth</function> truncates string @@ -1354,14 +1354,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_convert_encoding</function> converts @@ -1409,13 +1409,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_detect_encoding</function> detects character @@ -1467,14 +1467,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_convert_kana</function> performs "han-kaku" - @@ -1539,15 +1539,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_encode_mimeheader</function> converts string @@ -1593,12 +1593,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>mb_decode_mimeheader</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_decode_mimeheader</function> decodes encoded-word @@ -1620,14 +1620,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_convert_variables</function> convert @@ -1677,14 +1677,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_encode_numericentity</function> converts @@ -1756,14 +1756,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Convert numeric string reference of string @@ -1808,16 +1808,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>mb_send_mail</function> sends email. Headers and Index: phpdoc/en/functions/mcal.xml diff -u phpdoc/en/functions/mcal.xml:1.26.2.1 phpdoc/en/functions/mcal.xml:1.26.2.2 --- phpdoc/en/functions/mcal.xml:1.26.2.1 Sun Nov 11 20:08:52 2001 +++ phpdoc/en/functions/mcal.xml Mon Nov 12 09:59:21 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.26.2.1 $ --> +<!-- $Revision: 1.26.2.2 $ --> <reference id="ref.mcal"> <title>MCAL functions</title> <titleabbrev>MCAL</titleabbrev> @@ -136,15 +136,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an MCAL stream on success, &false; on error. </para> @@ -165,15 +165,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an MCAL stream on success, &false; on error. </para> @@ -194,13 +194,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Reopens an MCAL stream to a new calendar. </para> @@ -220,13 +220,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Closes the given mcal stream. </para> @@ -240,13 +240,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Creates a new calendar named <parameter>calendar</parameter>. </para> @@ -260,14 +260,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Renames the calendar <parameter>old_name</parameter> to <parameter>new_name</parameter>. @@ -282,13 +282,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Deletes the calendar named <parameter>calendar</parameter>. </para> @@ -304,14 +304,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mcal_fetch_event</function> fetches an event from the calendar stream specified by <parameter>id</parameter>. @@ -395,14 +395,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -425,12 +425,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mcal_append_event</methodname> <methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mcal_append_event</function> Stores the global event into an MCAL calendar for the given stream. @@ -449,12 +449,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mcal_store_event</methodname> <methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mcal_store_event</function> Stores the modifications to the current global event for the given stream. @@ -473,13 +473,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mcal_delete_event</function> deletes the calendar event specified by the event_id.</para> @@ -496,12 +496,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mcal_snooze</methodname> <methodparam><type>int</type><parameter>id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mcal_snooze</function> turns off an alarm for a calendar event specified by the id. @@ -522,8 +522,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -532,8 +532,8 @@ <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> + </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, @@ -557,12 +557,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mcal_event_init</methodname> <methodparam><type>int</type><parameter>stream</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mcal_event_init</function> initializes a streams global event structure. this effectively sets all elements of the @@ -583,13 +583,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mcal_event_set_category</function> sets the streams global event structure's category to the given string. @@ -609,13 +609,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mcal_event_set_title</function> sets the streams global event structure's title to the given string. @@ -635,13 +635,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mcal_event_set_description</function> sets the streams global event structure's description to the given string. @@ -662,8 +662,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -679,8 +679,8 @@ <methodparam choice="opt"><type>int</type><parameter> sec </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mcal_event_set_start</function> sets the streams global event structure's start date and time to the given values. @@ -700,8 +700,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -718,8 +718,8 @@ <methodparam choice="opt"><type>int</type><parameter> sec </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mcal_event_set_end</function> sets the streams global event structure's end date and time to the given values. @@ -739,13 +739,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mcal_event_set_alarm</function> sets the streams global event structure's alarm to the given minutes before the event. @@ -765,13 +765,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -793,12 +793,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mcal_is_leap_year</methodname> <methodparam><type>int</type><parameter>year</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mcal_is_leap_year</function> returns 1 if the given year is a leap year, 0 if not. @@ -815,13 +815,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -839,14 +839,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mcal_date_valid</function> Returns &true; if the given year, month and day is a valid date, &false; if not. @@ -863,14 +863,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mcal_time_valid</function> Returns &true; if the given hour, minutes and seconds is a valid time, &false; if not. @@ -887,14 +887,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mcal_day_of_week</function> returns the day of the week of the given date. @@ -913,14 +913,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mcal_day_of_year</function> returns the day of the year of the given date. @@ -935,8 +935,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -944,8 +944,8 @@ <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> + </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. @@ -960,14 +960,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mcal_next_recurrence</function> returns an object filled with the next date the event occurs, on or after the @@ -987,12 +987,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mcal_event_set_recur_none</methodname> <methodparam><type>int</type><parameter>stream</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mcal_event_set_recur_none</function> sets the streams global event structure to not recur (event->recur_type is set to @@ -1010,16 +1010,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mcal_event_set_recur_daily</function> sets the streams global event structure's recurrence to the given value to be @@ -1037,8 +1037,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -1046,8 +1046,8 @@ <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> + </methodsynopsis> + <para> <function>mcal_event_set_recur_weekly</function> sets the streams global event structure's recurrence to the given value to be @@ -1065,16 +1065,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mcal_event_set_recur_monthly_mday</function> sets the streams global event structure's recurrence to the given value to @@ -1093,16 +1093,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mcal_event_set_recur_monthly_wday</function> sets the streams global event structure's recurrence to the given value to @@ -1121,16 +1121,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mcal_event_set_recur_yearly</function> sets the streams global event structure's recurrence to the given value to be @@ -1148,12 +1148,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>object</type><methodname>mcal_fetch_current_stream_event</methodname> <methodparam><type>int</type><parameter>stream</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mcal_fetch_current_stream_event</function> returns the current stream's event structure as an object @@ -1219,14 +1219,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mcal_event_add_attribute</function> adds an attribute to the stream's global event structure with the value given by @@ -1244,12 +1244,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mcal_expunge</methodname> <methodparam><type>int</type><parameter>stream</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mcal_expunge</function> Deletes all events which have been previously marked for deletion. Index: phpdoc/en/functions/mcrypt.xml diff -u phpdoc/en/functions/mcrypt.xml:1.23.2.1 phpdoc/en/functions/mcrypt.xml:1.23.2.2 --- phpdoc/en/functions/mcrypt.xml:1.23.2.1 Sun Nov 11 20:08:52 2001 +++ phpdoc/en/functions/mcrypt.xml Mon Nov 12 09:59:22 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.23.2.1 $ --> +<!-- $Revision: 1.23.2.2 $ --> <reference id="ref.mcrypt"> <title>Mcrypt Encryption Functions</title> <titleabbrev>mcrypt</titleabbrev> @@ -369,18 +369,18 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>mcrypt_get_cipher_name</methodname> <methodparam><type>int</type><parameter>cipher</parameter></methodparam> - - </methodsynopsis> - <methodsynopsis> - + </methodsynopsis> + + + <methodsynopsis> <type>string</type><methodname>mcrypt_get_cipher_name</methodname> <methodparam><type>string</type><parameter>cipher</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mcrypt_get_cipher_name</function> is used to get the name of the specified cipher. @@ -419,17 +419,17 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The first prototype is when linked against libmcrypt 2.2.x, the second when linked against libmcrypt 2.4.x. @@ -456,17 +456,17 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The first prototype is when linked against libmcrypt 2.2.x, the second when linked against libmcrypt 2.4.x. @@ -495,13 +495,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mcrypt_create_iv</function> is used to create an IV. </para> @@ -539,26 +539,26 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> - + </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> + </methodsynopsis> + <para> The first prototype is when linked against libmcrypt 2.2.x, the second when linked against libmcrypt 2.4.x. @@ -602,26 +602,26 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> - + </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> + </methodsynopsis> + <para> The first prototype is when linked against libmcrypt 2.2.x, the second when linked against libmcrypt 2.4.x. @@ -665,25 +665,25 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> - + </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> + </methodsynopsis> + <para> The first prototype is when linked against libmcrypt 2.2.x, the second when linked against libmcrypt 2.4.x. @@ -724,26 +724,26 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> - + </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> + </methodsynopsis> + <para> The first prototype is when linked against libmcrypt 2.2.x, the second when linked against libmcrypt 2.4.x. @@ -787,14 +787,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>mcrypt_list_algorithms</methodname> <methodparam choice="opt"><type>string</type><parameter> lib_dir </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mcrypt_list_algorithms</function> is used to get an array of all supported algorithms in the @@ -834,14 +834,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>mcrypt_list_modes</methodname> <methodparam choice="opt"><type>string</type><parameter> lib_dir </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mcrypt_list_modes</function> is used to get an array of all supported modes in the @@ -883,17 +883,17 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The first prototype is when linked against libmcrypt 2.2.x, the second when linked against libmcrypt 2.4.x. @@ -926,8 +926,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>mcrypt_encrypt</methodname> <methodparam><type>string</type><parameter>cipher</parameter></methodparam> <methodparam><type>string</type><parameter>key</parameter></methodparam> @@ -936,8 +936,8 @@ <methodparam choice="opt"><type>string</type><parameter> iv </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mcrypt_encrypt</function> encrypts the data and returns the encrypted data. @@ -1003,8 +1003,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>mcrypt_decrypt</methodname> <methodparam><type>string</type><parameter>cipher</parameter></methodparam> <methodparam><type>string</type><parameter>key</parameter></methodparam> @@ -1013,8 +1013,8 @@ <methodparam choice="opt"><type>string</type><parameter> iv </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mcrypt_decrypt</function> decrypts the data and returns the unencrypted data. @@ -1055,15 +1055,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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, @@ -1106,14 +1106,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The maximum length of the key should be the one obtained by calling <function>mcrypt_enc_get_key_size</function> and every @@ -1141,13 +1141,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -1165,13 +1165,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function decrypts data. Note that the length of the returned string can in fact be longer then the unencrypted @@ -1211,12 +1211,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>mcrypt_generic_end</methodname> <methodparam><type>resource</type><parameter>td</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function terminates encryption specified by the encryption descriptor (td). Actually it clears all buffers, and closes @@ -1232,12 +1232,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mcrypt_enc_self_test</methodname> <methodparam><type>resource</type><parameter>td</parameter></methodparam> - - </methodsynopsis> + </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 @@ -1253,12 +1253,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mcrypt_enc_is_block_algorithm_mode</methodname> <methodparam><type>resource</type><parameter>td</parameter></methodparam> - - </methodsynopsis> + </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). @@ -1273,12 +1273,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mcrypt_enc_is_block_algorithm</methodname> <methodparam><type>resource</type><parameter>td</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns 1 if the algorithm is a block algorithm, or 0 if it is a stream algorithm. @@ -1293,12 +1293,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mcrypt_enc_is_block_mode</methodname> <methodparam><type>resource</type><parameter>td</parameter></methodparam> - - </methodsynopsis> + </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 @@ -1314,12 +1314,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mcrypt_enc_get_block_size</methodname> <methodparam><type>resource</type><parameter>td</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns the block size of the algorithm specified by the encryption descriptor td in bytes. @@ -1334,12 +1334,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mcrypt_enc_get_key_size</methodname> <methodparam><type>resource</type><parameter>td</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns the maximum supported key size of the algorithm specified by the encryption descriptor td in bytes. @@ -1354,12 +1354,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>mcrypt_enc_get_supported_key_sizes</methodname> <methodparam><type>resource</type><parameter>td</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns an array with the key sizes supported by the algorithm specified by the encryption descriptor. If it returns an empty @@ -1377,12 +1377,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mcrypt_enc_get_iv_size</methodname> <methodparam><type>resource</type><parameter>td</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns the size of the iv of the algorithm specified by the encryption descriptor in bytes. If it returns @@ -1399,12 +1399,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>mcrypt_enc_get_algorithms_name</methodname> <methodparam><type>resource</type><parameter>td</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns the name of the algorithm. </para> @@ -1418,12 +1418,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>mcrypt_enc_get_modes_name</methodname> <methodparam><type>resource</type><parameter>td</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns the name of the mode. </para> @@ -1437,13 +1437,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function runs the self test on the algorithm specified. The optional <parameter>lib_dir</parameter> parameter can contain @@ -1463,13 +1463,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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). @@ -1486,13 +1486,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function returns &true; if the specified algorithm is a block algorithm, or &false; is it is a stream algorithm. @@ -1509,13 +1509,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -1532,13 +1532,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function returns the block size of the algorithm specified in bytes. The optional <parameter>lib_dir</parameter> parameter @@ -1554,13 +1554,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function returns the maximum supported key size of the algorithm specified in bytes. The optional @@ -1577,13 +1577,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>mcrypt_module_get_algo_supported_key_sizes</methodname> <methodparam><type>string</type><parameter>algorithm</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns an array with the key sizes supported by the specified algorithm. If it returns an empty array then all key sizes Index: phpdoc/en/functions/mhash.xml diff -u phpdoc/en/functions/mhash.xml:1.18.2.1 phpdoc/en/functions/mhash.xml:1.18.2.2 --- phpdoc/en/functions/mhash.xml:1.18.2.1 Sun Nov 11 20:08:52 2001 +++ phpdoc/en/functions/mhash.xml Mon Nov 12 09:59:22 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.18.2.1 $ --> +<!-- $Revision: 1.18.2.2 $ --> <reference id="ref.mhash"> <title>Mhash Functions</title> <titleabbrev>mhash</titleabbrev> @@ -116,12 +116,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>mhash_get_hash_name</methodname> <methodparam><type>int</type><parameter>hash</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mhash_get_hash_name</function> is used to get the name of the specified hash. @@ -157,12 +157,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mhash_get_block_size</methodname> <methodparam><type>int</type><parameter>hash</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mhash_get_block_size</function> is used to get the size of a block of the specified <parameter>hash</parameter>. @@ -182,12 +182,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mhash_count</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mhash_count</function> returns the highest available hash id. Hashes are numbered from 0 to this hash id. @@ -219,14 +219,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mhash</function> applies a hash function specified by <parameter>hash</parameter> to the <parameter>data</parameter> and @@ -246,15 +246,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mhash_keygen_s2k</function> generates a key that is <parameter>bytes</parameter> long, from a user given password. Index: phpdoc/en/functions/ming.xml diff -u phpdoc/en/functions/ming.xml:1.26.2.2 phpdoc/en/functions/ming.xml:1.26.2.3 --- phpdoc/en/functions/ming.xml:1.26.2.2 Sun Nov 11 21:04:37 2001 +++ phpdoc/en/functions/ming.xml Mon Nov 12 09:59:22 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.26.2.2 $ --> +<!-- $Revision: 1.26.2.3 $ --> <reference id="ref.ming"> <title>Ming functions for Flash</title> <titleabbrev>Ming (flash)</titleabbrev> @@ -163,12 +163,8 @@ </sect1> </partintro> - - <!-- SWFMovie --> - - <refentry id="function.swfmovie"> <refnamediv> <refname>SWFMovie</refname> @@ -176,12 +172,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>new</type><methodname>swfmovie</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfmovie</function> creates a new movie object, @@ -210,12 +206,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfmovie->output</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfmovie->output</function> dumps your lovingly prepared movie out. @@ -248,12 +244,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfmovie->save</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfmovie->save</function> saves your movie to the @@ -273,12 +269,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfmovie->add</methodname> <methodparam><type>ressource</type><parameter>instance</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfmovie->add</function> adds <parameter>instance</parameter> to @@ -311,12 +307,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfmovie->remove</methodname> <methodparam><type>resource</type><parameter>instance</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfmovie->remove</function> removes the object instance @@ -336,14 +332,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfmovie->setbackground</function> sets the background color. Why is @@ -363,12 +359,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfmovie->setrate</methodname> <methodparam><type>int</type><parameter>rate</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfmovie->setrate</function> sets the frame rate to @@ -387,13 +383,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfmovie->setdimension</function> sets the movie's width @@ -409,12 +405,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfmovie->setframes</methodname> <methodparam><type>string</type><parameter>numberofframes</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfmovie->setframes</function> sets the total number of frames @@ -430,12 +426,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfmovie->nextframe</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfmovie->setframes</function> moves to the next frame of @@ -452,12 +448,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfmovie->streammp3</methodname> <methodparam><type>string</type><parameter>mp3FileName</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfmovie->streammp3</function> streams the mp3 file @@ -495,12 +491,8 @@ </refsect1> </refentry> - - <!-- SWFDisplayItem --> - - <refentry id="function.swfdisplayitem"> <refnamediv> <refname>SWFDisplayItem</refname> @@ -508,12 +500,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>new</type><methodname>swfdisplayitem</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfdisplayitem</function> creates a new swfdisplayitem object. @@ -544,13 +536,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfdisplayitem->moveto</function> moves the current object to @@ -576,13 +568,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfdisplayitem->move</function> moves the current object by @@ -609,13 +601,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfdisplayitem->scaleto</function> scales the current object to @@ -641,13 +633,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfdisplayitem->scale</function> scales the current object by @@ -674,12 +666,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfdisplayitem->rotateto</methodname> <methodparam><type>float</type><parameter>degrees</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfdisplayitem->rotateto</function> set the current object @@ -789,12 +781,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfdisplayitem->rotate</methodname> <methodparam><type>float</type><parameter>ddegrees</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfdisplayitem->rotate</function> rotates the current object @@ -820,12 +812,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfdisplayitem->skewxto</methodname> <methodparam><type>float</type><parameter>degrees</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfdisplayitem->skewxto</function> sets the @@ -855,12 +847,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfdisplayitem->skewx</methodname> <methodparam><type>float</type><parameter>ddegrees</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfdisplayitem->skewx</function> adds <parameter>ddegrees</parameter> @@ -888,12 +880,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfdisplayitem->skewyto</methodname> <methodparam><type>float</type><parameter>degrees</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfdisplayitem->skewyto</function> sets the @@ -923,12 +915,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfdisplayitem->skewy</methodname> <methodparam><type>float</type><parameter>ddegrees</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfdisplayitem->skewy</function> adds <parameter>ddegrees</parameter> @@ -956,12 +948,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfdisplayitem->setdepth</methodname> <methodparam><type>float</type><parameter>depth</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfdisplayitem->rotate</function> sets the object's @@ -986,12 +978,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfdisplayitem->remove</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfdisplayitem->remove</function> removes this object from @@ -1017,12 +1009,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfdisplayitem->setname</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfdisplayitem->setname</function> sets the object's name to @@ -1045,12 +1037,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfdisplayitem->setratio</methodname> <methodparam><type>float</type><parameter>ratio</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfdisplayitem->setratio</function> sets the object's ratio @@ -1137,15 +1129,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfdisplayitem->addcolor</function> adds the color to @@ -1167,15 +1159,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfdisplayitem->multcolor</function> multiplies the item's @@ -1225,12 +1217,8 @@ </refsect1> </refentry> - - <!-- SWFShape --> - - <refentry id="function.swfshape"> <refnamediv> <refname>SWFShape</refname> @@ -1238,12 +1226,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>new</type><methodname>swfshape</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfshape</function> creates a new shape object. @@ -1292,16 +1280,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfshape->setline</function> sets the shape's line style. @@ -1387,31 +1375,31 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfshape->addfill</function> adds a solid fill to the shape's list @@ -1514,22 +1502,22 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfshape->setleftfill</methodname> <methodparam><type>swfgradient</type><parameter>fill</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> What this nonsense is about is, every edge segment borders at most two fills. @@ -1563,22 +1551,22 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfshape->setrightfill</methodname> <methodparam><type>swfgradient</type><parameter>fill</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <simpara> See also @@ -1597,13 +1585,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <simpara> <function>swfshape->setrightfill</function> move the shape's pen to @@ -1627,13 +1615,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <simpara> <function>swfshape->setrightfill</function> move the shape's pen from @@ -1657,13 +1645,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <simpara> <function>swfshape->setrightfill</function> draws a line (using the @@ -1688,13 +1676,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <simpara> <function>swfshape->drawline</function> draws a line (using the current line style @@ -1718,15 +1706,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <simpara> <function>swfshape->drawcurveto</function> draws a quadratic curve @@ -1754,15 +1742,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <simpara> <function>swfshape->drawcurve</function> draws a quadratic curve @@ -1784,11 +1772,7 @@ </refsect1> </refentry> - - <!-- SWFGradient --> - - <refentry id="function.swfgradient"> <refnamediv> @@ -1797,12 +1781,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>new</type><methodname>swfgradient</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfgradient</function> creates a new SWFGradient object. @@ -1877,16 +1861,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfgradient->addentry</function> adds an entry to the gradient list. @@ -1900,11 +1884,7 @@ </refsect1> </refentry> - - <!-- SWFBitmap --> - - <refentry id="function.swfbitmap"> <refnamediv> @@ -1913,13 +1893,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfbitmap</function> creates a new SWFBitmap object from @@ -2030,12 +2010,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>swfbitmap->getwidth</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfbitmap->getwidth</function> returns the bitmap's width in pixels. @@ -2054,12 +2034,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>swfbitmap->getheight</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfbitmap->getheight</function> returns the bitmap's height in pixels. @@ -2071,11 +2051,7 @@ </refsect1> </refentry> - - <!-- SWFFill --> - - <refentry id="function.swffill"> <refnamediv> @@ -2104,13 +2080,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swffill->moveto</function> moves fill's origin to @@ -2126,13 +2102,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swffill->scaleto</function> sets fill's scale to @@ -2149,12 +2125,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swffill->rotateto</methodname> <methodparam><type>float</type><parameter>degrees</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swffill->rotateto</function> sets fill's rotation to @@ -2170,12 +2146,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swffill->skewxto</methodname> <methodparam><type>float</type><parameter>x</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swffill->skewxto</function> sets fill x-skew to <parameter>x</parameter>. @@ -2192,12 +2168,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swffill->skewyto</methodname> <methodparam><type>float</type><parameter>y</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swffill->skewyto</function> sets fill y-skew to <parameter>y</parameter>. @@ -2207,11 +2183,7 @@ </refsect1> </refentry> - - <!-- SWFMorph --> - - <refentry id="function.swfmorph"> <refnamediv> @@ -2220,12 +2192,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>new</type><methodname>swfmorph</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfmorph</function> creates a new SWFMorph object. @@ -2306,12 +2278,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>swfmorph->getshape1</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfmorph->getshape1</function> gets a handle to the morph's @@ -2328,12 +2300,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>swfmorph->getshape2</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfmorph->getshape2</function> gets a handle to the morph's @@ -2343,11 +2315,7 @@ </refsect1> </refentry> - - <!-- SWFText --> - - <refentry id="function.swftext"> <refnamediv> @@ -2356,12 +2324,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>new</type><methodname>swftext</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftext</function> creates a new SWFText object, @@ -2409,12 +2377,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swftext->setfont</methodname> <methodparam><type>string</type><parameter>font</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftext->setfont</function> sets the current font to @@ -2430,12 +2398,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swftext->setheight</methodname> <methodparam><type>int</type><parameter>height</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftext->setheight</function> sets the current font height to @@ -2451,12 +2419,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swftext->setspacing</methodname> <methodparam><type>float</type><parameter>spacing</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftext->setspacing</function> sets the current font spacing to @@ -2478,15 +2446,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftext->setspacing</function> changes the current text color. @@ -2502,13 +2470,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftext->moveto</function> moves the pen (or cursor, if @@ -2526,12 +2494,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swftext->addstring</methodname> <methodparam><type>string</type><parameter>string</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftext->addstring</function> draws the string <parameter>string</parameter> @@ -2548,12 +2516,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swftext->addstring</methodname> <methodparam><type>string</type><parameter>string</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftext->addstring</function> returns the rendered width of the @@ -2563,11 +2531,7 @@ </refsect1> </refentry> - - <!-- SWFFont --> - - <refentry id="function.swffont"> <refnamediv> @@ -2576,12 +2540,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>new</type><methodname>swffont</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> If <parameter>filename</parameter> is the name of an FDB file @@ -2625,12 +2589,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>swffont->getwidth</methodname> <methodparam><type>string</type><parameter>string</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swffont->getwidth</function> returns the string @@ -2641,11 +2605,7 @@ </refsect1> </refentry> - - <!-- SWFTextField --> - - <refentry id="function.swftextfield"> <refnamediv> @@ -2654,12 +2614,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>new</type><methodname>swftextfield</methodname> <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftextfield</function> creates a new text field object. @@ -2730,12 +2690,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swftextfield->setfont</methodname> <methodparam><type>string</type><parameter>font</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftextfield->setfont</function> sets the text field font to @@ -2751,13 +2711,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftextfield->setbounds</function> sets the text field width @@ -2775,12 +2735,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swftextfield->align</methodname> <methodparam><type>int</type><parameter>alignement</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftextfield->align</function> sets the text field alignment @@ -2799,12 +2759,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swftextfield->setheight</methodname> <methodparam><type>int</type><parameter>height</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftextfield->setheight</function> sets the font height of this text field @@ -2820,12 +2780,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swftextfield->setleftmargin</methodname> <methodparam><type>int</type><parameter>width</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftextfield->setleftmargin</function> sets the left margin width @@ -2841,12 +2801,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swftextfield->setrightmargin</methodname> <methodparam><type>int</type><parameter>width</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftextfield->setrightmargin</function> sets the right margin width @@ -2862,13 +2822,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftextfield->setmargins</function> set both margins at once, @@ -2884,12 +2844,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swftextfield->setindentation</methodname> <methodparam><type>int</type><parameter>width</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftextfield->setindentation</function> sets the indentation of @@ -2905,12 +2865,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swftextfield->setlinespacing</methodname> <methodparam><type>int</type><parameter>height</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftextfield->setlinespacing</function> sets the line spacing @@ -2926,15 +2886,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftextfield->setcolor</function> sets the color of the text field. @@ -2950,12 +2910,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swftextfield->setname</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftextfield->setname</function> sets the variable name of this @@ -2972,12 +2932,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swftextfield->addstring</methodname> <methodparam><type>string</type><parameter>string</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swftextfield->setname</function> concatenates the string @@ -2986,11 +2946,7 @@ </refsect1> </refentry> - - <!-- SWFSprite --> - - <refentry id="function.swfsprite"> <refnamediv> @@ -2999,12 +2955,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>new</type><methodname>swfsprite</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfsprite</function> are also known as a "movie clip", @@ -3069,12 +3025,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfsprite->add</methodname> <methodparam><type>ressource</type><parameter>object</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfsprite->add</function> adds a <function>swfshape</function>, a @@ -3097,12 +3053,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfsprite->remove</methodname> <methodparam><type>ressource</type><parameter>object</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfsprite->remove</function> remove a <function>swfshape</function>, a @@ -3120,12 +3076,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfsprite->setframes</methodname> <methodparam><type>int</type><parameter>numberofframes</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfsprite->setframes</function> sets the total number of frames @@ -3141,12 +3097,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfsprite->nextframe</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfsprite->setframes</function> moves to the next frame of @@ -3155,11 +3111,7 @@ </refsect1> </refentry> - - <!-- SWFButton --> - - <refentry id="function.swfbutton"> <refnamediv> @@ -3168,12 +3120,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>new</type><methodname>swfbutton</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfbutton</function> creates a new Button. @@ -3331,13 +3283,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfbutton->addshape</function> adds the shape @@ -3358,12 +3310,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfbutton->setup</methodname> <methodparam><type>ressource</type><parameter>shape</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfbutton->setup</function> alias for addShape(shape, SWFBUTTON_UP). @@ -3383,12 +3335,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfbutton->setover</methodname> <methodparam><type>ressource</type><parameter>shape</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfbutton->setover</function> alias for addShape(shape, SWFBUTTON_OVER). @@ -3408,12 +3360,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfbutton->setdown</methodname> <methodparam><type>ressource</type><parameter>shape</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfbutton->setdown</function> alias for addShape(shape, SWFBUTTON_DOWN). @@ -3433,12 +3385,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfbutton->sethit</methodname> <methodparam><type>ressource</type><parameter>shape</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfbutton->sethit</function> alias for addShape(shape, SWFBUTTON_HIT). @@ -3458,13 +3410,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfbutton->addaction</function> adds the action @@ -3489,12 +3441,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swfbutton->setaction</methodname> <methodparam><type>ressource</type><parameter>action</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfbutton->setaction</function> sets the action to be performed @@ -3509,11 +3461,7 @@ </refsect1> </refentry> - - <!-- SWFAction --> - - <refentry id="function.swfaction"> <refnamediv> @@ -3522,12 +3470,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>new</type><methodname>swfaction</methodname> <methodparam><type>string</type><parameter>script</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>swfaction</function> creates a new Action, and Index: phpdoc/en/functions/misc.xml diff -u phpdoc/en/functions/misc.xml:1.59.2.2 phpdoc/en/functions/misc.xml:1.59.2.3 --- phpdoc/en/functions/misc.xml:1.59.2.2 Sun Nov 11 21:04:37 2001 +++ phpdoc/en/functions/misc.xml Mon Nov 12 09:59:22 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.59.2.2 $ --> +<!-- $Revision: 1.59.2.3 $ --> <reference id="ref.misc"> <title>Miscellaneous functions</title> <titleabbrev>Misc.</titleabbrev> @@ -18,12 +18,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>connection_aborted</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns &true; if client disconnected. See the <link linkend="features.connection-handling">Connection Handling</link> description in the <link linkend="features">Features</link> @@ -39,12 +39,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>connection_status</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns the connection status bitfield. See the <link linkend="features.connection-handling">Connection Handling</link> description in the <link linkend="features">Features</link> @@ -60,12 +60,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>connection_timeout</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns &true; if script timed out. </simpara> @@ -75,13 +75,9 @@ This function is deprecated, and doesn't even exist anymore as of 4.0.5. </simpara> - - -<!-- so it's quite late to declare it 'deprecated' by now :) + <!-- so it's quite late to declare it 'deprecated' by now :) TODO: correct connection handling. Any volunteers? --> - - </warning> <simpara> @@ -99,12 +95,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>constant</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>constant</function> will return the value of the constant indicated by <parameter>name</parameter>. @@ -144,14 +140,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Defines a named constant. See the <link linkend="language.constants">section on constants</link> @@ -207,12 +203,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>defined</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if the named constant given by <parameter>name</parameter> has been defined, @@ -255,12 +251,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>eval</methodname> <methodparam><type>string</type><parameter>code_str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>eval</function> evaluates the string given in <parameter>code_str</parameter> as PHP code. Among other things, @@ -322,16 +318,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <note> <simpara> This is not a real function, but a language construct. @@ -363,11 +359,7 @@ ?&gt; </programlisting> - - -<!-- TODO: example with integer exit-statis --> - - + <!-- TODO: example with integer exit-statis --> </example> </para> </refsect1> @@ -382,12 +374,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>object</type><methodname>get_browser</methodname> <methodparam choice="opt"><type>string</type><parameter>user_agent</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>get_browser</function> attempts to determine the capabilities of the user's browser. This is done by looking up @@ -475,12 +467,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>highlight_file</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> The <function>highlight_file</function> function prints out a syntax higlighted version of the code contained in <parameter>filename</parameter> @@ -576,12 +568,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>highlight_string</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> The <function>highlight_string</function> function prints out a syntax highlighted version of <parameter>str</parameter> using the colors defined @@ -605,12 +597,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ignore_user_abort</methodname> <methodparam choice="opt"><type>int</type><parameter>setting</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> This function sets whether a client disconnect should cause a script to be aborted. It will return the previous setting and @@ -632,12 +624,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>iptcparse</methodname> <methodparam><type>string</type><parameter>iptcblock</parameter></methodparam> - - </methodsynopsis> + </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 @@ -654,12 +646,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>leak</methodname> <methodparam><type>int</type><parameter>bytes</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>leak</function> leaks the specified amount of memory. </simpara> @@ -678,13 +670,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Pack given arguments into binary string according to <parameter>format</parameter>. Returns binary string containing @@ -842,12 +834,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>show_source</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> The <function>show_source</function> function prints out a syntax higlighted version of the code contained in <parameter>filename</parameter> @@ -882,12 +874,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>sleep</methodname> <methodparam><type>int</type><parameter>seconds</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> The sleep function delays program execution for the given number of <parameter>seconds</parameter>. @@ -905,13 +897,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>uniqid</methodname> <methodparam><type>string</type><parameter>prefix</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>lcg</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>uniqid</function> returns a prefixed unique identifier based on the current time in microseconds. The prefix can be @@ -962,13 +954,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>unpack</methodname> <methodparam><type>string</type><parameter>format</parameter></methodparam> <methodparam><type>string</type><parameter>data</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>unpack</function> from binary string into array according to <parameter>format</parameter>. Returns array @@ -1010,12 +1002,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>usleep</methodname> <methodparam><type>int</type><parameter>micro_seconds</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> The <function>usleep</function> function delays program execution for the given number of <parameter>micro_seconds</parameter>. Index: phpdoc/en/functions/mnogosearch.xml diff -u phpdoc/en/functions/mnogosearch.xml:1.25.2.1 phpdoc/en/functions/mnogosearch.xml:1.25.2.2 --- phpdoc/en/functions/mnogosearch.xml:1.25.2.1 Sun Nov 11 20:08:52 2001 +++ phpdoc/en/functions/mnogosearch.xml Mon Nov 12 09:59:22 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.25.2.1 $ --> +<!-- $Revision: 1.25.2.2 $ --> <reference id="ref.mnogo"> <title>mnoGoSearch Functions</title> <titleabbrev>mnoGoSearch</titleabbrev> @@ -60,14 +60,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>udm_add_search_limit</function> returns &true; on success, &false; on error. Adds search restrictions. @@ -153,13 +153,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 +212,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>udm_api_version</methodname> <void/> - - </methodsynopsis> + </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> @@ -243,13 +243,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>udm_cat_path</function> returns array describing path in the categories tree from the tree root to the current category. @@ -313,13 +313,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>udm_cat_list</function> returns array listing all categories of the same @@ -380,12 +380,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>udm_clear_search_limits</methodname> <methodparam><type>int</type><parameter>agent</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>udm_clear_search_limits</function> resets defined search @@ -402,12 +402,12 @@ <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>udm_errno</methodname> <methodparam><type>int</type><parameter>agent</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>udm_errno</function> returns mnoGoSearch error number, zero if no error. @@ -431,12 +431,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>udm_error</methodname> <methodparam><type>int</type><parameter>agent</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>udm_error</function> returns mnoGoSearch error message, @@ -463,13 +463,13 @@ <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>udm_find</function> returns result link identifier on @@ -531,12 +531,12 @@ <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>udm_free_agent</methodname> <methodparam><type>int</type><parameter>agent</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>udm_free_agent</function> returns &true; on success, &false; on error. @@ -561,12 +561,12 @@ <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>udm_free_ispell_data</methodname> <methodparam><type>int</type><parameter>agent</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>udm_free_ispell_data</function> always returns &true;. @@ -595,12 +595,12 @@ <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>udm_free_res</methodname> <methodparam><type>int</type><parameter>res</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>udm_free_res</function> returns &true; on success, &false; on error. @@ -626,15 +626,15 @@ <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>udm_get_doc_count</methodname> <methodparam><type>int</type><parameter>agent</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> - <function>udm_get_doc_count</function> returns nuimber of documents in database. + <function>udm_get_doc_count</function> returns number of documents in database. </para> <para> @@ -659,14 +659,14 @@ <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>udm_get_res_field</function> returns result field value on @@ -771,13 +771,13 @@ <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>udm_get_res_param</function> returns result parameter value on @@ -839,16 +839,16 @@ <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>udm_load_ispell_data</function> loads ispell data. Returns &true; @@ -1031,14 +1031,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>udm_set_agent_param</function> returns &true; on success, @@ -1099,7 +1099,7 @@ Please note, that if phrase search is enabled (UDM_PHRASE_ENABLED), it is still possible to do search in any mode (ANY, ALL, BOOL or PHRASE). In 3.1.10 version of mnoGoSearch phrase search is supported only in sql - and buuilt-in database modes, + and built-in database modes, while beginning with 3.1.11 phrases are supported in cachemode as well. </simpara> <simpara> @@ -1179,7 +1179,7 @@ UDM_PARAM_WEIGHT_FACTOR=00100 will search through Titles only. </simpara> <simpara> - UDM_PARAM_WEIGHT_FACTOR=11100 will search through Title,Keywords,Desctription + UDM_PARAM_WEIGHT_FACTOR=11100 will search through Title,Keywords,Description but not through URL and Body. </simpara> <simpara> @@ -1214,7 +1214,7 @@ <simpara> UDM_PARAM_MIN_WORD_LEN - defines minimal word length. Any word shorter this limit is considered to be a stopword. Please note - that this paraneter value is inclusive, i.e. if UDM_PARAM_MIN_WORD_LEN=3, + that this parameter value is inclusive, i.e. if UDM_PARAM_MIN_WORD_LEN=3, a word 3 characters long will not be considered a stopword, while a word 2 characters long will be. Default value is 1. </simpara> Index: phpdoc/en/functions/msql.xml diff -u phpdoc/en/functions/msql.xml:1.16.2.2 phpdoc/en/functions/msql.xml:1.16.2.3 --- phpdoc/en/functions/msql.xml:1.16.2.2 Sun Nov 11 21:04:38 2001 +++ phpdoc/en/functions/msql.xml Mon Nov 12 09:59:22 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.16.2.2 $ --> +<!-- $Revision: 1.16.2.3 $ --> <reference id="ref.msql"> <title>mSQL functions</title> <titleabbrev>mSQL</titleabbrev> @@ -23,14 +23,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns a positive mSQL query identifier to the query result, or &false; on error. @@ -53,12 +53,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>msql_affected_rows</methodname> <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> - - </methodsynopsis> + </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 @@ -78,12 +78,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>msql_close</methodname> <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; on success, &false; on error. </para> @@ -116,8 +116,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>msql_connect</methodname> <methodparam choice="opt"><type>string</type><parameter> hostname @@ -131,8 +131,8 @@ <methodparam choice="opt"><type>string</type><parameter> password </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a positive mSQL link identifier on success, or &false; on error. @@ -167,13 +167,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> msql_create_db() attempts to create a new database on the server associated with the specified link identifier. @@ -190,13 +190,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Identical to <function>msql_create_db</function>. </para> @@ -210,13 +210,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns &true; on success, &false; on failure. </para> @@ -240,13 +240,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>msql_dbname</function> returns the database name stored in position <parameter>i</parameter> of the result pointer @@ -264,13 +264,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns &true; on success, &false; on failure. </para> @@ -305,12 +305,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>msql_error</methodname> - <methodparam><type/><parameter/></methodparam> - - </methodsynopsis> + <methodparam><type></type><parameter/></methodparam> + </methodsynopsis> + <para> Errors coming back from the mSQL database backend no longer issue warnings. Instead, use these functions to retrieve the @@ -326,13 +326,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array that corresponds to the fetched row, or &false; if there are no more rows. @@ -373,13 +373,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an object containing field information </para> @@ -437,13 +437,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an object with properties that correspond to the fetched row, or &false; if there are no more rows. @@ -480,12 +480,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>msql_fetch_row</methodname> <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns an array that corresponds to the fetched row, or &false; if there are no more rows. @@ -517,13 +517,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>msql_fieldname</function> returns the name of the specified field. <parameter>query_identifier</parameter> is the @@ -542,13 +542,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Seeks to the specified field offset. If the next call to <function>msql_fetch_field</function> won't include a field @@ -567,13 +567,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the name of the table <parameter>field</parameter> was fetched from. @@ -588,13 +588,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>msql_fieldtype</function> is similar to the <function>msql_fieldname</function> function. The arguments are @@ -611,13 +611,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>msql_fieldflags</function> returns the field flags of the specified field. Currently this is either, "not &null;", @@ -633,13 +633,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>msql_fieldlen</function> returns the length of the specified field. @@ -654,12 +654,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>msql_free_result</methodname> <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>msql_free_result</function> frees the memory associated with <parameter>query_identifier</parameter>. When PHP completes a @@ -689,13 +689,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>msql_list_fields</function> retrieves information about the given tablename. Arguments are the database name and the @@ -736,12 +736,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>msql_list_dbs</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> <function>msql_list_dbs</function> will return a result pointer containing the databases available from the current msql @@ -771,12 +771,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>msql_list_tables</methodname> <methodparam><type>string</type><parameter>database</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>msql_list_tables</function> takes a database name and result pointer much like the <function>msql</function> @@ -807,12 +807,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>msql_num_fields</methodname> <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>msql_num_fields</function> returns the number of fields in a result set. @@ -833,12 +833,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>msql_num_rows</methodname> <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>msql_num_rows</function> returns the number of rows in a result set. @@ -858,12 +858,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>msql_numfields</methodname> <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Identical to <function>msql_num_fields</function>. </para> @@ -877,12 +877,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>msql_numrows</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Identical to <function>msql_num_rows</function>. </para> @@ -896,8 +896,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>msql_pconnect</methodname> <methodparam choice="opt"><type>string</type><parameter> hostname @@ -911,8 +911,8 @@ <methodparam choice="opt"><type>string</type><parameter> password </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a positive mSQL persistent link identifier on success, or &false; on error. @@ -946,13 +946,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>msql_query</function> sends a query to the currently active database on the server that's associated with the @@ -994,14 +994,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the contents of the cell at the row and offset in the specified mSQL result set. @@ -1039,13 +1039,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns &true; on success, &false; on error. </para> @@ -1088,13 +1088,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>msql_tablename</function> takes a result pointer returned by the <function>msql_list_tables</function> function as Index: phpdoc/en/functions/mssql.xml diff -u phpdoc/en/functions/mssql.xml:1.19.2.1 phpdoc/en/functions/mssql.xml:1.19.2.2 --- phpdoc/en/functions/mssql.xml:1.19.2.1 Sun Nov 11 20:08:53 2001 +++ phpdoc/en/functions/mssql.xml Mon Nov 12 09:59:22 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.19.2.1 $ --> +<!-- $Revision: 1.19.2.2 $ --> <reference id="ref.mssql"> <title>Microsoft SQL Server functions</title> <titleabbrev>MS SQL Server</titleabbrev> @@ -11,12 +11,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mssql_close</methodname> <methodparam choice="opt"><type>int</type><parameter>link_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: &true; on success, &false; on error. </para> @@ -49,14 +49,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: A positive MS SQL link identifier on success, or &false; on error. @@ -91,13 +91,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: &true; on success, &false; on failure. </para> @@ -120,12 +120,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mssql_fetch_array</methodname> <methodparam><type>int</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: An array that corresponds to the fetched row, or &false; if there are no more rows. @@ -156,13 +156,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an object containing field information. </para> @@ -211,12 +211,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mssql_fetch_object</methodname> <methodparam><type>int</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: An object with properties that correspond to the fetched row, or &false; if there are no more rows. @@ -248,12 +248,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>mssql_fetch_row</methodname> <methodparam><type>int</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: An array that corresponds to the fetched row, or &false; if there are no more rows. @@ -286,13 +286,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + </refsect1> </refentry> @@ -303,13 +303,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + </refsect1> </refentry> @@ -320,13 +320,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Seeks to the specified field offset. If the next call to <function>mssql_fetch_field</function> won't include a field @@ -344,13 +344,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + </refsect1> </refentry> @@ -361,12 +361,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mssql_free_result</methodname> <methodparam><type>int</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mssql_free_result</function> only needs to be called if you are worried about using too much memory while your script @@ -388,12 +388,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>mssql_get_last_message</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + </refsect1> </refentry> @@ -404,12 +404,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>mssql_min_error_severity</methodname> <methodparam><type>int</type><parameter>severity</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + </refsect1> </refentry> @@ -420,12 +420,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>mssql_min_message_severity</methodname> <methodparam><type>int</type><parameter>severity</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + </refsect1> </refentry> @@ -436,12 +436,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>mssql_next_result</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> When sending more than one SQL statement to the server or executing a stored procedure with multiple results will cause the server to return multiple result sets. @@ -478,12 +478,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mssql_num_fields</methodname> <methodparam><type>int</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mssql_num_fields</function> returns the number of fields in a result set. @@ -504,12 +504,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mssql_num_rows</methodname> <methodparam><type>string</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mssql_num_rows</function> returns the number of rows in a result set. @@ -529,14 +529,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: A positive MS SQL persistent link identifier on success, or &false; on error. @@ -570,13 +570,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: A positive MS SQL result identifier on success, or &false; on error. @@ -604,14 +604,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mssql_result</function> returns the contents of one cell from a MS SQL result set. The field argument can be the @@ -645,13 +645,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: &true; on success, &false; on error </para> <para> Index: phpdoc/en/functions/mysql.xml diff -u phpdoc/en/functions/mysql.xml:1.67.2.2 phpdoc/en/functions/mysql.xml:1.67.2.3 --- phpdoc/en/functions/mysql.xml:1.67.2.2 Sun Nov 11 21:04:38 2001 +++ phpdoc/en/functions/mysql.xml Mon Nov 12 09:59:22 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.67.2.2 $ --> +<!-- $Revision: 1.67.2.3 $ --> <reference id="ref.mysql"> <title>MySQL Functions</title> <titleabbrev>MySQL</titleabbrev> @@ -68,14 +68,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mysql_affected_rows</methodname> <methodparam choice="opt"><type>resource</type><parameter> link_identifier </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mysql_affected_rows</function> returns the number of rows affected by the last INSERT, UPDATE or DELETE query @@ -128,8 +128,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -139,8 +139,8 @@ <methodparam choice="opt"><type>resource</type><parameter> link_identifier </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mysql_change_user</function> changes the logged in user of the current active connection, or the connection given by the @@ -150,16 +150,8 @@ the current connected user stays active. </para> - - -<!-- what is returned? bool -> succes/failure i suppose? --> - - - - -<!-- in PHP 3 int and in PHP 4 bool --> - - + <!-- what is returned? bool -> succes/failure i suppose? --> + <!-- in PHP 3 int and in PHP 4 bool --> <note> <para> @@ -177,14 +169,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>mysql_close</methodname> <methodparam choice="opt"><type>resource</type><parameter> link_identifier </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: &true; on success, &false; on error. </para> @@ -231,8 +223,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>resource</type><methodname>mysql_connect</methodname> <methodparam choice="opt"><type>string</type><parameter> hostname @@ -246,8 +238,8 @@ <methodparam choice="opt"><type>string</type><parameter> password </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a MySQL link identifier on success, or &false; on failure. </para> @@ -313,25 +305,21 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</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> + </methodsynopsis> + <para> <function>mysql_create_db</function> attempts to create a new database on the server associated with the specified link identifier. </para> - - -<!-- returns?? bool -> succes? --> - - + <!-- returns?? bool -> succes? --> <example> <title>MySQL create database example</title> <programlisting role="php"> @@ -363,13 +351,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: &true; on success, &false; on failure. </para> @@ -424,16 +412,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mysql_db_name</function> takes as its first parameter the result pointer from a call to @@ -479,16 +467,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: A positive MySQL result resource to the query result, or &false; on error. @@ -524,15 +512,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: &true; on success, &false; on failure. </para> @@ -558,14 +546,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mysql_errno</methodname> <methodparam choice="opt"><type>resource</type><parameter> link_identifier </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the error number from the last MySQL function, or <literal>0</literal> (zero) if no error occurred. @@ -608,14 +596,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>mysql_error</methodname> <methodparam choice="opt"><type>resource</type><parameter> link_identifier </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the error text from the last MySQL function, or <literal>''</literal> (the empty string) if no error occurred. @@ -656,12 +644,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>mysql_escape_string</methodname> <methodparam><type>string</type><parameter>unescaped_string</parameter></methodparam> - - </methodsynopsis> + </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>. @@ -684,15 +672,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array that corresponds to the fetched row, or &false; if there are no more rows.</para> @@ -758,12 +746,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>mysql_fetch_assoc</methodname> <methodparam><type>resource</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns an associative array that corresponds to the fetched row, or &false; if there are no more rows.</para> @@ -819,15 +807,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an object containing field information. </para> @@ -953,12 +941,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>mysql_fetch_lengths</methodname> <methodparam><type>resource</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: An array that corresponds to the lengths of each field in the last row fetched by <function>mysql_fetch_row</function>, @@ -985,15 +973,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an object with properties that correspond to the fetched row, or &false; if there are no more rows. @@ -1044,12 +1032,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>mysql_fetch_row</methodname> <methodparam><type>resource</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: An array that corresponds to the fetched row, or &false; if there are no more rows. @@ -1084,13 +1072,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mysql_field_flags</function> returns the field flags of the specified field. The flags are reported as a single word @@ -1118,13 +1106,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mysql_field_name</function> returns the name of the specified field index. <parameter>result</parameter> must be a @@ -1181,13 +1169,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mysql_field_len</function> returns the length of the specified field. @@ -1208,13 +1196,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Seeks to the specified field offset. If the next call to <function>mysql_fetch_field</function> doesn't include a field @@ -1236,13 +1224,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the name of the table that the specifed field is in. @@ -1263,13 +1251,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mysql_field_type</function> is similar to the <function>mysql_field_name</function> function. The arguments are @@ -1319,12 +1307,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mysql_free_result</methodname> <methodparam><type>resource</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mysql_free_result</function> will free all memory associated with the result identifier <parameter>result</parameter>. @@ -1334,17 +1322,9 @@ you are concerned about how much memory is being used for queries that return large result sets. All associated result memory is automatically freed at the end of the script's execution. - - -<!-- TODO and as of PHP4 before, see freeing resources --> - - + <!-- TODO and as of PHP4 before, see freeing resources --> </para> - - -<!-- returns?? --> - - + <!-- returns?? --> <para> For downward compatibility <function>mysql_freeresult</function> can also be used. @@ -1361,14 +1341,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mysql_insert_id</methodname> <methodparam choice="opt"><type>resource</type><parameter> link_identifier </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mysql_insert_id</function> returns the ID generated for an AUTO_INCREMENT column by the previous INSERT query using the @@ -1414,14 +1394,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>resource</type><methodname>mysql_list_dbs</methodname> <methodparam choice="opt"><type>resource</type><parameter> link_identifier </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mysql_list_dbs</function> will return a result pointer containing the databases available from the current mysql @@ -1475,16 +1455,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mysql_list_fields</function> retrieves information about the given tablename. Arguments are the database name and @@ -1494,9 +1474,7 @@ <function>mysql_field_name</function>, and <function>mysql_field_type</function>. </para> - - -<!-- + <!-- this is very outdated, and now incorrect <para> A result identifier is a positive integer. The function returns @@ -1505,8 +1483,6 @@ was called as <literal>@mysql()</literal> then this error string will also be printed out. </para> --> - - <para> <example> <title><function>mysql_list_fields</function> example</title> @@ -1537,14 +1513,10 @@ For downward compatibility <function>mysql_listfields</function> can also be used. </para> - - -<!-- TODO: this is equiv. with 'select * from $table where &false;,' + <!-- TODO: this is equiv. with 'select * from $table where &false;,' which implies you can better use the field-research functions on a real query, that saves you one mysql-query. --> - - </refsect1> </refentry> @@ -1555,15 +1527,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mysql_list_tables</function> takes a database name and returns a result pointer much like the @@ -1585,12 +1557,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mysql_num_fields</methodname> <methodparam><type>resource</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mysql_num_fields</function> returns the number of fields in a result set. @@ -1615,12 +1587,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mysql_num_rows</methodname> <methodparam><type>resource</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mysql_num_rows</function> returns the number of rows in a result set. This command is only valid for SELECT statements. @@ -1666,8 +1638,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>resource</type><methodname>mysql_pconnect</methodname> <methodparam choice="opt"><type>string</type><parameter> hostname @@ -1677,8 +1649,8 @@ </parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: A positive MySQL persistent link identifier on success, or &false; on error. @@ -1706,11 +1678,7 @@ </note> </para> - - -<!-- TODO move the story to features.persistent, and refer to that --> - - + <!-- TODO move the story to features.persistent, and refer to that --> <para> <function>mysql_pconnect</function> acts very much like <function>mysql_connect</function> with two major differences. @@ -1740,13 +1708,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mysql_query</function> sends a query to the currently active database on the server that's associated with the @@ -1841,13 +1809,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mysql_unbuffered_query</function> sends a SQL query <parameter>query</parameter> to MySQL, without fetching and @@ -1884,16 +1852,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mysql_result</function> returns the contents of one cell from a MySQL result set. The field argument can be the @@ -1931,15 +1899,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: &true; on success, &false; on error. </para> @@ -1974,13 +1942,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>mysql_tablename</function> takes a result pointer returned by the <function>mysql_list_tables</function> function @@ -2013,12 +1981,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>mysql_get_client_info</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mysql_get_client_info</function> returns a string that represents the client library version. @@ -2036,12 +2004,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>mysql_get_host_info</methodname> <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mysql_get_host_info</function> returns a string describing the type of connection in use for the connection @@ -2062,12 +2030,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mysql_get_proto_info</methodname> <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mysql_get_proto_info</function> returns the protocol version used by connection @@ -2088,12 +2056,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>mysql_get_server_info</methodname> <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>mysql_get_server_info</function> returns the server version used by connection Index: phpdoc/en/functions/network.xml diff -u phpdoc/en/functions/network.xml:1.44.2.1 phpdoc/en/functions/network.xml:1.44.2.2 --- phpdoc/en/functions/network.xml:1.44.2.1 Sun Nov 11 20:08:53 2001 +++ phpdoc/en/functions/network.xml Mon Nov 12 09:59:22 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.44.2.1 $ --> +<!-- $Revision: 1.44.2.2 $ --> <reference id="ref.network"> <title>Network Functions</title> <titleabbrev>Network</titleabbrev> @@ -14,13 +14,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> Searches DNS for records of type <parameter>type</parameter> corresponding to <parameter>host</parameter>. Returns &true; if any @@ -55,12 +55,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>closelog</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> <function>closelog</function> closes the descriptor being used to write to the system logger. The use of @@ -81,12 +81,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>debugger_off</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Disables the internal PHP debugger. The debugger is still under development. @@ -101,12 +101,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>debugger_on</methodname> <methodparam><type>string</type><parameter>address</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Enables the internal PHP debugger, connecting it to <parameter>address</parameter>. The debugger is still under @@ -122,12 +122,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>define_syslog_variables</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Initializes all constants used in the syslog functions. </para> @@ -149,16 +149,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -256,12 +256,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>gethostbyaddr</methodname> <methodparam><type>string</type><parameter>ip_address</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the host name of the Internet host specified by <parameter>ip_address</parameter>. If an error occurs, returns @@ -282,12 +282,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>gethostbyname</methodname> <methodparam><type>string</type><parameter>hostname</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the IP address of the Internet host specified by <parameter>hostname</parameter>. @@ -308,12 +308,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>gethostbynamel</methodname> <methodparam><type>string</type><parameter>hostname</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a list of IP addresses to which the Internet host specified by <parameter>hostname</parameter> resolves. @@ -336,14 +336,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> Searches DNS for MX records corresponding to <parameter>hostname</parameter>. Returns &true; if any records are @@ -375,12 +375,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>getprotobyname</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>getprotobyname</function> returns the protocol number associated with the protocol <parameter>name</parameter> as per @@ -401,12 +401,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>getprotobynumber</methodname> <methodparam><type>int</type><parameter>number</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>getprotobynumber</function> returns the protocol name associated with protocol <parameter>number</parameter> as per @@ -427,13 +427,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>getservbyname</methodname> <methodparam><type>string</type><parameter>service</parameter></methodparam> <methodparam><type>string</type><parameter>protocol</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>getservbyname</function> returns the Internet port which corresponds to <parameter>service</parameter> for the @@ -457,13 +457,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>getservbyport</methodname> <methodparam><type>int</type><parameter>port</parameter></methodparam> <methodparam><type>string</type><parameter>protocol</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>getservbyport</function> returns the Internet service associated with <parameter>port</parameter> for the specified @@ -487,12 +487,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ip2long</methodname> <methodparam><type>string</type><parameter>ip_address</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The function <function>ip2long</function> generates an IPv4 Internet network address from its Internet standard format (dotted string) @@ -545,12 +545,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>long2ip</methodname> <methodparam><type>int</type><parameter>proper_address</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The function <function>long2ip</function> generates an Internet address in dotted format (i.e.: aaa.bbb.ccc.ddd) from the proper address @@ -569,14 +569,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>openlog</function> opens a connection to the system logger for a program. The string <parameter>ident</parameter> is @@ -723,16 +723,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> + <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> + </methodsynopsis> + <para> This function behaves exactly as <function>fsockopen</function> with the difference that the connection is not closed after the @@ -751,12 +751,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>socket_get_status</methodname> <methodparam><type>resource</type><parameter>socket_get_status</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns information about an existing socket resource. Currently returns four entries in the result array: @@ -803,13 +803,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> If <parameter>mode</parameter> is &false;, the given socket descriptor will be switched to non-blocking mode, and if &true;, it @@ -833,14 +833,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Sets the timeout value on <parameter>socket descriptor</parameter>, expressed in the sum of <parameter>seconds</parameter> and @@ -882,13 +882,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>syslog</methodname> <methodparam><type>int</type><parameter>priority</parameter></methodparam> <methodparam><type>string</type><parameter>message</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>syslog</function> generates a log message that will be distributed by the system logger. Index: phpdoc/en/functions/nis.xml diff -u phpdoc/en/functions/nis.xml:1.17.2.2 phpdoc/en/functions/nis.xml:1.17.2.3 --- phpdoc/en/functions/nis.xml:1.17.2.2 Sun Nov 11 21:04:38 2001 +++ phpdoc/en/functions/nis.xml Mon Nov 12 09:59:22 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.17.2.2 $ --> +<!-- $Revision: 1.17.2.3 $ --> <reference id="ref.nis"> <title>YP/NIS Functions</title> <titleabbrev>YP/NIS</titleabbrev> @@ -25,12 +25,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>yp_get_default_domain</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> <function>yp_get_default_domain</function> returns the default domain of the node or &false;. Can be used as the domain parameter @@ -53,16 +53,12 @@ </programlisting> </example> </para> - - <!-- <para> See also: <link linkend="function.yp-errno">yp_errno</link> and <link linkend="function.yp-err-string">yp_err_string</link> </para> --> - - </refsect1> </refentry> @@ -73,13 +69,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>yp_order</function> returns the order number for a map or &false;. @@ -97,14 +93,10 @@ </para> <para> See also <function>yp-get-default-domain</function>. - - <!-- linkend="function.yp-errno">yp_errno</link> and <link linkend="function.yp-err-string">yp_err_string</link> --> - - </para> </refsect1> </refentry> @@ -118,13 +110,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>yp_master</function> returns the machine name of the master NIS server for a map. @@ -142,14 +134,10 @@ </para> <para> See also <function>yp-get-default-domain</function>. - - <!-- linkend="function.yp-errno">yp_errno</link> and <link linkend="function.yp-err-string">yp_err_string</link> --> - - </para> </refsect1> </refentry> @@ -161,14 +149,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>yp_match</function> returns the value associated with the passed key out of the specified map or &false;. This key must @@ -190,14 +178,10 @@ </para> <para> See also <function>yp-get-default-domain</function> - - <!-- linkend="function.yp-errno">yp_errno</link> and <link linkend="function.yp-err-string">yp_err_string</link> --> - - </para> </refsect1> </refentry> @@ -211,13 +195,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>yp_first</function> returns the first key-value pair from the named map in the named domain, otherwise &false;. @@ -237,14 +221,10 @@ </para> <para> See also <function>yp-get-default-domain</function> - - <!-- <link linkend="function.yp-errno">yp_errno</link> and <link linkend="function.yp-err-string">yp_err_string</link> --> - - </para> </refsect1> </refentry> @@ -257,14 +237,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>yp_next</function> returns the next key-value pair in the named map after the specified key or &false;. @@ -278,11 +258,7 @@ if (!$entry) { echo "No more entries found\n"; - - -<!-- echo yp_errno() . ": " . yp_err_string(); --> - - + <!-- echo yp_errno() . ": " . yp_err_string(); --> } $key = key ($entry); @@ -295,20 +271,14 @@ </para> <para> See also <function>yp-get-default-domain</function>. - - <!-- <link linkend="function.yp-errno">yp_errno</link> and <link linkend="function.yp-err-string">yp_err_string</link> --> - - </para> </refsect1> </refentry> - - <!-- Function doesn't exist <refentry id="function.yp-errno"> @@ -361,10 +331,6 @@ --> - - - - <!-- Function doesn't exist <refentry id="function.yp-err-string"> @@ -404,8 +370,6 @@ </refentry> --> - - </reference> <!-- Keep this comment at the end of the file Index: phpdoc/en/functions/oci8.xml diff -u phpdoc/en/functions/oci8.xml:1.34.2.1 phpdoc/en/functions/oci8.xml:1.34.2.2 --- phpdoc/en/functions/oci8.xml:1.34.2.1 Sun Nov 11 20:08:53 2001 +++ phpdoc/en/functions/oci8.xml Mon Nov 12 09:59:22 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.34.2.1 $ --> +<!-- $Revision: 1.34.2.2 $ --> <reference id="ref.oci8"> <title>Oracle 8 functions</title> <titleabbrev>OCI8</titleabbrev> @@ -156,15 +156,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>OCIDefineByName</function> uses fetches SQL-Columns into user-defined PHP-Variables. Be careful that Oracle user @@ -219,8 +219,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>OCIBindByName</methodname> <methodparam><type>int</type><parameter>stmt</parameter></methodparam> <methodparam><type>string</type><parameter>ph_name</parameter></methodparam> @@ -228,8 +228,8 @@ <methodparam><type>int</type><parameter>length</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter> type</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>OCIBindByName</function> binds the PHP variable <parameter>variable</parameter> to the Oracle placeholder @@ -327,14 +327,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>OCILogon</function> returns an connection identifier needed for most other OCI calls. The optional third parameter @@ -448,14 +448,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>OCIPLogon</function> creates a persistent connection to an Oracle 8 database and logs on. The optional third parameter @@ -480,14 +480,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>OCINLogon</function> creates a new connection to an Oracle 8 database and logs on. The optional third parameter can @@ -606,12 +606,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>OCILogOff</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>OCILogOff</function> closes an Oracle connection. </para> @@ -625,13 +625,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>OCIExecute</function> executes a previously parsed statement. (see <function>OCIParse</function>. The optional @@ -650,12 +650,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>OCICommit</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>OCICommit</function> commits all outstanding statements for Oracle connection <parameter>connection</parameter>. @@ -670,12 +670,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>OCIRollback</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>OCIRollback</function> rolls back all outstanding statements for Oracle connection <parameter>connection</parameter>. @@ -692,13 +692,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>OCINewDescriptor</function> Allocates storage to hold descriptors or LOB locators. Valid values for the valid @@ -814,12 +814,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>OCIRowCount</methodname> <methodparam><type>int</type><parameter>statement</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>OCIRowCount</function> returns the number of rows affected for eg update-statements. This function will not tell you the number @@ -859,12 +859,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>OCINumCols</methodname> <methodparam><type>int</type><parameter>stmt</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>OCINumCols</function> returns the number of columns in a statement @@ -904,13 +904,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>OCIResult</methodname> <methodparam><type>int</type><parameter>statement</parameter></methodparam> <methodparam><type>mixed</type><parameter>column</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>OCIResult</function> returns the data for column <parameter>column</parameter> in the current row (see @@ -928,12 +928,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>OCIFetch</methodname> <methodparam><type>int</type><parameter>statement</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>OCIFetch</function> fetches the next row (for SELECT statements) into the internal result-buffer. @@ -948,14 +948,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>OCIFetchInto</function> fetches the next row (for SELECT statements) into the <parameter>result</parameter> array. @@ -996,13 +996,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>OCIFetchStatement</function> fetches all the rows from a result into a user-defined array. @@ -1060,13 +1060,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>OCIColumnIsNULL</methodname> <methodparam><type>int</type><parameter>stmt</parameter></methodparam> <methodparam><type>mixed</type><parameter>column</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>OCIColumnIsNULL</function> returns &true; if the returned column <parameter>column</parameter> in the result from the @@ -1084,13 +1084,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>OCIColumnName</methodname> <methodparam><type>int</type><parameter>stmt</parameter></methodparam> <methodparam><type>int</type><parameter>col</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>OCIColumnName</function> returns the name of the column corresponding to the column number (1-based) that is passed in. @@ -1144,13 +1144,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>OCIColumnSize</methodname> <methodparam><type>int</type><parameter>stmt</parameter></methodparam> <methodparam><type>mixed</type><parameter>column</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>OCIColumnSize</function> returns the size of the column as given by Oracle. You can either use @@ -1207,13 +1207,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>OCIColumnType</methodname> <methodparam><type>int</type><parameter>stmt</parameter></methodparam> <methodparam><type>int</type><parameter>col</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>OCIColumnType</function> returns the data type of the column corresponding to the column number (1-based) that is passed @@ -1269,12 +1269,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>OCIServerVersion</methodname> <methodparam><type>int</type><parameter>conn</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <example> <title>OCIServerVersion</title> @@ -1297,12 +1297,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>OCIStatementType</methodname> <methodparam><type>int</type><parameter>stmt</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>OCIStatementType</function> returns one of the following values: @@ -1350,12 +1350,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>OCINewCursor</methodname> <methodparam><type>int</type><parameter>conn</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>OCINewCursor</function> allocates a new statement handle on the specified connection. @@ -1438,12 +1438,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>OCIFreeStatement</methodname> <methodparam><type>int</type><parameter>stmt</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>OCIFreeStatement</function> returns &true; if successful, or &false; if unsuccessful. @@ -1460,12 +1460,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>OCIFreeCursor</methodname> <methodparam><type>int</type><parameter>stmt</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>OCIFreeCursor</function> returns &true; if successful, or &false; if unsuccessful. @@ -1480,12 +1480,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>OCIFreeDesc</methodname> <methodparam><type>object</type><parameter>lob</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>OCIFreeDesc</function> returns &true; if successful, or &false; if unsuccessful. @@ -1500,13 +1500,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>OCIParse</methodname> <methodparam><type>int</type><parameter>conn</parameter></methodparam> <methodparam><type>string</type><parameter>query</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>OCIParse</function> parses the <parameter>query</parameter> using <parameter>conn</parameter>. @@ -1525,12 +1525,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>OCIError</methodname> <methodparam choice="opt"><type>int</type><parameter>stmt|conn|global</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>OCIError</function> returns the last error found. If the optional <parameter>stmt|conn|global</parameter> is not @@ -1554,12 +1554,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>OCIInternalDebug</methodname> <methodparam><type>int</type><parameter>onoff</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>OCIInternalDebug</function> enables internal debug output. Set <parameter>onoff</parameter> to 0 to turn debug @@ -1575,12 +1575,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>OCICancel</methodname> <methodparam><type>int</type><parameter>stmt</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> If you do not want read more data from a cursor, then call <function>OCICancel</function>. @@ -1595,13 +1595,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>OCISetPrefetch</methodname> <methodparam><type>int</type><parameter>stmt</parameter></methodparam> <methodparam><type>int</type><parameter>rows</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Sets the number of top level rows to be prefetched. The default value is 1 row. </simpara> @@ -1615,15 +1615,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> Coming soon. </simpara> @@ -1637,12 +1637,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>OCISaveLobFile</methodname> <methodparam><type>object</type><parameter>lob</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Coming soon. </simpara> @@ -1656,12 +1656,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>OCISaveLob</methodname> <methodparam><type>object</type><parameter>lob</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Coming soon. </simpara> @@ -1675,12 +1675,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>OCILoadLob</methodname> <methodparam><type>object</type><parameter>lob</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Coming soon. </simpara> @@ -1694,13 +1694,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>OCIColumnScale</methodname> <methodparam><type>int</type><parameter>stmt</parameter></methodparam> <methodparam><type>int</type><parameter>col</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Coming soon. </simpara> @@ -1714,13 +1714,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>OCIColumnPrecision</methodname> <methodparam><type>int</type><parameter>stmt</parameter></methodparam> <methodparam><type>int</type><parameter>col</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Coming soon. </simpara> @@ -1734,13 +1734,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>OCIColumnTypeRaw</methodname> <methodparam><type>int</type><parameter>stmt</parameter></methodparam> <methodparam><type>int</type><parameter>col</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Coming soon. </simpara> @@ -1754,14 +1754,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> Coming soon. </simpara> @@ -1775,12 +1775,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>OCIFreeCollection</methodname> <methodparam><type>object</type><parameter>lob</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Coming soon. </simpara> @@ -1794,13 +1794,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>OCICollAssign</methodname> <methodparam><type>object</type><parameter>collection</parameter></methodparam> <methodparam><type>object</type><parameter>object</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Coming soon. </simpara> @@ -1814,14 +1814,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> Coming soon. </simpara> @@ -1835,13 +1835,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>OCICollGetElem</methodname> <methodparam><type>object</type><parameter>collection</parameter></methodparam> <methodparam><type>string</type><parameter>ndx</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Coming soon. </simpara> @@ -1855,12 +1855,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>OCICollMax</methodname> <methodparam><type>object</type><parameter>collection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Coming soon. </simpara> @@ -1874,12 +1874,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>OCICollSize</methodname> <methodparam><type>object</type><parameter>collection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Coming soon. </simpara> @@ -1893,13 +1893,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>OCICollTrim</methodname> <methodparam><type>object</type><parameter>collection</parameter></methodparam> <methodparam><type>int</type><parameter>num</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Coming soon. </simpara> Index: phpdoc/en/functions/openssl.xml diff -u phpdoc/en/functions/openssl.xml:1.15.2.1 phpdoc/en/functions/openssl.xml:1.15.2.2 --- phpdoc/en/functions/openssl.xml:1.15.2.1 Sun Nov 11 20:08:53 2001 +++ phpdoc/en/functions/openssl.xml Mon Nov 12 09:59:22 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.15.2.1 $ --> +<!-- $Revision: 1.15.2.2 $ --> <reference id="ref.openssl"> <title>OpenSSL functions</title> <titleabbrev>OpenSSL</titleabbrev> @@ -183,12 +183,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>openssl_error_string</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Returns an error message string, or &false; if there are no more error @@ -226,12 +226,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>openssl_free_key</methodname> <methodparam><type>resource</type><parameter>key_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>openssl_free_key</function> frees the key associated with @@ -247,13 +247,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Returns a positive key resource identifier on success, or &false; on error. @@ -275,12 +275,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>resource</type><methodname>openssl_get_publickey</methodname> <methodparam><type>mixed</type><parameter>certificate</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Returns a positive key resource identifier on success, or &false; on error. @@ -301,15 +301,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Returns &true; on success, or &false; on error. If successful the opened @@ -362,15 +362,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Returns the length of the sealed data on success, or &false; on error. @@ -430,14 +430,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Returns &true; on success, or &false; on failure. @@ -484,14 +484,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Returns 1 if the signature is correct, 0 if it is incorrect, and @@ -544,15 +544,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Decrypts the S/MIME encrypted message contained in the file specified by @@ -594,16 +594,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>openssl_pkcs7_encrypt</function> takes the contents of the @@ -668,8 +668,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -678,8 +678,8 @@ <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>openssl_pkcs7_sign</function> takes the contents of the file @@ -746,16 +746,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>openssl_pkcs7_verify</function> reads the S/MIME message @@ -800,15 +800,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> Returns &true; if the certificate can be used for the intended purpose, @@ -891,12 +891,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>openssl_x509_free</methodname> <methodparam><type>resource</type><parameter>x509cert</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>openssl_x509_free</function> frees the certificate associated @@ -918,13 +918,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + &warn.experimental.func; <para> <function>openssl_x509_parse</function> returns information about the @@ -953,12 +953,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>resource</type><methodname>openssl_x509_read</methodname> <methodparam><type>mixed</type><parameter>x509certdata</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>openssl_x509_read</function> parses the certificate supplied by Index: phpdoc/en/functions/oracle.xml diff -u phpdoc/en/functions/oracle.xml:1.22.2.1 phpdoc/en/functions/oracle.xml:1.22.2.2 --- phpdoc/en/functions/oracle.xml:1.22.2.1 Sun Nov 11 20:08:53 2001 +++ phpdoc/en/functions/oracle.xml Mon Nov 12 09:59:22 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.22.2.1 $ --> +<!-- $Revision: 1.22.2.2 $ --> <reference id="ref.oracle"> <title>Oracle functions</title> <titleabbrev>Oracle</titleabbrev> @@ -11,16 +11,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns &true; if the bind succeeds, otherwise &false;. Details about the error can be retrieved using the @@ -65,12 +65,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ora_close</methodname> <methodparam><type>int</type><parameter>cursor</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if the close succeeds, otherwise &false;. Details about the error can be retrieved using the @@ -91,13 +91,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the name of the field/column <parameter>column</parameter> on the cursor @@ -114,13 +114,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the size of the Oracle column <parameter>column</parameter> on the cursor @@ -136,13 +136,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the Oracle data type name of the field/column <parameter>column</parameter> on the cursor @@ -170,12 +170,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ora_commit</methodname> <methodparam><type>int</type><parameter>conn</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; on success, &false; on error. Details about the error can be retrieved using the <function>ora_error</function> @@ -196,12 +196,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ora_commitoff</methodname> <methodparam><type>int</type><parameter>conn</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; on success, &false; on error. Details about the error can be retrieved using the <function>ora_error</function> and @@ -221,12 +221,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ora_commiton</methodname> <methodparam><type>int</type><parameter>conn</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function turns on automatic commit after each <function>ora_exec</function> on the given connection. @@ -246,13 +246,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function is quick combination of <function>ora_parse</function>, <function>ora_exec</function> and <function>ora_fetch</function>. @@ -277,12 +277,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>Ora_Error</methodname> <methodparam><type>int</type><parameter>cursor_or_connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns an error message of the form <replaceable>XXX</replaceable>-<replaceable>NNNNN</replaceable> @@ -318,12 +318,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>Ora_ErrorCode</methodname> <methodparam><type>int</type><parameter>cursor_or_connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the numeric error code of the last executed statement on the specified cursor or connection. @@ -342,12 +342,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ora_exec</methodname> <methodparam><type>int</type><parameter>cursor</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; on success, &false; on error. Details about the error can be retrieved using the <function>ora_error</function> and @@ -367,12 +367,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ora_fetch</methodname> <methodparam><type>int</type><parameter>cursor</parameter></methodparam> - - </methodsynopsis> + </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 @@ -397,16 +397,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> You can fetch a row into an array with this function. <example> @@ -436,13 +436,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the column data. If an error occurs, &false; is returned and <function>ora_errorcode</function> @@ -464,12 +464,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ora_logoff</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; on success, &false; on error. Details about the error can be retrieved using the <function>ora_error</function> and @@ -491,13 +491,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Establishes a connection between PHP and an Oracle database with the given username and password. @@ -536,13 +536,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Establishes a persistent connection between PHP and an Oracle database with the given username and password. @@ -560,12 +560,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ora_numcols</methodname> <methodparam><type>int</type><parameter>cursor_ind</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ora_numcols</function> returns the number of columns in a result. Only returns meaningful values after an parse/exec/fetch sequence. @@ -584,12 +584,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ora_numrows</methodname> <methodparam><type>int</type><parameter>cursor_ind</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ora_numrows</function> returns the number of rows in a result. </para> @@ -603,12 +603,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ora_open</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Opens an Oracle cursor associated with connection. </para> @@ -627,14 +627,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function parses an SQL statement or a PL/SQL block and associates it with the given cursor. @@ -657,12 +657,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ora_rollback</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function undoes an Oracle transaction. (See <function>ora_commit</function> for the definition of a Index: phpdoc/en/functions/outcontrol.xml diff -u phpdoc/en/functions/outcontrol.xml:1.18.2.1 phpdoc/en/functions/outcontrol.xml:1.18.2.2 --- phpdoc/en/functions/outcontrol.xml:1.18.2.1 Sun Nov 11 20:08:53 2001 +++ phpdoc/en/functions/outcontrol.xml Mon Nov 12 09:59:22 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.18.2.1 $ --> +<!-- $Revision: 1.18.2.2 $ --> <reference id="ref.outcontrol"> <title>Output Control Functions</title> <titleabbrev>Output Control</titleabbrev> @@ -53,12 +53,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>flush</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <simpara> Flushes the output buffers of PHP and whatever backend PHP is using (CGI, a web server, etc). This effectively tries to push @@ -99,14 +99,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>ob_start</methodname> <methodparam choice="opt"><type>string</type><parameter> output_callback </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function will turn output buffering on. While output buffering is active no output is sent from the script (other than @@ -209,12 +209,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>ob_get_contents</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> This will return the contents of the output buffer or &false;, if output buffering isn't active. @@ -235,12 +235,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>ob_get_length</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> This will return the length of the contents in the output buffer or &false;, if output buffering isnt't active. @@ -261,12 +261,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>ob_gzhandler</methodname> <methodparam><type>string</type><parameter>buffer</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ob_gzhandler</function> is intended to be used as a callback function for <function>ob_start</function> to help @@ -311,12 +311,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>ob_end_flush</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> This function will send the contents of the output buffer (if any) and turn output buffering off. If you want to further @@ -342,12 +342,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>ob_end_clean</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> This function discards the contents of the output buffer and turns off output buffering. @@ -368,12 +368,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>ob_implicit_flush</methodname> <methodparam choice="opt"><type>int</type><parameter>flag</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ob_implicit_flush</function> will turn implicit flushing on or off (if no <parameter>flag</parameter> is given, Index: phpdoc/en/functions/overload.xml diff -u phpdoc/en/functions/overload.xml:1.1.2.2 phpdoc/en/functions/overload.xml:1.1.2.3 --- phpdoc/en/functions/overload.xml:1.1.2.2 Sun Nov 11 20:08:53 2001 +++ phpdoc/en/functions/overload.xml Mon Nov 12 09:59:22 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.1.2.2 $ --> +<!-- $Revision: 1.1.2.3 $ --> <reference id="ref.overload"> <title>Object property and method call overloading</title> <titleabbrev>Object overloading</titleabbrev> @@ -65,6 +65,7 @@ $o->x = 56; // instantiate stdclass (it is built-in in PHP 4) +// $val is not overloaded! $val = new stdclass; $val->prop = 555; @@ -78,15 +79,17 @@ </programlisting> </example> </para> - <para> - As this is an experimental extension, not all things - work. There is no <literal>__call()</literal> support - currently, you can only overload the get and set - operations for properties. You cannot invoke the - original overloading handlers of the class, and - <literal>__set()</literal> only works to one level - of property access. - </para> + <warning> + <para> + As this is an experimental extension, not all things + work. There is no <literal>__call()</literal> support + currently, you can only overload the get and set + operations for properties. You cannot invoke the + original overloading handlers of the class, and + <literal>__set()</literal> only works to one level + of property access. + </para> + </warning> </partintro> <refentry id="function.overload"> @@ -96,14 +99,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>overload</methodname> <methodparam choice="opt"><type>string</type><parameter> class_name </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>overload</function> function will enable property and method call overloading for a class identified Index: phpdoc/en/functions/ovrimos.xml diff -u phpdoc/en/functions/ovrimos.xml:1.12.2.1 phpdoc/en/functions/ovrimos.xml:1.12.2.2 --- phpdoc/en/functions/ovrimos.xml:1.12.2.1 Sun Nov 11 20:08:53 2001 +++ phpdoc/en/functions/ovrimos.xml Mon Nov 12 09:59:22 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.12.2.1 $ --> +<!-- $Revision: 1.12.2.2 $ --> <reference id="ref.ovrimos"> <title>Ovrimos SQL functions</title> <titleabbrev>OvrimosSQL</titleabbrev> @@ -47,15 +47,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ovrimos_connect</function> is used to connect to the specified database. @@ -99,12 +99,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>ovrimos_close</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ovrimos_close</function> is used to close the specified connection. @@ -126,13 +126,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ovrimos_longreadlen</function> is used to specify how many bytes are to be retrieved from long datatypes. @@ -153,13 +153,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ovrimos_prepare</function> is used to prepare an SQL statement. </para> @@ -207,13 +207,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ovrimos_execute</function> is used to execute an SQL statement. @@ -238,12 +238,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ovrimos_cursor</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ovrimos_cursor</function> is used to get the name of the cursor. @@ -263,13 +263,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ovrimos_exec</function> is used to execute an SQL statement. @@ -289,15 +289,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ovrimos_fetch_into</function> is used to fetch a row from the result set. @@ -357,14 +357,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ovrimos_fetch_row</function> is used to fetch a row from the result set. @@ -418,13 +418,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ovrimos_result</function> is used to retrieve the output column. @@ -445,13 +445,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ovrimos_result_all</function> is used to print an HTML table containing the whole result set. @@ -552,12 +552,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ovrimos_num_rows</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ovrimos_num_rows</function> is used to get the number of rows affected by update operations. @@ -576,12 +576,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ovrimos_num_fields</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ovrimos_num_fields</function> is used to get the number of columns. @@ -600,13 +600,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ovrimos_field_name</function> is used to get the output column name. @@ -627,13 +627,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ovrimos_field_type</function> is used to get the (numeric) type of the output column. @@ -652,13 +652,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ovrimos_field_len</function> is used to get the length of the output column with number <parameter>field_number</parameter>, @@ -680,13 +680,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>ovrimos_field_num</function> is used to get the (1-based) index of the output column. @@ -705,12 +705,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>ovrimos_free_result</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ovrimos_free_result</function> is used to free the result_id. @@ -729,12 +729,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ovrimos_commit</methodname> <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ovrimos_commit</function> is used to commit the transaction. @@ -752,12 +752,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ovrimos_rollback</methodname> <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>ovrimos_rollback</function> is used to roll back the transaction. Index: phpdoc/en/functions/pcntl.xml diff -u phpdoc/en/functions/pcntl.xml:1.6.2.1 phpdoc/en/functions/pcntl.xml:1.6.2.2 --- phpdoc/en/functions/pcntl.xml:1.6.2.1 Sun Nov 11 20:08:53 2001 +++ phpdoc/en/functions/pcntl.xml Mon Nov 12 09:59:22 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.6.2.1 $ --> +<!-- $Revision: 1.6.2.2 $ --> <reference id="ref.pcntl"> <title>Process Control Functions</title> <titleabbrev>PCNTL</titleabbrev> @@ -172,12 +172,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pcntl_fork</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>pcntl_fork</function> function creates a child process that differs from the parent process only in it's PID and @@ -223,13 +223,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>pcntl_signal</function> function installs a new signal handler for the signal indicated by @@ -300,14 +300,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>pcntl_waitpid</function> function suspends execution of the current process until a child as specified by the @@ -422,12 +422,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pcntl_wexitstatus</methodname> <methodparam><type>int</type><parameter>status</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the return code of a terminated child. This function is only useful if <function>pcntl_wifexited</function> returned @@ -455,12 +455,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pcntl_wifexited</methodname> <methodparam><type>int</type><parameter>status</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if the child status code represents a successful exit. @@ -488,12 +488,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> + <methodsynopsis> <type>int</type><methodname>pcntl_wifsignaled</methodname> <methodparam><type>int</type><parameter>status</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if the child process exited because of a signal which was not caught. @@ -520,12 +520,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pcntl_wifstopped</methodname> <methodparam><type>int</type><parameter>status</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if the child process which caused the return is currently stopped; this is only possible if the call to @@ -553,12 +553,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pcntl_wstopsig</methodname> <methodparam><type>int</type><parameter>status</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the number of the signal which caused the child to stop. This function is only useful if @@ -586,12 +586,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pcntl_wtermsig</methodname> <methodparam><type>int</type><parameter>status</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the number of the signal that caused the child process to terminate. This function is only useful if Index: phpdoc/en/functions/pcre.xml diff -u phpdoc/en/functions/pcre.xml:1.62.2.1 phpdoc/en/functions/pcre.xml:1.62.2.2 --- phpdoc/en/functions/pcre.xml:1.62.2.1 Sun Nov 11 20:08:53 2001 +++ phpdoc/en/functions/pcre.xml Mon Nov 12 09:59:22 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.62.2.1 $ --> +<!-- $Revision: 1.62.2.2 $ --> <reference id="ref.pcre"> <title>Regular Expression Functions (Perl-Compatible)</title> <titleabbrev>PCRE</titleabbrev> @@ -73,14 +73,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Searches <parameter>subject</parameter> for a match to the regular expression given in <parameter>pattern</parameter>. @@ -155,15 +155,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Searches <parameter>subject</parameter> for all matches to the regular expression given in <parameter>pattern</parameter> and puts them in @@ -301,15 +301,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Searches <parameter>subject</parameter> for matches to <parameter> pattern</parameter> and replaces them with @@ -453,15 +453,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The behavior of this function is almost identical to <function>preg_replace</function>, except for the fact that instead of @@ -483,15 +483,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <note> <para> @@ -576,13 +576,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>preg_quote</function> takes <parameter>str</parameter> and puts a backslash in front of every character that is part of @@ -636,13 +636,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>preg_grep</function> returns the array consisting of Index: phpdoc/en/functions/pdf.xml diff -u phpdoc/en/functions/pdf.xml:1.69.2.1 phpdoc/en/functions/pdf.xml:1.69.2.2 --- phpdoc/en/functions/pdf.xml:1.69.2.1 Sun Nov 11 20:08:54 2001 +++ phpdoc/en/functions/pdf.xml Mon Nov 12 09:59:22 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.69.2.1 $ --> +<!-- $Revision: 1.69.2.2 $ --> <reference id="ref.pdf"> <title>PDF functions </title> <titleabbrev>PDF</titleabbrev> @@ -434,15 +434,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -459,8 +459,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -468,8 +468,8 @@ <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> + </methodsynopsis> + <para> Add a launch annotation (to a target of arbitrary file type). </para> @@ -483,8 +483,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -493,8 +493,8 @@ <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> + </methodsynopsis> + <para> Add a link annotation to a target within the current PDF file. </para> @@ -508,8 +508,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -520,8 +520,8 @@ <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> + </methodsynopsis> + <para> Add a note annotation. icon is one of of "comment, "insert", "note", "paragraph", "newparagraph", "key", or "help". @@ -552,8 +552,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -563,8 +563,8 @@ <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> + </methodsynopsis> + <para> Add a file link annotation (to a PDF target). </para> @@ -578,13 +578,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Add an existing image as thumbnail for the current page. </para> @@ -598,8 +598,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -607,8 +607,8 @@ <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> + </methodsynopsis> + <para> Add a weblink annotation to a target URL on the Web. </para> @@ -622,8 +622,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -631,8 +631,8 @@ <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> + </methodsynopsis> + <para> Draw a counterclockwise circular arc from alpha to beta degrees </para> @@ -649,8 +649,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -658,8 +658,8 @@ <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> + </methodsynopsis> + <para> Draw a clockwise circular arc from alpha to beta degrees </para> @@ -676,8 +676,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -689,8 +689,8 @@ <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> + </methodsynopsis> + <para> Add a file attachment annotation. icon is one of "graph, "paperclip", "pushpin", or "tag". @@ -705,14 +705,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Add a new page to the document. </para> @@ -726,8 +726,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -735,8 +735,8 @@ <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> + </methodsynopsis> + <para> Starts a new pattern definition and returns a pattern handle. <parameter>width</parameter>, and <parameter>height</parameter> @@ -756,14 +756,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Start a new template definition. </para> @@ -777,15 +777,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Draw a circle with center (x, y) and radius r. </para> @@ -799,12 +799,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>pdf_clip</methodname> <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Use the current path as clipping path. </para> @@ -818,12 +818,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>pdf_close</methodname> <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Close the generated PDF file, and free all document-related resources. </para> @@ -837,12 +837,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>pdf_closepath</methodname> <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Close the current path. </para> @@ -856,12 +856,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>pdf_closepath_fill_stroke</methodname> <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Close the path, fill, and stroke it. </para> @@ -875,12 +875,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>pdf_closepath_stroke</methodname> <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Close the path, and stroke it. </para> @@ -894,13 +894,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Close an <parameter>image</parameter> retrieved with one of the <function>pdf_open_image*</function> functions. @@ -917,13 +917,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Close all open page handles, and close the input PDF document. </para> @@ -939,13 +939,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Close the page handle, and free all page-related resources. </para> @@ -959,8 +959,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -969,8 +969,8 @@ <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> + </methodsynopsis> + <para> Concatenate a matrix to the CTM. </para> @@ -984,13 +984,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Print text at the next line. The spacing between lines is determined by the <parameter>leading</parameter> parameter. @@ -1005,8 +1005,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -1015,8 +1015,8 @@ <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> + </methodsynopsis> + <para> Draw a Bezier curve from the current point, using 3 more control points. </para> @@ -1030,12 +1030,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>pdf_delete</methodname> <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Delete the PDF object, and free all internal resources. </para> @@ -1049,12 +1049,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>pdf_end_page</methodname> <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Finish the page. </para> @@ -1081,12 +1081,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>pdf_end_pattern</methodname> <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Finish the pattern definition. </para> @@ -1100,12 +1100,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>pdf_end_template</methodname> <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Finish the template definition. </para> @@ -1119,12 +1119,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>pdf_fill_stroke</methodname> <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Fill the interior of the path with the current fill color. </para> @@ -1138,12 +1138,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>pdf_fill_stroke</methodname> <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Fill and stroke the path with the current fill and stroke color. </para> @@ -1157,15 +1157,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -1202,12 +1202,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>pdf_get_buffer</methodname> <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Get the contents of the PDF output buffer. The result must be used by the client before calling any other PDFlib function. @@ -1270,13 +1270,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>pdf_get_image_height</function> is deprecated, use <function>pdf_get_value</function> instead. @@ -1291,13 +1291,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>pdf_get_image_width</function> is deprecated, use <function>pdf_get_value</function> instead. @@ -1312,14 +1312,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Get the contents of some PDFlib parameter with string type. </para> @@ -1333,16 +1333,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Get the contents of some PDI document parameter with string type. </para> @@ -1356,16 +1356,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Get the contents of some PDI document parameter with numerical type. </para> @@ -1379,14 +1379,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Get the contents of some PDFlib parameter with float type. </para> @@ -1400,12 +1400,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>pdf_initgraphics</methodname> <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Reset all implicit color and graphics state parameters to their defaults. </para> @@ -1419,14 +1419,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Draw a line from the current point to (<parameter>x</parameter>, <parameter>y</parameter>). @@ -1441,13 +1441,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Make a named spot color from the current color. </para> @@ -1461,14 +1461,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set the current point. </para> @@ -1482,12 +1482,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pdf_new</methodname> <methodparam><parameter/></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Create a new PDF object, using default error handling and memory management. @@ -1521,8 +1521,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -1531,8 +1531,8 @@ <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> + </methodsynopsis> + <para> Open a raw CCITT image. </para> @@ -1546,13 +1546,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Create a new PDF file using the supplied file name. If <parameter>filename</parameter> is empty the PDF document @@ -1616,8 +1616,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -1629,8 +1629,8 @@ <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> + </methodsynopsis> + <para> Use image data from a variety of data sources. Supported types are "jpeg", "ccitt", "raw". Supported sources are "memory", "fileref", @@ -1647,16 +1647,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Open an image file. Supported types are "jpeg", "tiff", "gif", and "png". <parameter>stringparam</parameter> is either @@ -1690,13 +1690,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>pdf_open_memory_image</function> function takes an image created with the PHP's image functions and makes it available @@ -1733,15 +1733,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Open an existing PDF document for later use. </para> @@ -1757,15 +1757,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Prepare a page for later use with <function>pdf_place_image</function> </para> @@ -1797,13 +1797,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Deprecated. </para> @@ -1820,16 +1820,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Place an image with the lower left corner at (<parameter>x</parameter>, <parameter>y</parameter>), and scale it. @@ -1844,8 +1844,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -1853,8 +1853,8 @@ <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> + </methodsynopsis> + <para> Place a PDF page with the lower left corner at (<parameter>x</parameter>, <parameter>y</parameter>), and scale it. @@ -1869,16 +1869,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Draw a rectangle at lower left (x, y) with width and height. </para> @@ -1892,12 +1892,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>pdf_restore</methodname> <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Restore the most recently saved graphics state. </para> @@ -1911,13 +1911,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Rotate the coordinate system by phi degrees. </para> @@ -1931,12 +1931,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>pdf_save</methodname> <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Save the current graphics state. </para> @@ -1950,14 +1950,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Scale the coordinate system. </para> @@ -1971,8 +1971,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -1981,8 +1981,8 @@ <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> + </methodsynopsis> + <para> Set the current color space and color. The parameter <parameter>type</parameter> can be "fill", "stroke", or "both" @@ -2020,14 +2020,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> + <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. @@ -2042,13 +2042,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set the flatness to a value between 0 and 100 inclusive. </para> @@ -2062,14 +2062,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set the current font in the given size, using a <parameter>font</parameter> handle returned by @@ -2088,13 +2088,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set the current fill and stroke color. </para> @@ -2113,13 +2113,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set the current fill color to a gray value between 0 and 1 inclusive. </para> @@ -2138,13 +2138,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set the current stroke color to a gray value between 0 and 1 inclusive </para> @@ -2163,13 +2163,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set the <parameter>linecap</parameter> parameter to a value between 0 and 2 inclusive. </para> @@ -2183,13 +2183,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set the line join parameter to a value between 0 and 2 inclusive. </para> @@ -2203,13 +2203,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set the current linewidth to width. </para> @@ -2223,8 +2223,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -2233,8 +2233,8 @@ <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> + </methodsynopsis> + <para> Explicitly set the current transformation matrix. </para> @@ -2248,13 +2248,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set the miter limit to a value greater than or equal to 1. </para> @@ -2268,13 +2268,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set a more complicated dash pattern defined by an array. </para> @@ -2288,15 +2288,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set the current fill and stroke color to the supplied RGB values. </para> @@ -2315,15 +2315,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set the current fill color to the supplied RGB values. </para> @@ -2342,15 +2342,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set the current stroke color to the supplied RGB values. </para> @@ -2369,15 +2369,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set the border color for all kinds of annotations. </para> @@ -2391,14 +2391,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set the border dash style for all kinds of annotations. See <function>pdf_setdash</function>. @@ -2413,14 +2413,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set the border style for all kinds of annotations. <parameter>style</parameter> is "solid" or "dashed". @@ -2485,13 +2485,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Deprecated. </para> @@ -2508,14 +2508,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Fill document information field key with value. <parameter>key</parameter> is one of "Subject", "Title", "Creator", @@ -2547,14 +2547,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set some PDFlib parameter with string type. </para> @@ -2568,14 +2568,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set the text output position. </para> @@ -2634,14 +2634,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set the value of some PDFlib parameter with float type. </para> @@ -2671,13 +2671,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Print text in the current font and size at the current position. </para> @@ -2691,8 +2691,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -2702,8 +2702,8 @@ <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> + </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 @@ -2727,15 +2727,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Print text in the current font at (x, y). </para> @@ -2749,14 +2749,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Skew the coordinate system in x and y direction by alpha and beta degrees. @@ -2771,15 +2771,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the width of <parameter>text</parameter> using the last font set by <function>pdf_setfont</function>. If the optional @@ -2809,12 +2809,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>pdf_stroke</methodname> <methodparam><type>int</type><parameter>pdf object</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Stroke the path with the current color and line width, and clear it. </para> @@ -2828,14 +2828,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Translate the origin of the coordinate system. </para> Index: phpdoc/en/functions/pfpro.xml diff -u phpdoc/en/functions/pfpro.xml:1.9.2.1 phpdoc/en/functions/pfpro.xml:1.9.2.2 --- phpdoc/en/functions/pfpro.xml:1.9.2.1 Sun Nov 11 20:08:54 2001 +++ phpdoc/en/functions/pfpro.xml Mon Nov 12 09:59:22 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.9.2.1 $ --> +<!-- $Revision: 1.9.2.2 $ --> <reference id="ref.pfpro"> <title>Verisign Payflow Pro functions</title> <titleabbrev>Verisign Payflow Pro</titleabbrev> @@ -53,12 +53,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>pfpro_init</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pfpro_init</function> is used to initialise the Payflow Pro library. You may omit this call, in which case @@ -78,12 +78,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>pfpro_cleanup</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pfpro_cleanup</function> is used to shutdown the Payflow Pro library cleanly. It should be called after you @@ -105,8 +105,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>pfpro_process</methodname> <methodparam><type>array</type><parameter>parameters</parameter></methodparam> @@ -117,8 +117,8 @@ <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> + </methodsynopsis> + <para> Returns: An associative array containing the response </para> @@ -211,8 +211,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -222,8 +222,8 @@ <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> + </methodsynopsis> + <para> Returns: A string containing the response. </para> @@ -277,12 +277,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>pfpro_version</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pfpro_version</function> returns the version string of the Payflow Pro library. At the time of writing, this was L211. Index: phpdoc/en/functions/pgsql.xml diff -u phpdoc/en/functions/pgsql.xml:1.47.2.2 phpdoc/en/functions/pgsql.xml:1.47.2.3 --- phpdoc/en/functions/pgsql.xml:1.47.2.2 Sun Nov 11 21:04:38 2001 +++ phpdoc/en/functions/pgsql.xml Mon Nov 12 09:59:23 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.47.2.2 $ --> +<!-- $Revision: 1.47.2.3 $ --> <reference id="ref.pgsql"> <title>PostgreSQL functions</title> <titleabbrev>PostgreSQL</titleabbrev> @@ -42,11 +42,7 @@ </row> <row> <entry>postmaster -i &amp;</entry> - - <!-- <entry>pg_connect("", "", "", "", "dbname");</entry> --> - - <entry>pg_connect("dbname=MyDbName");</entry> <entry>OK</entry> </row> @@ -116,12 +112,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>pg_close</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &false; if connection is not a valid connection index, &true; otherwise. Closes down the connection to a PostgreSQL database @@ -146,12 +142,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pg_cmdtuples</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_cmdtuples</function> returns the number of tuples (instances) affected by INSERT, UPDATE, and DELETE queries. If no @@ -181,33 +177,33 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pg_connect</methodname> <methodparam><type>string</type><parameter>host</parameter></methodparam> <methodparam><type>string</type><parameter>port</parameter></methodparam> <methodparam><type>string</type><parameter>dbname</parameter></methodparam> - - + </methodsynopsis> + <methodsynopsis> <type>int</type><methodname>pg_connect</methodname> <methodparam><type>string</type><parameter>host</parameter></methodparam> <methodparam><type>string</type><parameter>port</parameter></methodparam> <methodparam><type>string</type><parameter>options</parameter></methodparam> <methodparam><type>string</type><parameter>dbname</parameter></methodparam> - - + </methodsynopsis> + <methodsynopsis> <type>int</type><methodname>pg_connect</methodname> <methodparam><type>string</type><parameter>host</parameter></methodparam> <methodparam><type>string</type><parameter>port</parameter></methodparam> <methodparam><type>string</type><parameter>options</parameter></methodparam> <methodparam><type>string</type><parameter>tty</parameter></methodparam> <methodparam><type>string</type><parameter>dbname</parameter></methodparam> - - + </methodsynopsis> + <methodsynopsis> <type>int</type><methodname>pg_connect</methodname> <methodparam><type>string</type><parameter>conn_string</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a connection index on success, or &false; if the connection could not be made. Opens a connection to a PostgreSQL database. @@ -261,12 +257,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>pg_dbname</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the name of the database that the given PostgreSQL connection index is connected to, or &false; if connection is not a @@ -282,12 +278,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>pg_end_copy</methodname> <methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_end_copy</function> syncs PostgreSQL frontend with the backend after doing a copy operation. It must be issued or @@ -308,12 +304,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>pg_errormessage</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a string containing the error message, &false; on failure. Details about the error probably cannot be retrieved using the @@ -332,13 +328,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pg_exec</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> <methodparam><type>string</type><parameter>query</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a result index if query could be executed, &false; on failure or if connection is not a valid connection index. Details @@ -368,14 +364,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>pg_fetch_array</methodname> <methodparam><type>int</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> + </methodsynopsis> + <para> Returns: An array that corresponds to the fetched row, or &false; if there are no more rows. @@ -440,14 +436,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>object</type><methodname>pg_fetch_object</methodname> <methodparam><type>int</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> + </methodsynopsis> + <para> Returns: An object with properties that correspond to the fetched row, or &false; if there are no more rows. @@ -531,13 +527,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>pg_fetch_row</methodname> <methodparam><type>int</type><parameter>result</parameter></methodparam> <methodparam><type>int</type><parameter>row</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: An array that corresponds to the fetched row, or &false; if there are no more rows. @@ -595,14 +591,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pg_fieldisnull</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> <methodparam><type>int</type><parameter>row</parameter></methodparam> <methodparam><type>mixed</type><parameter>field</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Test if a field is &null; or not. Returns 0 if the field in the given row is not &null;. Returns 1 if the field in the given row is @@ -619,13 +615,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>pg_fieldname</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> <methodparam><type>int</type><parameter>field_number</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_fieldname</function> will return the name of the field occupying the given column number in the given PostgreSQL @@ -641,13 +637,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pg_fieldnum</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> <methodparam><type>string</type><parameter>field_name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_fieldnum</function> will return the number of the column slot that corresponds to the named field in the given @@ -664,14 +660,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pg_fieldprtlen</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> <methodparam><type>int</type><parameter>row_number</parameter></methodparam> <methodparam><type>string</type><parameter>field_name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_fieldprtlen</function> will return the actual printed length (number of characters) of a specific value in a @@ -690,13 +686,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pg_fieldsize</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> <methodparam><type>int</type><parameter>field_number</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_fieldsize</function> will return the internal storage size (in bytes) of the field number in the given @@ -716,13 +712,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>pg_fieldtype</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> <methodparam><type>int</type><parameter>field_number</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_fieldtype</function> will return a string containing the type name of the given field in the given PostgreSQL result @@ -738,12 +734,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pg_freeresult</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_freeresult</function> only needs to be called if you are worried about using too much memory while your script is @@ -763,12 +759,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pg_getlastoid</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_getlastoid</function> can be used to retrieve the <varname>oid</varname> assigned to an inserted tuple if the @@ -791,12 +787,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>pg_host</methodname> <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_host</function> will return the host name of the given PostgreSQL connection identifier is connected to. @@ -811,12 +807,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>pg_loclose</methodname> <methodparam><type>int</type><parameter>fd</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_loclose</function> closes an Inversion Large Object. <parameter>Fd</parameter> is a file descriptor for the @@ -832,12 +828,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pg_locreate</methodname> <methodparam><type>int</type><parameter>conn</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_locreate</function> creates an Inversion Large Object and returns the <varname>oid</varname> of the large @@ -857,14 +853,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>pg_loexport</methodname> <methodparam><type>int</type><parameter>oid</parameter></methodparam> <methodparam><type>int</type><parameter>file</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>connection_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <parameter>oid</parameter> argument specifies the object id of the large object to export and the @@ -883,13 +879,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pg_loimport</methodname> <methodparam><type>int</type><parameter>file</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>connection_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <parameter>filename</parameter> argument specifies the pathname of the file to be imported as a large object. Returns @@ -908,14 +904,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pg_loopen</methodname> <methodparam><type>int</type><parameter>conn</parameter></methodparam> <methodparam><type>int</type><parameter>objoid</parameter></methodparam> <methodparam><type>string</type><parameter>mode</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_loopen</function> open an Inversion Large Object and returns file descriptor of the large object. The file descriptor @@ -934,13 +930,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>pg_loread</methodname> <methodparam><type>int</type><parameter>fd</parameter></methodparam> <methodparam><type>int</type><parameter>len</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_loread</function> reads at most <parameter>len</parameter> bytes from a large object and @@ -961,12 +957,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>pg_loreadall</methodname> <methodparam><type>int</type><parameter>fd</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_loreadall</function> reads a large object and passes it straight through to the browser after sending all pending @@ -982,13 +978,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>pg_lounlink</methodname> <methodparam><type>int</type><parameter>conn</parameter></methodparam> <methodparam><type>int</type><parameter>lobjid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_lounlink</function> deletes a large object with the <parameter>lobjid</parameter> identifier for that large object. @@ -1003,13 +999,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pg_lowrite</methodname> <methodparam><type>int</type><parameter>fd</parameter></methodparam> <methodparam><type>string</type><parameter>buf</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_lowrite</function> writes at most to a large object from a variable <parameter>buf</parameter> and returns the number @@ -1027,12 +1023,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pg_numfields</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_numfields</function> will return the number of fields (columns) in a PostgreSQL result. The argument is a valid @@ -1053,12 +1049,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pg_numrows</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_numrows</function> will return the number of rows in a PostgreSQL result. The argument is a valid result identifier @@ -1079,12 +1075,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>pg_options</methodname> <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_options</function> will return a string containing the options specified on the given PostgreSQL connection @@ -1100,12 +1096,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pg_pconnect</methodname> <methodparam><type>string</type><parameter>conn_string</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a connection index on success, or &false; if the connection could not be made. Opens a connection to a PostgreSQL database. @@ -1142,12 +1138,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pg_port</methodname> <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_port</function> will return the port number that the given PostgreSQL connection identifier is connected to. @@ -1162,13 +1158,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>pg_put_line</methodname> <methodparam choice="opt"><type>resource</type><parameter>connection_id</parameter></methodparam> <methodparam><type>string</type><parameter>data</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_put_line</function> sends a NULL-terminated string to the PostgreSQL backend server. This is useful for example for @@ -1211,14 +1207,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>pg_result</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> <methodparam><type>int</type><parameter>row_number</parameter></methodparam> <methodparam><type>mixed</type><parameter>fieldname</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_result</function> will return values from a result identifier produced by <function>pg_Exec</function>. The @@ -1232,11 +1228,7 @@ PostgreSQL has many built in types and only the basic ones are directly supported here. All forms of <type>integer</type>, <type>boolean</type> and void - - -<!-- FIXME: is that still true? PHP supports boolean&null now... --> - - + <!-- FIXME: is that still true? PHP supports boolean&null now... --> types are returned as <type>integer</type> values. All forms of float, and real types are returned as <type>float</type> values. All other types, @@ -1256,13 +1248,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pg_set_client_encoding</methodname> <methodparam choice="opt"><type>int</type><parameter>connection</parameter></methodparam> <methodparam><type>string</type><parameter>encoding</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The function set the client encoding and return 0 if success or -1 if error. @@ -1299,12 +1291,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>pg_client_encoding</methodname> <methodparam choice="opt"><type>int</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The functions returns the client encoding as the string. The returned string should be either : @@ -1335,14 +1327,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>pg_trace</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>mode</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Enables tracing of the PostgreSQL frontend/backend communication to a debugging file. To fully understand the results one needs to @@ -1379,12 +1371,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>pg_tty</methodname> <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>pg_tty</function> will return the tty name that server side debugging output is sent to on the given PostgreSQL @@ -1400,12 +1392,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>pg_untrace</methodname> <methodparam choice="opt"><type>int</type><parameter>connection</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Stop tracing started by <function>pg_trace</function>. <parameter>connection</parameter> specifies the connection that was Index: phpdoc/en/functions/posix.xml diff -u phpdoc/en/functions/posix.xml:1.16.2.1 phpdoc/en/functions/posix.xml:1.16.2.2 --- phpdoc/en/functions/posix.xml:1.16.2.1 Sun Nov 11 20:08:54 2001 +++ phpdoc/en/functions/posix.xml Mon Nov 12 09:59:23 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.16.2.1 $ --> +<!-- $Revision: 1.16.2.2 $ --> <reference id="ref.posix"> <title>POSIX functions</title> <titleabbrev>POSIX</titleabbrev> @@ -24,13 +24,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Send the signal <parameter>sig</parameter> to the process with the process identifier <parameter>pid</parameter>. Returns &false;, @@ -52,12 +52,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>posix_getpid</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Return the process identifier of the current process.</para> </refsect1> @@ -70,12 +70,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>posix_getppid</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Return the process identifier of the parent process of the current process. @@ -92,12 +92,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>posix_getuid</methodname> <void/> - - </methodsynopsis> + </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 +115,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>posix_geteuid</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Return the numeric effective user ID of the current process. See also <function>posix_getpwuid</function> for information on how @@ -138,12 +138,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>posix_getgid</methodname> <void/> - - </methodsynopsis> + </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 +161,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>posix_getegid</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Return the numeric effective group ID of the current process. See also <function>posix_getgrgid</function> for information on how @@ -184,12 +184,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>posix_setuid</methodname> <methodparam><type>int</type><parameter>uid</parameter></methodparam> - - </methodsynopsis> + </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 +211,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>posix_setgid</methodname> <methodparam><type>int</type><parameter>gid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Set the real group ID of the current process. This is a privileged function and you need appropriate privileges (usually @@ -240,12 +240,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>posix_getgroups</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Returns an array of integers containing the numeric group ids of the group set of the current process. See also @@ -262,12 +262,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>posix_getlogin</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the login name of the user owning the current process. See <function>posix_getpwnam</function> for information how to @@ -285,12 +285,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>posix_getpgrp</methodname> <void/> - - </methodsynopsis> + </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 @@ -306,12 +306,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>posix_setsid</methodname> <void/> - - </methodsynopsis> + </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 @@ -327,13 +327,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Let the process <parameter>pid</parameter> join the process group <parameter>pgid</parameter>. See POSIX.1 and the setsid(2) manual @@ -350,12 +350,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>posix_getpgid</methodname> <methodparam><type>int</type><parameter>pid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the process group identifier of the process <parameter>pid</parameter>. @@ -375,12 +375,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>posix_getsid</methodname> <methodparam><type>int</type><parameter>pid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Return the sid of the process <parameter>pid</parameter>. If <parameter>pid</parameter> is 0, the sid of the current process @@ -401,12 +401,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>posix_uname</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a hash of strings with information about the system. The indices of the hash are @@ -452,12 +452,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>posix_times</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a hash of strings with information about the current process CPU usage. The indices of the hash are @@ -490,12 +490,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>posix_ctermid</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Needs to be written. </para> @@ -509,12 +509,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>posix_ttyname</methodname> <methodparam><type>int</type><parameter>fd</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Needs to be written. </para> @@ -530,12 +530,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>posix_isatty</methodname> <methodparam><type>int</type><parameter>fd</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Needs to be written. </para> @@ -549,12 +549,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>posix_getcwd</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Needs to be written ASAP. </para> @@ -570,13 +570,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Needs to be written ASAP. </para> @@ -591,12 +591,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>posix_getgrnam</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Needs to be written. </para> @@ -610,12 +610,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>posix_getgrgid</methodname> <methodparam><type>int</type><parameter>gid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Needs to be written. </para> @@ -629,12 +629,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>posix_getpwnam</methodname> <methodparam><type>string</type><parameter>username</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns an associative array containing information about a user referenced by an alphanumeric username, passed in the @@ -724,12 +724,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>posix_getpwuid</methodname> <methodparam><type>int</type><parameter>uid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns an associative array containing information about a user referenced by a numeric user ID, passed in the @@ -819,12 +819,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>posix_getrlimit</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Needs to be written ASAP. </para> Index: phpdoc/en/functions/printer.xml diff -u phpdoc/en/functions/printer.xml:1.11.2.1 phpdoc/en/functions/printer.xml:1.11.2.2 --- phpdoc/en/functions/printer.xml:1.11.2.1 Sun Nov 11 20:08:54 2001 +++ phpdoc/en/functions/printer.xml Mon Nov 12 09:59:23 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.11.2.1 $ --> +<!-- $Revision: 1.11.2.2 $ --> <reference id="ref.printer"> <title>Printer functions</title> <titleabbrev>Printer</titleabbrev> @@ -18,12 +18,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>printer_open</methodname> <methodparam choice="opt"><type>string</type><parameter>devicename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function tries to open a connection to the printer <parameter>devicename</parameter>, and returns a handle on success @@ -56,12 +56,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>printer_abort</methodname> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function deletes the printers spool file. </para> @@ -86,12 +86,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>printer_close</methodname> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function closes the printer connection. <function>printer_close</function> also closes the active device @@ -118,13 +118,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Writes <parameter>content</parameter> directly to the printer, and returns &true; on success or &false; if it failed. @@ -152,14 +152,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The function enumerates available printers and their capabilities. <parameter>level</parameter> sets the level of information request. @@ -234,14 +234,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The function sets the following options for the current connection: <parameter>handle</parameter> must be a valid handle to a printer. @@ -465,13 +465,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The function retrieves the configuration setting of <parameter>option</parameter>. <parameter>handle</parameter> must be a valid handle to a printer. @@ -511,12 +511,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>printer_create_dc</methodname> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The function creates a new device context. A device context is used to customize the graphic objects of the document. @@ -559,12 +559,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>printer_delete_dc</methodname> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The function deletes the device context and returns &true; on success, or &false; if an error occurred. For an example see @@ -582,13 +582,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -618,12 +618,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>printer_end_doc</methodname> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Closes a new document in the printer spooler. The document is now ready for printing. For an example see @@ -640,12 +640,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>printer_start_page</methodname> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The function creates a new page in the active document. For an example see <function>printer_start_doc</function>. @@ -662,12 +662,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>printer_end_page</methodname> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The function closes the active page in the active document. For an example see <function>printer_start_doc</function>. @@ -684,14 +684,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -749,12 +749,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>printer_delete_pen</methodname> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The function deletes the selected pen. For an example see <function>printer_select_pen</function>. It returns &true; on success, @@ -772,13 +772,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -820,13 +820,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -895,12 +895,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>printer_delete_brush</methodname> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The function deletes the selected brush. For an example see <function>printer_select_brush</function>. It returns &true; on @@ -917,13 +917,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -975,8 +975,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -986,8 +986,8 @@ <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> + </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 @@ -1073,12 +1073,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>printer_delete_font</methodname> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The function deletes the selected font. For an example see <function>printer_select_font</function>. It returns &true; on success, @@ -1095,13 +1095,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The function selects a font to draw text. <parameter>printer_handle</parameter> must be a valid handle to a @@ -1137,13 +1137,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The function calculates the logical font height of <parameter>height</parameter>. <parameter>handle</parameter> must @@ -1169,8 +1169,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -1179,8 +1179,8 @@ <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> + </methodsynopsis> + <para> The function simply draws a rectangle with rounded corners. </para> @@ -1239,16 +1239,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The function simply draws a rectangle. </para> @@ -1302,16 +1302,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The function simply draws an ellipse. <parameter>handle</parameter> must be a valid handle to a printer. @@ -1363,15 +1363,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The function simply draws <parameter>text</parameter> at position <parameter>x</parameter>, <parameter>y</parameter> using the selected @@ -1405,16 +1405,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The function simply draws a line from position <parameter>from_x</parameter>, <parameter>from_y</parameter> to @@ -1452,8 +1452,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -1464,8 +1464,8 @@ <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> + </methodsynopsis> + <para> The function simply draws an chord. <parameter>handle</parameter> must be a valid handle to a printer. @@ -1535,8 +1535,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -1547,8 +1547,8 @@ <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> + </methodsynopsis> + <para> The function simply draws an pie. <parameter>handle</parameter> must be a valid handle to a printer. @@ -1618,15 +1618,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The function simply draws an bmp the bitmap <parameter>filename</parameter> at position <parameter>x</parameter>, Index: phpdoc/en/functions/pspell.xml diff -u phpdoc/en/functions/pspell.xml:1.20.2.2 phpdoc/en/functions/pspell.xml:1.20.2.3 --- phpdoc/en/functions/pspell.xml:1.20.2.2 Sun Nov 11 21:04:38 2001 +++ phpdoc/en/functions/pspell.xml Mon Nov 12 09:59:23 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.20.2.2 $ --> +<!-- $Revision: 1.20.2.3 $ --> <!-- pspell currently (2001-08-14) doesn't use resources --> <reference id="ref.pspell"> @@ -26,13 +26,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> <function>pspell_add_to_personal</function> adds a word to the personal wordlist. If you used <function>pspell_new_config</function> with @@ -65,13 +65,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> <function>pspell_add_to_session</function> adds a word to the wordlist associated with the current session. It is very similar to @@ -87,13 +87,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> <function>pspell_check</function> checks the spelling of a word and returns &true; if the spelling is correct, &false; if not. @@ -122,12 +122,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pspell_clear_session</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>pspell_clear_session</function> clears the current session. The current wordlist becomes blank, and, for example, if you try to save @@ -157,8 +157,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pspell_config_create</methodname> <methodparam><type>string</type><parameter>language</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter> @@ -170,8 +170,8 @@ <methodparam choice="opt"><type>string</type><parameter> encoding </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>pspell_config_create</function> has a very similar syntax to <function>pspell_new</function>. In fact, using @@ -252,13 +252,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> <function>pspell_config_ignore</function> should be used on a config before calling <function>pspell_new_config</function>. This function @@ -286,13 +286,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> <function>pspell_config_mode</function> should be used on a config before calling <function>pspell_new_config</function>. This function @@ -343,13 +343,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> <function>pspell_config_personal</function> should be used on a config before calling <function>pspell_new_config</function>. The personal @@ -382,13 +382,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> <function>pspell_config_repl</function> should be used on a config before calling <function>pspell_new_config</function>. The replacement @@ -423,13 +423,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> <function>pspell_config_runtogether</function> should be used on a config before calling <function>pspell_new_config</function>. This function @@ -462,13 +462,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> <function>pspell_config_save_repl</function> should be used on a config before calling <function>pspell_new_config</function>. It determines @@ -490,14 +490,10 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pspell_new</methodname> - - -<!-- not yet resource... --> - - + <!-- not yet resource... --> <methodparam><type>string</type><parameter>language</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter> spelling @@ -511,8 +507,8 @@ <methodparam choice="opt"><type>int</type><parameter> mode </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>pspell_new</function> opens up a new dictionary and returns the dictionary link identifier for use in other pspell @@ -602,12 +598,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pspell_new_config</methodname> <methodparam><type>int</type><parameter>config</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>pspell_new_config</function> opens up a new dictionary with settings specified in a config, created with with @@ -642,8 +638,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -659,8 +655,8 @@ <methodparam choice="opt"><type>int</type><parameter> mode </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>pspell_new_personal</function> opens up a new dictionary with a personal wordlist and returns the dictionary link identifier for use @@ -763,12 +759,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>pspell_save_wordlist</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>pspell_save_wordlist</function> saves the personal wordlist from the current session. The dictionary has to be open with @@ -801,14 +797,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> <function>pspell_store_replacement</function> stores a replacement pair for a word, so that replacement can be returned by @@ -846,13 +842,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> <function>pspell_suggest</function> returns an array of possible spellings for the given word. Index: phpdoc/en/functions/readline.xml diff -u phpdoc/en/functions/readline.xml:1.13.2.1 phpdoc/en/functions/readline.xml:1.13.2.2 --- phpdoc/en/functions/readline.xml:1.13.2.1 Sun Nov 11 20:08:54 2001 +++ phpdoc/en/functions/readline.xml Mon Nov 12 09:59:23 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.13.2.1 $ --> +<!-- $Revision: 1.13.2.2 $ --> <reference id="ref.readline"> <title>GNU Readline</title> <titleabbrev>Readline</titleabbrev> @@ -29,12 +29,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>readline</methodname> <methodparam choice="opt"><type>string</type><parameter>prompt</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns a single string from the user. You may specify a string with which to prompt the user. The line @@ -68,12 +68,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>readline_add_history</methodname> <methodparam><type>string</type><parameter>line</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function adds a line to the command line history. </para> @@ -87,12 +87,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>readline_clear_history</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> This function clears the entire command line history. </para> @@ -106,12 +106,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>readline_completion_function</methodname> <methodparam><type>string</type><parameter>line</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function registers a completion function. You must supply the name of an existing function which accepts a partial command @@ -129,13 +129,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> If called with no parameters, this function returns an array of values for all the setting readline uses. The elements will @@ -158,12 +158,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>readline_list_history</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns an array of the entire command line history. The elements are indexed by integers starting at zero. @@ -178,12 +178,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>readline_read_history</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function reads a command history from a file. </para> @@ -198,12 +198,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>readline_write_history</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function writes the command history to a file. </para> Index: phpdoc/en/functions/recode.xml diff -u phpdoc/en/functions/recode.xml:1.15.2.1 phpdoc/en/functions/recode.xml:1.15.2.2 --- phpdoc/en/functions/recode.xml:1.15.2.1 Sun Nov 11 20:08:54 2001 +++ phpdoc/en/functions/recode.xml Mon Nov 12 09:59:23 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.15.2.1 $ --> +<!-- $Revision: 1.15.2.2 $ --> <reference id="ref.recode"> <title>GNU Recode functions</title> <titleabbrev>Recode</titleabbrev> @@ -29,13 +29,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Recode the string <parameter>string</parameter> according to the recode request <parameter>request</parameter>. Returns the @@ -62,13 +62,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>recode</methodname> <methodparam><type>string</type><parameter>request</parameter></methodparam> <methodparam><type>string</type><parameter>string</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <note> <simpara> This is an alias for <function>recode_string</function>. It has @@ -87,14 +87,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Recode the file referenced by file handle <parameter>input</parameter> into the file referenced by file Index: phpdoc/en/functions/regex.xml diff -u phpdoc/en/functions/regex.xml:1.29.2.2 phpdoc/en/functions/regex.xml:1.29.2.3 --- phpdoc/en/functions/regex.xml:1.29.2.2 Sun Nov 11 20:08:54 2001 +++ phpdoc/en/functions/regex.xml Mon Nov 12 09:59:23 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.29.2.2 $ --> +<!-- $Revision: 1.29.2.3 $ --> <reference id="ref.regex"> <title>Regular Expression Functions (POSIX Extended)</title> <titleabbrev>Regexps</titleabbrev> @@ -95,14 +95,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <note> <para> <function>preg_match</function>, which uses a Perl-compatible @@ -170,14 +170,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <note> <para> <function>preg_replace</function>, which uses a Perl-compatible @@ -271,14 +271,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function is identical to <function>ereg</function> except that this ignores case distinction when matching alphabetic @@ -307,14 +307,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function is identical to <function>ereg_replace</function> except that this ignores case distinction when matching @@ -334,14 +334,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <note> <para> <function>preg_split</function>, which uses a Perl-compatible @@ -441,14 +441,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function is identical to <function>split</function> except that this ignores case distinction when matching alphabetic @@ -473,12 +473,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>sql_regcase</methodname> <methodparam><type>string</type><parameter>string</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a valid regular expression which will match <parameter>string</parameter>, ignoring case. This expression is Index: phpdoc/en/functions/satellite.xml diff -u phpdoc/en/functions/satellite.xml:1.17.2.1 phpdoc/en/functions/satellite.xml:1.17.2.2 --- phpdoc/en/functions/satellite.xml:1.17.2.1 Sun Nov 11 20:08:54 2001 +++ phpdoc/en/functions/satellite.xml Mon Nov 12 09:59:23 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.17.2.1 $ --> +<!-- $Revision: 1.17.2.2 $ --> <!-- Author: David Eriksson <david@2good.com> --> <reference id="ref.satellite"> @@ -22,12 +22,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>new</type><methodname>OrbitObject</methodname> <methodparam><type>string</type><parameter>ior</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> This class provides access to a CORBA object. The @@ -76,12 +76,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>new</type><methodname>OrbitEnum</methodname> <methodparam><type>string</type><parameter>id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> This class represents the enumeration identified with the @@ -124,12 +124,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>new</type><methodname>OrbitStruct</methodname> <methodparam><type>string</type><parameter>id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> This class represents the structure identified with the @@ -187,12 +187,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>satellite_caught_exception</methodname> - <methodparam/> - - </methodsynopsis> + <void/> + </methodsynopsis> + &warn.experimental.func; <para> This function returns &true; if an exception has been caught. @@ -241,12 +241,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>satellite_exception_id</methodname> - <methodparam/> - - </methodsynopsis> + <void/> + </methodsynopsis> + &warn.experimental.func; <para> Return a repository id string. (E.g. "IDL:MyException:1.0".) For @@ -265,12 +265,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>OrbitStruct</type><methodname>satellite_exception_value</methodname> - <methodparam/> - - </methodsynopsis> + <void/> + </methodsynopsis> + &warn.experimental.func; <para> Return an exception struct. For example usage see Index: phpdoc/en/functions/sem.xml diff -u phpdoc/en/functions/sem.xml:1.16.2.1 phpdoc/en/functions/sem.xml:1.16.2.2 --- phpdoc/en/functions/sem.xml:1.16.2.1 Sun Nov 11 20:08:54 2001 +++ phpdoc/en/functions/sem.xml Mon Nov 12 09:59:23 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.16.2.1 $ --> +<!-- $Revision: 1.16.2.2 $ --> <reference id="ref.sem"> <title>Semaphore and Shared Memory Functions</title> <titleabbrev>Semaphore</titleabbrev> @@ -61,14 +61,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: A positive semaphore identifier on success, or &false; on error. @@ -106,12 +106,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>sem_acquire</methodname> <methodparam><type>int</type><parameter>sem_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: &true; on success, &false; on error. </para> @@ -141,12 +141,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>sem_release</methodname> <methodparam><type>int</type><parameter>sem_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: &true; on success, &false; on error. </para> @@ -178,12 +178,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>sem_remove</methodname> <methodparam><type>int</type><parameter>sem_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: &true; on success, &false; on error. @@ -218,14 +218,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -255,12 +255,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>shm_detach</methodname> <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>shm_detach</function> disconnects from the shared memory given by the <parameter>shm_identifier</parameter> created @@ -277,12 +277,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>shm_remove</methodname> <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Removes shared memory from Unix systems. All data will be destroyed. @@ -303,14 +303,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Inserts or updates a <parameter>variable</parameter> with a given <parameter>variable_key</parameter>. <link linkend="language.types">All variable-types</link> are supported. @@ -330,13 +330,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>shm_get_var</function> returns the variable with a given <parameter>variable_key</parameter>. The variable is still present @@ -358,13 +358,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Removes a variable with a given <parameter>variable_key</parameter> and frees the occupied memory. Index: phpdoc/en/functions/sesam.xml diff -u phpdoc/en/functions/sesam.xml:1.14.2.1 phpdoc/en/functions/sesam.xml:1.14.2.2 --- phpdoc/en/functions/sesam.xml:1.14.2.1 Sun Nov 11 20:08:55 2001 +++ phpdoc/en/functions/sesam.xml Mon Nov 12 09:59:23 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.14.2.1 $ --> +<!-- $Revision: 1.14.2.2 $ --> <reference id="ref.sesam"> <title>SESAM database functions</title> <titleabbrev>SESAM</titleabbrev> @@ -498,14 +498,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns &true; if a connection to the SESAM database was made, or &false; on error. @@ -559,12 +559,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>sesam_disconnect</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: always &true;. </para> @@ -609,13 +609,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: &true; if the values are valid, and the <function>settransaction</function> operation was successful, @@ -729,12 +729,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>sesam_commit</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: &true; on success, &false; on errors @@ -780,12 +780,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>sesam_rollback</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: &true; on success, &false; on errors @@ -828,12 +828,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>sesam_execimm</methodname> <methodparam><type>string</type><parameter>query</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: A SESAM "result identifier" on success, or &false; on error. @@ -885,13 +885,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: A SESAM "result identifier" on success, or &false; on error. @@ -998,12 +998,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>sesam_num_fields</methodname> <methodparam><type>string</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> After calling <function>sesam_query</function> with a "select type" query, this function gives you the number of columns in the @@ -1034,13 +1034,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the name of a field (i.e., the column name) in the result set, or &false; on error. @@ -1071,12 +1071,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>sesam_diagnostic</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Returns an associative array of status and return codes for the last SQL query/statement/command. Elements of the array are: @@ -1219,13 +1219,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns a mixed array with the query result entries, optionally limited to a maximum of <parameter>max_rows</parameter> rows. @@ -1314,12 +1314,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>sesam_affected_rows</methodname> <methodparam><type>string</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <parameter>result_id</parameter> is a valid result id returned by <function>sesam_query</function>. @@ -1361,12 +1361,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>sesam_errormsg</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the SESAM error message associated with the most recent SESAM error. @@ -1393,12 +1393,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>sesam_field_array</methodname> <methodparam><type>string</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <parameter>result_id</parameter> is a valid result id returned by <function>sesam_query</function>. @@ -1588,14 +1588,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array that corresponds to the fetched row, or &false; if there are no more rows. @@ -1761,14 +1761,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array that corresponds to the fetched row, or &false; if there are no more rows. @@ -1874,14 +1874,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <parameter>result_id</parameter> is a valid result id (select type queries only, and only if a "scrollable" cursor was @@ -1972,12 +1972,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>sesam_free_result</methodname> <methodparam><type>string</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Releases resources for the query associated with <parameter>result_id</parameter>. Returns Index: phpdoc/en/functions/session.xml diff -u phpdoc/en/functions/session.xml:1.55.2.2 phpdoc/en/functions/session.xml:1.55.2.3 --- phpdoc/en/functions/session.xml:1.55.2.2 Sun Nov 11 21:04:38 2001 +++ phpdoc/en/functions/session.xml Mon Nov 12 09:59:23 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.55.2.2 $ --> +<!-- $Revision: 1.55.2.3 $ --> <reference id="ref.session"> <title>Session handling functions</title> <titleabbrev>Sessions</titleabbrev> @@ -332,12 +332,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>session_start</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>session_start</function> creates a session (or resumes the current one based on the session id being passed via a GET @@ -360,12 +360,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>session_destroy</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>session_destroy</function> destroys all of the data associated with the current session. @@ -385,12 +385,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>session_name</methodname> <methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>session_name</function> returns the name of the current session. If <parameter>name</parameter> is specified, the name of @@ -434,12 +434,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>session_module_name</methodname> <methodparam choice="opt"><type>string</type><parameter>module</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>session_module_name</function> returns the name of the current session module. If <parameter>module</parameter> is @@ -460,12 +460,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>session_save_path</methodname> <methodparam choice="opt"><type>string</type><parameter>path</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>session_save_path</function> returns the path of the current directory used to save session data. If <parameter>path</parameter> @@ -494,12 +494,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>session_id</methodname> <methodparam choice="opt"><type>string</type><parameter>id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>session_id</function> returns the session id for the current session. If <parameter>id</parameter> is specified, it @@ -522,13 +522,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>session_register</function> variable number of arguments, any of which can be either a string holding the @@ -571,12 +571,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>session_unregister</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>session_unregister</function> unregisters (forgets) the global variable named <parameter>name</parameter> from the @@ -603,12 +603,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>session_unset</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>session_unset</function> function free's all session variables currently registered. @@ -625,12 +625,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>session_is_registered</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>session_is_registered</function> returns &true; if there is a variable with the name <parameter>name</parameter> @@ -653,12 +653,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>session_get_cookie_params</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>session_get_cookie_params</function> function returns an array with the current session cookie information, the array contains @@ -693,14 +693,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Set cookie parameters defined in the php.ini file. The effect of this function only lasts for the duration of the script. @@ -715,12 +715,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>session_decode</methodname> <methodparam><type>string</type><parameter>data</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>session_decode</function> decodes the session data in <parameter>data</parameter>, setting variables stored in the @@ -743,12 +743,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>session_encode</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> <function>session_encode</function> returns a string with the contents of the current session encoded within. @@ -770,12 +770,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>session_set_save_handler</function> sets the user-level session storage functions which are used for storing and @@ -887,12 +887,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>session_cache_limiter</methodname> <methodparam choice="opt"><type>string</type><parameter>cache_limiter</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>session_cache_limiter</function> returns the name of the current cache limiter. If <parameter>cache_limiter</parameter> is @@ -955,12 +955,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>session_write_close</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> End the current session and store session data. </para> @@ -974,20 +974,14 @@ load all the frames by ending the session as soon as all changes to session variables are done. </para> - - <!-- commented out until final decision on implementation <para> See also: <function>session_readonly</function>. </para> --> - - </refsect1> </refentry> - - <!-- commented out until final decision on implementation <refentry id="function.session-readonly"> <refnamediv> @@ -1009,8 +1003,6 @@ </refsect1> </refentry> --> - - </reference> <!-- Keep this comment at the end of the file Local variables: Index: phpdoc/en/functions/shmop.xml diff -u phpdoc/en/functions/shmop.xml:1.9.2.2 phpdoc/en/functions/shmop.xml:1.9.2.3 --- phpdoc/en/functions/shmop.xml:1.9.2.2 Sun Nov 11 21:04:38 2001 +++ phpdoc/en/functions/shmop.xml Mon Nov 12 09:59:23 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.9.2.2 $ --> +<!-- $Revision: 1.9.2.3 $ --> <reference id="ref.shmop"> <title>Shared Memory Functions</title> <titleabbrev>shmop</titleabbrev> @@ -16,12 +16,8 @@ <simpara> In PHP 4.0.3, there functions were prefixed by <literal>shm</literal> rather than <literal>shmop</literal>. - - -<!-- TODO: do the old shm_* funcs still work, i.e. are they still + <!-- TODO: do the old shm_* funcs still work, i.e. are they still aliased? --> - - </simpara> </note> <para> @@ -72,15 +68,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>shmop_open</function> can create or open a shared memory block. </para> @@ -137,14 +133,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>shmop_read</function> will read a string from shared memory block. </para> @@ -177,14 +173,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>shmop_write</function> will write a string into shared memory block. </para> @@ -219,12 +215,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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. @@ -259,12 +255,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>shmop_delete</methodname> <methodparam><type>int</type><parameter>shmid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>shmop_delete</function> is used to delete a shared memory block. </para> @@ -297,12 +293,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>shmop_close</methodname> <methodparam><type>int</type><parameter>shmid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>shmop_close</function> is used to close a shared memory block. </para> Index: phpdoc/en/functions/snmp.xml diff -u phpdoc/en/functions/snmp.xml:1.15.2.1 phpdoc/en/functions/snmp.xml:1.15.2.2 --- phpdoc/en/functions/snmp.xml:1.15.2.1 Sun Nov 11 20:08:55 2001 +++ phpdoc/en/functions/snmp.xml Mon Nov 12 09:59:23 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.15.2.1 $ --> +<!-- $Revision: 1.15.2.2 $ --> <reference id="ref.snmp"> <title>SNMP functions</title> <titleabbrev>SNMP</titleabbrev> @@ -36,16 +36,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns SNMP object value on success and &false; on error.</para> @@ -75,8 +75,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>snmpset</methodname> <methodparam><type>string</type><parameter>hostname</parameter></methodparam> <methodparam><type>string</type><parameter>community</parameter></methodparam> @@ -85,8 +85,8 @@ <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> + </methodsynopsis> + <para> Sets the specified SNMP object value, returning &true; on success @@ -109,16 +109,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array of SNMP object values starting from the @@ -166,16 +166,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an associative array with object ids and their respective @@ -229,12 +229,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>snmp_get_quick_print</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the current value stored in the UCD Library for quick_print. @@ -271,12 +271,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>snmp_set_quick_print</methodname> <methodparam><type>bool</type><parameter>quick_print</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Sets the value of quick_print within the UCD SNMP library. When this Index: phpdoc/en/functions/sockets.xml diff -u phpdoc/en/functions/sockets.xml:1.23.2.1 phpdoc/en/functions/sockets.xml:1.23.2.2 --- phpdoc/en/functions/sockets.xml:1.23.2.1 Sun Nov 11 20:08:55 2001 +++ phpdoc/en/functions/sockets.xml Mon Nov 12 09:59:23 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.23.2.1 $ --> +<!-- $Revision: 1.23.2.2 $ --> <reference id="ref.sockets"> <title>Socket functions</title> <titleabbrev>Sockets</titleabbrev> @@ -164,12 +164,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>accept_connect</methodname> <methodparam><type>resource</type><parameter>socket</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> After the socket <parameter>socket</parameter> has been created @@ -219,14 +219,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>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> + </methodsynopsis> + &warn.experimental.func; <para> <function>bind</function> binds the name given in @@ -272,12 +272,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>close</methodname> <methodparam><type>resource</type><parameter>socket</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>close</function> closes the file (or socket) descriptor @@ -311,14 +311,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>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> + </methodsynopsis> + &warn.experimental.func; <para> Initiates a connection using the socket descriptor @@ -362,13 +362,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>listen</methodname> <methodparam><type>resource</type><parameter>socket</parameter></methodparam> <methodparam><type>int</type><parameter>backlog</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> After the socket <parameter>socket</parameter> has been created @@ -407,15 +407,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>read</methodname> <methodparam><type>resource</type><parameter>socket_des</parameter></methodparam> <methodparam><type>string</type><parameter>buffer</parameter></methodparam> <methodparam><type>int</type><parameter>length</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> The function <function>read</function> reads from socket @@ -461,14 +461,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>socket</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> + </methodsynopsis> + &warn.experimental.func; <para> Creates a communication endpoint (a socket), and returns a @@ -520,12 +520,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>strerror</methodname> <methodparam><type>int</type><parameter>errno</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <function>strerror</function> takes as its @@ -579,14 +579,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>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> + </methodsynopsis> + &warn.experimental.func; <para> The function <function>write</function> writes to the socket Index: phpdoc/en/functions/strings.xml diff -u phpdoc/en/functions/strings.xml:1.122.2.2 phpdoc/en/functions/strings.xml:1.122.2.3 --- phpdoc/en/functions/strings.xml:1.122.2.2 Sun Nov 11 21:04:38 2001 +++ phpdoc/en/functions/strings.xml Mon Nov 12 09:59:23 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.122.2.2 $ --> +<!-- $Revision: 1.122.2.3 $ --> <reference id="ref.strings"> <title>String functions</title> <titleabbrev>Strings</titleabbrev> @@ -26,13 +26,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>addcslashes</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> <methodparam><type>string</type><parameter>charlist</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a string with backslashes before characters that are listed in <parameter>charlist</parameter> parameter. It escapes @@ -104,12 +104,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>addslashes</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a string with backslashes before characters that need to be quoted in database queries etc. These characters are @@ -139,12 +139,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>bin2hex</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns an ASCII string containing the hexadecimal representation of <parameter>str</parameter>. The conversion is done byte-wise @@ -180,12 +180,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>chr</methodname> <methodparam><type>int</type><parameter>ascii</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a one-character string containing the character specified by <parameter>ascii</parameter>. @@ -218,14 +218,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>chunk_split</methodname> <methodparam><type>string</type><parameter>string</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>chunklen</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>end</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Can be used to split a string into smaller chunks which is useful for e.g. converting <link linkend="function.base64-encode">base64_encode</link> output to @@ -261,14 +261,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function returns the given string converted from one Cyrillic character set to another. The <parameter>from</parameter> @@ -320,15 +320,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>count_chars</methodname> <methodparam><type>string</type><parameter>string</parameter></methodparam> - <methodparam choice="opt"><type/><parameter> + <methodparam choice="opt"><type></type><parameter> mode </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Counts the number of occurrences of every byte-value (0..255) in <parameter>string</parameter> and returns it in various ways. @@ -381,12 +381,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>crc32</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Generates the cyclic redundancy checksum polynomial of 32-bit lengths of the <parameter>str</parameter>. This is usually used @@ -405,13 +405,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>crypt</function> will return an encrypted string using the standard Unix <abbrev>DES</abbrev> encryption method. Arguments @@ -493,13 +493,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <methodname>echo</methodname> <methodparam><type>string</type><parameter>arg1</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>argn...</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Outputs all parameters. </simpara> @@ -570,14 +570,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an array of strings, each of which is a substring of <parameter>string</parameter> formed by splitting it on @@ -638,13 +638,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>get_html_translation_table</function> will return the translation table that is used internally for @@ -706,13 +706,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Opens <parameter>filename</parameter> and parses it line by line for &lt;meta> tags of the form @@ -751,13 +751,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The optional parameter <parameter>max_chars_per_line</parameter> indicates maximum number of characters per line will be @@ -778,13 +778,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function is similar to <function>hebrev</function> with the difference that it converts newlines (\n) to "&lt;br&gt;\n". The @@ -807,14 +807,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function is identical to <function>htmlspecialchars</function> in all ways, except that @@ -853,14 +853,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Certain characters have special significance in HTML, and should be represented by HTML entities if they are to preserve their @@ -943,13 +943,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>implode</methodname> <methodparam><type>string</type><parameter>glue</parameter></methodparam> <methodparam><type>array</type><parameter>pieces</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a string containing a string representation of all the array elements in the same order, with the glue string between @@ -983,13 +983,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>join</methodname> <methodparam><type>string</type><parameter>glue</parameter></methodparam> <methodparam><type>array</type><parameter>pieces</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>join</function> is an alias to <function>implode</function>, and is identical in every way. @@ -1010,27 +1010,27 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function returns the Levenshtein-Distance between the two argument strings or -1, if one of the argument strings @@ -1135,12 +1135,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>localeconv</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Returns an associative array containing localized numeric and monetary formatting information. @@ -1346,11 +1346,7 @@ </refsect1> </refentry> - - -<!-- this section is nearly-identical to trim, ltrim and rtrim --> - - + <!-- this section is nearly-identical to trim, ltrim and rtrim --> <refentry id="function.ltrim"> <refnamediv> <refname>ltrim</refname> @@ -1360,13 +1356,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <note> <simpara> The second parameter was added in PHP 4.1.0 @@ -1377,11 +1373,7 @@ beginning of <parameter>str</parameter>. Without the second parameter, <function>ltrim</function> will strip these characters: - - -<!-- sorted by importance. Printed 3 times: trim, ltrim, rtrim --> - - + <!-- sorted by importance. Printed 3 times: trim, ltrim, rtrim --> <itemizedlist> <listitem> <simpara> @@ -1414,11 +1406,7 @@ </simpara> </listitem> <listitem> - <simpara> - -<!-- not \v, since not supported by PHP --> - - + <simpara> <!-- not \v, since not supported by PHP --> "\x0B" (<acronym>ASCII</acronym> <literal>11</literal> (<literal>0x0B</literal>)), a vertical tab. </simpara> @@ -1465,12 +1453,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>md5</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Calculates the MD5 hash of <parameter>str</parameter> using the <ulink url="&url.rfc;rfc1321.html">RSA Data Security, Inc. @@ -1489,12 +1477,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>metaphone</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Calculates the metaphone key of <parameter>str</parameter>. </para> @@ -1528,12 +1516,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>nl2br</methodname> <methodparam><type>string</type><parameter>string</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns <parameter>string</parameter> with '&lt;br /&gt;' inserted before all newlines. @@ -1561,12 +1549,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>ord</methodname> <methodparam><type>string</type><parameter>string</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the ASCII value of the first character of <parameter>string</parameter>. This function complements @@ -1596,14 +1584,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -1632,12 +1620,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <methodname>print</methodname> <methodparam><type>string</type><parameter>arg</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Outputs <parameter>arg</parameter>. </simpara> @@ -1655,13 +1643,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>printf</methodname> <methodparam><type>string</type><parameter>format</parameter></methodparam> <methodparam choice="opt"><type>mixed</type><parameter>args</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Produces output according to <parameter>format</parameter>, which is described in the documentation for <function>sprintf</function>. @@ -1683,12 +1671,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>quoted_printable_decode</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> This function returns an 8-bit binary string corresponding to the decoded quoted printable string. This function is similar to @@ -1705,12 +1693,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>quotemeta</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a version of str with a backslash character (<literal>\</literal>) before every character that is among @@ -1726,11 +1714,7 @@ </refsect1> </refentry> - - -<!-- this section is nearly-identical to trim, ltrim and rtrim --> - - + <!-- this section is nearly-identical to trim, ltrim and rtrim --> <refentry id="function.rtrim"> <refnamediv> <refname>rtrim</refname> @@ -1740,13 +1724,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <note> <simpara> The second parameter was added in PHP 4.1.0 @@ -1757,11 +1741,7 @@ end of <parameter>str</parameter>. Without the second parameter, <function>rtrim</function> will strip these characters: - - -<!-- sorted by importance. Printed 3 times: trim, ltrim, rtrim --> - - + <!-- sorted by importance. Printed 3 times: trim, ltrim, rtrim --> <itemizedlist> <listitem> <simpara> @@ -1794,11 +1774,7 @@ </simpara> </listitem> <listitem> - <simpara> - -<!-- not \v, since not supported by PHP --> - - + <simpara> <!-- not \v, since not supported by PHP --> "\x0B" (<acronym>ASCII</acronym> <literal>11</literal> (<literal>0x0B</literal>)), a vertical tab. </simpara> @@ -1847,14 +1823,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The function <function>sscanf</function> is the input analog of <function>printf</function>. <function>sscanf</function> reads @@ -1903,13 +1879,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>setlocale</methodname> <methodparam><type>mixed</type><parameter>category</parameter></methodparam> <methodparam><type>string</type><parameter>locale</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <parameter>Category</parameter> is a named constant (or string) specifying the category of the functions affected by the locale @@ -1978,14 +1954,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This calculates the similarity between two strings as described in Oliver [1993]. Note that this implementation does not use a @@ -2010,12 +1986,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>soundex</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Calculates the soundex key of <parameter>str</parameter>. </para> @@ -2054,13 +2030,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> Returns a string produced according to the formatting string <parameter>format</parameter>. @@ -2250,14 +2226,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function is similar to <function>strcasecmp</function>, with the difference that you can specify the (upper limit of the) @@ -2289,13 +2265,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>strcasecmp</methodname> <methodparam><type>string</type><parameter>str1</parameter></methodparam> <methodparam><type>string</type><parameter>str2</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &lt; 0 if <parameter>str1</parameter> is less than <parameter>str2</parameter>; &gt; 0 if <parameter>str1</parameter> @@ -2330,13 +2306,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>strchr</methodname> <methodparam><type>string</type><parameter>haystack</parameter></methodparam> <methodparam><type>string</type><parameter>needle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function is an alias for <function>strstr</function>, and is identical in every way. @@ -2351,13 +2327,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>strcmp</methodname> <methodparam><type>string</type><parameter>str1</parameter></methodparam> <methodparam><type>string</type><parameter>str2</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns &lt; 0 if <parameter>str1</parameter> is less than <parameter>str2</parameter>; &gt; 0 if <parameter>str1</parameter> @@ -2383,13 +2359,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>strcoll</methodname> <methodparam><type>string</type><parameter>str1</parameter></methodparam> <methodparam><type>string</type><parameter>str2</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns &lt; 0 if <parameter>str1</parameter> is less than <parameter>str2</parameter>; &gt; 0 if @@ -2427,13 +2403,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>strcspn</methodname> <methodparam><type>string</type><parameter>str1</parameter></methodparam> <methodparam><type>string</type><parameter>str2</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns the length of the initial segment of <parameter>str1</parameter> which does <emphasis>not</emphasis> @@ -2452,13 +2428,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -2505,12 +2481,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>stripcslashes</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a string with backslashes stripped off. Recognizes C-like <literal>\n</literal>, <literal>\r</literal> ..., octal @@ -2536,12 +2512,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>stripslashes</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a string with backslashes stripped off. (<literal>\'</literal> becomes <literal>'</literal> and so on.) @@ -2562,13 +2538,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>stristr</methodname> <methodparam><type>string</type><parameter>haystack</parameter></methodparam> <methodparam><type>string</type><parameter>needle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns all of <parameter>haystack</parameter> from the first occurrence of <parameter>needle</parameter> to the end. @@ -2597,12 +2573,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>strlen</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the length of <parameter>string</parameter>. </para> @@ -2618,13 +2594,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>strnatcmp</methodname> <methodparam><type>string</type><parameter>str1</parameter></methodparam> <methodparam><type>string</type><parameter>str2</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function implements a comparison algorithm that orders alphanumeric strings in the way a human being would, this is @@ -2699,13 +2675,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>strnatcasecmp</methodname> <methodparam><type>string</type><parameter>str1</parameter></methodparam> <methodparam><type>string</type><parameter>str2</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function implements a comparison algorithm that orders alphanumeric strings in the way a human being would. The @@ -2740,14 +2716,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function is similar to <function>strcmp</function>, with the difference that you can specify the (upper limit of the) number @@ -2784,15 +2760,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This functions returns the <parameter>input</parameter> string padded on the left, the right, or both sides to the specified @@ -2835,14 +2811,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the numeric position of the first occurrence of <parameter>needle</parameter> in the @@ -2903,13 +2879,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>strrchr</methodname> <methodparam><type>string</type><parameter>haystack</parameter></methodparam> <methodparam><type>string</type><parameter>needle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns the portion of <parameter>haystack</parameter> which starts at the last @@ -2952,13 +2928,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns <parameter>input_str</parameter> repeated <parameter>multiplier</parameter> times. @@ -2988,12 +2964,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>strrev</methodname> <methodparam><type>string</type><parameter>string</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns <parameter>string</parameter>, reversed. <example> @@ -3017,13 +2993,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>strrpos</methodname> <methodparam><type>string</type><parameter>haystack</parameter></methodparam> <methodparam><type>char</type><parameter>needle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the numeric position of the last occurrence of <parameter>needle</parameter> in the @@ -3078,13 +3054,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>strspn</methodname> <methodparam><type>string</type><parameter>str1</parameter></methodparam> <methodparam><type>string</type><parameter>str2</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns the length of the initial segment of <parameter>str1</parameter> which consists entirely of characters @@ -3113,13 +3089,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>strstr</methodname> <methodparam><type>string</type><parameter>haystack</parameter></methodparam> <methodparam><type>string</type><parameter>needle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns all of <parameter>haystack</parameter> from the first occurrence of <parameter>needle</parameter> to the end. @@ -3164,13 +3140,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>strtok</methodname> <methodparam><type>string</type><parameter>arg1</parameter></methodparam> <methodparam><type>string</type><parameter>arg2</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>strtok</function> is used to tokenize a string. That is, if you have a string like "This is an example string" you @@ -3216,12 +3192,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>strtolower</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns <parameter>string</parameter> with all alphabetic characters converted to lowercase. @@ -3254,12 +3230,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>strtoupper</methodname> <methodparam><type>string</type><parameter>string</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns <parameter>string</parameter> with all alphabetic characters converted to uppercase. @@ -3294,14 +3270,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function returns a string or an array with all occurences of <parameter>search</parameter> in <parameter>subject</parameter> @@ -3365,14 +3341,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function returns a copy of <parameter>str</parameter>, translating all occurrences of each character in @@ -3427,14 +3403,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Substr returns the portion of <parameter>string</parameter> specified by the <parameter>start</parameter> and @@ -3510,13 +3486,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>substr_count</function> returns the number of times the <parameter>needle</parameter> substring occurs in the @@ -3541,15 +3517,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>substr_replace</function> replaces a copy of <parameter>string</parameter> delimited by the @@ -3614,11 +3590,7 @@ </refsect1> </refentry> - - -<!-- this section is nearly-identical to trim, ltrim and rtrim --> - - + <!-- this section is nearly-identical to trim, ltrim and rtrim --> <refentry id="function.trim"> <refnamediv> <refname>trim</refname> @@ -3628,13 +3600,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <note> <simpara> The second parameter was added in PHP 4.1.0 @@ -3645,11 +3617,7 @@ beginning and end of <parameter>str</parameter>. Without the second parameter, <function>trim</function> will strip these characters: - - -<!-- sorted by importance. Printed 3 times: trim, ltrim, rtrim --> - - + <!-- sorted by importance. Printed 3 times: trim, ltrim, rtrim --> <itemizedlist> <listitem> <simpara> @@ -3682,11 +3650,7 @@ </simpara> </listitem> <listitem> - <simpara> - -<!-- not \v, since not supported by PHP --> - - + <simpara> <!-- not \v, since not supported by PHP --> "\x0B" (<acronym>ASCII</acronym> <literal>11</literal> (<literal>0x0B</literal>)), a vertical tab. </simpara> @@ -3733,12 +3697,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>ucfirst</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a string with the first character of <parameter>str</parameter> capitalized, if that character is @@ -3774,12 +3738,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>ucwords</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a string with the first character of each word in <parameter>str</parameter> capitalized, if that character is @@ -3819,15 +3783,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns a string with <parameter>str</parameter> wrapped at the column number specified by the (optional) Index: phpdoc/en/functions/swf.xml diff -u phpdoc/en/functions/swf.xml:1.24.2.1 phpdoc/en/functions/swf.xml:1.24.2.2 --- phpdoc/en/functions/swf.xml:1.24.2.1 Sun Nov 11 20:08:55 2001 +++ phpdoc/en/functions/swf.xml Mon Nov 12 09:59:23 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.24.2.1 $ --> +<!-- $Revision: 1.24.2.2 $ --> <reference id="ref.swf"> <title>Shockwave Flash functions</title> <titleabbrev>SWF</titleabbrev> @@ -91,8 +91,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_openfile</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> <methodparam><type>float</type><parameter>width</parameter></methodparam> @@ -101,8 +101,8 @@ <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> + </methodsynopsis> + <para> The <function>swf_openfile</function> function opens a new file named <parameter>filename</parameter> with a width of @@ -129,14 +129,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_closefile</methodname> <methodparam choice="opt"><type>int</type><parameter> return_file </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Close a file that was opened by the <function>swf_openfile</function> function. If the @@ -228,12 +228,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_labelframe</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Label the current frame with the name given by the <parameter>name</parameter> parameter. @@ -248,12 +248,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_showframe</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> The swf_showframe function will output the current frame. </para> @@ -267,12 +267,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_setframe</methodname> <methodparam><type>int</type><parameter>framenumber</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_setframe</function> changes the active frame to the frame specified by <parameter>framenumber</parameter>. @@ -287,12 +287,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>swf_getframe</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_getframe</function> function gets the number of the current frame. @@ -309,15 +309,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_mulcolor</function> function sets the global multiply color to the <parameter>rgba</parameter> color @@ -346,15 +346,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_addcolor</function> function sets the global add color to the <parameter>rgba</parameter> color specified. @@ -381,13 +381,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Places the object specified by <parameter>objid</parameter> in the current frame at a depth of <parameter>depth</parameter>. @@ -415,13 +415,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Updates the position and/or color of the object at the specified depth, <parameter>depth</parameter>. The parameter @@ -446,12 +446,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_removeobject</methodname> <methodparam><type>int</type><parameter>depth</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Removes the object at the depth specified by <parameter>depth</parameter>. @@ -466,12 +466,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>swf_nextid</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_nextid</function> function returns the next available object id. @@ -488,12 +488,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_startdoaction</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_startdoaction</function> function starts the description of an action list for the current frame. This must @@ -509,12 +509,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_actiongotoframe</methodname> <methodparam><type>int</type><parameter>framenumber</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_actionGotoFrame</function> function will go to the frame specified by <parameter>framenumber</parameter>, play @@ -530,13 +530,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_actionGetUrl</function> function gets the URL specified by the parameter <parameter>url</parameter> with the @@ -552,12 +552,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_actionnextframe</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Go foward one frame. </para> @@ -571,12 +571,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_actionprevframe</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + </refsect1> </refentry> @@ -589,12 +589,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_actionplay</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Start playing the flash movie from the current frame. </para> @@ -610,12 +610,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_actionstop</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Stop playing the flash movie at the current frame. </para> @@ -631,12 +631,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_actiontogglequality</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Toggle the flash movie between high and low quality. </para> @@ -652,13 +652,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_actionWaitForFrame</function> function will check to see if the frame, specified by the @@ -677,12 +677,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_actionsettarget</methodname> <methodparam><type>string</type><parameter>target</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_actionSetTarget</function> function sets the context for all actions. You can use this to control other flash @@ -700,12 +700,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_actiongotolabel</methodname> <methodparam><type>string</type><parameter>label</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_actionGotoLabel</function> function displays the frame with the label given by the @@ -721,12 +721,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_enddoaction</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> Ends the current action started by the <function>swf_startdoaction</function> function. @@ -741,8 +741,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_defineline</methodname> <methodparam><type>int</type><parameter>objid</parameter></methodparam> <methodparam><type>float</type><parameter>x1</parameter></methodparam> @@ -750,8 +750,8 @@ <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> + </methodsynopsis> + <para> The <function>swf_defineline</function> defines a line starting from the x coordinate given by <parameter>x1</parameter> and the @@ -771,8 +771,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_definerect</methodname> <methodparam><type>int</type><parameter>objid</parameter></methodparam> <methodparam><type>float</type><parameter>x1</parameter></methodparam> @@ -780,8 +780,8 @@ <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> + </methodsynopsis> + <para> The <function>swf_definerect</function> defines a rectangle with an upper left hand coordinate given by the x, @@ -804,15 +804,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_definepoly</function> function defines a polygon given an array of x, y coordinates (the coordinates are @@ -833,12 +833,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_startshape</methodname> <methodparam><type>int</type><parameter>objid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_startshape</function> function starts a complex shape, with an object id given by the @@ -854,16 +854,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_shapeLineSolid</function> function sets the current line style to the color of the @@ -881,12 +881,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_shapefilloff</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_shapeFillOff</function> function turns off filling for the current shape. @@ -903,15 +903,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_shapeFillSolid</function> function sets the current fill style to solid, and then sets the fill color to the @@ -929,12 +929,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_shapefillbitmapclip</methodname> <methodparam><type>int</type><parameter>bitmapid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Sets the fill to bitmap clipped, empty spaces will be filled by the bitmap given by the <parameter>bitmapid</parameter> @@ -952,12 +952,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_shapefillbitmaptile</methodname> <methodparam><type>int</type><parameter>bitmapid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Sets the fill to bitmap tile, empty spaces will be filled by the bitmap given by the <parameter>bitmapid</parameter> parameter @@ -973,13 +973,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_shapeMoveTo</function> function moves the current position to the x coordinate given by the @@ -996,13 +996,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_shapeLineTo</function> draws a line to the x,y coordinates given by the <parameter>x</parameter> parameter &amp; the @@ -1021,15 +1021,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_shapecurveto</function> function draws a quadratic bezier curve from the x coordinate given by @@ -1050,8 +1050,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_shapecurveto3</methodname> <methodparam><type>float</type><parameter>x1</parameter></methodparam> <methodparam><type>float</type><parameter>y1</parameter></methodparam> @@ -1059,8 +1059,8 @@ <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> + </methodsynopsis> + <para> Draw a cubic bezier curve using the x,y coordinate pairs <parameter>x1</parameter>, <parameter>y1</parameter> and @@ -1081,16 +1081,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_shapeArc</function> function draws a circular arc from angle A given by the <parameter>ang1</parameter> @@ -1112,12 +1112,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_endshape</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_endshape</function> completes the definition of the current shape. @@ -1134,13 +1134,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_definefont</function> function defines a font given by the <parameter>fontname</parameter> parameter and gives @@ -1158,12 +1158,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_setfont</methodname> <methodparam><type>int</type><parameter>fontid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_setfont</function> sets the current font to the value given by the <parameter>fontid</parameter> parameter. @@ -1178,12 +1178,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_fontsize</methodname> <methodparam><type>float</type><parameter>size</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_fontsize</function> function changes the font size to the value given by the <parameter>size</parameter> @@ -1199,12 +1199,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_fontslant</methodname> <methodparam><type>float</type><parameter>slant</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Set the current font slant to the angle indicated by the <parameter>slant</parameter> parameter. Positive values create a @@ -1220,12 +1220,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_fonttracking</methodname> <methodparam><type>float</type><parameter>tracking</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Set the font tracking to the value specified by the <parameter>tracking</parameter> parameter. This function is used @@ -1245,12 +1245,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>swf_getfontinfo</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_getfontinfo</function> function returns an associative array with the following parameters: @@ -1277,14 +1277,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Define a text string (the <parameter>str</parameter> parameter) using the current font and font size. The @@ -1302,12 +1302,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>float</type><methodname>swf_textwidth</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_textwidth</function> function gives the width of the string, <parameter>str</parameter>, in pixels, using the @@ -1323,13 +1323,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_definebitmap</function> function defines a bitmap given a GIF, JPEG, RGB or FI image. The image will be @@ -1345,12 +1345,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>swf_getbitmapinfo</methodname> <methodparam><type>int</type><parameter>bitmapid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_getbitmapinfo</function> function returns an array of information about a bitmap given by the @@ -1384,12 +1384,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_startsymbol</methodname> <methodparam><type>int</type><parameter>objid</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Define an object id as a symbol. Symbols are tiny flash movies that can be played simultaneously. The @@ -1406,12 +1406,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_endsymbol</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_endsymbol</function> function ends the definition of a symbol that was started by the @@ -1427,13 +1427,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_startbutton</function> function starts off the definition of a button. The <parameter>type</parameter> @@ -1454,14 +1454,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_addbuttonrecord</function> function allows you to define the specifics of using a button. The first parameter, @@ -1499,12 +1499,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_oncondition</methodname> <methodparam><type>int</type><parameter>transition</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_onCondition</function> function describes a transition that will trigger an action list. There are several @@ -1613,12 +1613,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_endbutton</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_endButton</function> function ends the definition of the current button. @@ -1633,15 +1633,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_viewport</function> function selects an area for future drawing for <parameter>xmin</parameter> to @@ -1662,8 +1662,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_ortho</methodname> <methodparam><type>float</type><parameter>xmin</parameter></methodparam> <methodparam><type>float</type><parameter>xmax</parameter></methodparam> @@ -1671,8 +1671,8 @@ <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> + </methodsynopsis> + <para> The <function>swf_ortho</function> funcion defines a orthographic mapping of user coordinates onto the current viewport. @@ -1690,15 +1690,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_ortho2</function> function defines a two dimensional orthographic mapping of user coordinates onto the @@ -1718,15 +1718,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_perspective</function> function defines a perspective projection transformation. The @@ -1756,15 +1756,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_polarview</function> function defines the viewer's position in polar coordinates. The @@ -1790,8 +1790,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -1800,8 +1800,8 @@ <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> + </methodsynopsis> + <para> The <function>swf_lookat</function> function defines a viewing transformation by giving the viewing position (the parameters @@ -1825,12 +1825,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_pushmatrix</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_pushmatrix</function> function pushes the current transformation matrix back onto the stack. @@ -1847,12 +1847,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_popmatrix</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_popmatrix</function> function pushes the current transformation matrix back onto the stack. @@ -1867,14 +1867,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_scale</function> scales the x coordinate of the curve by the value of the <parameter>x</parameter> parameter, the @@ -1892,14 +1892,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_translate</function> function translates the current transformation by the <parameter>x</parameter>, @@ -1916,13 +1916,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> The <function>swf_rotate</function> rotates the current transformation by the angle given by the @@ -1943,12 +1943,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>swf_posround</methodname> <methodparam><type>int</type><parameter>round</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The <function>swf_posround</function> function enables or disables the rounding of the translation when objects are placed Index: phpdoc/en/functions/sybase.xml diff -u phpdoc/en/functions/sybase.xml:1.19.2.1 phpdoc/en/functions/sybase.xml:1.19.2.2 --- phpdoc/en/functions/sybase.xml:1.19.2.1 Sun Nov 11 20:08:55 2001 +++ phpdoc/en/functions/sybase.xml Mon Nov 12 09:59:23 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.19.2.1 $ --> +<!-- $Revision: 1.19.2.2 $ --> <reference id="ref.sybase"> <title>Sybase functions</title> <titleabbrev>Sybase</titleabbrev> @@ -11,13 +11,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>sybase_affected_rows</methodname> <methodparam choice="opt"><type>int</type><parameter>link_identifier </parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: The number of affected rows by the last query. </para> @@ -48,12 +48,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>sybase_close</methodname> <methodparam><type>int</type><parameter>link_identifier</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: &true; on success, &false; on error </para> @@ -81,15 +81,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: A positive Sybase link identifier on success, or &false; on error. </para> @@ -118,13 +118,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: &true; on success, &false; on failure </para> <para> sybase_data_seek() moves the internal row pointer of the @@ -144,12 +144,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>sybase_fetch_array</methodname> <methodparam><type>int</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: An array that corresponds to the fetched row, or &false; if there are no more rows. </para> @@ -177,13 +177,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an object containing field information. </para> @@ -229,12 +229,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>sybase_fetch_object</methodname> <methodparam><type>int</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: An object with properties that correspond to the fetched row, or &false; if there are no more rows. </para> @@ -262,12 +262,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>sybase_fetch_row</methodname> <methodparam><type>int</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: An array that corresponds to the fetched row, or &false; if there are no more rows. </para> @@ -298,13 +298,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Seeks to the specified field offset. If the next call to <function>sybase_fetch_field</function> won't include a field @@ -322,12 +322,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>sybase_free_result</methodname> <methodparam><type>int</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>sybase_free_result</function> only needs to be called if you are worried about using too much memory while your script @@ -346,12 +346,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>sybase_get_last_message</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> <function>sybase_get_last_message</function> returns the last message reported by the server. @@ -366,12 +366,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>sybase_min_client_severity</methodname> <methodparam><type>int</type><parameter>severity</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>sybase_min_client_severity</function> sets the minimum client severity level. @@ -395,12 +395,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>sybase_min_error_severity</methodname> <methodparam><type>int</type><parameter>severity</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>sybase_min_error_severity</function> sets the minimum error severity level. @@ -418,12 +418,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>sybase_min_message_severity</methodname> <methodparam><type>int</type><parameter>severity</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>sybase_min_message_severity</function> sets the minimum message severity level. @@ -441,12 +441,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>sybase_min_server_severity</methodname> <methodparam><type>int</type><parameter>severity</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>sybase_min_server_severity</function> sets the minimum server severity level. @@ -470,12 +470,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>sybase_num_fields</methodname> <methodparam><type>int</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> sybase_num_fields() returns the number of fields in a result set. </para> @@ -496,12 +496,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>sybase_num_rows</methodname> <methodparam><type>int</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> sybase_num_rows() returns the number of rows in a result set. </para> @@ -521,15 +521,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: A positive Sybase persistent link identifier on success, or &false; on error</para> @@ -560,13 +560,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: A positive Sybase result identifier on success, or &false; on error. </para> @@ -593,14 +593,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: The contents of the cell at the row and offset in the specified Sybase result set. </para> @@ -637,13 +637,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns: &true; on success, &false; on error </para> <para> sybase_select_db() sets the current active database on the Index: phpdoc/en/functions/uodbc.xml diff -u phpdoc/en/functions/uodbc.xml:1.26.2.2 phpdoc/en/functions/uodbc.xml:1.26.2.3 --- phpdoc/en/functions/uodbc.xml:1.26.2.2 Sun Nov 11 21:04:38 2001 +++ phpdoc/en/functions/uodbc.xml Mon Nov 12 09:59:23 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.26.2.2 $ --> +<!-- $Revision: 1.26.2.3 $ --> <reference id="ref.odbc"> <title>Unified ODBC functions</title> <titleabbrev>ODBC</titleabbrev> @@ -16,8 +16,6 @@ The following databases are supported by the Unified ODBC functions: <ulink url="&url.adabas;">Adabas D</ulink>, <ulink url="&url.ibmdb2;">IBM DB2</ulink>, <ulink url="&url.iodbc;">iODBC</ulink>, <ulink url="&url.solid;">Solid</ulink>, and <ulink url="&url.sybase;">Sybase SQL Anywhere</ulink>. </simpara> - - <!-- install.xml has changed, so this link is no longer working <simpara> Please see the <link @@ -26,8 +24,6 @@ with these databases. </simpara> --> - - <note> <simpara> There is no ODBC involved when connecting to the above @@ -49,13 +45,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Without the <parameter>OnOff</parameter> parameter, this function returns auto-commit status for @@ -87,13 +83,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> (ODBC SQL types affected: BINARY, VARBINARY, LONGVARBINARY) </para> @@ -197,12 +193,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>odbc_close</methodname> <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>odbc_close</function> will close down the connection to the database server associated with the given connection @@ -224,12 +220,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>odbc_close_all</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> <function>odbc_close_all</function> will close down all connections to database server(s). @@ -250,12 +246,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>odbc_commit</methodname> <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns: &true; on success, &false; on failure. All pending transactions on @@ -271,15 +267,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an ODBC connection id or 0 (&false;) on error. @@ -340,12 +336,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>odbc_cursor</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> odbc_cursor will return a cursorname for the given result_id. </para> @@ -359,13 +355,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>odbc_do</function> will execute a query on the given connection. @@ -380,12 +376,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>odbc_error</methodname> <methodparam choice="opt"><type>int</type><parameter>connection_id</parameter></methodparam> - - </methodsynopsis> + </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 +402,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>odbc_errormsg</methodname> <methodparam choice="opt"><type>int</type><parameter>connection_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns a string containing the last ODBC error message, or an empty string if there has been no errors. If @@ -433,13 +429,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns &false; on error. Returns an ODBC result identifier if the SQL command was executed successfully. @@ -466,13 +462,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Executes a statement prepared with <function>odbc_prepare</function>. Returns @@ -491,14 +487,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the number of columns in the result; &false; on error. @@ -549,14 +545,14 @@ <para> Future: In PHP 4.1, this function will be moved to the following format: - <methodsynopsis> - + + <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> + </methodsynopsis> + Please note, that <parameter>rownumber</parameter> will be optional, while <parameter>result_array</parameter> is not. </para> @@ -570,13 +566,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> If <function>odbc_fetch_row</function> was succesful (there was a row), &true; is returned. If there are no more @@ -615,13 +611,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>odbc_field_name</function> will return the name of the field occupying the given column number in the given ODBC result @@ -638,13 +634,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -661,13 +657,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>odbc_field_type</function> will return the SQL type of the field referecend by number in the given ODBC result @@ -683,13 +679,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>odbc_field_len</function> will return the length of the field referecend by number in the given ODBC result @@ -709,13 +705,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>odbc_field_precision</function> will return the precision of the field referecend by number in the given ODBC result @@ -735,13 +731,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>odbc_field_precision</function> will return the scale of the field referecend by number in the given ODBC result @@ -757,12 +753,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>odbc_free_result</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Always returns &true;. </para> @@ -795,13 +791,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> (ODBC SQL types affected: LONG, LONGVARBINARY) The number of bytes returned to PHP is controled by the parameter length. If it @@ -824,12 +820,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>odbc_num_fields</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>odbc_num_fields</function> will return the number of fields (columns) in an ODBC result. This function will return -1 @@ -846,15 +842,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns an ODBC connection id or 0 (&false;) on error. This function is much like @@ -889,13 +885,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns &false; on error. </para> @@ -914,12 +910,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>odbc_num_rows</methodname> <methodparam><type>int</type><parameter>result_id</parameter></methodparam> - - </methodsynopsis> + </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 @@ -943,13 +939,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the contents of the field. </para> @@ -981,8 +977,6 @@ <function>odbc_binmode</function> and <function>odbc_longreadlen</function>. - - <!-- If the requested field contains @@ -994,8 +988,6 @@ HEX(binary_col) FROM mytable" --> - - </para> </refsect1> </refentry> @@ -1007,13 +999,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the number of rows in the result or &false; on error. @@ -1035,12 +1027,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>odbc_rollback</methodname> <methodparam><type>int</type><parameter>connection_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Rolls back all pending statements on <parameter>connection_id</parameter>. Returns @@ -1060,15 +1052,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function allows fiddling with the ODBC options for a particular connection or query result. It was written to help @@ -1138,16 +1130,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Lists all tables in the requested range. Returns an ODBC result identifier or &false; on failure. @@ -1235,15 +1227,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Lists tables in the requested range and the privileges associated with each table. Returns an ODBC result identifier or @@ -1283,16 +1275,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Lists all columns in the requested range. Returns an ODBC result identifier or &false; on failure. @@ -1342,16 +1334,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Lists columns and associated privileges for the given table. Returns an ODBC result identifier or &false; on @@ -1391,13 +1383,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Retrieves information about data types supported by the data source. Returns an ODBC result identifier or @@ -1440,15 +1432,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns the column names that comprise the primary key for a table. Returns an ODBC result identifier or @@ -1479,8 +1471,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -1489,8 +1481,8 @@ <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> + </methodsynopsis> + <para> <function>odbc_foreignkeys</function> retrieves information about foreign keys. Returns an ODBC result identifier or @@ -1547,15 +1539,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Lists all procedures in the requested range. Returns an ODBC result identifier or &false; on failure. @@ -1590,16 +1582,16 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -1646,8 +1638,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -1656,8 +1648,8 @@ <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> + </methodsynopsis> + <simpara> When the type argument is SQL_BEST_ROWID, <function>odbc_specialcolumns</function> returns the @@ -1700,8 +1692,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> @@ -1709,8 +1701,8 @@ <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> + </methodsynopsis> + <para> Get statistics about a table and it's indexes. Returns an ODBC result identifier or &false; on failure. Index: phpdoc/en/functions/url.xml diff -u phpdoc/en/functions/url.xml:1.19.2.1 phpdoc/en/functions/url.xml:1.19.2.2 --- phpdoc/en/functions/url.xml:1.19.2.1 Sun Nov 11 20:08:55 2001 +++ phpdoc/en/functions/url.xml Mon Nov 12 09:59:23 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.19.2.1 $ --> +<!-- $Revision: 1.19.2.2 $ --> <reference id="ref.url"> <title>URL Functions</title> <titleabbrev>URLs</titleabbrev> @@ -11,12 +11,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>base64_decode</methodname> <methodparam><type>string</type><parameter>encoded_data</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>base64_decode</function> decodes <parameter>encoded_data</parameter> and returns the original @@ -36,12 +36,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>base64_encode</methodname> <methodparam><type>string</type><parameter>data</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>base64_encode</function> returns <parameter>data</parameter> encoded with base64. This encoding @@ -67,12 +67,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>parse_url</methodname> <methodparam><type>string</type><parameter>url</parameter></methodparam> - - </methodsynopsis> + </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 +92,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>rawurldecode</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a string in which the sequences with percent (<literal>%</literal>) signs followed by two hex digits have been @@ -120,12 +120,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>rawurlencode</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a string in which all non-alphanumeric characters except <screen>-_.</screen> have been replaced with a percent @@ -166,12 +166,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>urldecode</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Decodes any <literal>%<replaceable>##</replaceable></literal> encoding in the given string. The decoded string is returned. @@ -204,12 +204,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>urlencode</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a string in which all non-alphanumeric characters except <literal>-_.</literal> have been replaced with a percent Index: phpdoc/en/functions/var.xml diff -u phpdoc/en/functions/var.xml:1.74.2.2 phpdoc/en/functions/var.xml:1.74.2.3 --- phpdoc/en/functions/var.xml:1.74.2.2 Sun Nov 11 21:04:38 2001 +++ phpdoc/en/functions/var.xml Mon Nov 12 09:59:23 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.74.2.2 $ --> +<!-- $Revision: 1.74.2.3 $ --> <reference id="ref.var"> <title>Variable Functions</title> <titleabbrev>Variables</titleabbrev> @@ -32,12 +32,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>boolean</type><methodname>empty</methodname> <methodparam><type>mixed</type><parameter>var</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <note> <para> <function>empty</function> is a language construct. @@ -51,13 +51,9 @@ to boolean</link> for more information. </para> - - -<!-- Returns &false; if <parameter>var</parameter> is set and has a + <!-- Returns &false; if <parameter>var</parameter> is set and has a non-empty or non-zero value; &true; otherwise. --> - - <informalexample> <programlisting role="php"> $var = 0; @@ -77,11 +73,7 @@ variable; i.e. <command>empty (addslashes ($name))</command> has no meaning since it would be checking whether something which isn't a variable is a variable with a &false; value. - - -<!-- will even result in parse error (at least in PHP 4) --> - - + <!-- will even result in parse error (at least in PHP 4) --> </simpara> <simpara> See also <function>isset</function> and @@ -97,12 +89,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>float</type><methodname>floatval</methodname> <methodparam><type>mixed</type><parameter>var</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns the <type>float</type> value of <parameter>var</parameter>. </simpara> @@ -133,12 +125,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>gettype</methodname> <methodparam><type>mixed</type><parameter>var</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the type of the PHP variable <parameter>var</parameter>. @@ -147,12 +139,8 @@ <simpara> Never use <function>gettype</function> to test for a certain type, since the returned string may be subject to change in a future version. - In addition, it is slow too, as it involves string comparision - -<!-- - where's my dictionary? --> - -. + In addition, it is slow too, as it involves string comparision <!-- + where's my dictionary? -->. </simpara> <simpara> Instead, use the <literal>is_*</literal> functions. @@ -191,11 +179,7 @@ <simpara>"user function" (PHP 3 only, deprecated)</simpara> </listitem> <listitem> - <simpara>"unknown type" - -<!-- someone's joking? --> - -</simpara> + <simpara>"unknown type"<!-- someone's joking? --></simpara> </listitem> </itemizedlist> </para> @@ -230,12 +214,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>array</type><methodname>get_defined_vars</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns an multidimensional array containing a list of all defined variables, be them environment, server or user-defined @@ -279,12 +263,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>get_resource_type</methodname> <methodparam><type>resource</type><parameter>$handle</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function returns a string representing the type of the <type>resource</type> passed to it. If the paramater is not a @@ -309,6 +293,61 @@ </refsect1> </refentry> + <refentry id="function.import-request-variables"> + <refnamediv> + <refname>import_request_variables</refname> + <refpurpose>Import GET/POST/Cookie variables into the global scope</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <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 + <link linkend="ini.register-globals">register_globals</link>, + but would like to see some variables in the global scope. + </simpara> + <simpara> + Using the <parameter>types</parameter> parameter, you can + specify, which request variables to import. You can use + 'G', 'P' and 'C' characters respectively for GET, POST and + Cookie. These characters are not case sensitive, so you + can also use any combination of 'g', 'p' and 'c'. POST + includes the uploaded file informations. Note, that the + order of the letters matters, as using "gp", the POST + variables will overwrite GET variables with the same + name. Any other other letters then GPC are discarded. + </simpara> + <note> + <para> + Although the <parameter>prefix</parameter> argument is + optional, you will get a notice level error, if you + specify no prefix, or specify an empty string as a + prefix. This is a possible security hazard. Notice + level errors are not displayed using the default + error reporting level. + </para> + </note> + <informalexample> + <programlisting role="php"> +// This will import GET and POST vars +// with an "rvar_" prefix +import_request_variables("gP", "rvar_"); + </programlisting> + </informalexample> + <simpara> + See also <link linkend="ini.register-globals">register_globals</link> + and <link linkend="ini.track-vars">track_vars</link>. + </simpara> + </refsect1> + </refentry> + <refentry id="function.intval"> <refnamediv> <refname>intval</refname> @@ -316,13 +355,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> Returns the <type>integer</type> value of <parameter>var</parameter>, using the specified base for the conversion (the default is @@ -355,12 +394,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>is_array</methodname> <methodparam><type>mixed</type><parameter>var</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if <parameter>var</parameter> is an <type>array</type>, &false; otherwise. @@ -385,12 +424,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> + <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>. @@ -427,12 +466,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>is_float</methodname> <methodparam><type>mixed</type><parameter>var</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns &true; if <parameter>var</parameter> is a <type>float</type>, &false; otherwise. @@ -456,12 +495,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>is_int</methodname> <methodparam><type>mixed</type><parameter>var</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns &true; if <parameter>var</parameter> is an <type>integer</type> &false; otherwise. @@ -512,12 +551,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>is_null</methodname> <methodparam><type>mixed</type><parameter>var</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if <parameter>var</parameter> is <type>null</type>, &false; otherwise. @@ -544,12 +583,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>is_numeric</methodname> <methodparam><type>mixed</type><parameter>var</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if <parameter>var</parameter> is a number or a numeric string, &false; otherwise. @@ -573,12 +612,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>is_object</methodname> <methodparam><type>mixed</type><parameter>var</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if <parameter>var</parameter> is an <type>object</type>, &false; otherwise. @@ -616,12 +655,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>is_resource</methodname> <methodparam><type>mixed</type><parameter>var</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>is_resource</function> returns &true; if the variable given by the <parameter>var</parameter> parameter is a @@ -643,12 +682,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>is_scalar</methodname> <methodparam><type>mixed</type><parameter>var</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>is_scalar</function> returns &true; if the variable given by the <parameter>var</parameter> parameter is a scalar, @@ -660,12 +699,8 @@ For example: <informalexample> <programlisting role="php"> - - <!-- TODO: better example, this one can be quite misleading for unexperienced programmers --> - - function show_var($var) { if (is_scalar($var)) echo $var; @@ -728,12 +763,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>is_string</methodname> <methodparam><type>mixed</type><parameter>var</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if <parameter>var</parameter> is a <type>string</type>, &false; otherwise. @@ -757,12 +792,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>boolean</type><methodname>isset</methodname> <methodparam><type>mixed</type><parameter>var</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns &true; if <parameter>var</parameter> exists; &false; otherwise. @@ -802,12 +837,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>print_r</methodname> <methodparam><type>mixed</type><parameter>expression</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> This function displays information about the values of variables in a way that's readable by humans. If given a <type>string</type>, @@ -860,12 +895,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>serialize</methodname> <methodparam><type>mixed</type><parameter>value</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>serialize</function> returns a string containing a byte-stream representation of <parameter>value</parameter> that @@ -883,9 +918,7 @@ references to itself. References inside the array/object you are <function>serialize</function>ing will also be stored. </simpara> - - -<!-- TODO + <!-- TODO in 4.0.4pl1 this didn't work properly, however, there been some fixes. I don't know whether this all works correctly now, and if so, whether it is since 405 @@ -897,8 +930,6 @@ </note> </simpara> --> - - <note> <para> In PHP 3, object properties will be serialized, but methods are @@ -943,13 +974,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>boolean</type><methodname>settype</methodname> <methodparam><type>mixed</type><parameter>var</parameter></methodparam> <methodparam><type>string</type><parameter>type</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Set the type of variable <parameter>var</parameter> to <parameter>type</parameter>. @@ -1026,12 +1057,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>strval</methodname> <methodparam><type>mixed</type><parameter>var</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> Returns the <type>string</type> value of <parameter>var</parameter>. See the documentation on <type>string</type> for more information @@ -1059,12 +1090,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>unserialize</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>unserialize</function> takes a single serialized variable (see <function>serialize</function>) and converts it @@ -1121,14 +1152,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>unset</function> destroys the specified variables. Note that in PHP 3, <function>unset</function> will always return &true; @@ -1270,14 +1301,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> This function returns structured information about one or more expressions that includes its type and value. Arrays are explored Index: phpdoc/en/functions/wddx.xml diff -u phpdoc/en/functions/wddx.xml:1.13.2.1 phpdoc/en/functions/wddx.xml:1.13.2.2 --- phpdoc/en/functions/wddx.xml:1.13.2.1 Sun Nov 11 20:08:55 2001 +++ phpdoc/en/functions/wddx.xml Mon Nov 12 09:59:24 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.13.2.1 $ --> +<!-- $Revision: 1.13.2.2 $ --> <reference id="ref.wddx"> <title>WDDX Functions</title> <titleabbrev>WDDX</titleabbrev> @@ -75,13 +75,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>wddx_serialize_value</function> is used to create a WDDX packet from a single given value. It takes the value @@ -99,13 +99,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>wddx_serialize_vars</function> is used to create a WDDX packet with a structure that contains the serialized @@ -154,12 +154,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>wddx_packet_start</methodname> <methodparam choice="opt"><type>string</type><parameter>comment</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Use <function>wddx_packet_start</function> to start a new WDDX packet for incremental addition of variables. It takes an @@ -177,12 +177,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>wddx_packet_end</methodname> <methodparam><type>int</type><parameter>packet_id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>wddx_packet_end</function> ends the WDDX packet specified by the <parameter>packet_id</parameter> and returns the @@ -200,14 +200,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>wddx_add_vars</function> is used to serialize passed variables and add the result to the packet specified by the @@ -225,12 +225,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>wddx_deserialize</methodname> <methodparam><type>string</type><parameter>packet</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>wddx_deserialize</function> takes a <parameter>packet</parameter> string and deserializes it. It Index: phpdoc/en/functions/xml.xml diff -u phpdoc/en/functions/xml.xml:1.20.2.1 phpdoc/en/functions/xml.xml:1.20.2.2 --- phpdoc/en/functions/xml.xml:1.20.2.1 Sun Nov 11 20:08:55 2001 +++ phpdoc/en/functions/xml.xml Mon Nov 12 09:59:24 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.20.2.1 $ --> +<!-- $Revision: 1.20.2.2 $ --> <reference id="ref.xml"> <title>XML parser functions</title> <titleabbrev>XML</titleabbrev> @@ -560,12 +560,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>xml_parser_create</methodname> <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <variablelist> <varlistentry> @@ -597,13 +597,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function allows to use <parameter>parser</parameter> inside <parameter>object</parameter>. All callback functions could be @@ -654,14 +654,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Sets the element handler functions for the XML parser <parameter>parser</parameter>. @@ -674,14 +674,14 @@ <para> The function named by <parameter>startElementHandler</parameter> must accept three parameters: - <methodsynopsis> + <methodsynopsis> <replaceable>startElementHandler</replaceable> <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> @@ -729,13 +729,13 @@ <para> The function named by <parameter>endElementHandler</parameter> must accept two parameters: - <methodsynopsis> + <methodsynopsis> <replaceable>endElementHandler</replaceable> <methodparam><type>int</type><parameter>parser</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> - </methodsynopsis> + <variablelist> <varlistentry> <term><parameter>parser</parameter></term> @@ -784,13 +784,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Sets the character data handler function for the XML parser <parameter>parser</parameter>. <parameter>handler</parameter> is @@ -800,13 +800,13 @@ <para> The function named by <parameter>handler</parameter> must accept two parameters: - <methodsynopsis> + <methodsynopsis> <replaceable>handler</replaceable> <methodparam><type>int</type><parameter>parser</parameter></methodparam> <methodparam><type>string</type><parameter>data</parameter></methodparam> - </methodsynopsis> + <variablelist> <varlistentry> <term><parameter>parser</parameter></term> @@ -853,13 +853,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Sets the processing instruction (PI) handler function for the XML parser <parameter>parser</parameter>. @@ -885,14 +885,14 @@ <para> The function named by <parameter>handler</parameter> must accept three parameters: - <methodsynopsis> + <methodsynopsis> <replaceable>handler</replaceable> <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> @@ -936,13 +936,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Sets the default handler function for the XML parser <parameter>parser</parameter>. <parameter>handler</parameter> is @@ -952,13 +952,13 @@ <para> The function named by <parameter>handler</parameter> must accept two parameters: - <methodsynopsis> + <methodsynopsis> <replaceable>handler</replaceable> <methodparam><type>int</type><parameter>parser</parameter></methodparam> <methodparam><type>string</type><parameter>data</parameter></methodparam> - </methodsynopsis> + <variablelist> <varlistentry> <term> @@ -1012,13 +1012,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Sets the unparsed entity declaration handler function for the XML parser <parameter>parser</parameter>. @@ -1041,8 +1041,8 @@ </para> <para> The function named by <parameter>handler</parameter> must accept six parameters: - <methodsynopsis> + <methodsynopsis> <replaceable>handler</replaceable> <methodparam><type>int</type><parameter>parser</parameter></methodparam> <methodparam><type>string</type><parameter>entityName</parameter></methodparam> @@ -1050,8 +1050,8 @@ <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> @@ -1130,13 +1130,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Sets the notation declaration handler function for the XML parser <parameter>parser</parameter>. <parameter>handler</parameter> is @@ -1154,16 +1154,16 @@ <para> The function named by <parameter>handler</parameter> must accept five parameters: - <methodsynopsis> + <methodsynopsis> <replaceable>handler</replaceable> <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> @@ -1245,13 +1245,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Sets the notation declaration handler function for the XML parser <parameter>parser</parameter>. <parameter>handler</parameter> is @@ -1265,16 +1265,16 @@ value returned from the handler is &false; (which it will be if no 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>. - <methodsynopsis> + <methodsynopsis> <type>int</type><replaceable>handler</replaceable> <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> @@ -1354,14 +1354,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <variablelist> <varlistentry> @@ -1419,12 +1419,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>xml_get_error_code</methodname> <methodparam><type>int</type><parameter>parser</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <variablelist> <varlistentry> @@ -1453,12 +1453,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>xml_error_string</methodname> <methodparam><type>int</type><parameter>code</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <variablelist> <varlistentry> @@ -1485,12 +1485,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>xml_get_current_line_number</methodname> <methodparam><type>int</type><parameter>parser</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <variablelist> <varlistentry> @@ -1520,12 +1520,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>xml_get_current_column_number</methodname> <methodparam><type>int</type><parameter>parser</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <variablelist> <varlistentry> @@ -1555,12 +1555,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>xml_get_current_byte_index</methodname> <methodparam><type>int</type><parameter>parser</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <variablelist> <varlistentry> @@ -1588,15 +1588,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function parses an XML file into 2 parallel array structures, one (<parameter>index</parameter>) containing pointers @@ -1802,12 +1802,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>xml_parser_free</methodname> <methodparam><type>int</type><parameter>parser</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <variablelist> <varlistentry> @@ -1834,14 +1834,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <variablelist> <varlistentry> @@ -1922,13 +1922,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <variablelist> <varlistentry> @@ -1974,12 +1974,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>utf8_decode</methodname> <methodparam><type>string</type><parameter>data</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function decodes <parameter>data</parameter>, assumed to be <literal>UTF-8</literal> encoded, to <literal>ISO-8859-1</literal>. @@ -1998,12 +1998,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>utf8_encode</methodname> <methodparam><type>string</type><parameter>data</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function encodes the string <parameter>data</parameter> to <literal>UTF-8</literal>, and returns the encoded version. Index: phpdoc/en/functions/xslt.xml diff -u phpdoc/en/functions/xslt.xml:1.24.2.1 phpdoc/en/functions/xslt.xml:1.24.2.2 --- phpdoc/en/functions/xslt.xml:1.24.2.1 Sun Nov 11 20:08:55 2001 +++ phpdoc/en/functions/xslt.xml Mon Nov 12 09:59:24 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.24.2.1 $ --> +<!-- $Revision: 1.24.2.2 $ --> <reference id="ref.xslt"> <title>XSLT functions</title> <titleabbrev>XSLT</titleabbrev> @@ -59,12 +59,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>xslt_closelog</methodname> <methodparam><type>resource</type><parameter>xh</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> <variablelist> @@ -92,12 +92,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>resource</type><methodname>xslt_create</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> This function returns a handle for a new XSL processor. This handle @@ -113,12 +113,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>xslt_errno</methodname> <methodparam><type>resource</type><parameter>xh</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Return the current error number of the given XSL processor. If @@ -135,12 +135,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>mixed</type><methodname>xslt_error</methodname> <methodparam><type>resource</type><parameter>xh</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Return the current error string of the given XSL processor. If @@ -157,13 +157,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>xslt_fetch_result</methodname> <methodparam><type>resource</type><parameter>xh</parameter></methodparam> <methodparam><type>string</type><parameter>result_name</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Fetch a result buffer from the XSLT processor identified by @@ -180,12 +180,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>xslt_free</methodname> <methodparam><type>resource</type><parameter>xh</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Free the XSLT processor identified by the given handle. @@ -200,14 +200,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>xslt_openlog</methodname> <methodparam><type>resource</type><parameter>xh</parameter></methodparam> <methodparam><type>string</type><parameter>logfile</parameter></methodparam> <methodparam><type>int</type><parameter>loglevel</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Set a logfile for the XSLT processor to place all of its error @@ -223,12 +223,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>xslt_output_begintransform</methodname> <methodparam><type>string</type><parameter>xslt_filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> This function will begin the output transformation on your data. @@ -280,12 +280,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>xslt_output_endtransform</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> The <function>xslt_output_endtransform</function> ends the output transformation @@ -302,14 +302,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>xslt_process</methodname> <methodparam><type>string</type><parameter>xsl_data</parameter></methodparam> <methodparam><type>string</type><parameter>xml_data</parameter></methodparam> <methodparam><type>string</type><parameter>result</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> The <function>xslt_process</function> takes a string containing the XSLT stylesheet as @@ -386,8 +386,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>xslt_run</methodname> <methodparam><type>resource</type><parameter>xh</parameter></methodparam> <methodparam><type>string</type><parameter>xslt_file</parameter></methodparam> @@ -395,8 +395,8 @@ <methodparam><type>string</type><parameter>result</parameter></methodparam> <methodparam><type>array</type><parameter>xslt_params</parameter></methodparam> <methodparam><type>array</type><parameter>xslt_args</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Process the xml_data_file by applying the xslt_file stylesheet to @@ -414,13 +414,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>xslt_set_sax_handler</methodname> <methodparam><type>resource</type><parameter>xh</parameter></methodparam> <methodparam><type>array</type><parameter>handlers</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> Set SAX handlers on the resource handle given by @@ -436,8 +436,8 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>bool</type><methodname>xslt_transform</methodname> <methodparam><type>string</type><parameter>xsl</parameter></methodparam> <methodparam><type>string</type><parameter>xml</parameter></methodparam> @@ -445,8 +445,8 @@ <methodparam><type>string</type><parameter>params</parameter></methodparam> <methodparam><type>string</type><parameter>args</parameter></methodparam> <methodparam><type>string</type><parameter>resultBuffer</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + &warn.experimental.func; <para> The <function>xslt_transform</function> provides an interface to sablotron's Index: phpdoc/en/functions/yaz.xml diff -u phpdoc/en/functions/yaz.xml:1.21.2.2 phpdoc/en/functions/yaz.xml:1.21.2.3 --- phpdoc/en/functions/yaz.xml:1.21.2.2 Sun Nov 11 21:04:38 2001 +++ phpdoc/en/functions/yaz.xml Mon Nov 12 09:59:24 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.21.2.2 $ --> +<!-- $Revision: 1.21.2.3 $ --> <reference id="ref.yaz"> <title>YAZ functions</title> <titleabbrev>YAZ</titleabbrev> @@ -127,12 +127,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>yaz_addinfo</methodname> <methodparam><type>int</type><parameter>id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns additional error message for target (last request). An empty string is returned if last operation was a success or if no @@ -148,12 +148,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>yaz_close</methodname> <methodparam><type>int</type><parameter>id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Closes the Z-association given by <parameter>id</parameter>. The <parameter>id</parameter> is a target ID as returned by a @@ -171,13 +171,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function returns a positive ID on success; zero on failure. @@ -250,12 +250,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>yaz_errno</methodname> <methodparam><type>int</type><parameter>id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns error for target (last request). A positive value is returned if the target returned a diagnostic code; a value of @@ -279,12 +279,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>yaz_error</methodname> <methodparam><type>int</type><parameter>id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns error message for target (last request). An empty string is returned if last operation was a success. @@ -304,12 +304,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>yaz_hits</methodname> <methodparam><type>int</type><parameter>id</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> <function>yaz_hits</function> returns number of hits for last search. @@ -326,13 +326,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function is used in conjunction with <function>yaz_search</function> and <function>yaz_present</function> @@ -355,13 +355,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function specifies one or more databases to be used in search, retrieval, etc. - overriding databases specified in call to @@ -387,14 +387,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function is used in conjunction with <function>yaz_search</function> to specify the maximum number of @@ -416,14 +416,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Returns record at position or empty string if no record exists at given position. @@ -448,14 +448,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>yaz_search</function> prepares for a search on the target with given id. The type represents the query type - only @@ -556,12 +556,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>yaz_present</methodname> <void/> - - </methodsynopsis> + </methodsynopsis> + <para> This function prepares for retrieval of records after a successful search. The <function>yaz_range</function> should @@ -580,13 +580,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -605,15 +605,15 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function prepares for a Z39.50 Scan Request. Argument <parameter>id</parameter> specifies target ID. Starting term @@ -678,13 +678,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Given a target ID this function returns and array with terms as received from the target in the last Scan Response. @@ -708,13 +708,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function configures the CCL query parser for a target with definitions of access points (CCL qualifiers) and their @@ -755,14 +755,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </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 @@ -793,12 +793,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>yaz_itemorder</methodname> <methodparam><type>array</type><parameter>args</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> This function prepares for an Extended Services request using the Profile for the Use of Z39.50 Item Order Extended Service to @@ -920,12 +920,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>yaz_wait</methodname> - <methodparam choice="opt"><type/><parameter>array options</parameter></methodparam> - - </methodsynopsis> + <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 @@ -957,13 +957,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function sets sorting criteria and enables Z39.50 Sort. Use this function together with <function>yaz_search</function> Index: phpdoc/en/functions/zip.xml diff -u phpdoc/en/functions/zip.xml:1.14.2.1 phpdoc/en/functions/zip.xml:1.14.2.2 --- phpdoc/en/functions/zip.xml:1.14.2.1 Sun Nov 11 20:08:55 2001 +++ phpdoc/en/functions/zip.xml Mon Nov 12 09:59:24 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.14.2.1 $ --> +<!-- $Revision: 1.14.2.2 $ --> <reference id="ref.zip"> <title>Zip File Functions (Read Only Access)</title> <titleabbrev>Zip</titleabbrev> @@ -79,12 +79,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>zip_close</methodname> <methodparam><type>resource</type><parameter>zip</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Closes a zip file archive. The parameter <parameter>zip</parameter> must be a zip archive previously @@ -107,12 +107,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>void</type><methodname>zip_entry_close</methodname> <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Closes a directory entry specified by <parameter>zip_entry</parameter>. The parameter @@ -136,12 +136,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>zip_entry_compressedsize</methodname> <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the compressed size of the directory entry specified by <parameter>zip_entry</parameter>. The parameter @@ -164,12 +164,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>zip_entry_compressionmethod</methodname> <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the compression method of the directory entry specified by <parameter>zip_entry</parameter>. The parameter @@ -192,12 +192,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>zip_entry_filesize</methodname> <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the actual size of the directory entry specified by <parameter>zip_entry</parameter>. The parameter @@ -218,12 +218,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>zip_entry_name</methodname> <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the name of the directory entry specified by <parameter>zip_entry</parameter>. The parameter @@ -244,14 +244,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Opens a directory entry in a zip file for reading. The parameter <parameter>zip</parameter> is a valid resource handle returned by @@ -295,13 +295,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Reads up to <parameter>length</parameter> bytes from an open directory entry. If <parameter>length</parameter> is not @@ -335,12 +335,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>resource</type><methodname>zip_open</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Opens a new zip archive for reading. The <parameter>filename</parameter> parameter is the filename of the @@ -366,12 +366,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>resource</type><methodname>zip_read</methodname> <methodparam><type>resource</type><parameter>zip</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Reads the next entry in a zip file archive. The parameter <parameter>zip</parameter> must be a zip archive previously Index: phpdoc/en/functions/zlib.xml diff -u phpdoc/en/functions/zlib.xml:1.19.2.1 phpdoc/en/functions/zlib.xml:1.19.2.2 --- phpdoc/en/functions/zlib.xml:1.19.2.1 Sun Nov 11 20:08:55 2001 +++ phpdoc/en/functions/zlib.xml Mon Nov 12 09:59:24 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.19.2.1 $ --> +<!-- $Revision: 1.19.2.2 $ --> <reference id="ref.zlib"> <title>Zlib Compression Functions</title> <titleabbrev>Zlib</titleabbrev> @@ -85,12 +85,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>gzclose</methodname> <methodparam><type>int</type><parameter>zp</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> The gz-file pointed to by zp is closed. </para> @@ -111,12 +111,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>gzeof</methodname> <methodparam><type>int</type><parameter>zp</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns &true; if the gz-file pointer is at EOF or an error occurs; otherwise returns &false;. @@ -135,13 +135,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Identical to <function>readgzfile</function>, except that <function>gzfile</function> returns the file in an array. @@ -164,12 +164,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>gzgetc</methodname> <methodparam><type>int</type><parameter>zp</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns a string containing a single (uncompressed) character read from the file pointed to by zp. Returns &false; on EOF (as @@ -193,13 +193,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>gzgets</methodname> <methodparam><type>int</type><parameter>zp</parameter></methodparam> <methodparam><type>int</type><parameter>length</parameter></methodparam> - - </methodsynopsis> + </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 @@ -229,14 +229,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Identical to <function>gzgets</function>, except that <function>gzgetss</function> attempts to strip any HTML and PHP @@ -266,14 +266,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Opens a gzip (.gz) file for reading or writing. The mode parameter is as in <function>fopen</function> ("rb" or "wb") but @@ -323,12 +323,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>gzpassthru</methodname> <methodparam><type>int</type><parameter>zp</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Reads to EOF on the given gz-file pointer and writes the (uncompressed) results to standard output. @@ -354,14 +354,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> <function>gzputs</function> is an alias to <function>gzwrite</function>, and is identical in every way. @@ -376,13 +376,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>string</type><methodname>gzread</methodname> <methodparam><type>int</type><parameter>zp</parameter></methodparam> <methodparam><type>int</type><parameter>length</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <simpara> <function>gzread</function> reads up to <parameter>length</parameter> bytes from the gz-file pointer @@ -416,12 +416,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>gzrewind</methodname> <methodparam><type>int</type><parameter>zp</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Sets the file position indicator for zp to the beginning of the file stream. @@ -447,13 +447,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>gzseek</methodname> <methodparam><type>int</type><parameter>zp</parameter></methodparam> <methodparam><type>int</type><parameter>offset</parameter></methodparam> - - </methodsynopsis> + </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) @@ -483,12 +483,12 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <methodsynopsis> <type>int</type><methodname>gztell</methodname> <methodparam><type>int</type><parameter>zp</parameter></methodparam> - - </methodsynopsis> + </methodsynopsis> + <para> Returns the position of the file pointer referenced by <parameter>zp</parameter>; i.e., its offset into the file @@ -515,14 +515,14 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <simpara> <function>gzwrite</function> writes the contents of <parameter>string</parameter> to the gz-file stream pointed to by @@ -552,13 +552,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> Reads a file, decompresses it and writes it to standard output. @@ -597,13 +597,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function returns a compressed version of the input <parameter>data</parameter> using the ZLIB data format, @@ -639,13 +639,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function takes <parameter>data</parameter> compressed by <function>gzcompress</function> and returns the original @@ -670,13 +670,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function returns a compressed version of the input <parameter>data</parameter> using the DEFLATE data format, @@ -706,13 +706,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function takes <parameter>data</parameter> compressed by <function>gzdeflate</function> and returns the original @@ -737,13 +737,13 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - + + <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> + </methodsynopsis> + <para> This function returns a compressed version of the input <parameter>data</parameter> compatible with the output of
« previous php.doc (#969338764) next »