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

WS, prepare for new doc style

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

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

@ -1,39 +1,37 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<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>
<methodsynopsis>
<type>bool</type><methodname>ibase_add_user</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>user_name</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>first_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>middle_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>last_name</parameter></methodparam>
</methodsynopsis>
<!-- $Revision: 1.4 $ -->
<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>
<methodsynopsis>
<type>bool</type><methodname>ibase_add_user</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>user_name</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>first_name</parameter></methodparam>
<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
<parameter>dba_user_password</parameter> instead of
<parameter>service_handle</parameter> parameter.
</para>
&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;
<para>
See also
<function>ibase_modify_user</function> and
<function>ibase_delete_user</function>.
</para>
</refsect1>
</refentry>
<para>
See also
<function>ibase_modify_user</function> and
<function>ibase_delete_user</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,32 +1,30 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<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>
<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>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.4 $ -->
<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>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,27 +1,25 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<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>
<methodsynopsis>
<type>mixed</type><methodname>ibase_backup</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>source_db</parameter></methodparam>
<methodparam><type>string</type><parameter>dest_file</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>verbose</parameter></methodparam>
</methodsynopsis>
<!-- $Revision: 1.2 $ -->
<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>
<methodsynopsis>
<type>mixed</type><methodname>ibase_backup</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>source_db</parameter></methodparam>
<methodparam><type>string</type><parameter>dest_file</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>verbose</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
&warn.undocumented.func;
</refsect1>
</refentry>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,34 +1,32 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<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>
<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>.
</para>
</refsect1>
</refentry>
<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>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,32 +1,30 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<refentry id='function.ibase-blob-cancel'>
<refnamediv>
<refname>ibase_blob_cancel</refname>
<refpurpose>
Cancel creating blob
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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>.
</para>
</refsect1>
</refentry>
<refentry id='function.ibase-blob-cancel'>
<refnamediv>
<refname>ibase_blob_cancel</refname>
<refpurpose>Cancel creating blob</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,34 +1,32 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<refentry id='function.ibase-blob-close'>
<refnamediv>
<refname>ibase_blob_close</refname>
<refpurpose>
Close blob
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>ibase_blob_close</methodname>
<methodparam><type>resource</type><parameter>blob_handle</parameter></methodparam>
</methodsynopsis>
<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>.
</para>
</refsect1>
</refentry>
<refentry id='function.ibase-blob-close'>
<refnamediv>
<refname>ibase_blob_close</refname>
<refpurpose>Close blob</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>ibase_blob_close</methodname>
<methodparam><type>resource</type><parameter>blob_handle</parameter></methodparam>
</methodsynopsis>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,33 +1,31 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<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>
<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>.
</para>
</refsect1>
</refentry>
<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>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,37 +1,35 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<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>
<methodsynopsis>
<type>bool</type><methodname>ibase_blob_echo</methodname>
<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>.
</para>
</refsect1>
</refentry>
<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>
<methodsynopsis>
<type>bool</type><methodname>ibase_blob_echo</methodname>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,26 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.41 -->
<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>
<methodsynopsis>
<type>string</type><methodname>ibase_blob_get</methodname>
<methodparam><type>resource</type><parameter>blob_handle</parameter></methodparam>
<methodparam><type>int</type><parameter>len</parameter></methodparam>
</methodsynopsis>
<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">
<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>
<methodsynopsis>
<type>string</type><methodname>ibase_blob_get</methodname>
<methodparam><type>resource</type><parameter>blob_handle</parameter></methodparam>
<methodparam><type>int</type><parameter>len</parameter></methodparam>
</methodsynopsis>
<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";
@ -31,25 +29,25 @@
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>
It is not possible to read from a BLOB that has been opened for writing
by <function>ibase_blob_create</function>.
</para>
</note>
<para>
See also
<function>ibase_blob_open</function>,
<function>ibase_blob_close</function> and
<function>ibase_blob_echo</function>.
</para>
</refsect1>
</refentry>
</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>
It is not possible to read from a BLOB that has been opened for writing
by <function>ibase_blob_create</function>.
</para>
</note>
<para>
See also
<function>ibase_blob_open</function>,
<function>ibase_blob_close</function> and
<function>ibase_blob_echo</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,33 +1,31 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<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>
<methodsynopsis>
<type>string</type><methodname>ibase_blob_import</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>resource</type><parameter>file_handle</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>string</type><methodname>ibase_blob_import</methodname>
<methodparam><type>resource</type><parameter>file_handle</parameter></methodparam>
</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.
</para>
<para>
<example>
<title><function>ibase_blob_import</function> example</title>
<programlisting role="php">
<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>
<methodsynopsis>
<type>string</type><methodname>ibase_blob_import</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>resource</type><parameter>file_handle</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>string</type><methodname>ibase_blob_import</methodname>
<methodparam><type>resource</type><parameter>file_handle</parameter></methodparam>
</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.
</para>
<para>
<example>
<title><function>ibase_blob_import</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$dbh = ibase_connect($host, $username, $password);
@ -53,18 +51,18 @@ if ($fd) {
}
?>
]]>
</programlisting>
</example>
</para>
<para>
See also
<function>ibase_blob_add</function>,
<function>ibase_blob_cancel</function>,
<function>ibase_blob_close</function> and
<function>ibase_blob_create</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<para>
See also
<function>ibase_blob_add</function>,
<function>ibase_blob_cancel</function>,
<function>ibase_blob_close</function> and
<function>ibase_blob_create</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,31 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<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>
<methodsynopsis>
<type>array</type><methodname>ibase_blob_info</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>blob_id</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>array</type><methodname>ibase_blob_info</methodname>
<methodparam><type>string</type><parameter>blob_id</parameter></methodparam>
</methodsynopsis>
<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>
<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>
<methodsynopsis>
<type>array</type><methodname>ibase_blob_info</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>blob_id</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>array</type><methodname>ibase_blob_info</methodname>
<methodparam><type>string</type><parameter>blob_id</parameter></methodparam>
</methodsynopsis>
<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
Local variables:

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

@ -1,37 +1,35 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.39 -->
<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>
<methodsynopsis>
<type>resource</type><methodname>ibase_blob_open</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>blob_id</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>resource</type><methodname>ibase_blob_open</methodname>
<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>.
</para>
</refsect1>
</refentry>
<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>
<methodsynopsis>
<type>resource</type><methodname>ibase_blob_open</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>blob_id</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>resource</type><methodname>ibase_blob_open</methodname>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,33 +1,31 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.2 -->
<refentry id="function.ibase-close">
<refnamediv>
<refname>ibase_close</refname>
<refpurpose>
Close a connection to an InterBase database
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ibase_close</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection_id</parameter></methodparam>
</methodsynopsis>
<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>.
</para>
</refsect1>
</refentry>
<refentry id="function.ibase-close">
<refnamediv>
<refname>ibase_close</refname>
<refpurpose>Close a connection to an InterBase database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ibase_close</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection_id</parameter></methodparam>
</methodsynopsis>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,27 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<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>
<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.
&return.success;
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<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>
<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.
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,26 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.23 -->
<refentry id="function.ibase-commit">
<refnamediv>
<refname>ibase_commit</refname>
<refpurpose>Commit a transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
&return.success;
</para>
</refsect1>
</refentry>
<refentry id="function.ibase-commit">
<refnamediv>
<refname>ibase_commit</refname>
<refpurpose>Commit a transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,52 +1,50 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.2 -->
<refentry id="function.ibase-connect">
<refnamediv>
<refname>ibase_connect</refname>
<refpurpose>
Open a connection to an InterBase database
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>ibase_connect</methodname>
<methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>buffers</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>dialect</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>role</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>sync</parameter></methodparam>
</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>.
<example>
<title><function>ibase_connect</function> example</title>
<programlisting role="php">
<refentry id="function.ibase-connect">
<refnamediv>
<refname>ibase_connect</refname>
<refpurpose>Open a connection to an InterBase database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>ibase_connect</methodname>
<methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>buffers</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>dialect</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>role</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>sync</parameter></methodparam>
</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>.
<example>
<title><function>ibase_connect</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$host = 'localhost:/path/to/your.gdb';
@ -61,43 +59,43 @@
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>
<para>
See also
<function>ibase_pconnect</function> and
<function>ibase_close</function>.
</para>
</refsect1>
</refentry>
</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>
<para>
See also
<function>ibase_pconnect</function> and
<function>ibase_close</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,26 +1,24 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.ibase-db-info">
<refnamediv>
<refname>ibase_db_info</refname>
<refpurpose>
Request statistics about a database
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>ibase_db_info</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>db</parameter></methodparam>
<methodparam><type>int</type><parameter>action</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>argument</parameter></methodparam>
</methodsynopsis>
<!-- $Revision: 1.2 $ -->
<refentry id="function.ibase-db-info">
<refnamediv>
<refname>ibase_db_info</refname>
<refpurpose>Request statistics about a database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>ibase_db_info</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>db</parameter></methodparam>
<methodparam><type>int</type><parameter>action</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>argument</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
&warn.undocumented.func;
</refsect1>
</refentry>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,35 +1,33 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<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>
<methodsynopsis>
<type>bool</type><methodname>ibase_delete_user</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>user_name</parameter></methodparam>
</methodsynopsis>
<!-- $Revision: 1.4 $ -->
<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>
<methodsynopsis>
<type>bool</type><methodname>ibase_delete_user</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>user_name</parameter></methodparam>
</methodsynopsis>
<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;
<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;
<para>
See also
<function>ibase_add_user</function> and
<function>ibase_modify_user</function>.
</para>
</refsect1>
</refentry>
<para>
See also
<function>ibase_add_user</function> and
<function>ibase_modify_user</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,30 +1,28 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.ibase-drop-db">
<refnamediv>
<refname>ibase_drop_db</refname>
<refpurpose>
Drops a database
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ibase_drop_db</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<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>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.ibase-drop-db">
<refnamediv>
<refname>ibase_drop_db</refname>
<refpurpose>Drops a database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ibase_drop_db</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<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>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,28 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.ibase-errcode">
<refnamediv>
<refname>ibase_errcode</refname>
<refpurpose>
Return an error code
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.2 $ -->
<refentry id="function.ibase-errcode">
<refnamediv>
<refname>ibase_errcode</refname>
<refpurpose>Return an error code</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,29 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.37 -->
<refentry id="function.ibase-errmsg">
<refnamediv>
<refname>ibase_errmsg</refname>
<refpurpose>
Return error messages
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
</simpara>
<para>
See also
<function>ibase_errcode</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.ibase-errmsg">
<refnamediv>
<refname>ibase_errmsg</refname>
<refpurpose>Return error messages</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
</simpara>
<para>
See also
<function>ibase_errcode</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,39 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- $Revision: 1.11 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.2 -->
<refentry id="function.ibase-execute">
<refnamediv>
<refname>ibase_execute</refname>
<refpurpose>Execute a previously prepared query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>ibase_execute</methodname>
<methodparam><type>resource</type><parameter>query</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>bind_arg</parameter></methodparam>
<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;.
</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>
<para>
<example>
<title><function>ibase_execute</function> example</title>
<programlisting role="php">
<refentry id="function.ibase-execute">
<refnamediv>
<refname>ibase_execute</refname>
<refpurpose>Execute a previously prepared query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>ibase_execute</methodname>
<methodparam><type>resource</type><parameter>query</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>bind_arg</parameter></methodparam>
<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;.
</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>
<para>
<example>
<title><function>ibase_execute</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$dbh = ibase_connect($host, $username, $password);
$dbh = ibase_connect($host, $username, $password);
$updates = array(
1 => 'Eric',
@ -49,22 +49,22 @@ 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>
<para>
See also <function>ibase_query</function>.
</para>
</refsect1>
</refentry>
</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>
<para>
See also <function>ibase_query</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,46 +1,44 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<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>
<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.
</para>
<para>
<function>ibase_fetch_assoc</function> fetches one row of data from the
<parameter>result</parameter>. If two or more columns of the result
have the same field names, the last column will take precedence. To
access the other column(s) of the same name, you either need to access
the result with numeric indices by using
<function>ibase_fetch_row</function> or use alias names in your query.
</para>
<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>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.4 $ -->
<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>
<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.
</para>
<para>
<function>ibase_fetch_assoc</function> fetches one row of data from the
<parameter>result</parameter>. If two or more columns of the result
have the same field names, the last column will take precedence. To
access the other column(s) of the same name, you either need to access
the result with numeric indices by using
<function>ibase_fetch_row</function> or use alias names in your query.
</para>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,25 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.9 -->
<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>
<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">
<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>
<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);
@ -31,27 +31,27 @@
ibase_close($dbh);
?>
]]>
</programlisting>
</informalexample>
</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>.
</para>
</refsect1>
</refentry>
</programlisting>
</informalexample>
</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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,47 +1,47 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.2 -->
<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>
<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.
</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>
<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>.
</para>
</refsect1>
</refentry>
<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>
<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.
</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>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,50 +1,48 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.23 -->
<refentry id="function.ibase-field-info">
<refnamediv>
<refname>ibase_field_info</refname>
<refpurpose>
Get information about a field
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>ibase_field_info</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>field_number</parameter></methodparam>
</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.
</para>
<para>
<informalexample>
<programlisting role="php">
<refentry id="function.ibase-field-info">
<refnamediv>
<refname>ibase_field_info</refname>
<refpurpose>Get information about a field</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>ibase_field_info</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>field_number</parameter></methodparam>
</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.
</para>
<para>
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
$rs = ibase_query("SELECT * FROM tablename");
$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";
$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>.
</para>
</refsect1>
</refentry>
</programlisting>
</informalexample>
</para>
<para>
See also: <function>ibase_num_fields</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,30 +1,28 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<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>
<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>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.2 $ -->
<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>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,25 +1,23 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.37 -->
<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>
<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>
</refsect1>
</refentry>
<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>
<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>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.2 -->
<refentry id="function.ibase-free-result">
<refnamediv>
<refname>ibase_free_result</refname>
<refpurpose>Free a result set</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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>
</refsect1>
</refentry>
<refentry id="function.ibase-free-result">
<refnamediv>
<refname>ibase_free_result</refname>
<refpurpose>Free a result set</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,29 +1,27 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- 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>
<methodsynopsis>
<type>mixed</type><methodname>ibase_gen_id</methodname>
<methodparam><type>string</type><parameter>generator</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>increment</parameter></methodparam>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<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>
<methodsynopsis>
<type>mixed</type><methodname>ibase_gen_id</methodname>
<methodparam><type>string</type><parameter>generator</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>increment</parameter></methodparam>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns new generator value as integer, or as string if the value is too big.
</para>
&warn.undocumented.func;
<para>
Returns new generator value as integer, or as string if the value is too big.
</para>
</refsect1>
</refentry>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,26 +1,24 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<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>
<methodsynopsis>
<type>bool</type><methodname>ibase_maintain_db</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>db</parameter></methodparam>
<methodparam><type>int</type><parameter>action</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>argument</parameter></methodparam>
</methodsynopsis>
<!-- $Revision: 1.2 $ -->
<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>
<methodsynopsis>
<type>bool</type><methodname>ibase_maintain_db</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>db</parameter></methodparam>
<methodparam><type>int</type><parameter>action</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>argument</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
&warn.undocumented.func;
</refsect1>
</refentry>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,39 +1,37 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<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>
<methodsynopsis>
<type>bool</type><methodname>ibase_modify_user</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>user_name</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>first_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>middle_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>last_name</parameter></methodparam>
</methodsynopsis>
<!-- $Revision: 1.4 $ -->
<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>
<methodsynopsis>
<type>bool</type><methodname>ibase_modify_user</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>user_name</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>first_name</parameter></methodparam>
<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
<parameter>dba_user_password</parameter> instead of
<parameter>service_handle</parameter> parameter.
</para>
&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;
<para>
See also
<function>ibase_add_user</function> and
<function>ibase_delete_user</function>.
</para>
</refsect1>
</refentry>
<para>
See also
<function>ibase_add_user</function> and
<function>ibase_delete_user</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,25 +1,23 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<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>
<methodsynopsis>
<type>bool</type><methodname>ibase_name_result</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<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.
&return.success;
<informalexample>
<programlisting role="php">
<!-- $Revision: 1.4 $ -->
<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>
<methodsynopsis>
<type>bool</type><methodname>ibase_name_result</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<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.
&return.success;
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
$result = ibase_query("SELECT field1,field2 FROM table FOR UPDATE");
@ -32,16 +30,16 @@
}
?>
]]>
</programlisting>
</informalexample>
</para>
<para>
See also
<function>ibase_prepare</function> and
<function>ibase_execute</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</informalexample>
</para>
<para>
See also
<function>ibase_prepare</function> and
<function>ibase_execute</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,46 +1,44 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.12 -->
<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>
<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>
<programlisting role="php">
<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>
<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>
<programlisting role="php">
<![CDATA[
<?php
$rs = ibase_query("SELECT * FROM tablename");
$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";
$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>.
</para>
</refsect1>
</refentry>
</programlisting>
</informalexample>
</para>
<para>
See also: <function>ibase_field_info</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,30 +1,28 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<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>
<methodsynopsis>
<type>int</type><methodname>ibase_num_params</methodname>
<methodparam><type>resource</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
This function returns the number of parameters in the prepared query specified
by <parameter>query</parameter>. This is the number of binding arguments that
must be present when calling <function>ibase_execute</function>.
</para>
<para>
See also
<function>ibase_prepare</function> and
<function>ibase_param_info</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.2 $ -->
<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>
<methodsynopsis>
<type>int</type><methodname>ibase_num_params</methodname>
<methodparam><type>resource</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
This function returns the number of parameters in the prepared query specified
by <parameter>query</parameter>. This is the number of binding arguments that
must be present when calling <function>ibase_execute</function>.
</para>
<para>
See also
<function>ibase_prepare</function> and
<function>ibase_param_info</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,31 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<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>
<methodsynopsis>
<type>array</type><methodname>ibase_param_info</methodname>
<methodparam><type>resource</type><parameter>query</parameter></methodparam>
<methodparam><type>int</type><parameter>param_number</parameter></methodparam>
</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>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<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>
<methodsynopsis>
<type>array</type><methodname>ibase_param_info</methodname>
<methodparam><type>resource</type><parameter>query</parameter></methodparam>
<methodparam><type>int</type><parameter>param_number</parameter></methodparam>
</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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,63 +1,61 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.2 -->
<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>
<methodsynopsis>
<type>resource</type><methodname>ibase_pconnect</methodname>
<methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>buffers</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>dialect</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>role</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>sync</parameter></methodparam>
</methodsynopsis>
<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
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>
<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.
</para>
</refsect1>
</refentry>
<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>
<methodsynopsis>
<type>resource</type><methodname>ibase_pconnect</methodname>
<methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>buffers</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>dialect</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>role</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>sync</parameter></methodparam>
</methodsynopsis>
<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
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>
<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.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,37 +1,34 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.2 -->
<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>
<methodsynopsis>
<type>resource</type><methodname>ibase_prepare</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>resource</type><methodname>ibase_prepare</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>resource</type><methodname>ibase_prepare</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>trans</parameter></methodparam>
<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>).
</simpara>
</refsect1>
</refentry>
<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>
<methodsynopsis>
<type>resource</type><methodname>ibase_prepare</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>resource</type><methodname>ibase_prepare</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>resource</type><methodname>ibase_prepare</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>trans</parameter></methodparam>
<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>).
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,29 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.2 -->
<refentry id="function.ibase-query">
<refnamediv>
<refname>ibase_query</refname>
<refpurpose>Execute a query on an InterBase database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>ibase_query</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<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;.
</simpara>
<para>
<example>
<title><function>ibase_query</function> example</title>
<programlisting role="php">
<refentry id="function.ibase-query">
<refnamediv>
<refname>ibase_query</refname>
<refpurpose>Execute a query on an InterBase database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>ibase_query</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<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;.
</simpara>
<para>
<example>
<title><function>ibase_query</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -36,34 +36,34 @@
?>
]]>
</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>
<para>
See also <function>ibase_errmsg</function>,
<function>ibase_fetch_row</function>,
<function>ibase_fetch_object</function>, and
<function>ibase_free_result</function>.
</para>
</refsect1>
</refentry>
</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>
<para>
See also <function>ibase_errmsg</function>,
<function>ibase_fetch_row</function>,
<function>ibase_fetch_object</function>, and
<function>ibase_free_result</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,27 +1,25 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<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>
<methodsynopsis>
<type>mixed</type><methodname>ibase_restore</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>source_file</parameter></methodparam>
<methodparam><type>string</type><parameter>dest_db</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>verbose</parameter></methodparam>
</methodsynopsis>
<!-- $Revision: 1.2 $ -->
<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>
<methodsynopsis>
<type>mixed</type><methodname>ibase_restore</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>source_file</parameter></methodparam>
<methodparam><type>string</type><parameter>dest_db</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>verbose</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
&warn.undocumented.func;
</refsect1>
</refentry>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,27 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<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>
<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.
&return.success;
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<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>
<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.
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,26 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.23 -->
<refentry id="function.ibase-rollback">
<refnamediv>
<refname>ibase_rollback</refname>
<refpurpose>Roll back a transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
&return.success;
</para>
</refsect1>
</refentry>
<refentry id="function.ibase-rollback">
<refnamediv>
<refname>ibase_rollback</refname>
<refpurpose>Roll back a transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,24 +1,22 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<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>
<methodsynopsis>
<type>string</type><methodname>ibase_server_info</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
<methodparam><type>int</type><parameter>action</parameter></methodparam>
</methodsynopsis>
<!-- $Revision: 1.2 $ -->
<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>
<methodsynopsis>
<type>string</type><methodname>ibase_server_info</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
<methodparam><type>int</type><parameter>action</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
&warn.undocumented.func;
</refsect1>
</refentry>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,25 +1,23 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.ibase-service-attach">
<refnamediv>
<refname>ibase_service_attach</refname>
<refpurpose>
Connect to the service manager
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>ibase_service_attach</methodname>
<methodparam><type>string</type><parameter>host</parameter></methodparam>
<methodparam><type>string</type><parameter>dba_username</parameter></methodparam>
<methodparam><type>string</type><parameter>dba_password</parameter></methodparam>
</methodsynopsis>
<!-- $Revision: 1.2 $ -->
<refentry id="function.ibase-service-attach">
<refnamediv>
<refname>ibase_service_attach</refname>
<refpurpose>Connect to the service manager</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>ibase_service_attach</methodname>
<methodparam><type>string</type><parameter>host</parameter></methodparam>
<methodparam><type>string</type><parameter>dba_username</parameter></methodparam>
<methodparam><type>string</type><parameter>dba_password</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
&warn.undocumented.func;
</refsect1>
</refentry>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,23 +1,21 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.ibase-service-detach">
<refnamediv>
<refname>ibase_service_detach</refname>
<refpurpose>
Disconnect from the service manager
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ibase_service_detach</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
</methodsynopsis>
<!-- $Revision: 1.2 $ -->
<refentry id="function.ibase-service-detach">
<refnamediv>
<refname>ibase_service_detach</refname>
<refpurpose>Disconnect from the service manager</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ibase_service_detach</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
&warn.undocumented.func;
</refsect1>
</refentry>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,49 +1,47 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<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>
<methodsynopsis>
<type>resource</type><methodname>ibase_set_event_handler</methodname>
<methodparam><type>callback</type><parameter>event_handler</parameter></methodparam>
<methodparam><type>string</type><parameter>event_name1</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>event_name2</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>...</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>resource</type><methodname>ibase_set_event_handler</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>callback</type><parameter>event_handler</parameter></methodparam>
<methodparam><type>string</type><parameter>event_name1</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>event_name2</parameter></methodparam>
<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.
</para>
<para>
<informalexample>
<programlisting role="php">
<!-- $Revision: 1.9 $ -->
<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>
<methodsynopsis>
<type>resource</type><methodname>ibase_set_event_handler</methodname>
<methodparam><type>callback</type><parameter>event_handler</parameter></methodparam>
<methodparam><type>string</type><parameter>event_name1</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>event_name2</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>...</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>resource</type><methodname>ibase_set_event_handler</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>callback</type><parameter>event_handler</parameter></methodparam>
<methodparam><type>string</type><parameter>event_name1</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>event_name2</parameter></methodparam>
<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.
</para>
<para>
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
function event_handler($event_name, $link)
function event_handler($event_name, $link)
{
if ($event_name=="NEW ORDER") {
// process new order
ibase_query($link, "UPDATE orders SET status='handled'");
} else if ($event_name=="DB_SHUTDOWN") {
// free event handler
// free event handler
return false;
}
}
@ -51,20 +49,20 @@ function event_handler($event_name, $link)
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>.
</para>
</refsect1>
</refentry>
</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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,31 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.2 -->
<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>
<methodsynopsis>
<type>int</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">
<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>
<methodsynopsis>
<type>int</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
@ -33,20 +31,20 @@
ibase_timefmt("%H hours %M minutes", IBASE_TIME);
?>
]]>
</programlisting>
</informalexample>
</para>
<para>
You can set defaults for these formats with the PHP configuration
directives ibase.timestampformat, ibase.dateformat and ibase.timeformat.
</para>
<note>
<para>
This function has been removed from PHP 5, use <function>ini_set</function> instead.
</para>
</note>
</refsect1>
</refentry>
</programlisting>
</informalexample>
</para>
<para>
You can set defaults for these formats with the PHP configuration
directives ibase.timestampformat, ibase.dateformat and ibase.timeformat.
</para>
<note>
<para>
This function has been removed from PHP 5, use <function>ini_set</function> instead.
</para>
</note>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,54 +1,54 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/ibase.xml, last change in rev 1.23 -->
<refentry id="function.ibase-trans">
<refnamediv>
<refname>ibase_trans</refname>
<refpurpose>Begin a transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>ibase_trans</methodname>
<methodparam choice="opt"><type>int</type><parameter>trans_args</parameter></methodparam>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<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
to <function>ibase_trans</function> will not return the default transaction
of a connection. All transactions started by <function>ibase_trans</function>
will be rolled back at the end of the script if they were not committed or
rolled back by either <function>ibase_commit</function> or
<function>ibase_rollback</function>.
</para>
</note>
<note>
<para>
In PHP 5.0.0. and up, this function will accept multiple <parameter>trans_args</parameter>
and <parameter>link_identifier</parameter> arguments. This allows transactions
over multiple database connections, which are committed using a 2-phase commit
algorithm. This means you can rely on the updates to either succeed in every
database, or fail in every database. It does NOT mean you can use tables from
different databases in the same query!
</para>
<para>
If you use transactions over multiple databases, you will have to specify both
the <parameter>link_id</parameter> and <parameter>transaction_id</parameter>
in calls to <function>ibase_query</function> and <function>ibase_prepare</function>.
</para>
</note>
</refsect1>
</refentry>
<refentry id="function.ibase-trans">
<refnamediv>
<refname>ibase_trans</refname>
<refpurpose>Begin a transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>ibase_trans</methodname>
<methodparam choice="opt"><type>int</type><parameter>trans_args</parameter></methodparam>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<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
to <function>ibase_trans</function> will not return the default transaction
of a connection. All transactions started by <function>ibase_trans</function>
will be rolled back at the end of the script if they were not committed or
rolled back by either <function>ibase_commit</function> or
<function>ibase_rollback</function>.
</para>
</note>
<note>
<para>
In PHP 5.0.0. and up, this function will accept multiple <parameter>trans_args</parameter>
and <parameter>link_identifier</parameter> arguments. This allows transactions
over multiple database connections, which are committed using a 2-phase commit
algorithm. This means you can rely on the updates to either succeed in every
database, or fail in every database. It does NOT mean you can use tables from
different databases in the same query!
</para>
<para>
If you use transactions over multiple databases, you will have to specify both
the <parameter>link_id</parameter> and <parameter>transaction_id</parameter>
in calls to <function>ibase_query</function> and <function>ibase_prepare</function>.
</para>
</note>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

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

@ -1,39 +1,37 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<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>
<methodsynopsis>
<type>string</type><methodname>ibase_wait_event</methodname>
<methodparam><type>string</type><parameter>event_name1</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>event_name2</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>...</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>string</type><methodname>ibase_wait_event</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>event_name1</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>event_name2</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>...</parameter></methodparam>
</methodsynopsis>
<para>
This function suspends execution of the script until one of the specified events
is posted by the database. The name of the event that was posted is returned. This
function accepts up to 15 event arguments.
</para>
<para>
See also
<function>ibase_set_event_handler</function> and
<function>ibase_free_event_handler</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.4 $ -->
<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>
<methodsynopsis>
<type>string</type><methodname>ibase_wait_event</methodname>
<methodparam><type>string</type><parameter>event_name1</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>event_name2</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>...</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>string</type><methodname>ibase_wait_event</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>event_name1</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>event_name2</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>...</parameter></methodparam>
</methodsynopsis>
<para>
This function suspends execution of the script until one of the specified events
is posted by the database. The name of the event that was posted is returned. This
function accepts up to 15 event arguments.
</para>
<para>
See also
<function>ibase_set_event_handler</function> and
<function>ibase_free_event_handler</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables: