sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

ref.ibase: new doc style

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@237853 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-06-16 21:54:21 +00:00
parent e9cc03c75c
commit afee2b3056
49 changed files with 2123 additions and 641 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
reference/ibase/functions/ibase-add-user.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ibase-add-user">
<refnamediv>
<refname>ibase_add_user</refname>
<refpurpose>Add a user to a security database (only for IB6 or later)</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ibase_add_user</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
@ -16,7 +17,6 @@
<methodparam choice="opt"><type>string</type><parameter>middle_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>last_name</parameter></methodparam>
</methodsynopsis>
<para>
PHP 4 uses <parameter>server</parameter>,
<parameter>dba_user_name</parameter> and
@ -24,13 +24,25 @@
<parameter>service_handle</parameter> parameter.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
See also
<function>ibase_modify_user</function> and
<function>ibase_delete_user</function>.
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_modify_user</function></member>
<member><function>ibase_delete_user</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

53
reference/ibase/functions/ibase-affected-rows.xml
View file

@ -1,29 +1,58 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ibase-affected-rows">
<refnamediv>
<refname>ibase_affected_rows</refname>
<refpurpose>Return the number of rows that were affected by the previous query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ibase_affected_rows</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
This function returns the number of rows that were affected by the
previous query (INSERT, UPDATE or DELETE) that was
executed from within the transaction context specified by <parameter>link_identifier</parameter>.
If <parameter>link_identifier</parameter> is a connection resource, its default transaction
is used.
</para>
<para>
See also
<function>ibase_query</function> and
<function>ibase_execute</function>.
previous query (INSERT, UPDATE or DELETE) that was executed from within
the specified transaction context.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
A transaction context. If <parameter>link_identifier</parameter> is a
connection resource, its default transaction is used.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of rows as an integer.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_query</function></member>
<member><function>ibase_execute</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/ibase/functions/ibase-backup.xml
View file

@ -1,12 +1,13 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.ibase-backup">
<refnamediv>
<refname>ibase_backup</refname>
<refpurpose>Initiates a backup task in the service manager and returns immediately</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>ibase_backup</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
@ -19,6 +20,7 @@
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

64
reference/ibase/functions/ibase-blob-add.xml
View file

@ -1,31 +1,67 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<!-- $Revision: 1.7 $ -->
<refentry id='function.ibase-blob-add'>
<refnamediv>
<refname>ibase_blob_add</refname>
<refpurpose>Add data into a newly created blob</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>ibase_blob_add</methodname>
<methodparam><type>resource</type><parameter>blob_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
<function>ibase_blob_add</function> adds data into a blob
created with <function>ibase_blob_create</function>.
Returns &null; on success or &false; on failure.
</para>
<para>
See also
<function>ibase_blob_cancel</function>,
<function>ibase_blob_close</function>,
<function>ibase_blob_create</function> and
<function>ibase_blob_import</function>.
<function>ibase_blob_add</function> adds data into a blob created with
<function>ibase_blob_create</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>blob_handle</parameter></term>
<listitem>
<para>
A blob handle opened with <function>ibase_blob_create</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
The data to be added.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_blob_cancel</function></member>
<member><function>ibase_blob_close</function></member>
<member><function>ibase_blob_create</function></member>
<member><function>ibase_blob_import</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

54
reference/ibase/functions/ibase-blob-cancel.xml
View file

@ -1,29 +1,57 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<!-- $Revision: 1.6 $ -->
<refentry id='function.ibase-blob-cancel'>
<refnamediv>
<refname>ibase_blob_cancel</refname>
<refpurpose>Cancel creating blob</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ibase_blob_cancel</methodname>
<methodparam><type>resource</type><parameter>blob_handle</parameter></methodparam>
</methodsynopsis>
<para>
This function will discard a BLOB created by <function>ibase_create_blob</function>
if it has not yet been closed by <function>ibase_blob_close</function>.
&return.success;
</para>
<para>
See also
<function>ibase_blob_close</function>,
<function>ibase_blob_create</function> and
<function>ibase_blob_import</function>.
This function will discard a BLOB if it has not yet been closed by
<function>ibase_blob_close</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>blob_handle</parameter></term>
<listitem>
<para>
A BLOB handle opened with <function>ibase_create_blob</function>.
</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>ibase_blob_close</function></member>
<member><function>ibase_blob_create</function></member>
<member><function>ibase_blob_import</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

56
reference/ibase/functions/ibase-blob-close.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<!-- $Revision: 1.6 $ -->
<refentry id='function.ibase-blob-close'>
<refnamediv>
<refname>ibase_blob_close</refname>
<refpurpose>Close blob</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>ibase_blob_close</methodname>
<methodparam><type>resource</type><parameter>blob_handle</parameter></methodparam>
@ -15,17 +15,47 @@
<para>
This function closes a BLOB that has either been opened for reading by
<function>ibase_open_blob</function> or has been opened for writing by
<function>ibase_create_blob</function>. 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>
<para>
See also
<function>ibase_blob_cancel</function> and
<function>ibase_blob_open</function>.
<function>ibase_create_blob</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>blob_handle</parameter></term>
<listitem>
<para>
A BLOB handle opened with <function>ibase_create_blob</function> or
<function>ibase_open_blob</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
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>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_blob_cancel</function></member>
<member><function>ibase_blob_open</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

58
reference/ibase/functions/ibase-blob-create.xml
View file

@ -1,30 +1,60 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<!-- $Revision: 1.6 $ -->
<refentry id='function.ibase-blob-create'>
<refnamediv>
<refname>ibase_blob_create</refname>
<refpurpose>Create a new blob for adding data</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>ibase_blob_create</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
<function>ibase_blob_create</function> creates a new BLOB for
filling with data. It returns a BLOB handle for later use with
<function>ibase_blob_add</function> or &false; on failure.
</para>
<para>
See also
<function>ibase_blob_add</function>,
<function>ibase_blob_cancel</function>,
<function>ibase_blob_close</function> and
<function>ibase_blob_import</function>.
<function>ibase_blob_create</function> creates a new BLOB for filling with
data.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
An InterBase link identifier. If omitted, the last opened link is
assumed.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a BLOB handle for later use with
<function>ibase_blob_add</function> or &false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_blob_add</function></member>
<member><function>ibase_blob_cancel</function></member>
<member><function>ibase_blob_close</function></member>
<member><function>ibase_blob_import</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

68
reference/ibase/functions/ibase-blob-echo.xml
View file

@ -1,34 +1,66 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<!-- $Revision: 1.7 $ -->
<refentry id='function.ibase-blob-echo'>
<refnamediv>
<refname>ibase_blob_echo</refname>
<refpurpose>Output blob contents to browser</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ibase_blob_echo</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>blob_id</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ibase_blob_echo</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>blob_id</parameter></methodparam>
</methodsynopsis>
<para>
This function opens a BLOB for reading and sends its contents directly
to standard output (the browser, in most cases).
&return.success;
</para>
<para>
See also
<function>ibase_blob_open</function>,
<function>ibase_blob_close</function> and
<function>ibase_blob_get</function>.
This function opens a BLOB for reading and sends its contents directly to
standard output (the browser, in most cases).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
An InterBase link identifier. If omitted, the last opened link is
assumed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>blob_id</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>ibase_blob_open</function></member>
<member><function>ibase_blob_close</function></member>
<member><function>ibase_blob_get</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

94
reference/ibase/functions/ibase-blob-get.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.41 -->
<!-- $Revision: 1.7 $ -->
<refentry id='function.ibase-blob-get'>
<refnamediv>
<refname>ibase_blob_get</refname>
<refpurpose>Get len bytes data from open blob</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ibase_blob_get</methodname>
<methodparam><type>resource</type><parameter>blob_handle</parameter></methodparam>
@ -16,23 +16,6 @@
<para>
This function returns at most <parameter>len</parameter> bytes from a BLOB
that has been opened for reading by <function>ibase_blob_open</function>.
Returns &false; on failure.
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
$sql = "SELECT blob_value FROM table";
$result = ibase_query($sql);
$data = ibase_fetch_object($result);
$blob_data = ibase_blob_info($data->BLOB_VALUE);
$blob_hndl = ibase_blob_open($data->BLOB_VALUE);
echo ibase_blob_get($blob_hndl, $blob_data[0]);
?>
]]>
</programlisting>
</informalexample>
Whilst this example doesn't do much more than a 'ibase_blob_echo($data->BLOB_VALUE)' would do,
it does show you how to get information into a $variable to manipulate as you please.
</para>
<note>
<para>
@ -40,13 +23,74 @@
by <function>ibase_blob_create</function>.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also
<function>ibase_blob_open</function>,
<function>ibase_blob_close</function> and
<function>ibase_blob_echo</function>.
<variablelist>
<varlistentry>
<term><parameter>blob_handle</parameter></term>
<listitem>
<para>
A BLOB handle opened with <function>ibase_blob_open</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>len</parameter></term>
<listitem>
<para>
Size of returned data.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns at most <parameter>len</parameter> bytes from the BLOB, or &false;
on failure.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ibase_blob_get</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$result = ibase_query("SELECT blob_value FROM table");
$data = ibase_fetch_object($result);
$blob_data = ibase_blob_info($data->BLOB_VALUE);
$blob_hndl = ibase_blob_open($data->BLOB_VALUE);
echo ibase_blob_get($blob_hndl, $blob_data[0]);
?>
]]>
</programlisting>
</example>
Whilst this example doesn't do much more than a
'ibase_blob_echo($data->BLOB_VALUE)' would do, it does show you how to get
information into a $variable to manipulate as you please.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_blob_open</function></member>
<member><function>ibase_blob_close</function></member>
<member><function>ibase_blob_echo</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

63
reference/ibase/functions/ibase-blob-import.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<!-- $Revision: 1.9 $ -->
<refentry id='function.ibase-blob-import'>
<refnamediv>
<refname>ibase_blob_import</refname>
<refpurpose>Create blob, copy file in it, and close it</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ibase_blob_import</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
@ -19,9 +19,44 @@
</methodsynopsis>
<para>
This function creates a BLOB, reads an entire file into it, closes it and
returns the assigned BLOB id. The file handle is a handle returned by
<function>fopen</function>. Returns &false; on failure.
returns the assigned BLOB id.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
An InterBase link identifier. If omitted, the last opened link is
assumed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>file_handle</parameter></term>
<listitem>
<para>
The file handle is a handle returned by <function>fopen</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the BLOB id on success, or &false; on error.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ibase_blob_import</function> example</title>
@ -54,14 +89,20 @@ if ($fd) {
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also
<function>ibase_blob_add</function>,
<function>ibase_blob_cancel</function>,
<function>ibase_blob_close</function> and
<function>ibase_blob_create</function>.
<simplelist>
<member><function>ibase_blob_add</function></member>
<member><function>ibase_blob_cancel</function></member>
<member><function>ibase_blob_close</function></member>
<member><function>ibase_blob_create</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

41
reference/ibase/functions/ibase-blob-info.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<!-- $Revision: 1.6 $ -->
<refentry id='function.ibase-blob-info'>
<refnamediv>
<refname>ibase_blob_info</refname>
<refpurpose>Return blob length and other useful info</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>ibase_blob_info</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
@ -17,12 +17,45 @@
<type>array</type><methodname>ibase_blob_info</methodname>
<methodparam><type>string</type><parameter>blob_id</parameter></methodparam>
</methodsynopsis>
<para>
Returns the BLOB length and other useful information.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
An InterBase link identifier. If omitted, the last opened link is
assumed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>blob_id</parameter></term>
<listitem>
<para>
A BLOB id.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
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>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

63
reference/ibase/functions/ibase-blob-open.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<!-- $Revision: 1.6 $ -->
<refentry id='function.ibase-blob-open'>
<refnamediv>
<refname>ibase_blob_open</refname>
<refpurpose>Open blob for retrieving data parts</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>ibase_blob_open</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
@ -18,17 +18,54 @@
<methodparam><type>string</type><parameter>blob_id</parameter></methodparam>
</methodsynopsis>
<para>
<function>ibase_blob_open</function> opens an existing BLOB for
reading. It returns a BLOB handle for later use with
<function>ibase_blob_get</function> or &false; on failure.
</para>
<para>
See also
<function>ibase_blob_close</function>,
<function>ibase_blob_echo</function> and
<function>ibase_blob_get</function>.
Opens an existing BLOB for reading.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
An InterBase link identifier. If omitted, the last opened link is
assumed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>blob_id</parameter></term>
<listitem>
<para>
A BLOB id.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a BLOB handle for later use with
<function>ibase_blob_get</function> or &false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_blob_close</function></member>
<member><function>ibase_blob_echo</function></member>
<member><function>ibase_blob_get</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

52
reference/ibase/functions/ibase-close.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ibase-close">
<refnamediv>
<refname>ibase_close</refname>
<refpurpose>Close a connection to an InterBase database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ibase_close</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection_id</parameter></methodparam>
@ -15,16 +15,46 @@
<para>
Closes the link to an InterBase database that's associated with
a connection id returned from <function>ibase_connect</function>.
If the connection id is omitted, the last opened link is assumed.
Default transaction on link is committed, other transactions are
rolled back. &return.success;
</para>
<para>
See also
<function>ibase_connect</function> and
<function>ibase_pconnect</function>.
rolled back.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection_id</parameter></term>
<listitem>
<para>
An InterBase link identifier returned from
<function>ibase_connect</function>. If omitted, the last opened link
is assumed.
</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>ibase_connect</function></member>
<member><function>ibase_pconnect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

43
reference/ibase/functions/ibase-commit-ret.xml
View file

@ -1,26 +1,51 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.ibase-commit-ret">
<refnamediv>
<refname>ibase_commit_ret</refname>
<refpurpose>Commit a transaction without closing it</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ibase_commit_ret</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_or_trans_identifier</parameter></methodparam>
</methodsynopsis>
<para>
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.
The transaction context will be retained, so statements executed from within
this transaction will not be invalidated.
Commits a transaction without closing it.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>link_or_trans_identifier</parameter></term>
<listitem>
<para>
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. The transaction context
will be retained, so statements executed from within this transaction
will not be invalidated.
</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

40
reference/ibase/functions/ibase-commit.xml
View file

@ -1,25 +1,49 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.23 -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.ibase-commit">
<refnamediv>
<refname>ibase_commit</refname>
<refpurpose>Commit a transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ibase_commit</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_or_trans_identifier</parameter></methodparam>
</methodsynopsis>
<para>
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.
Commits a transaction.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>link_or_trans_identifier</parameter></term>
<listitem>
<para>
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>
</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

221
reference/ibase/functions/ibase-connect.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.9 $ -->
<refentry id="function.ibase-connect">
<refnamediv>
<refname>ibase_connect</refname>
<refpurpose>Open a connection to an InterBase database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>ibase_connect</methodname>
<methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam>
@ -21,80 +21,177 @@
</methodsynopsis>
<para>
Establishes a connection to an InterBase server.
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. <parameter>username</parameter>
and <parameter>password</parameter> can also
be specified with PHP configuration directives ibase.default_user and
ibase.default_password. <parameter>charset</parameter> is the default
character set for a database. <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. <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>
<para>
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>.
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>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>database</parameter></term>
<listitem>
<para>
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>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<para>
The user name. Can be set with the
<literal>ibase.default_user</literal> &php.ini; directive.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The password for <parameter>username</parameter>. Can be set with the
<literal>ibase.default_password</literal> &php.ini; directive.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>charset</parameter></term>
<listitem>
<para>
<parameter>charset</parameter> is the default character set for a
database.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>buffers</parameter></term>
<listitem>
<para>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dialect</parameter></term>
<listitem>
<para>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>role</parameter></term>
<listitem>
<para>
Functional only with InterBase 5 and up.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sync</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an InterBase link identifier on success, or &false; on error.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
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>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>4.0.0</entry>
<entry>
The <parameter>buffers</parameter>, <parameter>dialect</parameter>
and <parameter>role</parameter> parameters were added
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ibase_connect</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$host = 'localhost:/path/to/your.gdb';
$host = 'localhost:/path/to/your.gdb';
$dbh = ibase_connect($host, $username, $password);
$stmt = 'SELECT * FROM tblname';
$sth = ibase_query($dbh, $stmt);
while ($row = ibase_fetch_object($sth)) {
echo $row->email, "\n";
}
ibase_free_result($sth);
ibase_close($dbh);
$dbh = ibase_connect($host, $username, $password);
$stmt = 'SELECT * FROM tblname';
$sth = ibase_query($dbh, $stmt);
while ($row = ibase_fetch_object($sth)) {
echo $row->email, "\n";
}
ibase_free_result($sth);
ibase_close($dbh);
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
The optional <parameter>buffers</parameter> parameter was added in
PHP 4.0.0.
</para>
</note>
<note>
<para>
The optional <parameter>dialect</parameter> parameter was added in PHP
4.0.0 and is functional only with InterBase 6 and up.
</para>
</note>
<note>
<para>
The optional <parameter>role</parameter> parameter was added in PHP
4.0.0 and is functional only with InterBase 5 and up.
</para>
</note>
<note>
<para>
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>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also
<function>ibase_pconnect</function> and
<function>ibase_close</function>.
<simplelist>
<member><function>ibase_pconnect</function></member>
<member><function>ibase_close</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/ibase/functions/ibase-db-info.xml
View file

@ -1,12 +1,13 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.ibase-db-info">
<refnamediv>
<refname>ibase_db_info</refname>
<refpurpose>Request statistics about a database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ibase_db_info</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
@ -18,6 +19,7 @@
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

26
reference/ibase/functions/ibase-delete-user.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ibase-delete-user">
<refnamediv>
<refname>ibase_delete_user</refname>
<refpurpose>Delete a user from a security database (only for IB6 or later)</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ibase_delete_user</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
@ -21,12 +22,25 @@
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
See also
<function>ibase_add_user</function> and
<function>ibase_modify_user</function>.
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_add_user</function></member>
<member><function>ibase_modify_user</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

48
reference/ibase/functions/ibase-drop-db.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.ibase-drop-db">
<refnamediv>
<refname>ibase_drop_db</refname>
<refpurpose>Drops a database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ibase_drop_db</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
@ -14,14 +15,43 @@
<para>
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.
&return.success;
</para>
<para>
See also
<function>ibase_connect</function> and
<function>ibase_pconnect</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
An InterBase link identifier. If omitted, the last opened link is
assumed.
</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>ibase_connect</function></member>
<member><function>ibase_pconnect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

30
reference/ibase/functions/ibase-errcode.xml
View file

@ -1,25 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.ibase-errcode">
<refnamediv>
<refname>ibase_errcode</refname>
<refpurpose>Return an error code</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ibase_errcode</methodname>
<void/>
</methodsynopsis>
<para>
Returns the error code that resulted from the most recent InterBase function
call. Returns &false; if no error occurred.
</para>
<para>
See also
<function>ibase_errmsg</function>.
call.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the error code as an integer, or &false; if no error occured.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_errmsg</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

27
reference/ibase/functions/ibase-errmsg.xml
View file

@ -1,26 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.37 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ibase-errmsg">
<refnamediv>
<refname>ibase_errmsg</refname>
<refpurpose>Return error messages</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ibase_errmsg</methodname>
<void/>
</methodsynopsis>
<simpara>
Returns the error message that resulted from the most recent InterBase function
call. Returns &false; if no error occurred.
call.
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
See also
<function>ibase_errcode</function>.
Returns the error message as a string, or &false; if no error occured.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_errcode</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

83
reference/ibase/functions/ibase-execute.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.12 $ -->
<refentry id="function.ibase-execute">
<refnamediv>
<refname>ibase_execute</refname>
<refpurpose>Execute a previously prepared query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>ibase_execute</methodname>
<methodparam><type>resource</type><parameter>query</parameter></methodparam>
@ -15,17 +15,65 @@
<methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
</methodsynopsis>
<para>
Execute a query prepared by <function>ibase_prepare</function>. 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;.
Execute a query prepared by <function>ibase_prepare</function>.
</para>
<para>
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>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
An InterBase query prepared by <function>ibase_prepare</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>bind_arg</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
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>
<note>
<para>
In PHP 5.0.0 and up, this function returns the number of rows affected by
the query (if > 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>
</note>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ibase_execute</function> example</title>
@ -52,18 +100,17 @@ foreach ($updates as $baz => $bar) {
</programlisting>
</example>
</para>
<note>
<para>
In PHP 5.0.0 and up, this function returns the number of rows affected by
the query (if > 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>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>ibase_query</function>.
<simplelist>
<member><function>ibase_query</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

68
reference/ibase/functions/ibase-fetch-assoc.xml
View file

@ -1,22 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ibase-fetch-assoc">
<refnamediv>
<refname>ibase_fetch_assoc</refname>
<refpurpose>Fetch a result row from a query as an associative array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>ibase_fetch_assoc</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>fetch_flag</parameter></methodparam>
</methodsynopsis>
<para>
<function>ibase_fetch_assoc</function> 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.
Fetch a result row from a query as an associative array.
</para>
<para>
<function>ibase_fetch_assoc</function> fetches one row of data from the
@ -26,18 +24,56 @@
the result with numeric indices by using
<function>ibase_fetch_row</function> or use alias names in your query.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<parameter>fetch_flag</parameter> is a combination of the constants IBASE_TEXT and IBASE_UNIXTIME
ORed together. Passing IBASE_TEXT will cause this function to return BLOB contents
instead of BLOB ids. Passing IBASE_UNIXTIME will cause this function to return
date/time values as Unix timestamps instead of as formatted strings.
</para>
<para>
See also
<function>ibase_fetch_row</function> and
<function>ibase_fetch_object</function>.
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
The result handle.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fetch_flag</parameter></term>
<listitem>
<para>
<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>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
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>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_fetch_row</function></member>
<member><function>ibase_fetch_object</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

113
reference/ibase/functions/ibase-fetch-object.xml
View file

@ -1,56 +1,97 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.9 -->
<!-- $Revision: 1.10 $ -->
<refentry id="function.ibase-fetch-object">
<refnamediv>
<refname>ibase_fetch_object</refname>
<refpurpose>Get an object from a InterBase database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>object</type><methodname>ibase_fetch_object</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>fetch_flag</parameter></methodparam>
</methodsynopsis>
<para>
Fetches a row as a pseudo-object from a
<parameter>result_id</parameter> obtained either by
<function>ibase_query</function> or
<function>ibase_execute</function>.
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
$dbh = ibase_connect($host, $username, $password);
$stmt = 'SELECT * FROM tblname';
$sth = ibase_query($dbh, $stmt);
while ($row = ibase_fetch_object($sth)) {
echo $row->email . "\n";
}
ibase_close($dbh);
?>
]]>
</programlisting>
</informalexample>
Fetches a row as a pseudo-object from a given result identifier.
</para>
<para>
Subsequent calls to <function>ibase_fetch_object</function>
return the next row in the result set, or &false; if there are no
more rows.
</para>
<para>
<parameter>fetch_flag</parameter> is a combination of the constants IBASE_TEXT and IBASE_UNIXTIME
ORed together. Passing IBASE_TEXT will cause this function to return BLOB contents
instead of BLOB ids. Passing IBASE_UNIXTIME will cause this function to return
date/time values as Unix timestamps instead of as formatted strings.
</para>
<para>
See also
<function>ibase_fetch_row</function> and
<function>ibase_fetch_assoc</function>.
return the next row in the result set.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
An InterBase result identifier obtained either by
<function>ibase_query</function> or <function>ibase_execute</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fetch_flag</parameter></term>
<listitem>
<para>
<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>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an object with the next row information, or &false; if there are
no more rows.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ibase_fetch_object</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$dbh = ibase_connect($host, $username, $password);
$stmt = 'SELECT * FROM tblname';
$sth = ibase_query($dbh, $stmt);
while ($row = ibase_fetch_object($sth)) {
echo $row->email . "\n";
}
ibase_close($dbh);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_fetch_row</function></member>
<member><function>ibase_fetch_assoc</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

75
reference/ibase/functions/ibase-fetch-row.xml
View file

@ -1,46 +1,77 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.ibase-fetch-row">
<refnamediv>
<refname>ibase_fetch_row</refname>
<refpurpose>Fetch a row from an InterBase database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>ibase_fetch_row</methodname>
<methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>fetch_flag</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array that corresponds to the fetched row, or &false;
if there are no more rows.
</para>
<para>
<function>ibase_fetch_row</function> fetches one row of data from
the result associated with the specified
<parameter>result_identifier</parameter>. The row is returned as
an array. Each result column is stored in an array offset,
starting at offset 0.
<function>ibase_fetch_row</function> fetches one row of data from the
given result set.
</para>
<para>
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>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<parameter>fetch_flag</parameter> is a combination of the constants IBASE_TEXT and IBASE_UNIXTIME
ORed together. Passing IBASE_TEXT will cause this function to return BLOB contents
instead of BLOB ids. Passing IBASE_UNIXTIME will cause this function to return
date/time values as Unix timestamps instead of as formatted strings.
</para>
<para>
See also
<function>ibase_fetch_assoc</function> and
<function>ibase_fetch_object</function>.
<variablelist>
<varlistentry>
<term><parameter>result_identifier</parameter></term>
<listitem>
<para>
An InterBase result identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fetch_flag</parameter></term>
<listitem>
<para>
<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>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
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>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_fetch_assoc</function></member>
<member><function>ibase_fetch_object</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

86
reference/ibase/functions/ibase-field-info.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.23 -->
<!-- $Revision: 1.9 $ -->
<refentry id="function.ibase-field-info">
<refnamediv>
<refname>ibase_field_info</refname>
<refpurpose>Get information about a field</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>ibase_field_info</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
@ -15,33 +15,77 @@
</methodsynopsis>
<para>
Returns an array with information about a field after a select
query has been run. The array is in the form of name, alias,
relation, length, type.
query has been run.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<informalexample>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
An InterBase result identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field_number</parameter></term>
<listitem>
<para>
Field offset.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array with the following keys: <literal>name</literal>,
<literal>alias</literal>, <literal>relation</literal>,
<literal>length</literal> and <literal>type</literal>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ibase_field_info</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$rs = ibase_query("SELECT * FROM tablename");
$coln = ibase_num_fields($rs);
for ($i = 0; $i < $coln; $i++) {
$col_info = ibase_field_info($rs, $i);
echo "name: ". $col_info['name']. "\n";
echo "alias: ". $col_info['alias']. "\n";
echo "relation: ". $col_info['relation']. "\n";
echo "length: ". $col_info['length']. "\n";
echo "type: ". $col_info['type']. "\n";
}
$rs = ibase_query("SELECT * FROM tablename");
$coln = ibase_num_fields($rs);
for ($i = 0; $i < $coln; $i++) {
$col_info = ibase_field_info($rs, $i);
echo "name: ". $col_info['name']. "\n";
echo "alias: ". $col_info['alias']. "\n";
echo "relation: ". $col_info['relation']. "\n";
echo "length: ". $col_info['length']. "\n";
echo "type: ". $col_info['type']. "\n";
}
?>
]]>
</programlisting>
</informalexample>
</para>
<para>
See also: <function>ibase_num_fields</function>.
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_num_fields</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

50
reference/ibase/functions/ibase-free-event-handler.xml
View file

@ -1,27 +1,57 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.ibase-free-event-handler">
<refnamediv>
<refname>ibase_free_event_handler</refname>
<refpurpose>Cancels a registered event handler</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ibase_free_event_handler</methodname>
<methodparam><type>resource</type><parameter>event</parameter></methodparam>
</methodsynopsis>
<para>
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.
&return.success;
</para>
<para>
See also
<function>ibase_set_event_handler</function>.
<parameter>event</parameter> to be cancelled. The callback function will
no longer be called for the events it was registered to handle.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>event</parameter></term>
<listitem>
<para>
An event resource, created by
<function>ibase_set_event_handler</function>.
</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>ibase_set_event_handler</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

39
reference/ibase/functions/ibase-free-query.xml
View file

@ -1,22 +1,45 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.37 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ibase-free-query">
<refnamediv>
<refname>ibase_free_query</refname>
<refpurpose>Free memory allocated by a prepared query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ibase_free_query</methodname>
<methodparam><type>resource</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<simpara>
Free a query prepared by <function>ibase_prepare</function>.
&return.success;
</simpara>
<para>
Frees a prepared query.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
A query prepared with <function>ibase_prepare</function>.
</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

41
reference/ibase/functions/ibase-free-result.xml
View file

@ -1,23 +1,46 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ibase-free-result">
<refnamediv>
<refname>ibase_free_result</refname>
<refpurpose>Free a result set</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ibase_free_result</methodname>
<methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam>
</methodsynopsis>
<simpara>
Frees a result set that has been created by
<function>ibase_query</function> or <function>ibase_execute</function>.
&return.success;
</simpara>
<para>
Frees a result set.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result_identifier</parameter></term>
<listitem>
<para>
A result set created by <function>ibase_query</function> or
<function>ibase_execute</function>.
</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

14
reference/ibase/functions/ibase-gen-id.xml
View file

@ -1,13 +1,14 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry id="function.ibase-gen-id">
<refnamediv>
<refname>ibase_gen_id</refname>
<refpurpose>Increments the named generator and returns its new value</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>ibase_gen_id</methodname>
<methodparam><type>string</type><parameter>generator</parameter></methodparam>
@ -16,11 +17,16 @@
</methodsynopsis>
&warn.undocumented.func;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns new generator value as integer, or as string if the value is too big.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

15
reference/ibase/functions/ibase-maintain-db.xml
View file

@ -1,12 +1,13 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.ibase-maintain-db">
<refnamediv>
<refname>ibase_maintain_db</refname>
<refpurpose>Execute a maintenance command on the database server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ibase_maintain_db</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
@ -18,6 +19,14 @@
&warn.undocumented.func;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

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

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ibase-modify-user">
<refnamediv>
<refname>ibase_modify_user</refname>
<refpurpose>Modify a user to a security database (only for IB6 or later)</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ibase_modify_user</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
@ -16,21 +17,32 @@
<methodparam choice="opt"><type>string</type><parameter>middle_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>last_name</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
PHP 4 uses <parameter>server</parameter>,
<parameter>dba_user_name</parameter> and
<parameter>dba_user_password</parameter> instead of
<parameter>service_handle</parameter> parameter.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
See also
<function>ibase_add_user</function> and
<function>ibase_delete_user</function>.
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_add_user</function></member>
<member><function>ibase_delete_user</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

76
reference/ibase/functions/ibase-name-result.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ibase-name-result">
<refnamediv>
<refname>ibase_name_result</refname>
<refpurpose>Assigns a name to a result set</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ibase_name_result</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
@ -15,30 +16,73 @@
<para>
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>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
An InterBase result set.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
Tbe name to be assigned.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
<informalexample>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ibase_name_result</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$result = ibase_query("SELECT field1,field2 FROM table FOR UPDATE");
ibase_name_result($result, "my_cursor");
$result = ibase_query("SELECT field1,field2 FROM table FOR UPDATE");
ibase_name_result($result, "my_cursor");
$updateqry = ibase_prepare("UPDATE table SET field2 = ? WHERE CURRENT OF my_cursor");
$updateqry = ibase_prepare("UPDATE table SET field2 = ? WHERE CURRENT OF my_cursor");
for ($i = 0; ibase_fetch_row($result); ++$i) {
ibase_execute($updateqry, $i);
}
for ($i = 0; ibase_fetch_row($result); ++$i) {
ibase_execute($updateqry, $i);
}
?>
]]>
</programlisting>
</informalexample>
</para>
<para>
See also
<function>ibase_prepare</function> and
<function>ibase_execute</function>.
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_prepare</function></member>
<member><function>ibase_execute</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

78
reference/ibase/functions/ibase-num-fields.xml
View file

@ -1,43 +1,79 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.12 -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.ibase-num-fields">
<refnamediv>
<refname>ibase_num_fields</refname>
<refpurpose>Get the number of fields in a result set</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ibase_num_fields</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
</methodsynopsis>
<para>
Returns an integer containing the number of fields in a result
set.
<informalexample>
Get the number of fields in a result set.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
An InterBase result identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of fields as an integer.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ibase_num_fields</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$rs = ibase_query("SELECT * FROM tablename");
$coln = ibase_num_fields($rs);
for ($i = 0; $i < $coln; $i++) {
$col_info = ibase_field_info($rs, $i);
echo "name: " . $col_info['name'] . "\n";
echo "alias: " . $col_info['alias'] . "\n";
echo "relation: " . $col_info['relation'] . "\n";
echo "length: " . $col_info['length'] . "\n";
echo "type: " . $col_info['type'] . "\n";
}
$rs = ibase_query("SELECT * FROM tablename");
$coln = ibase_num_fields($rs);
for ($i = 0; $i < $coln; $i++) {
$col_info = ibase_field_info($rs, $i);
echo "name: " . $col_info['name'] . "\n";
echo "alias: " . $col_info['alias'] . "\n";
echo "relation: " . $col_info['relation'] . "\n";
echo "length: " . $col_info['length'] . "\n";
echo "type: " . $col_info['type'] . "\n";
}
?>
]]>
</programlisting>
</informalexample>
</para>
<para>
See also: <function>ibase_field_info</function>.
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_field_info</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

42
reference/ibase/functions/ibase-num-params.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.ibase-num-params">
<refnamediv>
<refname>ibase_num_params</refname>
<refpurpose>Return the number of parameters in a prepared query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ibase_num_params</methodname>
<methodparam><type>resource</type><parameter>query</parameter></methodparam>
@ -16,12 +17,41 @@
by <parameter>query</parameter>. This is the number of binding arguments that
must be present when calling <function>ibase_execute</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also
<function>ibase_prepare</function> and
<function>ibase_param_info</function>.
<variablelist>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
The prepared query handle.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of parameters as an integer.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_prepare</function></member>
<member><function>ibase_param_info</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

59
reference/ibase/functions/ibase-param-info.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.ibase-param-info">
<refnamediv>
<refname>ibase_param_info</refname>
<refpurpose>Return information about a parameter in a prepared query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>ibase_param_info</methodname>
<methodparam><type>resource</type><parameter>query</parameter></methodparam>
@ -14,15 +15,53 @@
</methodsynopsis>
<para>
Returns an array with information about a parameter after a
query has been prepared. The array is in the form of name, alias,
relation, length, type.
</para>
<para>
See also
<function>ibase_field_info</function> and
<function>ibase_num_params</function>.
query has been prepared.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
An InterBase prepared query handle.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>param_number</parameter></term>
<listitem>
<para>
Parameter offset.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array with the following keys: <literal>name</literal>,
<literal>alias</literal>, <literal>relation</literal>,
<literal>length</literal> and <literal>type</literal>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_field_info</function></member>
<member><function>ibase_num_params</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

174
reference/ibase/functions/ibase-pconnect.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.ibase-pconnect">
<refnamediv>
<refname>ibase_pconnect</refname>
<refpurpose>Open a persistent connection to an InterBase database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>ibase_pconnect</methodname>
<methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam>
@ -19,42 +19,152 @@
<methodparam choice="opt"><type>string</type><parameter>role</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>sync</parameter></methodparam>
</methodsynopsis>
<para>
Opens a persistent connection to an InterBase database.
</para>
<para>
<function>ibase_pconnect</function> acts very much like
<function>ibase_connect</function> with two major differences.
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. 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
</para>
<para>
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>
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>
<note>
<para>
<parameter>buffers</parameter> was added in PHP 4.0.0.
</para>
</note>
<note>
<para>
<parameter>dialect</parameter> was added in PHP 4.0.0. It is
functional only with InterBase 6 and versions higher than that.
</para>
</note>
<note>
<para>
<parameter>role</parameter> was added in PHP 4.0.0. It is
functional only with InterBase 5 and versions higher than that.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>ibase_close</function> and
<function>ibase_connect</function> for the meaning of
parameters passed to this function. They are exactly the same.
<variablelist>
<varlistentry>
<term><parameter>database</parameter></term>
<listitem>
<para>
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>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<para>
The user name. Can be set with the
<literal>ibase.default_user</literal> &php.ini; directive.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The password for <parameter>username</parameter>. Can be set with the
<literal>ibase.default_password</literal> &php.ini; directive.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>charset</parameter></term>
<listitem>
<para>
<parameter>charset</parameter> is the default character set for a
database.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>buffers</parameter></term>
<listitem>
<para>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dialect</parameter></term>
<listitem>
<para>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>role</parameter></term>
<listitem>
<para>
Functional only with InterBase 5 and up.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sync</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an InterBase link identifier on success, or &false; on error.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>4.0.0</entry>
<entry>
The <parameter>buffers</parameter>, <parameter>dialect</parameter>
and <parameter>role</parameter> parameters were added
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_close</function></member>
<member><function>ibase_connect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

36
reference/ibase/functions/ibase-prepare.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.ibase-prepare">
<refnamediv>
<refname>ibase_prepare</refname>
<refpurpose>Prepare a query for later binding of parameter placeholders and execution</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>ibase_prepare</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
@ -24,10 +24,34 @@
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<simpara>
Prepare a query for later binding of parameter placeholders and
execution (via <function>ibase_execute</function>).
Prepare a query for later binding of parameter placeholders and execution
(via <function>ibase_execute</function>).
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
An InterBase query.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a prepared query handle, or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

118
reference/ibase/functions/ibase-query.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.ibase-query">
<refnamediv>
<refname>ibase_query</refname>
<refpurpose>Execute a query on an InterBase database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>ibase_query</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
@ -15,11 +15,73 @@
<methodparam choice="opt"><type>int</type><parameter>bind_args</parameter></methodparam>
</methodsynopsis>
<simpara>
Performs a query on an InterBase database. 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;.
Performs a query on an InterBase database.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
An InterBase link identifier. If omitted, the last opened link is
assumed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
An InterBase query.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>bind_args</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
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>
<note>
<para>
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>
</note>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
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>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ibase_query</function> example</title>
@ -27,42 +89,32 @@
<![CDATA[
<?php
$host = 'localhost:/path/to/your.gdb';
$host = 'localhost:/path/to/your.gdb';
$dbh = ibase_connect($host, $username, $password);
$stmt = 'SELECT * FROM tblname';
$dbh = ibase_connect($host, $username, $password);
$stmt = 'SELECT * FROM tblname';
$sth = ibase_query($dbh, $stmt) or die(ibase_errmsg());
$sth = ibase_query($dbh, $stmt) or die(ibase_errmsg());
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
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>
</note>
<note>
<para>
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>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>ibase_errmsg</function>,
<function>ibase_fetch_row</function>,
<function>ibase_fetch_object</function>, and
<function>ibase_free_result</function>.
<simplelist>
<member><function>ibase_errmsg</function></member>
<member><function>ibase_fetch_row</function></member>
<member><function>ibase_fetch_object</function></member>
<member><function>ibase_free_result</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/ibase/functions/ibase-restore.xml
View file

@ -1,12 +1,13 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.ibase-restore">
<refnamediv>
<refname>ibase_restore</refname>
<refpurpose>Initiates a restore task in the service manager and returns immediately</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>ibase_restore</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
@ -19,6 +20,7 @@
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

43
reference/ibase/functions/ibase-rollback-ret.xml
View file

@ -1,26 +1,51 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.ibase-rollback-ret">
<refnamediv>
<refname>ibase_rollback_ret</refname>
<refpurpose>Roll back a transaction without closing it</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ibase_rollback_ret</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_or_trans_identifier</parameter></methodparam>
</methodsynopsis>
<para>
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.
The transaction context will be retained, so statements executed from within
this transaction will not be invalidated.
Rolls back a transaction without closing it.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>link_or_trans_identifier</parameter></term>
<listitem>
<para>
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. The transaction context
will be retained, so statements executed from within this transaction
will not be invalidated.
</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

40
reference/ibase/functions/ibase-rollback.xml
View file

@ -1,25 +1,49 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.23 -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.ibase-rollback">
<refnamediv>
<refname>ibase_rollback</refname>
<refpurpose>Roll back a transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ibase_rollback</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_or_trans_identifier</parameter></methodparam>
</methodsynopsis>
<para>
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.
Rolls back a transaction.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>link_or_trans_identifier</parameter></term>
<listitem>
<para>
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>
</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

8
reference/ibase/functions/ibase-server-info.xml
View file

@ -1,12 +1,13 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.ibase-server-info">
<refnamediv>
<refname>ibase_server_info</refname>
<refpurpose>Request information about a database server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ibase_server_info</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
@ -16,6 +17,7 @@
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/ibase/functions/ibase-service-attach.xml
View file

@ -1,12 +1,13 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.ibase-service-attach">
<refnamediv>
<refname>ibase_service_attach</refname>
<refpurpose>Connect to the service manager</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>ibase_service_attach</methodname>
<methodparam><type>string</type><parameter>host</parameter></methodparam>
@ -17,6 +18,7 @@
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

15
reference/ibase/functions/ibase-service-detach.xml
View file

@ -1,12 +1,13 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.ibase-service-detach">
<refnamediv>
<refname>ibase_service_detach</refname>
<refpurpose>Disconnect from the service manager</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ibase_service_detach</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
@ -15,6 +16,14 @@
&warn.undocumented.func;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

100
reference/ibase/functions/ibase-set-event-handler.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- $Revision: 1.10 $ -->
<refentry id="function.ibase-set-event-handler">
<refnamediv>
<refname>ibase_set_event_handler</refname>
<refpurpose>Register a callback function to be called when events are posted</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>ibase_set_event_handler</methodname>
<methodparam><type>callback</type><parameter>event_handler</parameter></methodparam>
@ -23,24 +24,79 @@
<methodparam choice="opt"><type>string</type><parameter>...</parameter></methodparam>
</methodsynopsis>
<para>
This function registers a PHP user function as event handler for the specified
events. 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. 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.
This function registers a PHP user function as event handler for the
specified events.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<informalexample>
<variablelist>
<varlistentry>
<term><parameter>event_handler</parameter></term>
<listitem>
<para>
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>
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>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>event_name1</parameter></term>
<listitem>
<para>
An event name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>event_name2</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
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>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ibase_set_event_handler</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
function event_handler($event_name, $link)
{
if ($event_name=="NEW ORDER") {
if ($event_name == "NEW ORDER") {
// process new order
ibase_query($link, "UPDATE orders SET status='handled'");
} else if ($event_name=="DB_SHUTDOWN") {
} else if ($event_name == "DB_SHUTDOWN") {
// free event handler
return false;
}
@ -50,18 +106,20 @@ ibase_set_event_handler($link, "event_handler", "NEW_ORDER", "DB_SHUTDOWN");
?>
]]>
</programlisting>
</informalexample>
</para>
<para>
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>
<para>
See also
<function>ibase_free_event_handler</function> and
<function>ibase_wait_event</function>.
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_free_event_handler</function></member>
<member><function>ibase_wait_event</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

92
reference/ibase/functions/ibase-timefmt.xml
View file

@ -1,49 +1,89 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.2 -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.ibase-timefmt">
<refnamediv>
<refname>ibase_timefmt</refname>
<refpurpose>Sets the format of timestamp, date and time type columns returned from queries</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ibase_timefmt</methodname>
<type>bool</type><methodname>ibase_timefmt</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>columntype</parameter></methodparam>
</methodsynopsis>
<para>
Sets the format of timestamp, date or time type columns returned
from queries. Internally, the columns are formatted by c-function
strftime(), so refer to its documentation regarding to the format
of the string. <parameter>columntype</parameter> is one of the
constants IBASE_TIMESTAMP, IBASE_DATE and IBASE_TIME. If omitted,
defaults to IBASE_TIMESTAMP for backwards compatibility.
</para>
<para>
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
/* InterBase 6 TIME-type columns will be returned in
* the form '05 hours 37 minutes'. */
ibase_timefmt("%H hours %M minutes", IBASE_TIME);
?>
]]>
</programlisting>
</informalexample>
Sets the format of timestamp, date or time type columns returned from
queries.
</para>
<para>
You can set defaults for these formats with the PHP configuration
directives ibase.timestampformat, ibase.dateformat and ibase.timeformat.
directives <literal>ibase.timestampformat</literal>,
<literal>ibase.dateformat</literal> and
<literal>ibase.timeformat</literal>.
</para>
<note>
<para>
This function has been removed from PHP 5, use <function>ini_set</function> instead.
This function has been removed from PHP 5, use
<function>ini_set</function> instead.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>format</parameter></term>
<listitem>
<para>
Internally, the columns are formatted by c-function strftime(), so
refer to its documentation regarding to the format of the string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>columntype</parameter></term>
<listitem>
<para>
<parameter>columntype</parameter> is one of the constants
<constant>IBASE_TIMESTAMP</constant>, <constant>IBASE_DATE</constant>
and <constant>IBASE_TIME</constant>. If omitted, defaults to
<constant>IBASE_TIMESTAMP</constant> for backwards compatibility.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ibase_timefmt</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* InterBase 6 TIME-type columns will be returned in
* the form '05 hours 37 minutes'. */
ibase_timefmt("%H hours %M minutes", IBASE_TIME);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

56
reference/ibase/functions/ibase-trans.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.23 -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.ibase-trans">
<refnamediv>
<refname>ibase_trans</refname>
<refpurpose>Begin a transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>ibase_trans</methodname>
<methodparam choice="opt"><type>int</type><parameter>trans_args</parameter></methodparam>
@ -16,12 +16,6 @@
<para>
Begins a transaction.
</para>
<para>
<parameter>trans_args</parameter> can be a combination of
IBASE_READ, IBASE_WRITE, IBASE_COMMITTED, IBASE_CONSISTENCY,
IBASE_CONCURRENCY, IBASE_REC_VERSION, IBASE_REC_NO_VERSION,
IBASE_WAIT and IBASE_NOWAIT.
</para>
<note>
<para>
The behaviour of this function has been changed in PHP 5.0.0. The first call
@ -48,6 +42,48 @@
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>trans_args</parameter></term>
<listitem>
<para>
<parameter>trans_args</parameter> can be a combination of
<constant>IBASE_READ</constant>,
<constant>IBASE_WRITE</constant>,
<constant>IBASE_COMMITTED</constant>,
<constant>IBASE_CONSISTENCY</constant>,
<constant>IBASE_CONCURRENCY</constant>,
<constant>IBASE_REC_VERSION</constant>,
<constant>IBASE_REC_NO_VERSION</constant>,
<constant>IBASE_WAIT</constant> and
<constant>IBASE_NOWAIT</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
An InterBase link identifier. If omitted, the last opened link is
assumed.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a transaction handle, or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

56
reference/ibase/functions/ibase-wait-event.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.ibase-wait-event">
<refnamediv>
<refname>ibase_wait_event</refname>
<refpurpose>Wait for an event to be posted by the database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ibase_wait_event</methodname>
<methodparam><type>string</type><parameter>event_name1</parameter></methodparam>
@ -25,12 +26,55 @@
is posted by the database. The name of the event that was posted is returned. This
function accepts up to 15 event arguments.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also
<function>ibase_set_event_handler</function> and
<function>ibase_free_event_handler</function>.
<variablelist>
<varlistentry>
<term><parameter>event_name1</parameter></term>
<listitem>
<para>
The event name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>event_name2</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the name of the event that was posted.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_set_event_handler</function></member>
<member><function>ibase_free_event_handler</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file