cvs: phpdoc /en/reference/paradox .cvsignore configure.xml constants.xml reference.xml /en/reference/paradox/functions px-close.xml px-create-fp.xml
px-delete.xml px-get-field.xml px-get-info.xml px-get-parameter.xml px-get-record.xml px-get-schema.xml px-get-value.xml px-new.xml px-numfields.xml
px-numrecords.xml px-open-fp.xml px-put-record.xml px-set-blob-file.xml px-set-parameter.xml px-set-tablename.xml px-set-targetencoding.xml
px-set-value.xml px-timestamp2string.xml
| From: | Friedhelm Betz | Date: | Sun, 19 Jun 2005 18:42:59 +0000 |
| Subject: | cvs: phpdoc /en/reference/paradox .cvsignore configure.xml constants.xml reference.xml /en/reference/paradox/functions px-close.xml px-create-fp.xml px-delete.xml px-get-field.xml px-get-info.xml px-get-parameter.xml px-get-record.xml px-get-schema.xml px-get-value.xml px-new.xml px-numfields.xml px-numrecords.xml px-open-fp.xml px-put-record.xml px-set-blob-file.xml px-set-parameter.xml px-set-tablename.xml px-set-targetencoding.xml px-set-value.xml px-timestamp2string.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969368713@lists.php.net to get a copy of this message | ||
betz Sun Jun 19 14:42:59 2005 EDT
Added files:
/phpdoc/en/reference/paradox/functions px-close.xml
px-create-fp.xml
px-delete.xml
px-get-field.xml
px-get-info.xml
px-get-parameter.xml
px-get-record.xml
px-get-schema.xml
px-get-value.xml px-new.xml
px-numfields.xml
px-numrecords.xml
px-open-fp.xml
px-put-record.xml
px-set-blob-file.xml
px-set-parameter.xml
px-set-tablename.xml
px-set-targetencoding.xml
px-set-value.xml
px-timestamp2string.xml
/phpdoc/en/reference/paradox configure.xml constants.xml .cvsignore
reference.xml
Log:
move paradox from peardoc
http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-close.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-close.xml +++ phpdoc/en/reference/paradox/functions/px-close.xml <?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-close"> <refnamediv> <refname>px_close</refname> <refpurpose>Closes a paradox database</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_close</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> </methodsynopsis> <para> Closes the paradox database. This function will not close the file. You will have to call <function>fclose</function> afterwards. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>px_open_fp</function></member> <member><function>another_func</function></member> <member>The example at <function>px_new</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-create-fp.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-create-fp.xml +++ phpdoc/en/reference/paradox/functions/px-create-fp.xml <?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-create-fp"> <refnamediv> <refname>px_create_fp</refname> <refpurpose>Create a new paradox database</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_create_fp</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>array</type><parameter>fielddesc</parameter></methodparam> <methodparam><type>resource</type><parameter>file</parameter></methodparam> </methodsynopsis> <para> Create a new paradox database file. The actual file has to be opened before with <function>fopen</function>. Make sure the file is writable. The first parameter is the return value of <function>px_new</function>. <option>fielddesc</option> is an array containing one element for each field containing its specification. Each field specification is an array itself with either two or three elements.The first element is always a string value used as the name of the field. It may not be larger than ten characters. The second element contains the field type which is one of the constants listed in the table <link linkend="paradox.table-fieldtypes">Constants for field types</link>. In the case of a character field, you will have to provide a third element specifying the length of the field. </para> <note> <para>This function is highly experimental, due to insufficient documentation of the paradox file format. Database files created with this function can be opened by <function>px_open_fp</function> and has been successfully opened by the Paradox software, but your milage may vary. </para> </note> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>Creating a Paradox database with two fields</title> <programlisting role="php"> <![CDATA[ <?php if(!$pxdoc = px_new()) { /* Error handling */ } $fp = fopen("test.db", "w+"); $fields = array(array("col1", "S"), array("col2", "I")); if(!@px_create_fp($pxdoc, $fields, $fp)) { /* Error handling */ } px_set_tablename($pxdoc, "testtable"); for($i=-50; $i<50; $i++) { $rec = array($i, -$i); px_put_record($pxdoc, $rec); } px_close($pxdoc); px_delete($pxdoc); fclose($fp); ?> ]]> </programlisting> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>px_new</function></member> <member><function>px_put_record</function></member> <member><function>fopen</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-delete.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-delete.xml +++ phpdoc/en/reference/paradox/functions/px-delete.xml <?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"> <refnamediv> <refname>px_delete</refname> <refpurpose>Deletes resource of paradox database</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_delete</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> </methodsynopsis> <para> Deletes the resource of the paradox file and frees all memory. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-get-field.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-get-field.xml +++ phpdoc/en/reference/paradox/functions/px-get-field.xml <?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-get-field"> <refnamediv> <refname>px_get_field</refname> <refpurpose>Returns the specification of a single field</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>px_get_field</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>fieldno</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the specification of the <option>fieldno</option>'th database field as an associated array. The array contains three fields named <literal>name</literal>, <literal>type</literal>, and <literal>size</literal>. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-get-info.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-get-info.xml +++ phpdoc/en/reference/paradox/functions/px-get-info.xml <?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-get-info"> <refnamediv> <refname>px_get_info</refname> <refpurpose>Return lots of information about a paradox file</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>px_get_info</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns an associated array with lots of information about a paradox file. This array is likely to extend in the future. </para> <variablelist> <varlistentry> <term>fileversion</term> <listitem> <para>Version of file multiplied by 10.</para> </listitem> </varlistentry> <varlistentry> <term>tablename</term> <listitem> <para>Name of table as stored in the file.</para> </listitem> </varlistentry> <varlistentry> <term>numrecords</term> <listitem> <para>Number of records in this table.</para> </listitem> </varlistentry> <varlistentry> <term>numfields</term> <listitem> <para>Number of fields in this table.</para> </listitem> </varlistentry> <varlistentry> <term>headersize</term> <listitem> <para>Number of bytes used for the header. This is usally 0x800.</para> </listitem> </varlistentry> <varlistentry> <term>maxtablesize</term> <listitem> <para> This value multiplied by 0x400 is the size of a data block in bytes. </para> </listitem> </varlistentry> <varlistentry> <term>numdatablocks</term> <listitem> <para> The number of data blocks in the file. Each data block contains a certain number of records which depends on the record size and the data block size (maxtablesize). Data blocks may not necessarily be completely filled. </para> </listitem> </varlistentry> <varlistentry> <term>numindexfields</term> <listitem> <para> Number of fields used for the primary index. The fields do always start as field number 1. </para> </listitem> </varlistentry> <varlistentry> <term>codepage</term> <listitem> <para> The DOS codepage which was used for encoding fields with character data. If the target encoding is not set with <function>px_set_targetencoding</function> this will be the encoding for character fields when records are being accessed with <function>px_get_record</function>. </para> </listitem> </varlistentry> </variablelist> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>px_numfields</function></member> <member><function>px_numrecords</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-get-parameter.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-get-parameter.xml +++ phpdoc/en/reference/paradox/functions/px-get-parameter.xml <?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-get-parameter"> <refnamediv> <refname>px_get_parameter</refname> <refpurpose>Gets a parameter</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>px_get_parameter</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> </methodsynopsis> <para> Gets various parameters. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> The <parameter>name</parameter> can be one of the following: </para> <variablelist> <varlistentry> <term>tablename</term> <listitem> <para> The name of the table as it will be stored in the datbase header. </para> </listitem> </varlistentry> <varlistentry> <term>targetencoding</term> <listitem> <para> The encoding for the output. Data which is being read from character fields is being recode into the targetencoding. </para> </listitem> </varlistentry> <varlistentry> <term>inputencoding</term> <listitem> <para> The econding of the input data which is to be stored into the database. </para> </listitem> </varlistentry> </variablelist> </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-get-record.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-get-record.xml +++ phpdoc/en/reference/paradox/functions/px-get-record.xml <?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-get-record"> <refnamediv> <refname>px_get_record</refname> <refpurpose>Returns record of paradox database</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>px_get_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> </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 typ <constant>PX_FIELD_TIME</constant> will be returned as an integer counting the number of milli seconds starting at midnight. A timestamp is a floating point value also counting milli seconds starting at the beginning of julian calendar. </para> </listitem> </varlistentry> </variablelist> </para> </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> </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-get-schema.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-get-schema.xml +++ phpdoc/en/reference/paradox/functions/px-get-schema.xml <?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-get-schema"> <refnamediv> <refname>px_get_schema</refname> <refpurpose>Returns the database schema</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>px_get_schema</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> <para> </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>pxdoc</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> <varlistentry> <term><parameter>mode</parameter></term> <listitem> <para> If the optional <parameter>mode</parameter> is <constant>PX_KEYTOLOWER</constant> or <constant>PX_KEYTOUPPER</constant> the key will be converted to lower or upper case. If <parameter>mode</parameter> is 0 or not passed at all, then the key name will be identical to the field name. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the schema of a database file as an associated array. The key name is equal to the field name. Each array element is itself an associated array containing the two fields <literal>type</literal> and <literal>size</literal>. <literal>type</literal> is one of the constants in table <link linkend="paradox.table-fieldtypes">Constants for field types</link>. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-get-value.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-get-value.xml +++ phpdoc/en/reference/paradox/functions/px-get-value.xml <?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-get-value"> <refnamediv> <refname>px_get_value</refname> <refpurpose>Gets a value</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>float</type><methodname>px_get_value</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> </methodsynopsis> <para> Gets various values. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>pxdoc</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> <varlistentry> <term><parameter>name</parameter></term> <listitem> <para> <parameter>name</parameter> can be one of the following. <variablelist> <varlistentry> <term>numprimkeys</term> <listitem> <para> The number of primary keys. Paradox databases always use the first <literal>numprimkeys</literal> fields for the primary index. </para> </listitem> </varlistentry> </variablelist> </para> </listitem> </varlistentry> </variablelist> </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-new.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-new.xml +++ phpdoc/en/reference/paradox/functions/px-new.xml <?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-new"> <refnamediv> <refname>px_new</refname> <refpurpose>Create a new paradox object</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>resource</type><methodname>px_new</methodname> <void /> </methodsynopsis> <para> Create a new paradox object. You will have to call this function before any further functions. <function>px_new</function> does not create any file on the disk, it justs creates an instance of a paradox object. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns &false; on failure. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>Opening a Paradox database</title> <programlisting role="php"> <![CDATA[ <?php if(!$pxdoc = px_new()) { /* Error handling */ } $fp = fopen("test.db", "r"); if(!px_open_fp($pxdoc, $fp)) { /* Error handling */ } // ... px_close($pxdoc); px_delete($pxdoc); fclose($fp); ?> ]]> </programlisting> </example> </para> <para> If you prefer the object oriented API, then the above example will look like the following. <example> <title>Opening a Paradox database</title> <programlisting role="php"> <![CDATA[ <?php $fp = fopen("test.db", "r"); $pxdoc = new paradox_db(); if(!$pxdoc->open_fp($fp)) { /* Error handling */ } // ... $pxdoc->close(); fclose($fp); ?> ]]> </programlisting> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>px_delete</function></member> <member><function>px_open_fp</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-numfields.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-numfields.xml +++ phpdoc/en/reference/paradox/functions/px-numfields.xml <?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-numfields"> <refnamediv> <refname>px_numfields</refname> <refpurpose>Returns number of fields in a database</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>px_numfields</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> </methodsynopsis> <para> Get the number of fields in a database file. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the number of fields in a database file. The return value of this function is identical to the element <literal>numfields</literal> in the associated array returned by <function>px_get_info</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-numrecords.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-numrecords.xml +++ phpdoc/en/reference/paradox/functions/px-numrecords.xml <?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-numrecords"> <refnamediv> <refname>px_numrecords</refname> <refpurpose>Returns number of records in a database</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>px_numrecords</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> </methodsynopsis> <para> Get the number of records in a database file. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the number of records in a database file. The return value of this function is identical to the element <literal>numrecords</literal> in the associated array returned by <function>px_get_info</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-open-fp.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-open-fp.xml +++ phpdoc/en/reference/paradox/functions/px-open-fp.xml <?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-open-fp"> <refnamediv> <refname>px_open_fp</refname> <refpurpose>Open paradox database</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_open_fp</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>resource</type><parameter>file</parameter></methodparam> </methodsynopsis> <para> Open an existing paradox database file. The actual file has to be opened before with <function>fopen</function>. This function can also be used to open primary index files and tread them like a paradox database. This is supported for those who would like to investigate a primary index. It cannot be used to accelerate access to a database file. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>pxdoc</parameter></term> <listitem> <para> <parameter>pxdoc</parameter> is the return value of <function>px_new</function>. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>file</parameter></term> <listitem> <para> <parameter>file</parameter> is the return value from <function>fopen</function> with the actual database file as parameter. </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>fopen</function></member> <member>The example at <function>px_new</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-put-record.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-put-record.xml +++ phpdoc/en/reference/paradox/functions/px-put-record.xml <?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-put-record"> <refnamediv> <refname>px_put_record</refname> <refpurpose>Stores record into paradox database</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_put_record</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>array</type><parameter>record</parameter></methodparam> </methodsynopsis> <para> Stores a record into a paradox database. The record is added at the end of the database. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-set-blob-file.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-set-blob-file.xml +++ phpdoc/en/reference/paradox/functions/px-set-blob-file.xml <?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-set-blob-file"> <refnamediv> <refname>px_set_blob_file</refname> <refpurpose>Sets the file where blobs are read from</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_set_blob_file</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> <para> Sets the name of the file where blobs are going to be read from. Without calling this function, <function>px_get_record</function> will only return data in blob fields if the data is part of the record and not stored in the blob file. Blob data is stored in the record if it is small enough to fit in the size of the blob field. </para> <para> Calling this function twice will close the first blob file and open the new one. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-set-parameter.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-set-parameter.xml +++ phpdoc/en/reference/paradox/functions/px-set-parameter.xml <?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-set-parameter"> <refnamediv> <refname>px_set_parameter</refname> <refpurpose>Sets a parameter</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_set_parameter</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> <methodparam><type>string</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> Sets various parameters. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>pxdoc</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> <varlistentry> <term><parameter>name</parameter></term> <listitem> <para> <parameter>name</parameter> can be one of the following. </para> <variablelist> <varlistentry> <term>tablename</term> <listitem> <para> The name of the table as it will be stored in the datbase header. </para> </listitem> </varlistentry> <varlistentry> <term>targetencoding</term> <listitem> <para> The encoding for the output. Data which is being read from character fields is being recode into the targetencoding. </para> </listitem> </varlistentry> <varlistentry> <term>inputencoding</term> <listitem> <para> The econding of the input data which is to be stored into the database. </para> </listitem> </varlistentry> </variablelist> </listitem> </varlistentry> <varlistentry> <term><parameter>value</parameter></term> <listitem> <para> </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>px_get_info</function> to determine the DOS code page.</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-set-tablename.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-set-tablename.xml +++ phpdoc/en/reference/paradox/functions/px-set-tablename.xml <?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-set-tablename"> <refnamediv> <refname>px_set_tablename</refname> <refpurpose>Sets the name of a table (deprecated)</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_set_tablename</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> </methodsynopsis> <para> Sets the table name of a paradox database, which was created with <function>px_create_fp</function>. Applying this function on an existing database has no effect. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-set-targetencoding.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-set-targetencoding.xml +++ phpdoc/en/reference/paradox/functions/px-set-targetencoding.xml <?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-set-targetencoding"> <refnamediv> <refname>px_set_targetencoding</refname> <refpurpose>Sets the encoding for character fields (deprecated)</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_set_targetencoding</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> Set the encoding for data retrieved from a character field. All character fields will be recoded to the encoding set by this function. If the encoding is not set, the character data will be returned in the DOS code page encoding as specified in the database. </para> <para> See also <function>px_get_info</function> to determine the DOS code page. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns &false; if the encoding could not be set, e.g. the encoding is unknown, or pxlib does not support recoding at all. In the second case a warning will be issued. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-set-value.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-set-value.xml +++ phpdoc/en/reference/paradox/functions/px-set-value.xml <?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-set-value"> <refnamediv> <refname>px_set_value</refname> <refpurpose>Sets a value</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_set_value</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> <methodparam><type>float</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> Sets various values. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>pxdoc</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> <varlistentry> <term><parameter>name</parameter></term> <listitem> <para> <parameter>name</parameter> can be one of the following.</para> <variablelist> <varlistentry> <term>numprimkeys</term> <listitem> <para> The number of primary keys. Paradox databases always use the first <option>numprimkeys</option> fields for the primary index. </para> </listitem> </varlistentry> </variablelist> </listitem> </varlistentry> <varlistentry> <term><parameter>value</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para>&return.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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-timestamp2string.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-timestamp2string.xml +++ phpdoc/en/reference/paradox/functions/px-timestamp2string.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.px-timestamp2string"> <refnamediv> <refname>px_timestamp2string</refname> <refpurpose> Converts the timestamp into a string. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_timestamp2string</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>float</type><parameter>value</parameter></methodparam> <methodparam><type>string</type><parameter>format</parameter></methodparam> </methodsynopsis> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>pxdoc</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> <varlistentry> <term><parameter>value</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> <varlistentry> <term><parameter>format</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here <entry>Description of change </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>px_timestamp2string</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/configure.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/configure.xml +++ phpdoc/en/reference/paradox/configure.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <section id="paradox.installation"> &reftitle.install; <para> A short installation note: just type <screen> $ pear install paradox </screen> in your console. </para> </section> <!-- 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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/constants.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/constants.xml +++ phpdoc/en/reference/paradox/constants.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <section id="paradox.constants"> &reftitle.constants; &extension.constants; <para> The following two tables lists all constants defined by the paradox extension. <table id="paradox.table-fieldtypes"> <title>Contants for field types</title> <tgroup cols="2"> <thead> <row> <entry>Name</entry> <entry>Meaning</entry> </row> </thead> <tbody> <row> <entry>PX_FIELD_ALPHA</entry> <entry>Character data with fixed length</entry> </row> <row> <entry>PX_FIELD_DATE</entry> <entry>Date</entry> </row> <row> <entry>PX_FIELD_SHORT</entry> <entry>Short integer (2 Bytes)</entry> </row> <row> <entry>PX_FIELD_LONG</entry> <entry>Long integer (4 Bytes)</entry> </row> <row> <entry>PX_FIELD_CURRENCY</entry> <entry>same as PX_FIELD_NUMBER</entry> </row> <row> <entry>PX_FIELD_NUMBER</entry> <entry>Double</entry> </row> <row> <entry>PX_FIELD_LOGICAL</entry> <entry>Boolean</entry> </row> <row> <entry>PX_FIELD_MEMOBLOB</entry> <entry>Binary large object (not supported)</entry> </row> <row> <entry>PX_FIELD_BLOB</entry> <entry>Binary large object (not supported)</entry> </row> <row> <entry>PX_FIELD_FMTMEMOBLOB</entry> <entry>Binary large object (not supported)</entry> </row> <row> <entry>PX_FIELD_OLE</entry> <entry>OLE object (basically a blob, not supported)</entry> </row> <row> <entry>PX_FIELD_GRAPHIC</entry> <entry>Graphic (basically a blob, not supported)</entry> </row> <row> <entry>PX_FIELD_TIME</entry> <entry>time</entry> </row> <row> <entry>PX_FIELD_TIMESTAMP</entry> <entry>timestamp (like the unix timestamp)</entry> </row> <row> <entry>PX_FIELD_AUTOINC</entry> <entry>Auto incrementing interger (like PX_FIELD_LONG)</entry> </row> <row> <entry>PX_FIELD_BCD</entry> <entry>Decimal number stored in bcd format (not supported)</entry> </row> <row> <entry>PX_FIELD_BYTES</entry> <entry>Array of Bytes with not more than 255 bytes (not supported)</entry> </row> </tbody> </tgroup> </table> <table id="paradox.table-filetypes"> <title>Contants for file types</title> <tgroup cols="2"> <thead> <row> <entry>Name</entry> <entry>Meaning</entry> </row> </thead> <tbody> <row> <entry>PX_FILE_INDEX_DB</entry> <entry>Indexed database</entry> </row> <row> <entry>PX_FILE_PRIM_INDEX</entry> <entry>Primary index</entry> </row> <row> <entry>PX_FILE_NON_INDEX_DB</entry> <entry>None indexed database</entry> </row> <row> <entry>PX_FILE_NON_INC_SEC_INDEX</entry> <entry>None incremental secondary index (not supported)</entry> </row> <row> <entry>PX_FILE_SEC_INDEX</entry> <entry>Secondary index (not supported)</entry> </row> <row> <entry>PX_FILE_INC_SEC_INDEX</entry> <entry>Incremental secondary index (not supported)</entry> </row> <row> <entry>PX_FILE_NON_INC_SEC_INDEX_G</entry> <entry>(not supported)</entry> </row> <row> <entry>PX_FILE_SEC_INDEX_G</entry> <entry>(not supported)</entry> </row> <row> <entry>PX_FILE_INC_SEC_INDEX_G</entry> <entry>(not supported)</entry> </row> </tbody> </tgroup> </table> </para> </section> <!-- 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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/.cvsignore?r=1.1&p=1 Index: phpdoc/en/reference/paradox/.cvsignore +++ phpdoc/en/reference/paradox/.cvsignore functions.xml http://cvs.php.net/co.php/phpdoc/en/reference/paradox/reference.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/reference.xml +++ phpdoc/en/reference/paradox/reference.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Author: Uwe Steinmann <steinm@php.net> --> <reference id="ref.paradox"> <title>Paradox File Access</title> <titleabbrev>Paradox</titleabbrev> <partintro> <section id="paradox.intro"> &reftitle.intro; &warn.experimental; <para> This module allows to read Paradox database and primary index files. It has initial support for creating Paradox databases. Consider it to be experimental due to lack of documentation of the Paradox file format. </para> <note> <para> This module has not been tested on other platforms than Debian/GNU Linux for PPC. </para> </note> <note> <para> This module is also in development and may change, though I don't expect major changes to the API. </para> </note> </section> <section id="paradox.requirements"> &reftitle.required; <para> You need at least PHP 5.0.0 and libpx >= 0.1.9. The paradox library (libpx) is available at <ulink url="&url.paradox.pxlib;">&url.paradox.pxlib;</ulink>. </para> </section> &reference.paradox.configure; <section id="paradox.configuration"> &reftitle.runtime; &no.config; </section> <section id="paradox.oo-api"> <title>Object oriented API</title> <para> The paradox extension provides also an object oriented API. It consists of only one class called paradox_doc. Its methods only differ from the functions in its name and of course the missing first parameter. The following table will list all methods and its equivalent functions. <table id="paradox.table-class-methods"> <title>Methods of class paradox_doc</title> <tgroup cols="2"> <thead> <row> <entry>Name of method</entry> <entry>Equivalent function</entry> </row> </thead> <tbody> <row> <entry>Constructor</entry> <entry><function>px_new</function></entry> </row> <row> <entry>Destructor</entry> <entry><function>px_delete</function></entry> </row> <row> <entry><function>open_fp</function></entry> <entry><function>px_open_fp</function></entry> </row> <row> <entry><function>create_fp</function></entry> <entry><function>px_create_fp</function></entry> </row> <row> <entry><function>close</function></entry> <entry><function>px_close</function></entry> </row> <row> <entry><function>numrecords</function></entry> <entry><function>px_numrecords</function></entry> </row> <row> <entry><function>numfields</function></entry> <entry><function>px_numfields</function></entry> </row> <row> <entry><function>get_record</function></entry> <entry><function>px_get_record</function></entry> </row> <row> <entry><function>put_record</function></entry> <entry><function>px_put_record</function></entry> </row> <row> <entry><function>get_field</function></entry> <entry><function>px_get_field</function></entry> </row> <row> <entry><function>get_schema</function></entry> <entry><function>px_get_schema</function></entry> </row> <row> <entry><function>get_info</function></entry> <entry><function>px_get_info</function></entry> </row> <row> <entry><function>set_parameter</function></entry> <entry><function>px_set_parameter</function></entry> </row> <row> <entry><function>get_parameter</function></entry> <entry><function>px_get_parameter</function></entry> </row> <row> <entry><function>set_value</function></entry> <entry><function>px_set_value</function></entry> </row> <row> <entry><function>get_value</function></entry> <entry><function>px_get_value</function></entry> </row> <row> <entry><function>get_info</function></entry> <entry><function>px_get_info</function></entry> </row> <row> <entry><function>set_targetencoding</function></entry> <entry><function>px_set_targetencoding</function></entry> </row> <row> <entry><function>set_tablename</function></entry> <entry><function>px_set_tablename</function></entry> </row> <row> <entry><function>set_blob_file</function></entry> <entry><function>px_set_blob_file</function></entry> </row> </tbody> </tgroup> </table> </para> </section> </partintro> &reference.paradox.functions; </reference> <!-- 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 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 -->
http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-close.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-close.xml +++ phpdoc/en/reference/paradox/functions/px-close.xml <?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-close"> <refnamediv> <refname>px_close</refname> <refpurpose>Closes a paradox database</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_close</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> </methodsynopsis> <para> Closes the paradox database. This function will not close the file. You will have to call <function>fclose</function> afterwards. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>px_open_fp</function></member> <member><function>another_func</function></member> <member>The example at <function>px_new</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-create-fp.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-create-fp.xml +++ phpdoc/en/reference/paradox/functions/px-create-fp.xml <?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-create-fp"> <refnamediv> <refname>px_create_fp</refname> <refpurpose>Create a new paradox database</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_create_fp</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>array</type><parameter>fielddesc</parameter></methodparam> <methodparam><type>resource</type><parameter>file</parameter></methodparam> </methodsynopsis> <para> Create a new paradox database file. The actual file has to be opened before with <function>fopen</function>. Make sure the file is writable. The first parameter is the return value of <function>px_new</function>. <option>fielddesc</option> is an array containing one element for each field containing its specification. Each field specification is an array itself with either two or three elements.The first element is always a string value used as the name of the field. It may not be larger than ten characters. The second element contains the field type which is one of the constants listed in the table <link linkend="paradox.table-fieldtypes">Constants for field types</link>. In the case of a character field, you will have to provide a third element specifying the length of the field. </para> <note> <para>This function is highly experimental, due to insufficient documentation of the paradox file format. Database files created with this function can be opened by <function>px_open_fp</function> and has been successfully opened by the Paradox software, but your milage may vary. </para> </note> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>Creating a Paradox database with two fields</title> <programlisting role="php"> <![CDATA[ <?php if(!$pxdoc = px_new()) { /* Error handling */ } $fp = fopen("test.db", "w+"); $fields = array(array("col1", "S"), array("col2", "I")); if(!@px_create_fp($pxdoc, $fields, $fp)) { /* Error handling */ } px_set_tablename($pxdoc, "testtable"); for($i=-50; $i<50; $i++) { $rec = array($i, -$i); px_put_record($pxdoc, $rec); } px_close($pxdoc); px_delete($pxdoc); fclose($fp); ?> ]]> </programlisting> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>px_new</function></member> <member><function>px_put_record</function></member> <member><function>fopen</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-delete.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-delete.xml +++ phpdoc/en/reference/paradox/functions/px-delete.xml <?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"> <refnamediv> <refname>px_delete</refname> <refpurpose>Deletes resource of paradox database</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_delete</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> </methodsynopsis> <para> Deletes the resource of the paradox file and frees all memory. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-get-field.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-get-field.xml +++ phpdoc/en/reference/paradox/functions/px-get-field.xml <?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-get-field"> <refnamediv> <refname>px_get_field</refname> <refpurpose>Returns the specification of a single field</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>px_get_field</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>fieldno</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the specification of the <option>fieldno</option>'th database field as an associated array. The array contains three fields named <literal>name</literal>, <literal>type</literal>, and <literal>size</literal>. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-get-info.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-get-info.xml +++ phpdoc/en/reference/paradox/functions/px-get-info.xml <?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-get-info"> <refnamediv> <refname>px_get_info</refname> <refpurpose>Return lots of information about a paradox file</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>px_get_info</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns an associated array with lots of information about a paradox file. This array is likely to extend in the future. </para> <variablelist> <varlistentry> <term>fileversion</term> <listitem> <para>Version of file multiplied by 10.</para> </listitem> </varlistentry> <varlistentry> <term>tablename</term> <listitem> <para>Name of table as stored in the file.</para> </listitem> </varlistentry> <varlistentry> <term>numrecords</term> <listitem> <para>Number of records in this table.</para> </listitem> </varlistentry> <varlistentry> <term>numfields</term> <listitem> <para>Number of fields in this table.</para> </listitem> </varlistentry> <varlistentry> <term>headersize</term> <listitem> <para>Number of bytes used for the header. This is usally 0x800.</para> </listitem> </varlistentry> <varlistentry> <term>maxtablesize</term> <listitem> <para> This value multiplied by 0x400 is the size of a data block in bytes. </para> </listitem> </varlistentry> <varlistentry> <term>numdatablocks</term> <listitem> <para> The number of data blocks in the file. Each data block contains a certain number of records which depends on the record size and the data block size (maxtablesize). Data blocks may not necessarily be completely filled. </para> </listitem> </varlistentry> <varlistentry> <term>numindexfields</term> <listitem> <para> Number of fields used for the primary index. The fields do always start as field number 1. </para> </listitem> </varlistentry> <varlistentry> <term>codepage</term> <listitem> <para> The DOS codepage which was used for encoding fields with character data. If the target encoding is not set with <function>px_set_targetencoding</function> this will be the encoding for character fields when records are being accessed with <function>px_get_record</function>. </para> </listitem> </varlistentry> </variablelist> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>px_numfields</function></member> <member><function>px_numrecords</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-get-parameter.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-get-parameter.xml +++ phpdoc/en/reference/paradox/functions/px-get-parameter.xml <?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-get-parameter"> <refnamediv> <refname>px_get_parameter</refname> <refpurpose>Gets a parameter</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>px_get_parameter</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> </methodsynopsis> <para> Gets various parameters. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> The <parameter>name</parameter> can be one of the following: </para> <variablelist> <varlistentry> <term>tablename</term> <listitem> <para> The name of the table as it will be stored in the datbase header. </para> </listitem> </varlistentry> <varlistentry> <term>targetencoding</term> <listitem> <para> The encoding for the output. Data which is being read from character fields is being recode into the targetencoding. </para> </listitem> </varlistentry> <varlistentry> <term>inputencoding</term> <listitem> <para> The econding of the input data which is to be stored into the database. </para> </listitem> </varlistentry> </variablelist> </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-get-record.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-get-record.xml +++ phpdoc/en/reference/paradox/functions/px-get-record.xml <?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-get-record"> <refnamediv> <refname>px_get_record</refname> <refpurpose>Returns record of paradox database</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>px_get_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> </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 typ <constant>PX_FIELD_TIME</constant> will be returned as an integer counting the number of milli seconds starting at midnight. A timestamp is a floating point value also counting milli seconds starting at the beginning of julian calendar. </para> </listitem> </varlistentry> </variablelist> </para> </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> </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-get-schema.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-get-schema.xml +++ phpdoc/en/reference/paradox/functions/px-get-schema.xml <?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-get-schema"> <refnamediv> <refname>px_get_schema</refname> <refpurpose>Returns the database schema</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>px_get_schema</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> <para> </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>pxdoc</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> <varlistentry> <term><parameter>mode</parameter></term> <listitem> <para> If the optional <parameter>mode</parameter> is <constant>PX_KEYTOLOWER</constant> or <constant>PX_KEYTOUPPER</constant> the key will be converted to lower or upper case. If <parameter>mode</parameter> is 0 or not passed at all, then the key name will be identical to the field name. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the schema of a database file as an associated array. The key name is equal to the field name. Each array element is itself an associated array containing the two fields <literal>type</literal> and <literal>size</literal>. <literal>type</literal> is one of the constants in table <link linkend="paradox.table-fieldtypes">Constants for field types</link>. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-get-value.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-get-value.xml +++ phpdoc/en/reference/paradox/functions/px-get-value.xml <?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-get-value"> <refnamediv> <refname>px_get_value</refname> <refpurpose>Gets a value</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>float</type><methodname>px_get_value</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> </methodsynopsis> <para> Gets various values. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>pxdoc</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> <varlistentry> <term><parameter>name</parameter></term> <listitem> <para> <parameter>name</parameter> can be one of the following. <variablelist> <varlistentry> <term>numprimkeys</term> <listitem> <para> The number of primary keys. Paradox databases always use the first <literal>numprimkeys</literal> fields for the primary index. </para> </listitem> </varlistentry> </variablelist> </para> </listitem> </varlistentry> </variablelist> </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-new.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-new.xml +++ phpdoc/en/reference/paradox/functions/px-new.xml <?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-new"> <refnamediv> <refname>px_new</refname> <refpurpose>Create a new paradox object</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>resource</type><methodname>px_new</methodname> <void /> </methodsynopsis> <para> Create a new paradox object. You will have to call this function before any further functions. <function>px_new</function> does not create any file on the disk, it justs creates an instance of a paradox object. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns &false; on failure. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>Opening a Paradox database</title> <programlisting role="php"> <![CDATA[ <?php if(!$pxdoc = px_new()) { /* Error handling */ } $fp = fopen("test.db", "r"); if(!px_open_fp($pxdoc, $fp)) { /* Error handling */ } // ... px_close($pxdoc); px_delete($pxdoc); fclose($fp); ?> ]]> </programlisting> </example> </para> <para> If you prefer the object oriented API, then the above example will look like the following. <example> <title>Opening a Paradox database</title> <programlisting role="php"> <![CDATA[ <?php $fp = fopen("test.db", "r"); $pxdoc = new paradox_db(); if(!$pxdoc->open_fp($fp)) { /* Error handling */ } // ... $pxdoc->close(); fclose($fp); ?> ]]> </programlisting> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>px_delete</function></member> <member><function>px_open_fp</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-numfields.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-numfields.xml +++ phpdoc/en/reference/paradox/functions/px-numfields.xml <?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-numfields"> <refnamediv> <refname>px_numfields</refname> <refpurpose>Returns number of fields in a database</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>px_numfields</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> </methodsynopsis> <para> Get the number of fields in a database file. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the number of fields in a database file. The return value of this function is identical to the element <literal>numfields</literal> in the associated array returned by <function>px_get_info</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-numrecords.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-numrecords.xml +++ phpdoc/en/reference/paradox/functions/px-numrecords.xml <?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-numrecords"> <refnamediv> <refname>px_numrecords</refname> <refpurpose>Returns number of records in a database</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>px_numrecords</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> </methodsynopsis> <para> Get the number of records in a database file. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the number of records in a database file. The return value of this function is identical to the element <literal>numrecords</literal> in the associated array returned by <function>px_get_info</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-open-fp.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-open-fp.xml +++ phpdoc/en/reference/paradox/functions/px-open-fp.xml <?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-open-fp"> <refnamediv> <refname>px_open_fp</refname> <refpurpose>Open paradox database</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_open_fp</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>resource</type><parameter>file</parameter></methodparam> </methodsynopsis> <para> Open an existing paradox database file. The actual file has to be opened before with <function>fopen</function>. This function can also be used to open primary index files and tread them like a paradox database. This is supported for those who would like to investigate a primary index. It cannot be used to accelerate access to a database file. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>pxdoc</parameter></term> <listitem> <para> <parameter>pxdoc</parameter> is the return value of <function>px_new</function>. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>file</parameter></term> <listitem> <para> <parameter>file</parameter> is the return value from <function>fopen</function> with the actual database file as parameter. </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>fopen</function></member> <member>The example at <function>px_new</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-put-record.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-put-record.xml +++ phpdoc/en/reference/paradox/functions/px-put-record.xml <?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-put-record"> <refnamediv> <refname>px_put_record</refname> <refpurpose>Stores record into paradox database</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_put_record</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>array</type><parameter>record</parameter></methodparam> </methodsynopsis> <para> Stores a record into a paradox database. The record is added at the end of the database. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-set-blob-file.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-set-blob-file.xml +++ phpdoc/en/reference/paradox/functions/px-set-blob-file.xml <?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-set-blob-file"> <refnamediv> <refname>px_set_blob_file</refname> <refpurpose>Sets the file where blobs are read from</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_set_blob_file</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> <para> Sets the name of the file where blobs are going to be read from. Without calling this function, <function>px_get_record</function> will only return data in blob fields if the data is part of the record and not stored in the blob file. Blob data is stored in the record if it is small enough to fit in the size of the blob field. </para> <para> Calling this function twice will close the first blob file and open the new one. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-set-parameter.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-set-parameter.xml +++ phpdoc/en/reference/paradox/functions/px-set-parameter.xml <?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-set-parameter"> <refnamediv> <refname>px_set_parameter</refname> <refpurpose>Sets a parameter</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_set_parameter</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> <methodparam><type>string</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> Sets various parameters. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>pxdoc</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> <varlistentry> <term><parameter>name</parameter></term> <listitem> <para> <parameter>name</parameter> can be one of the following. </para> <variablelist> <varlistentry> <term>tablename</term> <listitem> <para> The name of the table as it will be stored in the datbase header. </para> </listitem> </varlistentry> <varlistentry> <term>targetencoding</term> <listitem> <para> The encoding for the output. Data which is being read from character fields is being recode into the targetencoding. </para> </listitem> </varlistentry> <varlistentry> <term>inputencoding</term> <listitem> <para> The econding of the input data which is to be stored into the database. </para> </listitem> </varlistentry> </variablelist> </listitem> </varlistentry> <varlistentry> <term><parameter>value</parameter></term> <listitem> <para> </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>px_get_info</function> to determine the DOS code page.</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-set-tablename.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-set-tablename.xml +++ phpdoc/en/reference/paradox/functions/px-set-tablename.xml <?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-set-tablename"> <refnamediv> <refname>px_set_tablename</refname> <refpurpose>Sets the name of a table (deprecated)</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_set_tablename</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> </methodsynopsis> <para> Sets the table name of a paradox database, which was created with <function>px_create_fp</function>. Applying this function on an existing database has no effect. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-set-targetencoding.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-set-targetencoding.xml +++ phpdoc/en/reference/paradox/functions/px-set-targetencoding.xml <?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-set-targetencoding"> <refnamediv> <refname>px_set_targetencoding</refname> <refpurpose>Sets the encoding for character fields (deprecated)</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_set_targetencoding</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> Set the encoding for data retrieved from a character field. All character fields will be recoded to the encoding set by this function. If the encoding is not set, the character data will be returned in the DOS code page encoding as specified in the database. </para> <para> See also <function>px_get_info</function> to determine the DOS code page. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns &false; if the encoding could not be set, e.g. the encoding is unknown, or pxlib does not support recoding at all. In the second case a warning will be issued. </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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-set-value.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-set-value.xml +++ phpdoc/en/reference/paradox/functions/px-set-value.xml <?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-set-value"> <refnamediv> <refname>px_set_value</refname> <refpurpose>Sets a value</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_set_value</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> <methodparam><type>float</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> Sets various values. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>pxdoc</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> <varlistentry> <term><parameter>name</parameter></term> <listitem> <para> <parameter>name</parameter> can be one of the following.</para> <variablelist> <varlistentry> <term>numprimkeys</term> <listitem> <para> The number of primary keys. Paradox databases always use the first <option>numprimkeys</option> fields for the primary index. </para> </listitem> </varlistentry> </variablelist> </listitem> </varlistentry> <varlistentry> <term><parameter>value</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para>&return.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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/functions/px-timestamp2string.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/functions/px-timestamp2string.xml +++ phpdoc/en/reference/paradox/functions/px-timestamp2string.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.px-timestamp2string"> <refnamediv> <refname>px_timestamp2string</refname> <refpurpose> Converts the timestamp into a string. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>px_timestamp2string</methodname> <methodparam><type>resource</type><parameter>pxdoc</parameter></methodparam> <methodparam><type>float</type><parameter>value</parameter></methodparam> <methodparam><type>string</type><parameter>format</parameter></methodparam> </methodsynopsis> &warn.undocumented.func; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>pxdoc</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> <varlistentry> <term><parameter>value</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> <varlistentry> <term><parameter>format</parameter></term> <listitem> <para> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <!-- Use when EXCEPTIONS exist <refsect1 role="exceptions"> &reftitle.exceptions; <para> When does this function throw exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here <entry>Description of change </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>px_timestamp2string</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/configure.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/configure.xml +++ phpdoc/en/reference/paradox/configure.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <section id="paradox.installation"> &reftitle.install; <para> A short installation note: just type <screen> $ pear install paradox </screen> in your console. </para> </section> <!-- 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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/constants.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/constants.xml +++ phpdoc/en/reference/paradox/constants.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <section id="paradox.constants"> &reftitle.constants; &extension.constants; <para> The following two tables lists all constants defined by the paradox extension. <table id="paradox.table-fieldtypes"> <title>Contants for field types</title> <tgroup cols="2"> <thead> <row> <entry>Name</entry> <entry>Meaning</entry> </row> </thead> <tbody> <row> <entry>PX_FIELD_ALPHA</entry> <entry>Character data with fixed length</entry> </row> <row> <entry>PX_FIELD_DATE</entry> <entry>Date</entry> </row> <row> <entry>PX_FIELD_SHORT</entry> <entry>Short integer (2 Bytes)</entry> </row> <row> <entry>PX_FIELD_LONG</entry> <entry>Long integer (4 Bytes)</entry> </row> <row> <entry>PX_FIELD_CURRENCY</entry> <entry>same as PX_FIELD_NUMBER</entry> </row> <row> <entry>PX_FIELD_NUMBER</entry> <entry>Double</entry> </row> <row> <entry>PX_FIELD_LOGICAL</entry> <entry>Boolean</entry> </row> <row> <entry>PX_FIELD_MEMOBLOB</entry> <entry>Binary large object (not supported)</entry> </row> <row> <entry>PX_FIELD_BLOB</entry> <entry>Binary large object (not supported)</entry> </row> <row> <entry>PX_FIELD_FMTMEMOBLOB</entry> <entry>Binary large object (not supported)</entry> </row> <row> <entry>PX_FIELD_OLE</entry> <entry>OLE object (basically a blob, not supported)</entry> </row> <row> <entry>PX_FIELD_GRAPHIC</entry> <entry>Graphic (basically a blob, not supported)</entry> </row> <row> <entry>PX_FIELD_TIME</entry> <entry>time</entry> </row> <row> <entry>PX_FIELD_TIMESTAMP</entry> <entry>timestamp (like the unix timestamp)</entry> </row> <row> <entry>PX_FIELD_AUTOINC</entry> <entry>Auto incrementing interger (like PX_FIELD_LONG)</entry> </row> <row> <entry>PX_FIELD_BCD</entry> <entry>Decimal number stored in bcd format (not supported)</entry> </row> <row> <entry>PX_FIELD_BYTES</entry> <entry>Array of Bytes with not more than 255 bytes (not supported)</entry> </row> </tbody> </tgroup> </table> <table id="paradox.table-filetypes"> <title>Contants for file types</title> <tgroup cols="2"> <thead> <row> <entry>Name</entry> <entry>Meaning</entry> </row> </thead> <tbody> <row> <entry>PX_FILE_INDEX_DB</entry> <entry>Indexed database</entry> </row> <row> <entry>PX_FILE_PRIM_INDEX</entry> <entry>Primary index</entry> </row> <row> <entry>PX_FILE_NON_INDEX_DB</entry> <entry>None indexed database</entry> </row> <row> <entry>PX_FILE_NON_INC_SEC_INDEX</entry> <entry>None incremental secondary index (not supported)</entry> </row> <row> <entry>PX_FILE_SEC_INDEX</entry> <entry>Secondary index (not supported)</entry> </row> <row> <entry>PX_FILE_INC_SEC_INDEX</entry> <entry>Incremental secondary index (not supported)</entry> </row> <row> <entry>PX_FILE_NON_INC_SEC_INDEX_G</entry> <entry>(not supported)</entry> </row> <row> <entry>PX_FILE_SEC_INDEX_G</entry> <entry>(not supported)</entry> </row> <row> <entry>PX_FILE_INC_SEC_INDEX_G</entry> <entry>(not supported)</entry> </row> </tbody> </tgroup> </table> </para> </section> <!-- 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 --> http://cvs.php.net/co.php/phpdoc/en/reference/paradox/.cvsignore?r=1.1&p=1 Index: phpdoc/en/reference/paradox/.cvsignore +++ phpdoc/en/reference/paradox/.cvsignore functions.xml http://cvs.php.net/co.php/phpdoc/en/reference/paradox/reference.xml?r=1.1&p=1 Index: phpdoc/en/reference/paradox/reference.xml +++ phpdoc/en/reference/paradox/reference.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Author: Uwe Steinmann <steinm@php.net> --> <reference id="ref.paradox"> <title>Paradox File Access</title> <titleabbrev>Paradox</titleabbrev> <partintro> <section id="paradox.intro"> &reftitle.intro; &warn.experimental; <para> This module allows to read Paradox database and primary index files. It has initial support for creating Paradox databases. Consider it to be experimental due to lack of documentation of the Paradox file format. </para> <note> <para> This module has not been tested on other platforms than Debian/GNU Linux for PPC. </para> </note> <note> <para> This module is also in development and may change, though I don't expect major changes to the API. </para> </note> </section> <section id="paradox.requirements"> &reftitle.required; <para> You need at least PHP 5.0.0 and libpx >= 0.1.9. The paradox library (libpx) is available at <ulink url="&url.paradox.pxlib;">&url.paradox.pxlib;</ulink>. </para> </section> &reference.paradox.configure; <section id="paradox.configuration"> &reftitle.runtime; &no.config; </section> <section id="paradox.oo-api"> <title>Object oriented API</title> <para> The paradox extension provides also an object oriented API. It consists of only one class called paradox_doc. Its methods only differ from the functions in its name and of course the missing first parameter. The following table will list all methods and its equivalent functions. <table id="paradox.table-class-methods"> <title>Methods of class paradox_doc</title> <tgroup cols="2"> <thead> <row> <entry>Name of method</entry> <entry>Equivalent function</entry> </row> </thead> <tbody> <row> <entry>Constructor</entry> <entry><function>px_new</function></entry> </row> <row> <entry>Destructor</entry> <entry><function>px_delete</function></entry> </row> <row> <entry><function>open_fp</function></entry> <entry><function>px_open_fp</function></entry> </row> <row> <entry><function>create_fp</function></entry> <entry><function>px_create_fp</function></entry> </row> <row> <entry><function>close</function></entry> <entry><function>px_close</function></entry> </row> <row> <entry><function>numrecords</function></entry> <entry><function>px_numrecords</function></entry> </row> <row> <entry><function>numfields</function></entry> <entry><function>px_numfields</function></entry> </row> <row> <entry><function>get_record</function></entry> <entry><function>px_get_record</function></entry> </row> <row> <entry><function>put_record</function></entry> <entry><function>px_put_record</function></entry> </row> <row> <entry><function>get_field</function></entry> <entry><function>px_get_field</function></entry> </row> <row> <entry><function>get_schema</function></entry> <entry><function>px_get_schema</function></entry> </row> <row> <entry><function>get_info</function></entry> <entry><function>px_get_info</function></entry> </row> <row> <entry><function>set_parameter</function></entry> <entry><function>px_set_parameter</function></entry> </row> <row> <entry><function>get_parameter</function></entry> <entry><function>px_get_parameter</function></entry> </row> <row> <entry><function>set_value</function></entry> <entry><function>px_set_value</function></entry> </row> <row> <entry><function>get_value</function></entry> <entry><function>px_get_value</function></entry> </row> <row> <entry><function>get_info</function></entry> <entry><function>px_get_info</function></entry> </row> <row> <entry><function>set_targetencoding</function></entry> <entry><function>px_set_targetencoding</function></entry> </row> <row> <entry><function>set_tablename</function></entry> <entry><function>px_set_tablename</function></entry> </row> <row> <entry><function>set_blob_file</function></entry> <entry><function>px_set_blob_file</function></entry> </row> </tbody> </tgroup> </table> </para> </section> </partintro> &reference.paradox.functions; </reference> <!-- 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 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 -->