cvs: phpdoc /en/reference/dbplus/functions dbplus-add.xml dbplus-aql.xml dbplus-chdir.xml dbplus-close.xml dbplus-curr.xml dbplus-errcode.xml
dbplus-errno.xml dbplus-find.xml dbplus-first.xml dbplus-flush.xml dbplus-freealllocks.xml dbplus-freelock.xml dbplus-freerlocks.xml
dbplus-getlock.xml dbplus-getunique.xml dbplus-info.xml dbplus-last.xml dbplus-lockrel.xml dbplus-next.xml dbplus-open.xml dbplus-prev.xml
dbplus-rchperm.xml dbplus-rcreate.xml dbplus-rcrtexact.xml dbplus-rcrtlike.xml dbplus-resolve.xml dbplus-restorepos.xml dbplus-rkeys.xml
dbplus-ropen.xml dbplus-rquery.xml dbplus-rrename.xml dbplus-rsecindex.xml dbplus-runlink.xml dbplus-rzap.xml dbplus-savepos.xml dbplus-setindex.xml
dbplus-setindexbynumber.xml dbplus-sql.xml dbplus-tcl.xml dbplus-tremove.xml dbplus-undo.xml dbplus-undoprepare.xml dbplus-unlockrel.xml
dbplus-unselect.xml dbplus-update.xml dbplus-xlockrel.xml dbplus-xunlockrel.xml

didou Sun Mar 4 00:42:25 2007 UTC Modified files: /phpdoc/en/reference/dbplus/functions dbplus-add.xml dbplus-aql.xml dbplus-chdir.xml dbplus-close.xml dbplus-curr.xml dbplus-errcode.xml dbplus-errno.xml dbplus-find.xml dbplus-first.xml dbplus-flush.xml dbplus-freealllocks.xml dbplus-freelock.xml dbplus-freerlocks.xml dbplus-getlock.xml dbplus-getunique.xml dbplus-info.xml dbplus-last.xml dbplus-lockrel.xml dbplus-next.xml dbplus-open.xml dbplus-prev.xml dbplus-rchperm.xml dbplus-rcreate.xml dbplus-rcrtexact.xml dbplus-rcrtlike.xml dbplus-resolve.xml dbplus-restorepos.xml dbplus-rkeys.xml dbplus-ropen.xml dbplus-rquery.xml dbplus-rrename.xml dbplus-rsecindex.xml dbplus-runlink.xml dbplus-rzap.xml dbplus-savepos.xml dbplus-setindex.xml dbplus-setindexbynumber.xml dbplus-sql.xml dbplus-tcl.xml dbplus-tremove.xml dbplus-undo.xml dbplus-undoprepare.xml dbplus-unlockrel.xml dbplus-unselect.xml dbplus-update.xml dbplus-xlockrel.xml dbplus-xunlockrel.xml Log: ref.dbplus: switch to new doc style

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-add.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-add.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-add.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-add.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-add.xml:1.3 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-add.xml Sun Mar 4 00:42:25 2007 @@ -1,35 +1,75 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-add"> <refnamediv> <refname>dbplus_add</refname> <refpurpose>Add a tuple to a relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; + <!-- TODO: Check if tuple should be passed by reference --> <methodsynopsis> <type>int</type><methodname>dbplus_add</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> <methodparam><type>array</type><parameter>tuple</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - This function will add a tuple to a relation. The - <parameter>tuple</parameter> data is an array of attribute/value - pairs to be inserted into the given - <parameter>relation</parameter>. After successful execution the - <parameter>tuple</parameter> array will contain the complete data - of the newly created tuple, including all implicitly set domain - fields like sequences. + Adds a tuple to a <parameter>relation</parameter>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>tuple</parameter></term> + <listitem> + <para> + An array of attribute/value pairs to be inserted into the given + <parameter>relation</parameter>. + </para> + <para> + After successful execution this array will contain the complete data + of the newly created tuple, including all implicitly set domain fields + like sequences. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The function will return zero (aka. DBPLUS_ERR_NOERR) on success - or a db++ error code on failure. See - <function>dbplus_errcode</function> or the introduction to this - chapter for more information on db++ error codes. + The function will return <constant>DBPLUS_ERR_NOERR</constant> on success + or a db++ error code on failure. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbplus_errcode</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-aql.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-aql.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-aql.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-aql.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-aql.xml:1.3 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-aql.xml Sun Mar 4 00:42:25 2007 @@ -1,38 +1,72 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-aql"> <refnamediv> <refname>dbplus_aql</refname> <refpurpose>Perform AQL query</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>dbplus_aql</methodname> <methodparam><type>string</type><parameter>query</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>server</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>dbpath</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_aql</function> will execute an AQL - <parameter>query</parameter> on the given - <parameter>server</parameter> and - <parameter>dbpath</parameter>. + Executes an AQL <parameter>query</parameter> on the given + <parameter>server</parameter> and <parameter>dbpath</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - On success it will return a relation handle. The result data may - be fetched from this relation by calling - <function>dbplus_next</function> and - <function>dbplus_current</function>. Other relation access - functions will not work on a result relation. + <variablelist> + <varlistentry> + <term><parameter>query</parameter></term> + <listitem> + <para> + <!-- TODO: What is A... about? --> + The AQL query to be executed. Further information on the AQL A... + Query Language is provided in the original db++ manual. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>server</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dbpath</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - Further information on the AQL A... Query Language is provided in - the original db++ manual. + Returns a relation handle on success. The result data may be fetched from + this relation by calling <function>dbplus_next</function> and + <function>dbplus_current</function>. Other relation access functions will + not work on a result relation. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-chdir.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-chdir.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-chdir.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-chdir.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-chdir.xml:1.3 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-chdir.xml Sun Mar 4 00:42:25 2007 @@ -1,29 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-chdir"> <refnamediv> <refname>dbplus_chdir</refname> <refpurpose>Get/Set database virtual current directory</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>dbplus_chdir</methodname> <methodparam choice="opt"><type>string</type><parameter>newdir</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_chdir</function> will change the virtual current - directory where relation files will be looked for by - <function>dbplus_open</function>. - <function>dbplus_chdir</function> will return the absolute path - of the current directory. Calling - <function>dbplus_chdir</function> without giving any - <parameter>newdir</parameter> may be used to query the current - working directory. + Changes the virtual current directory where relation files will be looked + for by <function>dbplus_open</function>. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>newdir</parameter></term> + <listitem> + <para> + The new directory for relation files. You can omit this parameter to + query the current working directory. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the absolute path of the current directory. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-close.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-close.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-close.xml:1.5 phpdoc/en/reference/dbplus/functions/dbplus-close.xml:1.6 --- phpdoc/en/reference/dbplus/functions/dbplus-close.xml:1.5 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-close.xml Sun Mar 4 00:42:25 2007 @@ -1,27 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.dbplus-close"> <refnamediv> <refname>dbplus_close</refname> <refpurpose>Close a relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>dbplus_close</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - Calling <function>dbplus_close</function> will close a relation - previously opened by <function>dbplus_open</function>. + Closes a relation previously opened by <function>dbplus_open</function>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> Returns &true; on success or <constant>DBPLUS_ERR_UNKNOWN</constant> on failure. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-curr.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-curr.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-curr.xml:1.5 phpdoc/en/reference/dbplus/functions/dbplus-curr.xml:1.6 --- phpdoc/en/reference/dbplus/functions/dbplus-curr.xml:1.5 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-curr.xml Sun Mar 4 00:42:25 2007 @@ -1,38 +1,75 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.dbplus-curr"> <refnamediv> <refname>dbplus_curr</refname> <refpurpose>Get current tuple from relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_curr</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> <methodparam><type>array</type><parameter role="reference">tuple</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_curr</function> will read the data for the - current tuple for the given <parameter>relation</parameter> and - will pass it back as an associative array in - <parameter>tuple</parameter>. + Reads the data for the current tuple for the given + <parameter>relation</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>tuple</parameter></term> + <listitem> + <para> + The data will be passed back in this parameter, as an associative + array. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> The function will return zero (aka. DBPLUS_ERR_NOERR) on success - or a db++ error code on failure. See - <function>dbplus_errcode</function> or the introduction to this - chapter for more information on db++ error codes. + or a db++ error code on failure. </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>dbplus_first</function>, - <function>dbplus_prev</function>, - <function>dbplus_next</function>, and - <function>dbplus_last</function>. + <simplelist> + <member><function>dbplus_first</function></member> + <member><function>dbplus_prev</function></member> + <member><function>dbplus_next</function></member> + <member><function>dbplus_last</function></member> + <member><function>dbplus_errcode</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-errcode.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-errcode.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-errcode.xml:1.4 phpdoc/en/reference/dbplus/functions/dbplus-errcode.xml:1.5 --- phpdoc/en/reference/dbplus/functions/dbplus-errcode.xml:1.4 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-errcode.xml Sun Mar 4 00:42:25 2007 @@ -1,25 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.dbplus-errcode"> <refnamediv> <refname>dbplus_errcode</refname> <refpurpose>Get error string for given errorcode or last error</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>dbplus_errcode</methodname> <methodparam choice="opt"><type>int</type><parameter>errno</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_errcode</function> returns a cleartext error - string for the error code passed as <parameter>errno</parameter> - of for the result code of the last db++ operation if no parameter - is given. + Returns a clear error string for the given error code. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>errno</parameter></term> + <listitem> + <para> + The error code. If not provided, the result code of the last db++ + operation is assumed. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the error message. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-errno.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-errno.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-errno.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-errno.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-errno.xml:1.3 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-errno.xml Sun Mar 4 00:42:25 2007 @@ -1,26 +1,43 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.10 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-errno"> <refnamediv> <refname>dbplus_errno</refname> <refpurpose>Get error code for last operation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_errno</methodname> <void/> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_errno</function> will return the error code - returned by the last db++ operation. + Returns the error code returned by the last db++ operation. </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>dbplus_errcode</function>. + Returns the error code, as an integer. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbplus_errcode</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-find.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-find.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-find.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-find.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-find.xml:1.3 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-find.xml Sun Mar 4 00:42:25 2007 @@ -1,44 +1,90 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.5 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-find"> <refnamediv> <refname>dbplus_find</refname> <refpurpose>Set a constraint on a relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_find</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> <methodparam><type>array</type><parameter>constraints</parameter></methodparam> <methodparam><type>mixed</type><parameter>tuple</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_find</function> will place a constraint on the - given relation. Further calls to functions like - <function>dbplus_curr</function> or - <function>dbplus_next</function> will only return tuples matching - the given constraints. + Places a constraint on the given <parameter>relation</parameter>. </para> <para> - Constraints are triplets of strings containing of a domain name, - a comparison operator and a comparison value. The - <parameter>constraints</parameter> parameter array may consist of - a collection of string arrays, each of which contains a domain, an - operator and a value, or of a single string array containing a - multiple of three elements. + Further calls to functions like <function>dbplus_curr</function> or + <function>dbplus_next</function> will only return tuples matching the + given constraints. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The comparison operator may be one of the following strings: - '==', '&gt;', '&gt;=', '&lt;', '&lt;=', '!=', '~' for a regular - expression match and 'BAND' or 'BOR' for bitwise operations. + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>constraints</parameter></term> + <listitem> + <para> + Constraints are triplets of strings containing of a domain name, + a comparison operator and a comparison value. The + <parameter>constraints</parameter> parameter array may consist of + a collection of string arrays, each of which contains a domain, an + operator and a value, or of a single string array containing a + multiple of three elements. + </para> + <para> + The comparison operator may be one of the following strings: + '==', '&gt;', '&gt;=', '&lt;', '&lt;=', '!=', '~' for a regular + expression match and 'BAND' or 'BOR' for bitwise operations. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>tuple</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>dbplus_unselect</function>. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbplus_unselect</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-first.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-first.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-first.xml:1.5 phpdoc/en/reference/dbplus/functions/dbplus-first.xml:1.6 --- phpdoc/en/reference/dbplus/functions/dbplus-first.xml:1.5 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-first.xml Sun Mar 4 00:42:25 2007 @@ -1,38 +1,74 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.dbplus-first"> <refnamediv> <refname>dbplus_first</refname> <refpurpose>Get first tuple from relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_first</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> <methodparam><type>array</type><parameter role="reference">tuple</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_curr</function> will read the data for the first - tuple for the given <parameter>relation</parameter>, make it the - current tuple and pass it back as an associative array in - <parameter>tuple</parameter>. + Reads the data for the first tuple for the given + <parameter>relation</parameter>, makes it the current tuple and pass it + back as an associative array in <parameter>tuple</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The function will return zero (aka. DBPLUS_ERR_NOERR) on success - or a db++ error code on failure. See - <function>dbplus_errcode</function> or the introduction to this - chapter for more information on db++ error codes. + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>tuple</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>dbplus_curr</function>, - <function>dbplus_prev</function>, - <function>dbplus_next</function>, and - <function>dbplus_last</function>. + Returns <constant>DBPLUS_ERR_NOERR</constant> on success or a db++ error + code on failure. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbplus_curr</function></member> + <member><function>dbplus_prev</function></member> + <member><function>dbplus_next</function></member> + <member><function>dbplus_last</function></member> + <member><function>dbplus_errcode</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-flush.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-flush.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-flush.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-flush.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-flush.xml:1.3 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-flush.xml Sun Mar 4 00:42:25 2007 @@ -1,29 +1,61 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-flush"> <refnamediv> <refname>dbplus_flush</refname> <refpurpose>Flush all changes made on a relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_flush</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_flush</function> will write all changes applied - to <parameter>relation</parameter> since the last flush to disk. + Writes all changes applied to <parameter>relation</parameter> since the + last flush to disk. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The function will return zero (aka. DBPLUS_ERR_NOERR) on success - or a db++ error code on failure. See - <function>dbplus_errcode</function> or the introduction to this - chapter for more information on db++ error codes. + Returns <constant>DBPLUS_ERR_NOERR</constant> on success or a db++ error + code on failure. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbplus_errcode</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-freealllocks.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-freealllocks.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-freealllocks.xml:1.4 phpdoc/en/reference/dbplus/functions/dbplus-freealllocks.xml:1.5 --- phpdoc/en/reference/dbplus/functions/dbplus-freealllocks.xml:1.4 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-freealllocks.xml Sun Mar 4 00:42:25 2007 @@ -1,28 +1,44 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.10 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.dbplus-freealllocks"> <refnamediv> <refname>dbplus_freealllocks</refname> <refpurpose>Free all locks held by this client</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_freealllocks</methodname> <void/> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_freealllocks</function> will free all tuple locks - held by this client. + Frees all tuple locks held by this client. </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>dbplus_getlock</function>, - <function>dbplus_freelock</function>, and - <function>dbplus_freerlocks</function>. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbplus_getlock</function></member> + <member><function>dbplus_freelock</function></member> + <member><function>dbplus_freerlocks</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-freelock.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-freelock.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-freelock.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-freelock.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-freelock.xml:1.3 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-freelock.xml Sun Mar 4 00:42:25 2007 @@ -1,30 +1,69 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-freelock"> <refnamediv> <refname>dbplus_freelock</refname> <refpurpose>Release write lock on tuple</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_freelock</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> - <methodparam><type>string</type><parameter>tname</parameter></methodparam> + <methodparam><type>string</type><parameter>tuple</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_freelock</function> will release a write lock on - the given <parameter>tuple</parameter> previously obtained by - <function>dbplus_getlock</function>. + Releases a write lock on the given <parameter>tuple</parameter> previously + obtained by <function>dbplus_getlock</function>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>tuple</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>dbplus_getlock</function>, - <function>dbplus_freerlocks</function>, and - <function>dbplus_freealllocks</function>. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbplus_getlock</function></member> + <member><function>dbplus_freerlocks</function></member> + <member><function>dbplus_freealllocks</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-freerlocks.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-freerlocks.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-freerlocks.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-freerlocks.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-freerlocks.xml:1.3 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-freerlocks.xml Sun Mar 4 00:42:25 2007 @@ -1,28 +1,60 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.10 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-freerlocks"> <refnamediv> <refname>dbplus_freerlocks</refname> <refpurpose>Free all tuple locks on given relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_freerlocks</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_freerlocks</function> will free all tuple locks held - on the given <parameter>relation</parameter>. + Frees all tuple locks held on the given <parameter>relation</parameter>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>dbplus_getlock</function>, - <function>dbplus_freelock</function>, and - <function>dbplus_freealllocks</function>. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbplus_getlock</function></member> + <member><function>dbplus_freelock</function></member> + <member><function>dbplus_freealllocks</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-getlock.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-getlock.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-getlock.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-getlock.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-getlock.xml:1.3 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-getlock.xml Sun Mar 4 00:42:25 2007 @@ -1,31 +1,70 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.10 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-getlock"> <refnamediv> <refname>dbplus_getlock</refname> <refpurpose>Get a write lock on a tuple</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_getlock</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> - <methodparam><type>string</type><parameter>tname</parameter></methodparam> + <methodparam><type>string</type><parameter>tuple</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_getlock</function> will request a write lock on - the specified <parameter>tuple</parameter>. It will return zero on - success or a non-zero error code, especially DBPLUS_ERR_WLOCKED, - on failure. + Requests a write lock on the specified <parameter>tuple</parameter>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>tuple</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>dbplus_freelock</function>, - <function>dbplus_freerlocks</function>, and - <function>dbplus_freealllocks</function>. + Returns zero on success or a non-zero error code, especially + <constant>DBPLUS_ERR_WLOCKED</constant> on failure. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbplus_freelock</function></member> + <member><function>dbplus_freerlocks</function></member> + <member><function>dbplus_freealllocks</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-getunique.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-getunique.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-getunique.xml:1.4 phpdoc/en/reference/dbplus/functions/dbplus-getunique.xml:1.5 --- phpdoc/en/reference/dbplus/functions/dbplus-getunique.xml:1.4 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-getunique.xml Sun Mar 4 00:42:25 2007 @@ -1,32 +1,61 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.dbplus-getunique"> <refnamediv> <refname>dbplus_getunique</refname> <refpurpose>Get an id number unique to a relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_getunique</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> <methodparam><type>int</type><parameter>uniqueid</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_getunique</function> will obtain a number - guaranteed to be unique for the given - <parameter>relation</parameter> and will pass it back in the - variable given as <parameter>uniqueid</parameter>. + Obtains a number guaranteed to be unique for the given + <parameter>relation</parameter> and will pass it back in the variable + given as <parameter>uniqueid</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The function will return zero (aka. DBPLUS_ERR_NOERR) on success - or a db++ error code on failure. See - <function>dbplus_errcode</function> or the introduction to this - chapter for more information on db++ error codes. + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>uniqueid</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns <constant>DBPLUS_ERR_NOERR</constant> on success or a db++ error + code on failure. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-info.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-info.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-info.xml:1.6 phpdoc/en/reference/dbplus/functions/dbplus-info.xml:1.7 --- phpdoc/en/reference/dbplus/functions/dbplus-info.xml:1.6 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-info.xml Sun Mar 4 00:42:25 2007 @@ -1,22 +1,57 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.dbplus-info"> <refnamediv> <refname>dbplus_info</refname> <refpurpose>Get information about a relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <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 role="reference">result</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; &warn.undocumented.func; </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>key</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>result</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-last.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-last.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-last.xml:1.5 phpdoc/en/reference/dbplus/functions/dbplus-last.xml:1.6 --- phpdoc/en/reference/dbplus/functions/dbplus-last.xml:1.5 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-last.xml Sun Mar 4 00:42:25 2007 @@ -1,38 +1,73 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.dbplus-last"> <refnamediv> <refname>dbplus_last</refname> <refpurpose>Get last tuple from relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_last</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> <methodparam><type>array</type><parameter role="reference">tuple</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_curr</function> will read the data for the last - tuple for the given <parameter>relation</parameter>, make it the - current tuple and pass it back as an associative array in - <parameter>tuple</parameter>. + Reads the data for the last tuple for the given + <parameter>relation</parameter>, makes it the current tuple and pass it + back as an associative array in <parameter>tuple</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The function will return zero (aka. DBPLUS_ERR_NOERR) on success - or a db++ error code on failure. See - <function>dbplus_errcode</function> or the introduction to this - chapter for more information on db++ error codes. + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>tuple</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>dbplus_first</function>, - <function>dbplus_curr</function>, - <function>dbplus_prev</function>, and - <function>dbplus_next</function>. + Returns <constant>DBPLUS_ERR_NOERR</constant> on success or a db++ error + code on failure. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbplus_first</function></member> + <member><function>dbplus_curr</function></member> + <member><function>dbplus_prev</function></member> + <member><function>dbplus_next</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-lockrel.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-lockrel.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-lockrel.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-lockrel.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-lockrel.xml:1.3 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-lockrel.xml Sun Mar 4 00:42:25 2007 @@ -1,24 +1,53 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-lockrel"> <refnamediv> <refname>dbplus_lockrel</refname> <refpurpose>Request write lock on relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_lockrel</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_lockrel</function> will request a write lock - on the given relation. Other clients may still query the - relation, but can't alter it while it is locked. + Requests a write lock on the given <parameter>relation</parameter>. + </para> + <para> + Other clients may still query the relation, but can't alter it while it is + locked. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-next.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-next.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-next.xml:1.5 phpdoc/en/reference/dbplus/functions/dbplus-next.xml:1.6 --- phpdoc/en/reference/dbplus/functions/dbplus-next.xml:1.5 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-next.xml Sun Mar 4 00:42:25 2007 @@ -1,38 +1,73 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.dbplus-next"> <refnamediv> <refname>dbplus_next</refname> <refpurpose>Get next tuple from relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_next</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> <methodparam><type>array</type><parameter role="reference">tuple</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_curr</function> will read the data for the next - tuple for the given <parameter>relation</parameter>, will make it - the current tuple and will pass it back as an associative array - in <parameter>tuple</parameter>. + Reads the data for the next tuple for the given + <parameter>relation</parameter>, makes it the current tuple and will pass + it back as an associative array in <parameter>tuple</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The function will return zero (aka. DBPLUS_ERR_NOERR) on success - or a db++ error code on failure. See - <function>dbplus_errcode</function> or the introduction to this - chapter for more information on db++ error codes. + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>tuple</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>dbplus_first</function>, - <function>dbplus_curr</function>, - <function>dbplus_prev</function>, and - <function>dbplus_last</function>. + Returns <constant>DBPLUS_ERR_NOERR</constant> on success or a db++ error + code on failure. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbplus_first</function></member> + <member><function>dbplus_curr</function></member> + <member><function>dbplus_prev</function></member> + <member><function>dbplus_last</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-open.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-open.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-open.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-open.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-open.xml:1.3 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-open.xml Sun Mar 4 00:42:25 2007 @@ -1,25 +1,42 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-open"> <refnamediv> <refname>dbplus_open</refname> <refpurpose>Open relation file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>dbplus_open</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - The relation file <parameter>name</parameter> will be opened. - <parameter>name</parameter> can be either a file name or a - relative or absolute path name. This will be mapped in any case - to an absolute relation file path on a specific host machine and - server. + Opens the given relation file. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>name</parameter></term> + <listitem> + <para> + Can be either a file name or a relative or absolute path name. This + will be mapped in any case to an absolute relation file path on a + specific host machine and server. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> On success a relation file resource (cursor) is returned which must be used in any subsequent commands referencing the relation. @@ -27,6 +44,12 @@ be asked for by calling <function>dbplus_errno</function>. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-prev.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-prev.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-prev.xml:1.6 phpdoc/en/reference/dbplus/functions/dbplus-prev.xml:1.7 --- phpdoc/en/reference/dbplus/functions/dbplus-prev.xml:1.6 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-prev.xml Sun Mar 4 00:42:25 2007 @@ -1,38 +1,73 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.dbplus-prev"> <refnamediv> <refname>dbplus_prev</refname> <refpurpose>Get previous tuple from relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_prev</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> <methodparam><type>array</type><parameter role="reference">tuple</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_curr</function> will read the data for the previous - tuple for the given <parameter>relation</parameter>, will make it - the current tuple and will pass it back as an associative array - in <parameter>tuple</parameter>. + Reads the data for the previous tuple for the given + <parameter>relation</parameter>, makes it the current tuple and will pass + it back as an associative array in <parameter>tuple</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The function will return zero (aka. DBPLUS_ERR_NOERR) on success - or a db++ error code on failure. See - <function>dbplus_errcode</function> or the introduction to this - chapter for more information on db++ error codes. + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>tuple</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>dbplus_first</function>, - <function>dbplus_curr</function>, - <function>dbplus_next</function>, and - <function>dbplus_last</function>. + Returns <constant>DBPLUS_ERR_NOERR</constant> on success or a db++ error + code on failure. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbplus_first</function></member> + <member><function>dbplus_curr</function></member> + <member><function>dbplus_next</function></member> + <member><function>dbplus_last</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-rchperm.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-rchperm.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-rchperm.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-rchperm.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-rchperm.xml:1.3 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-rchperm.xml Sun Mar 4 00:42:25 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-rchperm"> <refnamediv> <refname>dbplus_rchperm</refname> <refpurpose>Change relation permissions</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_rchperm</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> @@ -15,14 +15,61 @@ <methodparam><type>string</type><parameter>user</parameter></methodparam> <methodparam><type>string</type><parameter>group</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_rchperm</function> will change access - permissions as specified by <parameter>mask</parameter>, + Changes access permissions as specified by <parameter>mask</parameter>, <parameter>user</parameter> and <parameter>group</parameter>. The values for these are operating system specific. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mask</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>user</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>group</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-rcreate.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-rcreate.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-rcreate.xml:1.4 phpdoc/en/reference/dbplus/functions/dbplus-rcreate.xml:1.5 --- phpdoc/en/reference/dbplus/functions/dbplus-rcreate.xml:1.4 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-rcreate.xml Sun Mar 4 00:42:25 2007 @@ -1,39 +1,84 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.dbplus-rcreate"> <refnamediv> <refname>dbplus_rcreate</refname> <refpurpose>Creates a new DB++ relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <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>bool</type><parameter>overwrite</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_rcreate</function> will create a new relation - named <parameter>name</parameter>. An existing relation by the - same name will only be overwritten if the relation is currently - not in use and <parameter>overwrite</parameter> is set to TRUE. + Creates a new relation. Any existing relation sharing the same + <parameter>name</parameter> will be overwritten if the relation is + currently not in use and <parameter>overwrite</parameter> is set to TRUE. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>name</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>domlist</parameter></term> + <listitem> + <para> + A combination of domains. May be passed as a single domain name string + or as an array of domain names. + </para> + <para> + This parameter should contain the domain specification for the new + relation within an array of domain description strings. ( <function>dbplus_rcreate</function> will + also accept a string with space delimited domain description + strings, but it is recommended to use an array). A domain + description string consists of a domain name unique to this + relation, a slash and a type specification character. See the + db++ documentation, especially the dbcreate(1) manpage, for a + description of available type specifiers and their meanings. + </para> + <note> + <para> + This function will also accept a string with space delimited domain + description strings, but it is recommended to use an array + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>overwrite</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>domlist</parameter> should contain the domain - specification for the new relation within an array of domain - description strings. ( <function>dbplus_rcreate</function> will - also accept a string with space delimited domain description - strings, but it is recommended to use an array). A domain - description string consists of a domain name unique to this - relation, a slash and a type specification character. See the - db++ documentation, especially the dbcreate(1) manpage, for a - description of available type specifiers and their meanings. </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-rcrtexact.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-rcrtexact.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-rcrtexact.xml:1.7 phpdoc/en/reference/dbplus/functions/dbplus-rcrtexact.xml:1.8 --- phpdoc/en/reference/dbplus/functions/dbplus-rcrtexact.xml:1.7 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-rcrtexact.xml Sun Mar 4 00:42:25 2007 @@ -1,33 +1,72 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.dbplus-rcrtexact"> <refnamediv> <refname>dbplus_rcrtexact</refname> <refpurpose>Creates an exact but empty copy of a relation including indices</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>dbplus_rcrtexact</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>overwrite</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> <function>dbplus_rcrtexact</function> will create an exact but empty copy of the given <parameter>relation</parameter> under a - new <parameter>name</parameter>. An existing relation by the same - <parameter>name</parameter> will only be overwritten if - <parameter>overwrite</parameter> is &true; and no other process is - currently using the relation. + new <parameter>name</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>name</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + The copied relation, opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>overwrite</parameter></term> + <listitem> + <para> + An existing relation by the same <parameter>name</parameter> will only + be overwritten if this parameter is set to &true; and no other process + is currently using the relation. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> Returns resource on success or <constant>DBPLUS_ERR_UNKNOWN</constant> on failure. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-rcrtlike.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-rcrtlike.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-rcrtlike.xml:1.5 phpdoc/en/reference/dbplus/functions/dbplus-rcrtlike.xml:1.6 --- phpdoc/en/reference/dbplus/functions/dbplus-rcrtlike.xml:1.5 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-rcrtlike.xml Sun Mar 4 00:42:25 2007 @@ -1,33 +1,72 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.dbplus-rcrtlike"> <refnamediv> <refname>dbplus_rcrtlike</refname> <refpurpose>Creates an empty copy of a relation with default indices</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>dbplus_rcrtlike</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>overwrite</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> <function>dbplus_rcrtexact</function> will create an empty copy of the given <parameter>relation</parameter> under a new - <parameter>name</parameter>, but with default indices. An - existing relation by the same <parameter>name</parameter> will - only be overwritten if <parameter>overwrite</parameter> is &true; - and no other process is currently using the relation. + <parameter>name</parameter>, but with default indices. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>name</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + The copied relation, opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>overwrite</parameter></term> + <listitem> + <para> + An existing relation by the same <parameter>name</parameter> will only + be overwritten if this parameter is set to &true; and no other process + is currently using the relation. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> Returns resource on success or <constant>DBPLUS_ERR_UNKNOWN</constant> on failure. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-resolve.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-resolve.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-resolve.xml:1.4 phpdoc/en/reference/dbplus/functions/dbplus-resolve.xml:1.5 --- phpdoc/en/reference/dbplus/functions/dbplus-resolve.xml:1.4 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-resolve.xml Sun Mar 4 00:42:25 2007 @@ -1,29 +1,63 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.dbplus-resolve"> <refnamediv> <refname>dbplus_resolve</refname> <refpurpose>Resolve host information for relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>dbplus_resolve</methodname> <methodparam><type>string</type><parameter>relation_name</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> <function>dbplus_resolve</function> will try to resolve the given <parameter>relation_name</parameter> and find out internal server - id, real hostname and the database path on this host. The - function will return an array containing these values under the - keys 'sid', 'host' and 'host_path' or &false; on error. + id, real hostname and the database path on this host. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation_name</parameter></term> + <listitem> + <para> + The relation name. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>dbplus_tcl</function>. + Returns an array containing these values under the keys + <literal>sid</literal>, <literal>host</literal> and + <literal>host_path</literal> or &false; on error. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbplus_tcl</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-restorepos.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-restorepos.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-restorepos.xml:1.4 phpdoc/en/reference/dbplus/functions/dbplus-restorepos.xml:1.5 --- phpdoc/en/reference/dbplus/functions/dbplus-restorepos.xml:1.4 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-restorepos.xml Sun Mar 4 00:42:25 2007 @@ -1,21 +1,55 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.dbplus-restorepos"> <refnamediv> <refname>dbplus_restorepos</refname> <refpurpose>Restore position</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_restorepos</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> <methodparam><type>array</type><parameter>tuple</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; &warn.undocumented.func; </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>tuple</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-rkeys.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-rkeys.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-rkeys.xml:1.4 phpdoc/en/reference/dbplus/functions/dbplus-rkeys.xml:1.5 --- phpdoc/en/reference/dbplus/functions/dbplus-rkeys.xml:1.4 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-rkeys.xml Sun Mar 4 00:42:25 2007 @@ -1,33 +1,63 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.dbplus-rkeys"> <refnamediv> <refname>dbplus_rkeys</refname> <refpurpose>Specify new primary key for a relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>dbplus_rkeys</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> <methodparam><type>mixed</type><parameter>domlist</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> <function>dbplus_rkeys</function> will replace the current primary key for <parameter>relation</parameter> with the combination of domains specified by <parameter>domlist</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>domlist</parameter> may be passed as a single domain name - string or as an array of domain names. + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>domlist</parameter></term> + <listitem> + <para> + A combination of domains. May be passed as a single domain name + string or as an array of domain names. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> Returns resource on success or <constant>DBPLUS_ERR_UNKNOWN</constant> on failure. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-ropen.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-ropen.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-ropen.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-ropen.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-ropen.xml:1.3 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-ropen.xml Sun Mar 4 00:42:25 2007 @@ -1,18 +1,17 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-ropen"> <refnamediv> <refname>dbplus_ropen</refname> <refpurpose>Open relation file local</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>dbplus_ropen</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> <function>dbplus_ropen</function> will open the relation <parameter>file</parameter> locally for quick access without any @@ -22,6 +21,33 @@ relation. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>name</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-rquery.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-rquery.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-rquery.xml:1.5 phpdoc/en/reference/dbplus/functions/dbplus-rquery.xml:1.6 --- phpdoc/en/reference/dbplus/functions/dbplus-rquery.xml:1.5 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-rquery.xml Sun Mar 4 00:42:25 2007 @@ -1,19 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.dbplus-rquery"> <refnamediv> <refname>dbplus_rquery</refname> <refpurpose>Perform local (raw) AQL query</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>dbplus_rquery</methodname> <methodparam><type>string</type><parameter>query</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>dbpath</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> <function>dbplus_rquery</function> performs a local (raw) AQL query using an AQL interpreter embedded into the db++ client @@ -21,6 +20,40 @@ <function>dbplus_aql</function> but will work on local data only. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>query</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dbpath</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-rrename.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-rrename.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-rrename.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-rrename.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-rrename.xml:1.3 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-rrename.xml Sun Mar 4 00:42:25 2007 @@ -1,24 +1,58 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-rrename"> <refnamediv> <refname>dbplus_rrename</refname> <refpurpose>Rename a relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_rrename</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> <function>dbplus_rrename</function> will change the name of <parameter>relation</parameter> to <parameter>name</parameter>. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>name</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-rsecindex.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-rsecindex.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-rsecindex.xml:1.4 phpdoc/en/reference/dbplus/functions/dbplus-rsecindex.xml:1.5 --- phpdoc/en/reference/dbplus/functions/dbplus-rsecindex.xml:1.4 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-rsecindex.xml Sun Mar 4 00:42:25 2007 @@ -1,35 +1,72 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.dbplus-rsecindex"> <refnamediv> <refname>dbplus_rsecindex</refname> <refpurpose>Create a new secondary index for a relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>dbplus_rsecindex</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> <methodparam><type>mixed</type><parameter>domlist</parameter></methodparam> <methodparam><type>int</type><parameter>type</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> <function>dbplus_rsecindex</function> will create a new secondary index for <parameter>relation</parameter> with consists of the domains specified by <parameter>domlist</parameter> and is of type <parameter>type</parameter> </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>domlist</parameter> may be passed as a single domain name - string or as an array of domain names. + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>domlist</parameter></term> + <listitem> + <para> + A combination of domains. May be passed as a single domain name + string or as an array of domain names. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>type</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> Returns resource on success or <constant>DBPLUS_ERR_UNKNOWN</constant> on failure. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-runlink.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-runlink.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-runlink.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-runlink.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-runlink.xml:1.3 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-runlink.xml Sun Mar 4 00:42:25 2007 @@ -1,23 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-runlink"> <refnamediv> <refname>dbplus_runlink</refname> <refpurpose>Remove relation from filesystem</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_runlink</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> <function>dbplus_unlink</function> will close and remove the <parameter>relation</parameter>. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-rzap.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-rzap.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-rzap.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-rzap.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-rzap.xml:1.3 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-rzap.xml Sun Mar 4 00:42:25 2007 @@ -1,23 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-rzap"> <refnamediv> <refname>dbplus_rzap</refname> <refpurpose>Remove all tuples from relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_rzap</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> <function>dbplus_rzap</function> will remove all tuples from <parameter>relation</parameter>. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-savepos.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-savepos.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-savepos.xml:1.4 phpdoc/en/reference/dbplus/functions/dbplus-savepos.xml:1.5 --- phpdoc/en/reference/dbplus/functions/dbplus-savepos.xml:1.4 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-savepos.xml Sun Mar 4 00:42:25 2007 @@ -1,20 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.dbplus-savepos"> <refnamediv> <refname>dbplus_savepos</refname> <refpurpose>Save position</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_savepos</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; &warn.undocumented.func; </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-setindex.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-setindex.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-setindex.xml:1.4 phpdoc/en/reference/dbplus/functions/dbplus-setindex.xml:1.5 --- phpdoc/en/reference/dbplus/functions/dbplus-setindex.xml:1.4 Sun Mar 4 00:37:55 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-setindex.xml Sun Mar 4 00:42:25 2007 @@ -1,21 +1,55 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.dbplus-setindex"> <refnamediv> <refname>dbplus_setindex</refname> <refpurpose>Set index</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_setindex</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> <methodparam><type>string</type><parameter>idx_name</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; &warn.undocumented.func; </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>idx_name</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-setindexbynumber.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-setindexbynumber.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-setindexbynumber.xml:1.4 phpdoc/en/reference/dbplus/functions/dbplus-setindexbynumber.xml:1.5 --- phpdoc/en/reference/dbplus/functions/dbplus-setindexbynumber.xml:1.4 Sun Mar 4 00:37:56 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-setindexbynumber.xml Sun Mar 4 00:42:25 2007 @@ -1,21 +1,55 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.dbplus-setindexbynumber"> <refnamediv> <refname>dbplus_setindexbynumber</refname> <refpurpose>Set index by number</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_setindexbynumber</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> <methodparam><type>int</type><parameter>idx_number</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; &warn.undocumented.func; </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>idx_number</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-sql.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-sql.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-sql.xml:1.5 phpdoc/en/reference/dbplus/functions/dbplus-sql.xml:1.6 --- phpdoc/en/reference/dbplus/functions/dbplus-sql.xml:1.5 Sun Mar 4 00:37:56 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-sql.xml Sun Mar 4 00:42:25 2007 @@ -1,22 +1,62 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.dbplus-sql"> <refnamediv> <refname>dbplus_sql</refname> <refpurpose>Perform SQL query</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>dbplus_sql</methodname> <methodparam><type>string</type><parameter>query</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>server</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>dbpath</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; &warn.undocumented.func; </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>query</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>server</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dbpath</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-tcl.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-tcl.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-tcl.xml:1.4 phpdoc/en/reference/dbplus/functions/dbplus-tcl.xml:1.5 --- phpdoc/en/reference/dbplus/functions/dbplus-tcl.xml:1.4 Sun Mar 4 00:37:56 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-tcl.xml Sun Mar 4 00:42:25 2007 @@ -1,19 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.dbplus-tcl"> <refnamediv> <refname>dbplus_tcl</refname> <refpurpose>Execute TCL code on server side</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>dbplus_tcl</methodname> <methodparam><type>int</type><parameter>sid</parameter></methodparam> <methodparam><type>string</type><parameter>script</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> A db++ server will prepare a TCL interpreter for each client connection. This interpreter will enable the server to execute @@ -28,10 +27,50 @@ this connection id. The function will return whatever the TCL code returns or a TCL error message if the TCL code fails. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>sid</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>script</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>dbplus_resolve</function>. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbplus_resolve</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-tremove.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-tremove.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-tremove.xml:1.5 phpdoc/en/reference/dbplus/functions/dbplus-tremove.xml:1.6 --- phpdoc/en/reference/dbplus/functions/dbplus-tremove.xml:1.5 Sun Mar 4 00:37:56 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-tremove.xml Sun Mar 4 00:42:25 2007 @@ -1,20 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.dbplus-tremove"> <refnamediv> <refname>dbplus_tremove</refname> <refpurpose>Remove tuple and return new current tuple</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <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 role="reference">current</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> <function>dbplus_tremove</function> removes <parameter>tuple</parameter> from <parameter>relation</parameter> @@ -24,6 +23,48 @@ <function>dbplus_tremove</function>. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>tuple</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>current</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-undo.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-undo.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-undo.xml:1.4 phpdoc/en/reference/dbplus/functions/dbplus-undo.xml:1.5 --- phpdoc/en/reference/dbplus/functions/dbplus-undo.xml:1.4 Sun Mar 4 00:37:56 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-undo.xml Sun Mar 4 00:42:25 2007 @@ -1,20 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.dbplus-undo"> <refnamediv> <refname>dbplus_undo</refname> <refpurpose>Undo</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_undo</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; &warn.undocumented.func; </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-undoprepare.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-undoprepare.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-undoprepare.xml:1.4 phpdoc/en/reference/dbplus/functions/dbplus-undoprepare.xml:1.5 --- phpdoc/en/reference/dbplus/functions/dbplus-undoprepare.xml:1.4 Sun Mar 4 00:37:56 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-undoprepare.xml Sun Mar 4 00:42:25 2007 @@ -1,20 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.dbplus-undoprepare"> <refnamediv> <refname>dbplus_undoprepare</refname> <refpurpose>Prepare undo</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_undoprepare</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; &warn.undocumented.func; </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-unlockrel.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-unlockrel.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-unlockrel.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-unlockrel.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-unlockrel.xml:1.3 Sun Mar 4 00:37:56 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-unlockrel.xml Sun Mar 4 00:42:25 2007 @@ -1,23 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-unlockrel"> <refnamediv> <refname>dbplus_unlockrel</refname> <refpurpose>Give up write lock on relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_unlockrel</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_unlockrel</function> will release a write lock - previously obtained by <function>dbplus_lockrel</function>. + Release a write lock previously obtained by + <function>dbplus_lockrel</function>. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-unselect.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-unselect.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-unselect.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-unselect.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-unselect.xml:1.3 Sun Mar 4 00:37:56 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-unselect.xml Sun Mar 4 00:42:25 2007 @@ -1,24 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-unselect"> <refnamediv> <refname>dbplus_unselect</refname> <refpurpose>Remove a constraint from relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_unselect</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> Calling <function>dbplus_unselect</function> will remove a constraint previously set by <function>dbplus_find</function> on <parameter>relation</parameter>. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-update.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-update.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-update.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-update.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-update.xml:1.3 Sun Mar 4 00:37:56 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-update.xml Sun Mar 4 00:42:25 2007 @@ -1,28 +1,70 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-update"> <refnamediv> <refname>dbplus_update</refname> <refpurpose>Update specified tuple in relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_update</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> <methodparam><type>array</type><parameter>old</parameter></methodparam> <methodparam><type>array</type><parameter>new</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_update</function> replaces the tuple given by - <parameter>old</parameter> with the data from - <parameter>new</parameter> if and only if + <function>dbplus_update</function> replaces the <parameter>old</parameter> + tuple with the data from the <parameter>new</parameter> one, only if the <parameter>old</parameter> completely matches a tuple within <parameter>relation</parameter>. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>old</parameter></term> + <listitem> + <para> + The old tuple. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>new</parameter></term> + <listitem> + <para> + The new tuple. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-xlockrel.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-xlockrel.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-xlockrel.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-xlockrel.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-xlockrel.xml:1.3 Sun Mar 4 00:37:56 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-xlockrel.xml Sun Mar 4 00:42:25 2007 @@ -1,27 +1,59 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-xlockrel"> <refnamediv> <refname>dbplus_xlockrel</refname> <refpurpose>Request exclusive lock on relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_xlockrel</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_xlockrel</function> will request an exclusive - lock on <parameter>relation</parameter> preventing even read - access from other clients. + Request an exclusive lock on <parameter>relation</parameter> preventing + even read access from other clients. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>dbplus_xunlockrel</function>. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dbplus_xunlockrel</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/dbplus/functions/dbplus-xunlockrel.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/dbplus/functions/dbplus-xunlockrel.xml diff -u phpdoc/en/reference/dbplus/functions/dbplus-xunlockrel.xml:1.3 phpdoc/en/reference/dbplus/functions/dbplus-xunlockrel.xml:1.4 --- phpdoc/en/reference/dbplus/functions/dbplus-xunlockrel.xml:1.3 Sun Mar 4 00:37:56 2007 +++ phpdoc/en/reference/dbplus/functions/dbplus-xunlockrel.xml Sun Mar 4 00:42:25 2007 @@ -1,24 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.dbplus-xunlockrel"> <refnamediv> <refname>dbplus_xunlockrel</refname> <refpurpose>Free exclusive lock on relation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>dbplus_xunlockrel</methodname> <methodparam><type>resource</type><parameter>relation</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; <para> - <function>dbplus_xunlockrel</function> will release an exclusive - lock on <parameter>relation</parameter> previously obtained by + Releases an exclusive lock previously obtained by <function>dbplus_xlockrel</function>. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>relation</parameter></term> + <listitem> + <para> + A relation opened by <function>dbplus_open</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &warn.experimental.func; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file