1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- Author: Uwe Steinmann <steinm@php.net> -->
<!-- Purpose: database.vendors -->
<!-- Membership: pecl, external -->
<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 and write Paradox databases, primary index
files and blob files. Write support has been proven to be quite reliable,
though due to lack of documentation the produced files may not in
any case be readable by other applications. Encrypted databases can
be read without specifying a password if pxlib >= 0.5.0 is used.
</para>
<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 pxlib >= 0.4.4 for the basic set
of functions. Some newer functions are only available with pxlib >=
0.6.0. Reading and writing of encrypted databases requires at least
pxlib >= 0.5.0. The paradox library (pxlib) 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_db. 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_db</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>retrieve_record</function></entry>
<entry><function>px_retrieve_record</function></entry>
</row>
<row>
<entry><function>delete_record</function></entry>
<entry><function>px_delete_record</function></entry>
</row>
<row>
<entry><function>insert_record</function></entry>
<entry><function>px_insert_record</function></entry>
</row>
<row>
<entry><function>update_record</function></entry>
<entry><function>px_update_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>date2string</function></entry>
<entry><function>px_date2string</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
-->
|