cvs: phpdoc /en/reference/dba/functions dba-close.xml dba-delete.xml dba-exists.xml dba-fetch.xml dba-firstkey.xml dba-handlers.xml dba-insert.xml
dba-key-split.xml dba-list.xml dba-nextkey.xml dba-open.xml dba-optimize.xml dba-popen.xml dba-replace.xml dba-sync.xml

didou Sat Feb 5 22:06:33 2005 EDT Modified files: /phpdoc/en/reference/dba/functions dba-close.xml dba-delete.xml dba-exists.xml dba-fetch.xml dba-firstkey.xml dba-handlers.xml dba-insert.xml dba-key-split.xml dba-list.xml dba-nextkey.xml dba-open.xml dba-optimize.xml dba-popen.xml dba-replace.xml dba-sync.xml Log: WS (start at col 0)

http://cvs.php.net/diff.php/phpdoc/en/reference/dba/functions/dba-close.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/dba/functions/dba-close.xml diff -u phpdoc/en/reference/dba/functions/dba-close.xml:1.5 phpdoc/en/reference/dba/functions/dba-close.xml:1.6 --- phpdoc/en/reference/dba/functions/dba-close.xml:1.5 Sun Jan 30 19:21:23 2005 +++ phpdoc/en/reference/dba/functions/dba-close.xml Sat Feb 5 22:06:33 2005 @@ -1,53 +1,53 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> - <refentry id="function.dba-close"> - <refnamediv> - <refname>dba_close</refname> - <refpurpose>Close a DBA database</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>void</type><methodname>dba_close</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - </methodsynopsis> - <para> - <function>dba_close</function> closes the established database and frees - all resources of the specified database handle. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>handle</parameter></term> - <listitem> - <para> - The database handler, returned by <function>dba_open</function> or - <function>dba_popen</function>. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - &return.void; - </para> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>dba_open</function></member> - <member><function>dba_popen</function></member> - </simplelist> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id="function.dba-close"> + <refnamediv> + <refname>dba_close</refname> + <refpurpose>Close a DBA database</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>void</type><methodname>dba_close</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> + <para> + <function>dba_close</function> closes the established database and frees + all resources of the specified database handle. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + The database handler, returned by <function>dba_open</function> or + <function>dba_popen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dba_open</function></member> + <member><function>dba_popen</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/dba/functions/dba-delete.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/dba/functions/dba-delete.xml diff -u phpdoc/en/reference/dba/functions/dba-delete.xml:1.5 phpdoc/en/reference/dba/functions/dba-delete.xml:1.6 --- phpdoc/en/reference/dba/functions/dba-delete.xml:1.5 Sun Jan 30 19:21:24 2005 +++ phpdoc/en/reference/dba/functions/dba-delete.xml Sat Feb 5 22:06:33 2005 @@ -1,63 +1,63 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> - <refentry id="function.dba-delete"> - <refnamediv> - <refname>dba_delete</refname> - <refpurpose>Delete DBA entry specified by key</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>dba_delete</methodname> - <methodparam><type>string</type><parameter>key</parameter></methodparam> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - </methodsynopsis> - <para> - <function>dba_delete</function> deletes the specified entry from the database. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>key</parameter></term> - <listitem> - <para> - The key of the entry which is deleted. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>handle</parameter></term> - <listitem> - <para> - The database handler, returned by <function>dba_open</function> or - <function>dba_popen</function>. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - &return.success; - </para> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>dba_exists</function></member> - <member><function>dba_fetch</function></member> - <member><function>dba_insert</function></member> - <member><function>dba_replace</function></member> - </simplelist> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id="function.dba-delete"> + <refnamediv> + <refname>dba_delete</refname> + <refpurpose>Delete DBA entry specified by key</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>dba_delete</methodname> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> + <para> + <function>dba_delete</function> deletes the specified entry from the database. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>key</parameter></term> + <listitem> + <para> + The key of the entry which is deleted. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + The database handler, returned by <function>dba_open</function> or + <function>dba_popen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dba_exists</function></member> + <member><function>dba_fetch</function></member> + <member><function>dba_insert</function></member> + <member><function>dba_replace</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/dba/functions/dba-exists.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/dba/functions/dba-exists.xml diff -u phpdoc/en/reference/dba/functions/dba-exists.xml:1.4 phpdoc/en/reference/dba/functions/dba-exists.xml:1.5 --- phpdoc/en/reference/dba/functions/dba-exists.xml:1.4 Sun Jan 30 19:21:24 2005 +++ phpdoc/en/reference/dba/functions/dba-exists.xml Sat Feb 5 22:06:33 2005 @@ -1,64 +1,64 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> - <refentry id="function.dba-exists"> - <refnamediv> - <refname>dba_exists</refname> - <refpurpose>Check whether key exists</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>dba_exists</methodname> - <methodparam><type>string</type><parameter>key</parameter></methodparam> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - </methodsynopsis> - <para> - <function>dba_exists</function> checks whether the specified - <parameter>key</parameter> exists in the database. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>key</parameter></term> - <listitem> - <para> - The key the check is performed for. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>handle</parameter></term> - <listitem> - <para> - The database handler, returned by <function>dba_open</function> or - <function>dba_popen</function>. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; if the key exists, &false; otherwise. - </para> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>dba_delete</function></member> - <member><function>dba_fetch</function></member> - <member><function>dba_insert</function></member> - <member><function>dba_replace</function></member> - </simplelist> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.5 $ --> +<refentry id="function.dba-exists"> + <refnamediv> + <refname>dba_exists</refname> + <refpurpose>Check whether key exists</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>dba_exists</methodname> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> + <para> + <function>dba_exists</function> checks whether the specified + <parameter>key</parameter> exists in the database. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>key</parameter></term> + <listitem> + <para> + The key the check is performed for. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + The database handler, returned by <function>dba_open</function> or + <function>dba_popen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if the key exists, &false; otherwise. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dba_delete</function></member> + <member><function>dba_fetch</function></member> + <member><function>dba_insert</function></member> + <member><function>dba_replace</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/dba/functions/dba-fetch.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/dba/functions/dba-fetch.xml diff -u phpdoc/en/reference/dba/functions/dba-fetch.xml:1.8 phpdoc/en/reference/dba/functions/dba-fetch.xml:1.9 --- phpdoc/en/reference/dba/functions/dba-fetch.xml:1.8 Mon Jan 31 07:35:36 2005 +++ phpdoc/en/reference/dba/functions/dba-fetch.xml Sat Feb 5 22:06:33 2005 @@ -1,114 +1,114 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> - <refentry id="function.dba-fetch"> - <refnamediv> - <refname>dba_fetch</refname> - <refpurpose>Fetch data specified by key</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>string</type><methodname>dba_fetch</methodname> - <methodparam><type>string</type><parameter>key</parameter></methodparam> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - </methodsynopsis> - <methodsynopsis> - <type>string</type><methodname>dba_fetch</methodname> - <methodparam><type>string</type><parameter>key</parameter></methodparam> - <methodparam><type>int</type><parameter>skip</parameter></methodparam> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - </methodsynopsis> - <para> - <function>dba_fetch</function> fetches the data specified by - <parameter>key</parameter> from the database specified with - <parameter>handle</parameter>. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>key</parameter></term> - <listitem> - <para> - The key the data is specified by. - </para> - <note> - <para> - When working with inifiles this function accepts arrays as keys - where index 0 is the group and index 1 is the value name. See: - <function>dba_key_split</function>. - </para> - </note> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>skip</parameter></term> - <listitem> - <para> - The number of key-value pairs to ignore when using cdb databases. - This value is ignored for all other databases which do not support - multiple keys with the same name. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>handle</parameter></term> - <listitem> - <para> - The database handler, returned by <function>dba_open</function> or - <function>dba_popen</function>. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the associated string if the key/data pair is found, &false; - otherwise. - </para> - </refsect1> - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>4.3</entry> - <entry> - The <parameter>skip</parameter> parameter is available to support - cdb's capability of multiple keys having the same name. - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>dba_exists</function></member> - <member><function>dba_delete</function></member> - <member><function>dba_insert</function></member> - <member><function>dba_replace</function></member> - <member><function>dba_key_split</function></member> - </simplelist> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.9 $ --> +<refentry id="function.dba-fetch"> + <refnamediv> + <refname>dba_fetch</refname> + <refpurpose>Fetch data specified by key</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>dba_fetch</methodname> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> + <methodsynopsis> + <type>string</type><methodname>dba_fetch</methodname> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>int</type><parameter>skip</parameter></methodparam> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> + <para> + <function>dba_fetch</function> fetches the data specified by + <parameter>key</parameter> from the database specified with + <parameter>handle</parameter>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>key</parameter></term> + <listitem> + <para> + The key the data is specified by. + </para> + <note> + <para> + When working with inifiles this function accepts arrays as keys + where index 0 is the group and index 1 is the value name. See: + <function>dba_key_split</function>. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>skip</parameter></term> + <listitem> + <para> + The number of key-value pairs to ignore when using cdb databases. + This value is ignored for all other databases which do not support + multiple keys with the same name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + The database handler, returned by <function>dba_open</function> or + <function>dba_popen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the associated string if the key/data pair is found, &false; + otherwise. + </para> + </refsect1> + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.3</entry> + <entry> + The <parameter>skip</parameter> parameter is available to support + cdb's capability of multiple keys having the same name. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dba_exists</function></member> + <member><function>dba_delete</function></member> + <member><function>dba_insert</function></member> + <member><function>dba_replace</function></member> + <member><function>dba_key_split</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/dba/functions/dba-firstkey.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/dba/functions/dba-firstkey.xml diff -u phpdoc/en/reference/dba/functions/dba-firstkey.xml:1.6 phpdoc/en/reference/dba/functions/dba-firstkey.xml:1.7 --- phpdoc/en/reference/dba/functions/dba-firstkey.xml:1.6 Sun Jan 30 19:21:24 2005 +++ phpdoc/en/reference/dba/functions/dba-firstkey.xml Sat Feb 5 22:06:33 2005 @@ -1,55 +1,55 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> - <refentry id="function.dba-firstkey"> - <refnamediv> - <refname>dba_firstkey</refname> - <refpurpose>Fetch first key</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>string</type><methodname>dba_firstkey</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - </methodsynopsis> - <para> - <function>dba_firstkey</function> returns the first key of the database - and resets the internal key pointer. This permits a linear search through - the whole database. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>handle</parameter></term> - <listitem> - <para> - The database handler, returned by <function>dba_open</function> or - <function>dba_popen</function>. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the key on success, or &false; on failure. - </para> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>dba_nextkey</function></member> - <member><function>dba_key_split</function></member> - <member>Example 2 in the <link linkend="dba.examples">DBA examples</link></member> - </simplelist> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.7 $ --> +<refentry id="function.dba-firstkey"> + <refnamediv> + <refname>dba_firstkey</refname> + <refpurpose>Fetch first key</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>dba_firstkey</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> + <para> + <function>dba_firstkey</function> returns the first key of the database + and resets the internal key pointer. This permits a linear search through + the whole database. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + The database handler, returned by <function>dba_open</function> or + <function>dba_popen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the key on success, or &false; on failure. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dba_nextkey</function></member> + <member><function>dba_key_split</function></member> + <member>Example 2 in the <link linkend="dba.examples">DBA examples</link></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/dba/functions/dba-handlers.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/dba/functions/dba-handlers.xml diff -u phpdoc/en/reference/dba/functions/dba-handlers.xml:1.6 phpdoc/en/reference/dba/functions/dba-handlers.xml:1.7 --- phpdoc/en/reference/dba/functions/dba-handlers.xml:1.6 Sun Jan 30 19:21:24 2005 +++ phpdoc/en/reference/dba/functions/dba-handlers.xml Sat Feb 5 22:06:33 2005 @@ -1,73 +1,73 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> - <refentry id="function.dba-handlers"> - <refnamediv> - <refname>dba_handlers</refname> - <refpurpose>List all the handlers available</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>array</type><methodname>dba_handlers</methodname> - <methodparam choice="opt"><type>bool</type><parameter>full_info</parameter></methodparam> - </methodsynopsis> - <para> - <function>dba_handlers</function> list all the handlers supported by this - extension. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>full_info</parameter></term> - <listitem> - <para> - Turns on/off full information display in the result. The default is - &false;. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns an array of database handlers. If <parameter>full_info</parameter> - is set to &true;, the array will be associative with the handlers names as - keys, and their version information as value. Otherwise, the result will be - an indexed array of handlers names. - </para> - <note> - <para> - When the internal cdb library is used you will see - <literal>cdb</literal> and <literal>cdb_make</literal>. - </para> - </note> - </refsect1> - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title><function>dba_handlers</function> Example</title> - <programlisting role="php"> +<!-- $Revision: 1.7 $ --> +<refentry id="function.dba-handlers"> + <refnamediv> + <refname>dba_handlers</refname> + <refpurpose>List all the handlers available</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>array</type><methodname>dba_handlers</methodname> + <methodparam choice="opt"><type>bool</type><parameter>full_info</parameter></methodparam> + </methodsynopsis> + <para> + <function>dba_handlers</function> list all the handlers supported by this + extension. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>full_info</parameter></term> + <listitem> + <para> + Turns on/off full information display in the result. The default is + &false;. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array of database handlers. If <parameter>full_info</parameter> + is set to &true;, the array will be associative with the handlers names as + keys, and their version information as value. Otherwise, the result will be + an indexed array of handlers names. + </para> + <note> + <para> + When the internal cdb library is used you will see + <literal>cdb</literal> and <literal>cdb_make</literal>. + </para> + </note> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>dba_handlers</function> Example</title> + <programlisting role="php"> <![CDATA[ <?php echo "Available DBA handlers:\n"; foreach (dba_handlers(true) as $handler_name => $handler_version) { - // clean the versions - $handler_version = str_replace('$', '', $handler_version); - echo " - $handler_name: $handler_version\n"; + // clean the versions + $handler_version = str_replace('$', '', $handler_version); + echo " - $handler_name: $handler_version\n"; } ?> ]]> - </programlisting> - &example.outputs.similar; - <screen> + </programlisting> + &example.outputs.similar; + <screen> <![CDATA[ Available DBA handlers: - cdb: 0.75, Revision: 1.3.2.3 @@ -76,11 +76,11 @@ - inifile: 1.0, Revision: 1.6.2.3 - flatfile: 1.0, Revision: 1.5.2.4 ]]> - </screen> - </example> - </para> - </refsect1> - </refentry> + </screen> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/dba/functions/dba-insert.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/dba/functions/dba-insert.xml diff -u phpdoc/en/reference/dba/functions/dba-insert.xml:1.5 phpdoc/en/reference/dba/functions/dba-insert.xml:1.6 --- phpdoc/en/reference/dba/functions/dba-insert.xml:1.5 Sun Jan 30 19:21:24 2005 +++ phpdoc/en/reference/dba/functions/dba-insert.xml Sat Feb 5 22:06:33 2005 @@ -1,76 +1,76 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> - <refentry id="function.dba-insert"> - <refnamediv> - <refname>dba_insert</refname> - <refpurpose>Insert entry</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>dba_insert</methodname> - <methodparam><type>string</type><parameter>key</parameter></methodparam> - <methodparam><type>string</type><parameter>value</parameter></methodparam> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - </methodsynopsis> - <para> - <function>dba_insert</function> inserts the entry described with - <parameter>key</parameter> and <parameter>value</parameter> into the - database. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>key</parameter></term> - <listitem> - <para> - The key of the entry to be inserted. If this key already exist in the - database, this function will fail. Use <function>dba_replace</function> - if you need to replace an existent key. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>value</parameter></term> - <listitem> - <para> - The value to be inserted. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>handle</parameter></term> - <listitem> - <para> - The database handler, returned by <function>dba_open</function> or - <function>dba_popen</function>. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - &return.success; - </para> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>dba_exists</function></member> - <member><function>dba_delete</function></member> - <member><function>dba_fetch</function></member> - <member><function>dba_replace</function></member> - </simplelist> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id="function.dba-insert"> + <refnamediv> + <refname>dba_insert</refname> + <refpurpose>Insert entry</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>dba_insert</methodname> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> + <para> + <function>dba_insert</function> inserts the entry described with + <parameter>key</parameter> and <parameter>value</parameter> into the + database. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>key</parameter></term> + <listitem> + <para> + The key of the entry to be inserted. If this key already exist in the + database, this function will fail. Use <function>dba_replace</function> + if you need to replace an existent key. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <para> + The value to be inserted. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + The database handler, returned by <function>dba_open</function> or + <function>dba_popen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dba_exists</function></member> + <member><function>dba_delete</function></member> + <member><function>dba_fetch</function></member> + <member><function>dba_replace</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/dba/functions/dba-key-split.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/dba/functions/dba-key-split.xml diff -u phpdoc/en/reference/dba/functions/dba-key-split.xml:1.5 phpdoc/en/reference/dba/functions/dba-key-split.xml:1.6 --- phpdoc/en/reference/dba/functions/dba-key-split.xml:1.5 Mon Jan 31 07:35:36 2005 +++ phpdoc/en/reference/dba/functions/dba-key-split.xml Sat Feb 5 22:06:33 2005 @@ -1,55 +1,57 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> - <refentry id="function.dba-key-split"> - <refnamediv> - <refname>dba_key_split</refname> - <refpurpose>Splits a key in string representation into array representation</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>mixed</type><methodname>dba_key_split</methodname> - <methodparam><type>mixed</type><parameter>key</parameter></methodparam> - </methodsynopsis> - <para> - <function>dba_key_split</function> splits a key (string representation) - into an array representation. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>key</parameter></term> - <listitem> - <para> - The key in string representation. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns an array of the form <literal>array(0 =&gt; group, 1 =&gt; - value_name)</literal>. This function will return &false; if - <parameter>key</parameter> is &null; or &false;. - </para> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>dba_firstkey</function></member> - <member><function>dba_nextkey</function></member> - <member><function>dba_fetch</function></member> - </simplelist> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id="function.dba-key-split"> + <refnamediv> + <refname>dba_key_split</refname> + <refpurpose> + Splits a key in string representation into array representation + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>mixed</type><methodname>dba_key_split</methodname> + <methodparam><type>mixed</type><parameter>key</parameter></methodparam> + </methodsynopsis> + <para> + <function>dba_key_split</function> splits a key (string representation) + into an array representation. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>key</parameter></term> + <listitem> + <para> + The key in string representation. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array of the form <literal>array(0 =&gt; group, 1 =&gt; + value_name)</literal>. This function will return &false; if + <parameter>key</parameter> is &null; or &false;. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dba_firstkey</function></member> + <member><function>dba_nextkey</function></member> + <member><function>dba_fetch</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/dba/functions/dba-list.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/dba/functions/dba-list.xml diff -u phpdoc/en/reference/dba/functions/dba-list.xml:1.3 phpdoc/en/reference/dba/functions/dba-list.xml:1.4 --- phpdoc/en/reference/dba/functions/dba-list.xml:1.3 Mon Jan 31 07:35:36 2005 +++ phpdoc/en/reference/dba/functions/dba-list.xml Sat Feb 5 22:06:33 2005 @@ -1,27 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> - <refentry id="function.dba-list"> - <refnamediv> - <refname>dba_list</refname> - <refpurpose>List all open database files</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>array</type><methodname>dba_list</methodname> - <void/> - </methodsynopsis> - <para> - <function>dba_list</function> list all open database files. - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - An associative array, in the form <literal>resourceid =&gt; filename</literal>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.4 $ --> +<refentry id="function.dba-list"> + <refnamediv> + <refname>dba_list</refname> + <refpurpose>List all open database files</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>array</type><methodname>dba_list</methodname> + <void/> + </methodsynopsis> + <para> + <function>dba_list</function> list all open database files. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + An associative array, in the form <literal>resourceid =&gt; filename</literal>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/dba/functions/dba-nextkey.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/dba/functions/dba-nextkey.xml diff -u phpdoc/en/reference/dba/functions/dba-nextkey.xml:1.6 phpdoc/en/reference/dba/functions/dba-nextkey.xml:1.7 --- phpdoc/en/reference/dba/functions/dba-nextkey.xml:1.6 Sun Jan 30 19:21:24 2005 +++ phpdoc/en/reference/dba/functions/dba-nextkey.xml Sat Feb 5 22:06:33 2005 @@ -1,54 +1,54 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> - <refentry id="function.dba-nextkey"> - <refnamediv> - <refname>dba_nextkey</refname> - <refpurpose>Fetch next key</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>string</type><methodname>dba_nextkey</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - </methodsynopsis> - <para> - <function>dba_nextkey</function> returns the next key of the database - and advances the internal key pointer. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>handle</parameter></term> - <listitem> - <para> - The database handler, returned by <function>dba_open</function> or - <function>dba_popen</function>. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the key on success, or &false; on failure. - </para> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>dba_firstkey</function></member> - <member><function>dba_key_split</function></member> - <member>Example 2 in the <link linkend="dba.examples">DBA examples</link></member> - </simplelist> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.7 $ --> +<refentry id="function.dba-nextkey"> + <refnamediv> + <refname>dba_nextkey</refname> + <refpurpose>Fetch next key</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>dba_nextkey</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> + <para> + <function>dba_nextkey</function> returns the next key of the database + and advances the internal key pointer. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + The database handler, returned by <function>dba_open</function> or + <function>dba_popen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the key on success, or &false; on failure. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dba_firstkey</function></member> + <member><function>dba_key_split</function></member> + <member>Example 2 in the <link linkend="dba.examples">DBA examples</link></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/dba/functions/dba-open.xml?r1=1.14&r2=1.15&ty=u Index: phpdoc/en/reference/dba/functions/dba-open.xml diff -u phpdoc/en/reference/dba/functions/dba-open.xml:1.14 phpdoc/en/reference/dba/functions/dba-open.xml:1.15 --- phpdoc/en/reference/dba/functions/dba-open.xml:1.14 Mon Jan 31 07:38:48 2005 +++ phpdoc/en/reference/dba/functions/dba-open.xml Sat Feb 5 22:06:33 2005 @@ -1,228 +1,228 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.14 $ --> - <refentry id="function.dba-open"> - <refnamediv> - <refname>dba_open</refname> - <refpurpose>Open database</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>resource</type><methodname>dba_open</methodname> - <methodparam><type>string</type><parameter>path</parameter></methodparam> - <methodparam><type>string</type><parameter>mode</parameter></methodparam> - <methodparam><type>string</type><parameter>handler</parameter></methodparam> - <methodparam choice="opt"><parameter>...</parameter></methodparam> - </methodsynopsis> - <para> - <function>dba_open</function> establishes a database instance for - <parameter>path</parameter> with <parameter>mode</parameter> using - <parameter>handler</parameter>. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>path</parameter></term> - <listitem> - <para> - Commonly a regular path in your filesystem. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>mode</parameter></term> - <listitem> - <para> - It is <literal>r</literal> for read access, <literal>w</literal> for - read/write access to an already existing database, <literal>c</literal> - for read/write access and database creation if it doesn't currently exist, - and <literal>n</literal> for create, truncate and read/write access. - </para> - <para> - Additionally you can set the database lock method with the next char. - Use <literal>l</literal> to lock the database with a <filename>.lck</filename> - file or <literal>d</literal> to lock the databasefile itself. It is - important that all of your applications do this consistently. - </para> - <para> - If you want to test the access and do not want to wait for the lock - you can add <literal>t</literal> as third character. When you are - absolutely sure that you do not require database locking you can do - so by using <literal>-</literal> instead of <literal>l</literal> or - <literal>d</literal>. When none of <literal>d</literal>, - <literal>l</literal> or <literal>-</literal> is used, dba will lock - on the database file as it would with <literal>d</literal>. - </para> - <note> - <para> - There can only be one writer for one database file. When you use dba on - a webserver and more than one request requires write operations they can - only be done one after another. Also read during write is not allowed. - The dba extension uses locks to prevent this. See the following table: - <table> - <title>DBA locking</title> - <tgroup cols="9"> - <thead> - <row> - <entry>already open</entry> - <entry><parameter>mode</parameter> = "rl"</entry> - <entry><parameter>mode</parameter> = "rlt"</entry> - <entry><parameter>mode</parameter> = "wl"</entry> - <entry><parameter>mode</parameter> = "wlt"</entry> - <entry><parameter>mode</parameter> = "rd"</entry> - <entry><parameter>mode</parameter> = "rdt"</entry> - <entry><parameter>mode</parameter> = "wd"</entry> - <entry><parameter>mode</parameter> = "wdt"</entry> - </row> - </thead> - <tbody> - <row> - <entry>not open</entry> - <entry>ok</entry> - <entry>ok</entry> - <entry>ok</entry> - <entry>ok</entry> - <entry>ok</entry> - <entry>ok</entry> - <entry>ok</entry> - <entry>ok</entry> - </row> - <row> - <entry><parameter>mode</parameter> = "rl"</entry> - <entry>ok</entry> - <entry>ok</entry> - <entry>wait</entry> - <entry>false</entry> - <entry>illegal</entry> - <entry>illegal</entry> - <entry>illegal</entry> - <entry>illegal</entry> - </row> - <row> - <entry><parameter>mode</parameter> = "wl"</entry> - <entry>wait</entry> - <entry>false</entry> - <entry>wait</entry> - <entry>false</entry> - <entry>illegal</entry> - <entry>illegal</entry> - <entry>illegal</entry> - <entry>illegal</entry> - </row> - <row> - <entry><parameter>mode</parameter> = "rd"</entry> - <entry>illegal</entry> - <entry>illegal</entry> - <entry>illegal</entry> - <entry>illegal</entry> - <entry>ok</entry> - <entry>ok</entry> - <entry>wait</entry> - <entry>false</entry> - </row> - <row> - <entry><parameter>mode</parameter> = "wd"</entry> - <entry>illegal</entry> - <entry>illegal</entry> - <entry>illegal</entry> - <entry>illegal</entry> - <entry>wait</entry> - <entry>false</entry> - <entry>wait</entry> - <entry>false</entry> - </row> - </tbody> - </tgroup> - </table> - <simplelist> - <member>ok: the second call will be successfull.</member> - <member>wait: the second call waits until <function>dba_close</function> is called for the first.</member> - <member>false: the second call returns false.</member> - <member>illegal: you must not mix "l" and "d" modifiers for <parameter>mode</parameter> parameter.</member> - </simplelist> - </para> - </note> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>handler</parameter></term> - <listitem> - <para> - The name of the <link linkend="dba.requirements">handler</link> which - shall be used for accessing <parameter>path</parameter>. It is passed - all optional parameters given to <function>dba_popen</function> and - can act on behalf of them. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns a positive handle on success, or &false; on failure. - </para> - </refsect1> - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>4.3.0</entry> - <entry> - It's possible to open database files over network connection. However - in cases a socket connection will be used (as with http or ftp) the - connection will be locked instead of the resource itself. This is important - to know since in such cases locking is simply ignored on the resource - and other solutions have to be found. - </entry> - </row> - <row> - <entry>4.3.0</entry> - <entry> - Locking and the <parameter>mode</parameter> modifiers "l", "d", "-" - and "t" were added. - In previous PHP versions, you must use semaphores to guard against - simultaneous database access for any database handler with the exception - of GDBM. See <link linkend="ref.sem">System V semaphore support</link>. - </entry> - </row> - <row> - <entry>before 4.3.5</entry> - <entry> - open mode 'c' is broken for several internal handlers and truncates - the database instead of appending data to an existent database. - Also dbm and ndbm fail on mode 'c' in typical configurations (this - cannot be fixed). - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>dba_popen</function></member> - <member><function>dba_close</function></member> - </simplelist> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.15 $ --> +<refentry id="function.dba-open"> + <refnamediv> + <refname>dba_open</refname> + <refpurpose>Open database</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>resource</type><methodname>dba_open</methodname> + <methodparam><type>string</type><parameter>path</parameter></methodparam> + <methodparam><type>string</type><parameter>mode</parameter></methodparam> + <methodparam><type>string</type><parameter>handler</parameter></methodparam> + <methodparam choice="opt"><parameter>...</parameter></methodparam> + </methodsynopsis> + <para> + <function>dba_open</function> establishes a database instance for + <parameter>path</parameter> with <parameter>mode</parameter> using + <parameter>handler</parameter>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>path</parameter></term> + <listitem> + <para> + Commonly a regular path in your filesystem. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + It is <literal>r</literal> for read access, <literal>w</literal> for + read/write access to an already existing database, <literal>c</literal> + for read/write access and database creation if it doesn't currently exist, + and <literal>n</literal> for create, truncate and read/write access. + </para> + <para> + Additionally you can set the database lock method with the next char. + Use <literal>l</literal> to lock the database with a <filename>.lck</filename> + file or <literal>d</literal> to lock the databasefile itself. It is + important that all of your applications do this consistently. + </para> + <para> + If you want to test the access and do not want to wait for the lock + you can add <literal>t</literal> as third character. When you are + absolutely sure that you do not require database locking you can do + so by using <literal>-</literal> instead of <literal>l</literal> or + <literal>d</literal>. When none of <literal>d</literal>, + <literal>l</literal> or <literal>-</literal> is used, dba will lock + on the database file as it would with <literal>d</literal>. + </para> + <note> + <para> + There can only be one writer for one database file. When you use dba on + a webserver and more than one request requires write operations they can + only be done one after another. Also read during write is not allowed. + The dba extension uses locks to prevent this. See the following table: + <table> + <title>DBA locking</title> + <tgroup cols="9"> + <thead> + <row> + <entry>already open</entry> + <entry><parameter>mode</parameter> = "rl"</entry> + <entry><parameter>mode</parameter> = "rlt"</entry> + <entry><parameter>mode</parameter> = "wl"</entry> + <entry><parameter>mode</parameter> = "wlt"</entry> + <entry><parameter>mode</parameter> = "rd"</entry> + <entry><parameter>mode</parameter> = "rdt"</entry> + <entry><parameter>mode</parameter> = "wd"</entry> + <entry><parameter>mode</parameter> = "wdt"</entry> + </row> + </thead> + <tbody> + <row> + <entry>not open</entry> + <entry>ok</entry> + <entry>ok</entry> + <entry>ok</entry> + <entry>ok</entry> + <entry>ok</entry> + <entry>ok</entry> + <entry>ok</entry> + <entry>ok</entry> + </row> + <row> + <entry><parameter>mode</parameter> = "rl"</entry> + <entry>ok</entry> + <entry>ok</entry> + <entry>wait</entry> + <entry>false</entry> + <entry>illegal</entry> + <entry>illegal</entry> + <entry>illegal</entry> + <entry>illegal</entry> + </row> + <row> + <entry><parameter>mode</parameter> = "wl"</entry> + <entry>wait</entry> + <entry>false</entry> + <entry>wait</entry> + <entry>false</entry> + <entry>illegal</entry> + <entry>illegal</entry> + <entry>illegal</entry> + <entry>illegal</entry> + </row> + <row> + <entry><parameter>mode</parameter> = "rd"</entry> + <entry>illegal</entry> + <entry>illegal</entry> + <entry>illegal</entry> + <entry>illegal</entry> + <entry>ok</entry> + <entry>ok</entry> + <entry>wait</entry> + <entry>false</entry> + </row> + <row> + <entry><parameter>mode</parameter> = "wd"</entry> + <entry>illegal</entry> + <entry>illegal</entry> + <entry>illegal</entry> + <entry>illegal</entry> + <entry>wait</entry> + <entry>false</entry> + <entry>wait</entry> + <entry>false</entry> + </row> + </tbody> + </tgroup> + </table> + <simplelist> + <member>ok: the second call will be successfull.</member> + <member>wait: the second call waits until <function>dba_close</function> is called for the first.</member> + <member>false: the second call returns false.</member> + <member>illegal: you must not mix "l" and "d" modifiers for <parameter>mode</parameter> parameter.</member> + </simplelist> + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>handler</parameter></term> + <listitem> + <para> + The name of the <link linkend="dba.requirements">handler</link> which + shall be used for accessing <parameter>path</parameter>. It is passed + all optional parameters given to <function>dba_popen</function> and + can act on behalf of them. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a positive handle on success, or &false; on failure. + </para> + </refsect1> + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.3.0</entry> + <entry> + It's possible to open database files over network connection. However + in cases a socket connection will be used (as with http or ftp) the + connection will be locked instead of the resource itself. This is important + to know since in such cases locking is simply ignored on the resource + and other solutions have to be found. + </entry> + </row> + <row> + <entry>4.3.0</entry> + <entry> + Locking and the <parameter>mode</parameter> modifiers "l", "d", "-" + and "t" were added. + In previous PHP versions, you must use semaphores to guard against + simultaneous database access for any database handler with the exception + of GDBM. See <link linkend="ref.sem">System V semaphore support</link>. + </entry> + </row> + <row> + <entry>before 4.3.5</entry> + <entry> + open mode 'c' is broken for several internal handlers and truncates + the database instead of appending data to an existent database. + Also dbm and ndbm fail on mode 'c' in typical configurations (this + cannot be fixed). + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dba_popen</function></member> + <member><function>dba_close</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/dba/functions/dba-optimize.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/dba/functions/dba-optimize.xml diff -u phpdoc/en/reference/dba/functions/dba-optimize.xml:1.4 phpdoc/en/reference/dba/functions/dba-optimize.xml:1.5 --- phpdoc/en/reference/dba/functions/dba-optimize.xml:1.4 Sun Jan 30 19:21:24 2005 +++ phpdoc/en/reference/dba/functions/dba-optimize.xml Sat Feb 5 22:06:33 2005 @@ -1,51 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> - <refentry id="function.dba-optimize"> - <refnamediv> - <refname>dba_optimize</refname> - <refpurpose>Optimize database</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>dba_optimize</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - </methodsynopsis> - <para> - <function>dba_optimize</function> optimizes the underlying database. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>handle</parameter></term> - <listitem> - <para> - The database handler, returned by <function>dba_open</function> or - <function>dba_popen</function>. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - &return.success; - </para> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>dba_sync</function></member> - </simplelist> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.5 $ --> +<refentry id="function.dba-optimize"> + <refnamediv> + <refname>dba_optimize</refname> + <refpurpose>Optimize database</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>dba_optimize</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> + <para> + <function>dba_optimize</function> optimizes the underlying database. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + The database handler, returned by <function>dba_open</function> or + <function>dba_popen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dba_sync</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/dba/functions/dba-popen.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/dba/functions/dba-popen.xml diff -u phpdoc/en/reference/dba/functions/dba-popen.xml:1.4 phpdoc/en/reference/dba/functions/dba-popen.xml:1.5 --- phpdoc/en/reference/dba/functions/dba-popen.xml:1.4 Mon Jan 31 07:35:36 2005 +++ phpdoc/en/reference/dba/functions/dba-popen.xml Sat Feb 5 22:06:33 2005 @@ -1,78 +1,78 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> - <refentry id="function.dba-popen"> - <refnamediv> - <refname>dba_popen</refname> - <refpurpose>Open database persistently</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>resource</type><methodname>dba_popen</methodname> - <methodparam><type>string</type><parameter>path</parameter></methodparam> - <methodparam><type>string</type><parameter>mode</parameter></methodparam> - <methodparam><type>string</type><parameter>handler</parameter></methodparam> - <methodparam choice="opt"><parameter>...</parameter></methodparam> - </methodsynopsis> - <para> - <function>dba_popen</function> establishes a persistent database instance - for <parameter>path</parameter> with <parameter>mode</parameter> using - <parameter>handler</parameter>. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>path</parameter></term> - <listitem> - <para> - Commonly a regular path in your filesystem. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>mode</parameter></term> - <listitem> - <para> - It is <literal>r</literal> for read access, <literal>w</literal> for - read/write access to an already existing database, <literal>c</literal> - for read/write access and database creation if it doesn't currently exist, - and <literal>n</literal> for create, truncate and read/write access. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>handler</parameter></term> - <listitem> - <para> - The name of the <link linkend="dba.requirements">handler</link> which - shall be used for accessing <parameter>path</parameter>. It is passed - all optional parameters given to <function>dba_popen</function> and - can act on behalf of them. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns a positive handle on success, or &false; on failure. - </para> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>dba_open</function></member> - <member><function>dba_close</function></member> - </simplelist> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.5 $ --> +<refentry id="function.dba-popen"> + <refnamediv> + <refname>dba_popen</refname> + <refpurpose>Open database persistently</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>resource</type><methodname>dba_popen</methodname> + <methodparam><type>string</type><parameter>path</parameter></methodparam> + <methodparam><type>string</type><parameter>mode</parameter></methodparam> + <methodparam><type>string</type><parameter>handler</parameter></methodparam> + <methodparam choice="opt"><parameter>...</parameter></methodparam> + </methodsynopsis> + <para> + <function>dba_popen</function> establishes a persistent database instance + for <parameter>path</parameter> with <parameter>mode</parameter> using + <parameter>handler</parameter>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>path</parameter></term> + <listitem> + <para> + Commonly a regular path in your filesystem. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + It is <literal>r</literal> for read access, <literal>w</literal> for + read/write access to an already existing database, <literal>c</literal> + for read/write access and database creation if it doesn't currently exist, + and <literal>n</literal> for create, truncate and read/write access. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>handler</parameter></term> + <listitem> + <para> + The name of the <link linkend="dba.requirements">handler</link> which + shall be used for accessing <parameter>path</parameter>. It is passed + all optional parameters given to <function>dba_popen</function> and + can act on behalf of them. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a positive handle on success, or &false; on failure. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dba_open</function></member> + <member><function>dba_close</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/dba/functions/dba-replace.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/dba/functions/dba-replace.xml diff -u phpdoc/en/reference/dba/functions/dba-replace.xml:1.4 phpdoc/en/reference/dba/functions/dba-replace.xml:1.5 --- phpdoc/en/reference/dba/functions/dba-replace.xml:1.4 Sun Jan 30 19:21:24 2005 +++ phpdoc/en/reference/dba/functions/dba-replace.xml Sat Feb 5 22:06:33 2005 @@ -1,74 +1,74 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> - <refentry id="function.dba-replace"> - <refnamediv> - <refname>dba_replace</refname> - <refpurpose>Replace or insert entry</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>dba_replace</methodname> - <methodparam><type>string</type><parameter>key</parameter></methodparam> - <methodparam><type>string</type><parameter>value</parameter></methodparam> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - </methodsynopsis> - <para> - <function>dba_replace</function> replaces or inserts the entry described - with <parameter>key</parameter> and <parameter>value</parameter> into the - database specified by <parameter>handle</parameter>. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>key</parameter></term> - <listitem> - <para> - The key of the entry to be replaced. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>value</parameter></term> - <listitem> - <para> - The value to be replaced. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>handle</parameter></term> - <listitem> - <para> - The database handler, returned by <function>dba_open</function> or - <function>dba_popen</function>. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - &return.success; - </para> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>dba_exists</function></member> - <member><function>dba_delete</function></member> - <member><function>dba_fetch</function></member> - <member><function>dba_insert</function></member> - </simplelist> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.5 $ --> +<refentry id="function.dba-replace"> + <refnamediv> + <refname>dba_replace</refname> + <refpurpose>Replace or insert entry</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>dba_replace</methodname> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> + <para> + <function>dba_replace</function> replaces or inserts the entry described + with <parameter>key</parameter> and <parameter>value</parameter> into the + database specified by <parameter>handle</parameter>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>key</parameter></term> + <listitem> + <para> + The key of the entry to be replaced. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <para> + The value to be replaced. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + The database handler, returned by <function>dba_open</function> or + <function>dba_popen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dba_exists</function></member> + <member><function>dba_delete</function></member> + <member><function>dba_fetch</function></member> + <member><function>dba_insert</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/dba/functions/dba-sync.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/dba/functions/dba-sync.xml diff -u phpdoc/en/reference/dba/functions/dba-sync.xml:1.4 phpdoc/en/reference/dba/functions/dba-sync.xml:1.5 --- phpdoc/en/reference/dba/functions/dba-sync.xml:1.4 Sun Jan 30 19:21:24 2005 +++ phpdoc/en/reference/dba/functions/dba-sync.xml Sat Feb 5 22:06:33 2005 @@ -1,52 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> - <refentry id="function.dba-sync"> - <refnamediv> - <refname>dba_sync</refname> - <refpurpose>Synchronize database</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>dba_sync</methodname> - <methodparam><type>resource</type><parameter>handle</parameter></methodparam> - </methodsynopsis> - <para> - <function>dba_sync</function> synchronizes the database. This will probably - trigger a physical write to the disk, if supported. - </para> - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>handle</parameter></term> - <listitem> - <para> - The database handler, returned by <function>dba_open</function> or - <function>dba_popen</function>. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - &return.success; - </para> - </refsect1> - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>dba_optimize</function></member> - </simplelist> - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.5 $ --> +<refentry id="function.dba-sync"> + <refnamediv> + <refname>dba_sync</refname> + <refpurpose>Synchronize database</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>dba_sync</methodname> + <methodparam><type>resource</type><parameter>handle</parameter></methodparam> + </methodsynopsis> + <para> + <function>dba_sync</function> synchronizes the database. This will probably + trigger a physical write to the disk, if supported. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + The database handler, returned by <function>dba_open</function> or + <function>dba_popen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>dba_optimize</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: