php-doc-en/reference/paradox/reference.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- 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 &gt;= 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>
       <row>
        <entry><function>timestamp2string</function></entry>
        <entry><function>px_timestamp2string</function></entry>
       </row>
      </tbody>
     </tgroup>
    </table>
   </para>
  </section>

  &reference.paradox.constants;
 </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
-->