mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 08:58:56 +00:00
- new functions for modify and read the database
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@206724 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Uwe Steinmann
parent
602df7d50b
commit
0e3ca408c6
4 changed files with 363 additions and 0 deletions
76
reference/paradox/functions/px-delete-record.xml
Normal file
76
reference/paradox/functions/px-delete-record.xml
Normal file
|
|
@ -0,0 +1,76 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- splitted from ./en/functions/paradox.xml, last change in rev -->
|
||||
<refentry id="function.px-delete-record">
|
||||
<refnamediv>
|
||||
<refname>px_delete_record</refname>
|
||||
<refpurpose>Deletes record from paradox database</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>px_delete_record</methodname>
|
||||
<methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>num</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>pxdoc</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Resource identifier of the paradox database.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>num</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The record number is an artificial number counting records in the order
|
||||
as they are stored in the database. The first record has number 0.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
<para>
|
||||
This function deletes a record from the database. It does not free
|
||||
the space in the database file but just marks it as deleted. Inserting
|
||||
a new record afterwards will reuse the space.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
This function is only available if pxlib >= 0.6.0 is used.
|
||||
</para>
|
||||
</note>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-omittag:t
|
||||
sgml-shorttag:t
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-indent-step:1
|
||||
sgml-indent-data:t
|
||||
indent-tabs-mode:nil
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:"../../../../manual.ced"
|
||||
sgml-exposed-tags:nil
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
End:
|
||||
vim600: syn=xml fen fdm=syntax fdl=2 si
|
||||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
|
||||
82
reference/paradox/functions/px-insert-record.xml
Normal file
82
reference/paradox/functions/px-insert-record.xml
Normal file
|
|
@ -0,0 +1,82 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- splitted from ./en/functions/paradox.xml, last change in rev -->
|
||||
<refentry id="function.px-insert-record">
|
||||
<refnamediv>
|
||||
<refname>px_insert_record</refname>
|
||||
<refpurpose>Inserts record into paradox database</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>px_insert_record</methodname>
|
||||
<methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam>
|
||||
<methodparam><type>array</type><parameter>data</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>pxdoc</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Resource identifier of the paradox database.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>data</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Associated array containing the field values as returned by
|
||||
<function>px_retrieve_record</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
<para>
|
||||
This function inserts a new record into the database. The record
|
||||
is stored into the first free slot found in the database.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
This function is only available if pxlib >= 0.6.0 is used.
|
||||
</para>
|
||||
</note>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns &false; on failure or the record number in case of success.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-omittag:t
|
||||
sgml-shorttag:t
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-indent-step:1
|
||||
sgml-indent-data:t
|
||||
indent-tabs-mode:nil
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:"../../../../manual.ced"
|
||||
sgml-exposed-tags:nil
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
End:
|
||||
vim600: syn=xml fen fdm=syntax fdl=2 si
|
||||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
|
||||
113
reference/paradox/functions/px-retrieve-record.xml
Normal file
113
reference/paradox/functions/px-retrieve-record.xml
Normal file
|
|
@ -0,0 +1,113 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- splitted from ./en/functions/paradox.xml, last change in rev -->
|
||||
<refentry id="function.px-retrieve-record">
|
||||
<refnamediv>
|
||||
<refname>px_retrieve_record</refname>
|
||||
<refpurpose>Returns record of paradox database</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>px_retrieve_record</methodname>
|
||||
<methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>num</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>pxdoc</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Resource identifier of the paradox database
|
||||
as returned by <function>px_new</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>num</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The record number is an artificial number counting records in the order
|
||||
as they are stored in the database. The first record has number 0.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>mode</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The optional <parameter>mode</parameter> can be
|
||||
<constant>PX_KEYTOLOWER</constant> or <constant>PX_KEYTOUPPER</constant>
|
||||
in order to convert the keys into lower or upper case. If
|
||||
<parameter>mode</parameter> is not passed or is 0, then the key will be
|
||||
exactly like the field name. The element values will contain the field
|
||||
values. NULL values will be retained and are different from 0.0, 0 or
|
||||
the empty string. Fields of type <constant>PX_FIELD_TIME</constant>
|
||||
will be returned as an integer counting the number of milliseconds
|
||||
starting at midnight. A timestamp is a floating point value also
|
||||
counting milliseconds starting at the beginning of julian calendar.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
<para>
|
||||
This function is very similar to <function>px_get_record</function>
|
||||
but uses internally a different approach to retrieve the data. It
|
||||
relies on pxlib for reading each single field value, which usually
|
||||
results in support for more field types.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
This function is only available if pxlib >= 0.6.0 is used.
|
||||
</para>
|
||||
</note>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the <parameter>num</parameter>'th record from the paradox
|
||||
database. The record is returned as an associated array with its keys
|
||||
being the field names.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>px_get_record</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-omittag:t
|
||||
sgml-shorttag:t
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-indent-step:1
|
||||
sgml-indent-data:t
|
||||
indent-tabs-mode:nil
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:"../../../../manual.ced"
|
||||
sgml-exposed-tags:nil
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
End:
|
||||
vim600: syn=xml fen fdm=syntax fdl=2 si
|
||||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
|
||||
92
reference/paradox/functions/px-update-record.xml
Normal file
92
reference/paradox/functions/px-update-record.xml
Normal file
|
|
@ -0,0 +1,92 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- splitted from ./en/functions/paradox.xml, last change in rev -->
|
||||
<refentry id="function.px-update-record">
|
||||
<refnamediv>
|
||||
<refname>px_update_record</refname>
|
||||
<refpurpose>Updates record in paradox database</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>px_update_record</methodname>
|
||||
<methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam>
|
||||
<methodparam><type>array</type><parameter>data</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>num</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>pxdoc</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Resource identifier of the paradox database
|
||||
as returned by <function>px_new</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>data</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Associated array containing the field values as returned by
|
||||
<function>px_retrieve_record</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>num</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The record number is an artificial number counting records in the order
|
||||
as they are stored in the database. The first record has number 0.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
<para>
|
||||
This function updates a record in the database.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
This function is only available if pxlib >= 0.6.0 is used.
|
||||
</para>
|
||||
</note>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<function>px_insert_record</function>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-omittag:t
|
||||
sgml-shorttag:t
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-indent-step:1
|
||||
sgml-indent-data:t
|
||||
indent-tabs-mode:nil
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:"../../../../manual.ced"
|
||||
sgml-exposed-tags:nil
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
End:
|
||||
vim600: syn=xml fen fdm=syntax fdl=2 si
|
||||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
|
||||
Loading…
Reference in a new issue