php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

ibase: fix XML by converting para to simpara tags via script (#5135)

Browse Source
This commit is contained in:
Gina Peter Banyard
2026-01-18 21:25:41 +00:00
committed by GitHub
parent a148eb08b6
commit 17b3531ad4
51 changed files with 456 additions and 462 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
reference/ibase/book.xml
View File

@@ -1,56 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<book xml:id="book.ibase" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.ibase">
<?phpdoc extension-membership="pecl" ?>
<title>Firebird/InterBase</title>
<!-- {{{ preface -->
<preface xml:id="intro.ibase">
&reftitle.intro;
<warning>
<para>
<simpara>
&pecl.info.dead.git;
<link xlink:href="&url.php.git.mirror;pecl-database-interbase">&url.php.git.mirror;pecl-database-interbase</link>.
</para>
</simpara>
</warning>
<para>
<simpara>
Firebird is a relational database offering many ISO SQL-2003 features
that runs on Linux, Windows, and a variety of Unix platforms. Firebird
offers excellent concurrency, high performance, and powerful language
support for stored procedures and triggers. It has been used in production
systems, under a variety of names since 1981.
</para>
<para>
systems, under a variety of names since 1981.
</simpara>
<simpara>
InterBase is the name of the closed-source variant of this RDBMS that
was developed by Embarcadero/Inprise. More information about InterBase is
was developed by Embarcadero/Inprise. More information about InterBase is
available at <link xlink:href="&url.ibase;">&url.ibase;</link>.
</para>
<para>
</simpara>
<simpara>
Firebird is a commercially independent project (fundation) of C++ programmers,
technical advisors and supporters developing and enhancing a multi-platform
relational database management system based on the source code released by
Inprise Corp (now known as Embarcadero) under the InterBase
Public License v.1.0 on 25 July, 2000. More information about Firebird is
Public License v.1.0 on 25 July, 2000. More information about Firebird is
available at <link xlink:href="&url.firebird;">&url.firebird;</link>.
</para>
</simpara>
<note>
<para>
<simpara>
&pecl.moved-ver;7.4.0
</para>
<para>
</simpara>
<simpara>
This extension supports InterBase versions 6 and up and Firebird version 2.0 and up.
</para>
</simpara>
</note>
</preface>
<!-- }}} -->
&reference.ibase.setup;
&reference.ibase.constants;
&reference.ibase.reference;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -71,4 +69,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

21
reference/ibase/configure.xml
View File

@@ -1,35 +1,34 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="ibase.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ibase.installation">
&reftitle.install;
<para>
<simpara>
&pecl.moved-ver;7.4.0
</para>
<para>
</simpara>
<simpara>
&pecl.info;
<link xlink:href="&url.git.hub;FirebirdSQL/php-firebird">&url.git.hub;FirebirdSQL/php-firebird</link>.
</para>
<para>
</simpara>
<simpara>
To enable Firebird/InterBase support configure PHP
<option role="configure">--with-interbase[=DIR]</option>, where DIR is the
Firebird/InterBase base install directory, which defaults to
<filename>/usr</filename>.
</para>
</simpara>
<note>
<title>Note to Win32/Win64 Users</title>
<para>
<simpara>
&ext.windows.path.dll;
<filename>fbclient.dll,gds32.dll</filename>
</para>
</simpara>
<para>
If you installed the Firebird/InterBase database server on the
same machine PHP is running on, you will have this DLL already and
<filename>fbclient.dll,gds32.dll</filename> (gds32.dll is generated from the installer for legacy applications) will already be in
<filename>fbclient.dll,gds32.dll</filename> (gds32.dll is generated from the installer for legacy applications) will already be in
the <envar>PATH</envar>.
</para>
</note>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/ibase/functions/fbird-blob-cancel.xml
View File

@@ -12,10 +12,10 @@
<type>bool</type><methodname>fbird_blob_cancel</methodname>
<methodparam><type>resource</type><parameter>blob_handle</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function will discard a BLOB if it has not yet been closed by
<function>fbird_blob_close</function>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<varlistentry>
<term><parameter>blob_handle</parameter></term>
<listitem>
<para>
<simpara>
A BLOB handle opened with <function>fbird_blob_create</function>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,9 +34,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

28
reference/ibase/functions/ibase-add-user.xml
View File

@@ -25,49 +25,49 @@
<varlistentry>
<term><parameter>service_handle</parameter></term>
<listitem>
<para>
<simpara>
The handle on the database server service.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_name</parameter></term>
<listitem>
<para>
<simpara>
The login name of the new database user.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
<simpara>
The password of the new user.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>first_name</parameter></term>
<listitem>
<para>
<simpara>
The first name of the new database user.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>middle_name</parameter></term>
<listitem>
<para>
<simpara>
The middle name of the new database user.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>last_name</parameter></term>
<listitem>
<para>
<simpara>
The last name of the new database user.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -75,9 +75,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

12
reference/ibase/functions/ibase-affected-rows.xml
View File

@@ -12,11 +12,11 @@
<type>int</type><methodname>ibase_affected_rows</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function returns the number of rows that were affected by the
previous query (INSERT, UPDATE or DELETE) that was executed from within
the specified transaction context.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,10 +25,10 @@
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
<simpara>
A transaction context. If <parameter>link_identifier</parameter> is a
connection resource, its default transaction is used.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -36,9 +36,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the number of rows as an integer.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

28
reference/ibase/functions/ibase-backup.xml
View File

@@ -16,10 +16,10 @@
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>verbose</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
This function passes the arguments to the (remote) database server. There it starts a new backup process. Therefore you
won't get any responses.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -28,25 +28,25 @@
<varlistentry>
<term><parameter>service_handle</parameter></term>
<listitem>
<para>
<simpara>
A previously opened connection to the database server.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>source_db</parameter></term>
<listitem>
<para>
<simpara>
The absolute file path to the database on the database server. You can also use a database alias.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dest_file</parameter></term>
<listitem>
<para>
<simpara>
The path to the backup file on the database server.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -70,10 +70,10 @@
<varlistentry>
<term><parameter>verbose</parameter></term>
<listitem>
<para>
<simpara>
Since the backup process is done on the database server, you don't have any chance
to get its output. This argument is useless.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -81,13 +81,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
<para>
</simpara>
<simpara>
Since the backup process is done on the (remote) server, this function just passes the arguments to it.
While the arguments are legal, you won't get &false;.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

16
reference/ibase/functions/ibase-blob-add.xml
View File

@@ -13,10 +13,10 @@
<methodparam><type>resource</type><parameter>blob_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>ibase_blob_add</function> adds data into a blob created with
<function>ibase_blob_create</function>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,17 +25,17 @@
<varlistentry>
<term><parameter>blob_handle</parameter></term>
<listitem>
<para>
<simpara>
A blob handle opened with <function>ibase_blob_create</function>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
The data to be added.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -43,9 +43,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

12
reference/ibase/functions/ibase-blob-cancel.xml
View File

@@ -12,10 +12,10 @@
<type>bool</type><methodname>ibase_blob_cancel</methodname>
<methodparam><type>resource</type><parameter>blob_handle</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function will discard a BLOB if it has not yet been closed by
<function>ibase_blob_close</function>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<varlistentry>
<term><parameter>blob_handle</parameter></term>
<listitem>
<para>
<simpara>
A BLOB handle opened with <function>ibase_blob_create</function>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,9 +34,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

12
reference/ibase/functions/ibase-blob-close.xml
View File

@@ -12,11 +12,11 @@
<type>mixed</type><methodname>ibase_blob_close</methodname>
<methodparam><type>resource</type><parameter>blob_handle</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function closes a BLOB that has either been opened for reading by
<function>ibase_blob_open</function> or has been opened for writing by
<function>ibase_blob_create</function>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,10 +25,10 @@
<varlistentry>
<term><parameter>blob_handle</parameter></term>
<listitem>
<para>
<simpara>
A BLOB handle opened with <function>ibase_blob_create</function> or
<function>ibase_blob_open</function>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -36,12 +36,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
If the BLOB was being read, this function returns &true; on success, if
the BLOB was being written to, this function returns a string containing
the BLOB id that has been assigned to it by the database. On failure, this
function returns &false;.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

12
reference/ibase/functions/ibase-blob-create.xml
View File

@@ -12,10 +12,10 @@
<type class="union"><type>resource</type><type>false</type></type><methodname>ibase_blob_create</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>ibase_blob_create</function> creates a new BLOB for filling with
data.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,10 +24,10 @@
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
<simpara>
An InterBase link identifier. If omitted, the last opened link is
assumed.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,10 +35,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a BLOB handle for later use with
<function>ibase_blob_add</function>&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

16
reference/ibase/functions/ibase-blob-echo.xml
View File

@@ -17,10 +17,10 @@
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>blob_id</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function opens a BLOB for reading and sends its contents directly to
standard output (the browser, in most cases).
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -29,17 +29,17 @@
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
<simpara>
An InterBase link identifier. If omitted, the last opened link is
assumed.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>blob_id</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -47,9 +47,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

20
reference/ibase/functions/ibase-blob-get.xml
View File

@@ -13,15 +13,15 @@
<methodparam><type>resource</type><parameter>blob_handle</parameter></methodparam>
<methodparam><type>int</type><parameter>len</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function returns at most <parameter>len</parameter> bytes from a BLOB
that has been opened for reading by <function>ibase_blob_open</function>.
</para>
</simpara>
<note>
<para>
<simpara>
It is not possible to read from a BLOB that has been opened for writing
by <function>ibase_blob_create</function>.
</para>
</simpara>
</note>
</refsect1>
@@ -31,17 +31,17 @@
<varlistentry>
<term><parameter>blob_handle</parameter></term>
<listitem>
<para>
<simpara>
A BLOB handle opened with <function>ibase_blob_open</function>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>len</parameter></term>
<listitem>
<para>
<simpara>
Size of returned data.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -49,10 +49,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns at most <parameter>len</parameter> bytes from the BLOB, or &false;
on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

16
reference/ibase/functions/ibase-blob-import.xml
View File

@@ -17,10 +17,10 @@
<type>string</type><methodname>ibase_blob_import</methodname>
<methodparam><type>resource</type><parameter>file_handle</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function creates a BLOB, reads an entire file into it, closes it and
returns the assigned BLOB id.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -29,18 +29,18 @@
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
<simpara>
An InterBase link identifier. If omitted, the last opened link is
assumed.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>file_handle</parameter></term>
<listitem>
<para>
<simpara>
The file handle is a handle returned by <function>fopen</function>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -48,9 +48,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the BLOB id on success, or &false; on error.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

16
reference/ibase/functions/ibase-blob-info.xml
View File

@@ -17,9 +17,9 @@
<type>array</type><methodname>ibase_blob_info</methodname>
<methodparam><type>string</type><parameter>blob_id</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Returns the BLOB length and other useful information.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -28,18 +28,18 @@
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
<simpara>
An InterBase link identifier. If omitted, the last opened link is
assumed.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>blob_id</parameter></term>
<listitem>
<para>
<simpara>
A BLOB id.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -47,11 +47,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an array containing information about a BLOB. The information returned
consists of the length of the BLOB, the number of segments it contains, the size
of the largest segment, and whether it is a stream BLOB or a segmented BLOB.
</para>
</simpara>
</refsect1>
</refentry>

16
reference/ibase/functions/ibase-blob-open.xml
View File

@@ -17,9 +17,9 @@
<type class="union"><type>resource</type><type>false</type></type><methodname>ibase_blob_open</methodname>
<methodparam><type>string</type><parameter>blob_id</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Opens an existing BLOB for reading.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -28,18 +28,18 @@
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
<simpara>
An InterBase link identifier. If omitted, the last opened link is
assumed.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>blob_id</parameter></term>
<listitem>
<para>
<simpara>
A BLOB id.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -47,10 +47,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a BLOB handle for later use with
<function>ibase_blob_get</function>&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

12
reference/ibase/functions/ibase-close.xml
View File

@@ -12,12 +12,12 @@
<type>bool</type><methodname>ibase_close</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection_id</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Closes the link to an InterBase database that's associated with
a connection id returned from <function>ibase_connect</function>.
Default transaction on link is committed, other transactions are
rolled back.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,11 +26,11 @@
<varlistentry>
<term><parameter>connection_id</parameter></term>
<listitem>
<para>
<simpara>
An InterBase link identifier returned from
<function>ibase_connect</function>. If omitted, the last opened link
is assumed.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -38,9 +38,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

12
reference/ibase/functions/ibase-commit-ret.xml
View File

@@ -12,9 +12,9 @@
<type>bool</type><methodname>ibase_commit_ret</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_or_trans_identifier</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Commits a transaction without closing it.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,7 +23,7 @@
<varlistentry>
<term><parameter>link_or_trans_identifier</parameter></term>
<listitem>
<para>
<simpara>
If called without an argument, this function commits the default
transaction of the default link. If the argument is a connection
identifier, the default transaction of the corresponding connection
@@ -31,7 +31,7 @@
corresponding transaction will be committed. The transaction context
will be retained, so statements executed from within this transaction
will not be invalidated.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -39,9 +39,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
</refentry>

12
reference/ibase/functions/ibase-commit.xml
View File

@@ -12,9 +12,9 @@
<type>bool</type><methodname>ibase_commit</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_or_trans_identifier</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Commits a transaction.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,13 +23,13 @@
<varlistentry>
<term><parameter>link_or_trans_identifier</parameter></term>
<listitem>
<para>
<simpara>
If called without an argument, this function commits the default
transaction of the default link. If the argument is a connection
identifier, the default transaction of the corresponding connection
will be committed. If the argument is a transaction identifier, the
corresponding transaction will be committed.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,9 +37,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
</refentry>

48
reference/ibase/functions/ibase-connect.xml
View File

@@ -19,16 +19,16 @@
<methodparam choice="opt"><type>string</type><parameter>role</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>sync</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Establishes a connection to an Firebird/InterBase server.
</para>
<para>
</simpara>
<simpara>
In case a second call is made to <function>ibase_connect</function> with
the same arguments, no new link will be established, but instead, the link
identifier of the already opened link will be returned. The link to the
server will be closed as soon as the execution of the script ends, unless
it's closed earlier by explicitly calling <function>ibase_close</function>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -37,76 +37,76 @@
<varlistentry>
<term><parameter>database</parameter></term>
<listitem>
<para>
<simpara>
The <parameter>database</parameter> argument has to be a valid path to
database file on the server it resides on. If the server is not local,
it must be prefixed with either 'hostname:' (TCP/IP), 'hostname/port:'
(TCP/IP with interbase server on custom TCP port), '//hostname/'
(NetBEUI), depending on the connection
protocol used.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<para>
<simpara>
The user name. Can be set with the
<literal>ibase.default_user</literal> &php.ini; directive.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
<simpara>
The password for <parameter>username</parameter>. Can be set with the
<literal>ibase.default_password</literal> &php.ini; directive.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>charset</parameter></term>
<listitem>
<para>
<simpara>
<parameter>charset</parameter> is the default character set for a
database.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>buffers</parameter></term>
<listitem>
<para>
<simpara>
<parameter>buffers</parameter> is the number of database buffers to
allocate for the server-side cache. If 0 or omitted, server chooses
its own default.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dialect</parameter></term>
<listitem>
<para>
<simpara>
<parameter>dialect</parameter> selects the default SQL dialect for any
statement executed within a connection, and it defaults to the highest
one supported by client libraries.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>role</parameter></term>
<listitem>
<para>
<simpara>
Functional only with InterBase 5 and up.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sync</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -114,20 +114,20 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an Firebird/InterBase link identifier on success, or &false; on error.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
If you get some error like "arithmetic exception, numeric overflow, or
string truncation. Cannot transliterate character between character sets"
(this occurs when you try use some character with accents) when using this
and after <function>ibase_query</function> you must set the character set
(i.e. ISO8859_1 or your current character set).
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

12
reference/ibase/functions/ibase-delete-user.xml
View File

@@ -22,17 +22,17 @@
<varlistentry>
<term><parameter>service_handle</parameter></term>
<listitem>
<para>
<simpara>
The handle on the database server service.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_name</parameter></term>
<listitem>
<para>
<simpara>
The login name of the user you want to delete from the database.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -40,9 +40,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

12
reference/ibase/functions/ibase-drop-db.xml
View File

@@ -12,10 +12,10 @@
<type>bool</type><methodname>ibase_drop_db</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
This functions drops a database that was opened by either <function>ibase_connect</function>
or <function>ibase_pconnect</function>. The database is closed and deleted from the server.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,10 +24,10 @@
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
<simpara>
An InterBase link identifier. If omitted, the last opened link is
assumed.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,9 +35,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

8
reference/ibase/functions/ibase-errcode.xml
View File

@@ -12,10 +12,10 @@
<type>int</type><methodname>ibase_errcode</methodname>
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the error code that resulted from the most recent InterBase function
call.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,9 +25,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the error code as an integer, or &false; if no error occurred.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

4
reference/ibase/functions/ibase-errmsg.xml
View File

@@ -25,9 +25,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the error message as a string, or &false; if no error occurred.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

24
reference/ibase/functions/ibase-execute.xml
View File

@@ -13,14 +13,14 @@
<methodparam><type>resource</type><parameter>query</parameter></methodparam>
<methodparam rep="repeat"><type>mixed</type><parameter>values</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Execute a query prepared by <function>ibase_prepare</function>.
</para>
<para>
</simpara>
<simpara>
This is a lot more effective than using <function>ibase_query</function>
if you are repeating a same kind of query several times with only
some parameters changing.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -29,16 +29,16 @@
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
<simpara>
An InterBase query prepared by <function>ibase_prepare</function>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>values</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -46,19 +46,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
If the query raises an error, returns &false;. If it is successful and
there is a (possibly empty) result set (such as with a SELECT query),
returns a result identifier. If the query was successful and there were
no results, returns &true;.
</para>
</simpara>
<note>
<para>
<simpara>
This function returns the number of rows affected by
the query (if &gt; 0 and applicable to the statement type). A query that
succeeded, but did not affect any rows (e.g. an UPDATE of a non-existent
record) will return &true;.
</para>
</simpara>
</note>
</refsect1>

20
reference/ibase/functions/ibase-fetch-assoc.xml
View File

@@ -13,17 +13,17 @@
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>fetch_flag</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Fetch a result row from a query as an associative array.
</para>
<para>
</simpara>
<simpara>
<function>ibase_fetch_assoc</function> fetches one row of data from the
<parameter>result</parameter>. If two or more columns of the result
have the same field names, the last column will take precedence. To
access the other column(s) of the same name, you either need to access
the result with numeric indices by using
<function>ibase_fetch_row</function> or use alias names in your query.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -32,22 +32,22 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
<simpara>
The result handle.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fetch_flag</parameter></term>
<listitem>
<para>
<simpara>
<parameter>fetch_flag</parameter> is a combination of the constants
<constant>IBASE_TEXT</constant> and <constant>IBASE_UNIXTIME</constant>
ORed together. Passing <constant>IBASE_TEXT</constant> will cause this
function to return BLOB contents instead of BLOB ids. Passing
<constant>IBASE_UNIXTIME</constant> will cause this function to return
date/time values as Unix timestamps instead of as formatted strings.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -55,11 +55,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an associative array that corresponds to the fetched row.
Subsequent calls will return the next row in the result set, or &false; if
there are no more rows.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

20
reference/ibase/functions/ibase-fetch-object.xml
View File

@@ -13,13 +13,13 @@
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>fetch_flag</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Fetches a row as a pseudo-object from a given result identifier.
</para>
<para>
</simpara>
<simpara>
Subsequent calls to <function>ibase_fetch_object</function>
return the next row in the result set.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -28,23 +28,23 @@
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
<simpara>
An InterBase result identifier obtained either by
<function>ibase_query</function> or <function>ibase_execute</function>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fetch_flag</parameter></term>
<listitem>
<para>
<simpara>
<parameter>fetch_flag</parameter> is a combination of the constants
<constant>IBASE_TEXT</constant> and <constant>IBASE_UNIXTIME</constant>
ORed together. Passing <constant>IBASE_TEXT</constant> will cause this
function to return BLOB contents instead of BLOB ids. Passing
<constant>IBASE_UNIXTIME</constant> will cause this function to return
date/time values as Unix timestamps instead of as formatted strings.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -52,10 +52,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an object with the next row information, or &false; if there are
no more rows.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

20
reference/ibase/functions/ibase-fetch-row.xml
View File

@@ -13,15 +13,15 @@
<methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>fetch_flag</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>ibase_fetch_row</function> fetches one row of data from the
given result set.
</para>
<para>
</simpara>
<simpara>
Subsequent calls to <function>ibase_fetch_row</function>
return the next row in the result set, or &false; if there are no
more rows.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -30,22 +30,22 @@
<varlistentry>
<term><parameter>result_identifier</parameter></term>
<listitem>
<para>
<simpara>
An InterBase result identifier.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fetch_flag</parameter></term>
<listitem>
<para>
<simpara>
<parameter>fetch_flag</parameter> is a combination of the constants
<constant>IBASE_TEXT</constant> and <constant>IBASE_UNIXTIME</constant>
ORed together. Passing <constant>IBASE_TEXT</constant> will cause this
function to return BLOB contents instead of BLOB ids. Passing
<constant>IBASE_UNIXTIME</constant> will cause this function to return
date/time values as Unix timestamps instead of as formatted strings.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -53,11 +53,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an array that corresponds to the fetched row, or &false; if there
are no more rows. Each result column is stored in an array offset,
starting at offset 0.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

16
reference/ibase/functions/ibase-field-info.xml
View File

@@ -13,10 +13,10 @@
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>field_number</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Returns an array with information about a field after a select
query has been run.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,17 +25,17 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
<simpara>
An InterBase result identifier.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field_number</parameter></term>
<listitem>
<para>
<simpara>
Field offset.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -43,11 +43,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an array with the following keys: <literal>name</literal>,
<literal>alias</literal>, <literal>relation</literal>,
<literal>length</literal> and <literal>type</literal>.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

12
reference/ibase/functions/ibase-free-event-handler.xml
View File

@@ -12,11 +12,11 @@
<type>bool</type><methodname>ibase_free_event_handler</methodname>
<methodparam><type>resource</type><parameter>event</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function causes the registered event handler specified by
<parameter>event</parameter> to be cancelled. The callback function will
no longer be called for the events it was registered to handle.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,10 +25,10 @@
<varlistentry>
<term><parameter>event</parameter></term>
<listitem>
<para>
<simpara>
An event resource, created by
<function>ibase_set_event_handler</function>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -36,9 +36,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

12
reference/ibase/functions/ibase-free-query.xml
View File

@@ -12,9 +12,9 @@
<type>bool</type><methodname>ibase_free_query</methodname>
<methodparam><type>resource</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Frees a prepared query.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
<simpara>
A query prepared with <function>ibase_prepare</function>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,9 +33,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
</refentry>

12
reference/ibase/functions/ibase-free-result.xml
View File

@@ -12,9 +12,9 @@
<type>bool</type><methodname>ibase_free_result</methodname>
<methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Frees a result set.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,10 +23,10 @@
<varlistentry>
<term><parameter>result_identifier</parameter></term>
<listitem>
<para>
<simpara>
A result set created by <function>ibase_query</function> or
<function>ibase_execute</function>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,9 +34,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
</refentry>

7
reference/ibase/functions/ibase-gen-id.xml
View File

@@ -6,7 +6,7 @@
<refname>ibase_gen_id</refname>
<refpurpose>Increments the named generator and returns its new value</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -22,13 +22,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns new generator value as integer, or as string if the value is too big.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

7
reference/ibase/functions/ibase-maintain-db.xml
View File

@@ -5,7 +5,7 @@
<refname>ibase_maintain_db</refname>
<refpurpose>Execute a maintenance command on the database server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -22,13 +22,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

28
reference/ibase/functions/ibase-modify-user.xml
View File

@@ -25,49 +25,49 @@
<varlistentry>
<term><parameter>service_handle</parameter></term>
<listitem>
<para>
<simpara>
The handle on the database server service.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_name</parameter></term>
<listitem>
<para>
<simpara>
The login name of the database user to modify.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
<simpara>
The user's new password.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>first_name</parameter></term>
<listitem>
<para>
<simpara>
The user's new first name.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>middle_name</parameter></term>
<listitem>
<para>
<simpara>
The user's new middle name.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>last_name</parameter></term>
<listitem>
<para>
<simpara>
The user's new last name.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -75,9 +75,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

16
reference/ibase/functions/ibase-name-result.xml
View File

@@ -13,10 +13,10 @@
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function assigns a name to a result set. This name can be used later in
UPDATE|DELETE ... WHERE CURRENT OF <parameter>name</parameter> statements.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,17 +25,17 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
<simpara>
An InterBase result set.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
<simpara>
The name to be assigned.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -43,9 +43,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

12
reference/ibase/functions/ibase-num-fields.xml
View File

@@ -12,9 +12,9 @@
<type>int</type><methodname>ibase_num_fields</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Get the number of fields in a result set.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
<simpara>
An InterBase result identifier.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,9 +33,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the number of fields as an integer.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

12
reference/ibase/functions/ibase-num-params.xml
View File

@@ -12,11 +12,11 @@
<type>int</type><methodname>ibase_num_params</methodname>
<methodparam><type>resource</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function returns the number of parameters in the prepared query specified
by <parameter>query</parameter>. This is the number of binding arguments that
must be present when calling <function>ibase_execute</function>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,9 +25,9 @@
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
<simpara>
The prepared query handle.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,9 +35,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the number of parameters as an integer.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

16
reference/ibase/functions/ibase-param-info.xml
View File

@@ -13,10 +13,10 @@
<methodparam><type>resource</type><parameter>query</parameter></methodparam>
<methodparam><type>int</type><parameter>param_number</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Returns an array with information about a parameter after a
query has been prepared.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,17 +25,17 @@
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
<simpara>
An InterBase prepared query handle.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>param_number</parameter></term>
<listitem>
<para>
<simpara>
Parameter offset.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -43,11 +43,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an array with the following keys: <literal>name</literal>,
<literal>alias</literal>, <literal>relation</literal>,
<literal>length</literal> and <literal>type</literal>.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

52
reference/ibase/functions/ibase-pconnect.xml
View File

@@ -19,25 +19,25 @@
<methodparam choice="opt"><type>string</type><parameter>role</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>sync</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Opens a persistent connection to an InterBase database.
</para>
<para>
</simpara>
<simpara>
<function>ibase_pconnect</function> acts very much like
<function>ibase_connect</function> with two major differences.
</para>
<para>
</simpara>
<simpara>
First, when connecting, the function will first try to find a (persistent)
link that's already opened with the same parameters. If one is found, an
identifier for it will be returned instead of opening a new connection.
</para>
<para>
</simpara>
<simpara>
Second, the connection to the InterBase server will not be closed when the
execution of the script ends. Instead, the link will remain open for
future use (<function>ibase_close</function> will not close links
established by <function>ibase_pconnect</function>). This type of link is
therefore called 'persistent'.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -46,76 +46,76 @@
<varlistentry>
<term><parameter>database</parameter></term>
<listitem>
<para>
<simpara>
The <parameter>database</parameter> argument has to be a valid path to
database file on the server it resides on. If the server is not local,
it must be prefixed with either 'hostname:' (TCP/IP), '//hostname/'
(NetBEUI) or 'hostname@' (IPX/SPX), depending on the connection
protocol used.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<para>
<simpara>
The user name. Can be set with the
<literal>ibase.default_user</literal> &php.ini; directive.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
<simpara>
The password for <parameter>username</parameter>. Can be set with the
<literal>ibase.default_password</literal> &php.ini; directive.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>charset</parameter></term>
<listitem>
<para>
<simpara>
<parameter>charset</parameter> is the default character set for a
database.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>buffers</parameter></term>
<listitem>
<para>
<simpara>
<parameter>buffers</parameter> is the number of database buffers to
allocate for the server-side cache. If 0 or omitted, server chooses
its own default.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dialect</parameter></term>
<listitem>
<para>
<simpara>
<parameter>dialect</parameter> selects the default SQL dialect for any
statement executed within a connection, and it defaults to the highest
one supported by client libraries. Functional only with InterBase 6
and up.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>role</parameter></term>
<listitem>
<para>
<simpara>
Functional only with InterBase 5 and up.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sync</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -123,9 +123,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an InterBase link identifier on success, or &false; on error.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

16
reference/ibase/functions/ibase-prepare.xml
View File

@@ -35,28 +35,28 @@
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
<simpara>
An InterBase query.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
<simpara>
An InterBase link identifier returned from
<function>ibase_connect</function>. If omitted, the last opened link
is assumed.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>trans</parameter></term>
<listitem>
<para>
<simpara>
An InterBase transaction handle the query should be associated with.
If omitted, the default transaction of the connection is assumed.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -64,9 +64,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a prepared query handle, or &false; on error.
</para>
</simpara>
</refsect1>
</refentry>

24
reference/ibase/functions/ibase-query.xml
View File

@@ -25,25 +25,25 @@
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
<simpara>
An InterBase link identifier. If omitted, the last opened link is
assumed.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
<simpara>
An InterBase query.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>bind_args</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -51,31 +51,31 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
If the query raises an error, returns &false;. If it is successful and
there is a (possibly empty) result set (such as with a SELECT query),
returns a result identifier. If the query was successful and there were
no results, returns &true;.
</para>
</simpara>
<note>
<para>
<simpara>
In PHP 5.0.0 and up, this function will return the number of rows
affected by the query for INSERT, UPDATE and DELETE statements. In order
to retain backward compatibility, it will return &true; for these
statements if the query succeeded without affecting any rows.
</para>
</simpara>
</note>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
If you get some error like "arithmetic exception, numeric overflow, or
string truncation. Cannot transliterate character between character sets"
(this occurs when you try use some character with accents) when using this
and after <function>ibase_query</function> you must set the character set
(i.e. ISO8859_1 or your current character set).
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

28
reference/ibase/functions/ibase-restore.xml
View File

@@ -17,10 +17,10 @@
<methodparam choice="opt"><type>bool</type><parameter>verbose</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
This function passes the arguments to the (remote) database server. There it starts a new restore process. Therefore you
won't get any responses.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -29,25 +29,25 @@
<varlistentry>
<term><parameter>service_handle</parameter></term>
<listitem>
<para>
<simpara>
A previously opened connection to the database server.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>source_file</parameter></term>
<listitem>
<para>
<simpara>
The absolute path on the server where the backup file is located.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dest_db</parameter></term>
<listitem>
<para>
<simpara>
The path to create the new database on the server. You can also use database alias.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -74,10 +74,10 @@
<varlistentry>
<term><parameter>verbose</parameter></term>
<listitem>
<para>
<simpara>
Since the restore process is done on the database server, you don't have any chance
to get its output. This argument is useless.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -85,13 +85,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
<para>
</simpara>
<simpara>
Since the restore process is done on the (remote) server, this function just passes the arguments to it.
While the arguments are legal, you won't get &false;.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

12
reference/ibase/functions/ibase-rollback-ret.xml
View File

@@ -12,9 +12,9 @@
<type>bool</type><methodname>ibase_rollback_ret</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_or_trans_identifier</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Rolls back a transaction without closing it.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,7 +23,7 @@
<varlistentry>
<term><parameter>link_or_trans_identifier</parameter></term>
<listitem>
<para>
<simpara>
If called without an argument, this function rolls back the default
transaction of the default link. If the argument is a connection
identifier, the default transaction of the corresponding connection
@@ -31,7 +31,7 @@
corresponding transaction will be rolled back. The transaction context
will be retained, so statements executed from within this transaction
will not be invalidated.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -39,9 +39,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
</refentry>

12
reference/ibase/functions/ibase-rollback.xml
View File

@@ -12,9 +12,9 @@
<type>bool</type><methodname>ibase_rollback</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_or_trans_identifier</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Rolls back a transaction.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,13 +23,13 @@
<varlistentry>
<term><parameter>link_or_trans_identifier</parameter></term>
<listitem>
<para>
<simpara>
If called without an argument, this function rolls back the default
transaction of the default link. If the argument is a connection
identifier, the default transaction of the corresponding connection
will be rolled back. If the argument is a transaction identifier, the
corresponding transaction will be rolled back.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,9 +37,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
</refentry>

12
reference/ibase/functions/ibase-server-info.xml
View File

@@ -21,17 +21,17 @@
<varlistentry>
<term><parameter>service_handle</parameter></term>
<listitem>
<para>
<simpara>
A previously created connection to the database server.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>action</parameter></term>
<listitem>
<para>
<simpara>
A valid constant.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -39,9 +39,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns mixed types depending on context.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

16
reference/ibase/functions/ibase-service-attach.xml
View File

@@ -22,26 +22,26 @@
<varlistentry>
<term><parameter>host</parameter></term>
<listitem>
<para>
<simpara>
The name or ip address of the database host. You can define the port by adding
'/' and port number. If no port is specified, port 3050 will be used.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dba_username</parameter></term>
<listitem>
<para>
<simpara>
The name of any valid user.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dba_password</parameter></term>
<listitem>
<para>
<simpara>
The user's password.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -49,9 +49,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a Interbase / Firebird link identifier on success&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

8
reference/ibase/functions/ibase-service-detach.xml
View File

@@ -20,9 +20,9 @@
<varlistentry>
<term><parameter>service_handle</parameter></term>
<listitem>
<para>
<simpara>
A previously created connection to the database server.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -30,9 +30,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

24
reference/ibase/functions/ibase-set-event-handler.xml
View File

@@ -21,10 +21,10 @@
<methodparam><type>string</type><parameter>event_name</parameter></methodparam>
<methodparam rep="repeat"><type>string</type><parameter>event_names</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function registers a PHP user function as event handler for the
specified events.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -33,32 +33,32 @@
<varlistentry>
<term><parameter>event_handler</parameter></term>
<listitem>
<para>
<simpara>
The callback is called with the event name and the link resource as
arguments whenever one of the specified events is posted by the
database.
</para>
<para>
</simpara>
<simpara>
The callback must return &false; if the event handler should be
canceled. Any other return value is ignored. This function accepts up
to 15 event arguments.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>event_name</parameter></term>
<listitem>
<para>
<simpara>
An event name.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>event_names</parameter></term>
<listitem>
<para>
<simpara>
At most 15 events allowed.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -66,10 +66,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The return value is an event resource. This resource can be used to free
the event handler using <function>ibase_free_event_handler</function>.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

28
reference/ibase/functions/ibase-trans.xml
View File

@@ -18,32 +18,32 @@
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>trans_args</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Begins a transaction.
</para>
</simpara>
<note>
<para>
<simpara>
The first call to <function>ibase_trans</function> will not return the default transaction
of a connection. All transactions started by <function>ibase_trans</function>
will be rolled back at the end of the script if they were not committed or
rolled back by either <function>ibase_commit</function> or
<function>ibase_rollback</function>.
</para>
</simpara>
</note>
<note>
<para>
<simpara>
This function will accept multiple <parameter>trans_args</parameter>
and <parameter>link_identifier</parameter> arguments. This allows transactions
over multiple database connections, which are committed using a 2-phase commit
algorithm. This means you can rely on the updates to either succeed in every
database, or fail in every database. It does NOT mean you can use tables from
different databases in the same query!
</para>
<para>
</simpara>
<simpara>
If you use transactions over multiple databases, you will have to specify both
the <parameter>link_id</parameter> and <parameter>transaction_id</parameter>
in calls to <function>ibase_query</function> and <function>ibase_prepare</function>.
</para>
</simpara>
</note>
</refsect1>
@@ -53,7 +53,7 @@
<varlistentry>
<term><parameter>trans_args</parameter></term>
<listitem>
<para>
<simpara>
<parameter>trans_args</parameter> can be a combination of
<constant>IBASE_READ</constant>,
<constant>IBASE_WRITE</constant>,
@@ -64,16 +64,16 @@
<constant>IBASE_REC_NO_VERSION</constant>,
<constant>IBASE_WAIT</constant> and
<constant>IBASE_NOWAIT</constant>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
<simpara>
An InterBase link identifier. If omitted, the last opened link is
assumed.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -81,9 +81,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a transaction handle, or &false; on error.
</para>
</simpara>
</refsect1>
</refentry>

16
reference/ibase/functions/ibase-wait-event.xml
View File

@@ -19,11 +19,11 @@
<methodparam><type>string</type><parameter>event_name</parameter></methodparam>
<methodparam rep="repeat"><type>string</type><parameter>event_names</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function suspends execution of the script until one of the specified events
is posted by the database. The name of the event that was posted is returned. This
function accepts up to 15 event arguments.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -32,16 +32,16 @@
<varlistentry>
<term><parameter>event_name</parameter></term>
<listitem>
<para>
<simpara>
The event name.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>event_names</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -49,9 +49,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the name of the event that was posted.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

40
reference/ibase/ini.xml
View File

@@ -91,11 +91,11 @@
<type>bool</type>
</term>
<listitem>
<para>
<simpara>
Whether to allow
<link linkend="features.persistent-connections">persistent connections</link>
to Firebird/InterBase.
</para>
</simpara>
</listitem>
</varlistentry>
@@ -105,11 +105,11 @@
<type>int</type>
</term>
<listitem>
<para>
<simpara>
The maximum number of persistent Firebird/InterBase connections per
process. New connections created with ibase_pconnect() will be non-persistent
if this number would be exceeded.
</para>
</simpara>
</listitem>
</varlistentry>
@@ -119,10 +119,10 @@
<type>int</type>
</term>
<listitem>
<para>
<simpara>
The maximum number of Firebird/InterBase connections per process, including
persistent connections.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ibase.default-db">
@@ -131,11 +131,11 @@
<type>string</type>
</term>
<listitem>
<para>
<simpara>
The default database to connect to when ibase_[p]connect() is called
without specifying a database name. If this value is set and SQL safe
mode is enabled, no other connections than to this database will be allowed.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ibase.default-user">
@@ -144,10 +144,10 @@
<type>string</type>
</term>
<listitem>
<para>
<simpara>
The user name to use when connecting to a database
if no user name is specified.
</para>
</simpara>
</listitem>
</varlistentry>
@@ -157,10 +157,10 @@
<type>string</type>
</term>
<listitem>
<para>
<simpara>
The password to use when connecting to a database
if no password is specified.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ibase.default-charset">
@@ -169,10 +169,10 @@
<type>string</type>
</term>
<listitem>
<para>
<simpara>
The character set to use when connecting to a database
if no character set is specified.
</para>
</simpara>
</listitem>
</varlistentry>
@@ -184,8 +184,8 @@
<type>string</type>
</term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ibase.dateformat">
@@ -194,8 +194,8 @@
<type>string</type>
</term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.ibase.timeformat">
@@ -204,11 +204,11 @@
<type>string</type>
</term>
<listitem>
<para>
<simpara>
These directives are used to set the date and time formats
that are used when returning dates and times from a result set,
or when binding arguments to date and time parameters.
</para>
</simpara>
</listitem>
</varlistentry>