mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
Added basic function descriptions for every function.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@20630 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Sterling Hughes
parent
c9e9affcd1
commit
cae8a93cc3
1 changed files with 98 additions and 31 deletions
|
|
@ -1,7 +1,18 @@
|
|||
<reference id="ref.ibase">
|
||||
<title>InterBase functions</title>
|
||||
<titleabbrev>InterBase</titleabbrev>
|
||||
|
||||
<refnamediv>
|
||||
<refname>checkdate</refname>
|
||||
<refpurpose>validate a date/time</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcdef>int <function>checkdate</function></funcdef>
|
||||
<paramdef>int <parameter>month</parameter></paramdef>
|
||||
<paramdef>int <parameter>day</parameter></paramdef>
|
||||
<paramdef>int <parameter>year</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
<partintro>
|
||||
<para>
|
||||
</para>
|
||||
|
|
@ -10,14 +21,25 @@
|
|||
<refentry id="function.ibase-connect">
|
||||
<refnamediv>
|
||||
<refname>ibase_connect</refname>
|
||||
<refpurpose></refpurpose>
|
||||
<refpurpose>Open a connection to an Interbase database</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcdef> <function>ibase_connect</function></funcdef>
|
||||
<paramdef> <parameter></parameter></paramdef>
|
||||
<funcdef>int <function>ibase_connect</function></funcdef>
|
||||
<paramdef> <parameter>string database</parameter></paramdef>
|
||||
<paramdef> <optional> string username
|
||||
<optional> string password </optional>
|
||||
</optional>
|
||||
</paramdef>
|
||||
<parameter>
|
||||
</funcsynopsis>
|
||||
<simpara>
|
||||
Opens a connection to an Interbase database.
|
||||
</simpara>
|
||||
<para>
|
||||
See also: <function>ibase_pconnect</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
|
@ -27,137 +49,182 @@
|
|||
<refpurpose></refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcdef> <function>ibase_pconnect</function></funcdef>
|
||||
<paramdef> <parameter></parameter></paramdef>
|
||||
<funcdef>int <function>ibase_connect</function></funcdef>
|
||||
<paramdef> <parameter>string database</parameter></paramdef>
|
||||
<paramdef> <optional> string username
|
||||
<optional> string password </optional>
|
||||
</optional>
|
||||
</paramdef>
|
||||
<parameter>
|
||||
</funcsynopsis>
|
||||
<simpara>
|
||||
Opens a persistent connection to an Interbase database.
|
||||
</simpara>
|
||||
<para>
|
||||
See also <function>ibase_connect</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.ibase-close">
|
||||
<refnamediv>
|
||||
<refname>ibase_close</refname>
|
||||
<refpurpose></refpurpose>
|
||||
<refpurpose>Close a connection to an Interbase database</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcdef> <function>ibase_close</function></funcdef>
|
||||
<paramdef> <parameter></parameter></paramdef>
|
||||
<funcdef>int <function>ibase_close</function></funcdef>
|
||||
<paramdef> <parameter><optional>int connection_id</optional></parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
Close a connection to an Interbase database. This function takes a connection id returned from ibase_connect.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.ibase-query">
|
||||
<refnamediv>
|
||||
<refname>ibase_query</refname>
|
||||
<refpurpose></refpurpose>
|
||||
<refpurpose> Execute a query on an Interbase database</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcdef> <function>ibase_query</function></funcdef>
|
||||
<paramdef> <parameter></parameter></paramdef>
|
||||
<funcdef>int <function>ibase_query</function></funcdef>
|
||||
<paramdef> <parameter><optional> int link_identifier</optional></parameter></paramdef>
|
||||
<paramdef> <parameter> string query </parameter> </paramdef>
|
||||
</funcsynopsis>
|
||||
<simpara>
|
||||
Performs a query on a Interbase database, returning a result identifier for use with <function>ibase_fetch_row</function>,
|
||||
<function>ibase_free_result</function> and <function>ibase_free_query</function>.
|
||||
</simpara>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.ibase-fetch-row">
|
||||
<refnamediv>
|
||||
<refname>ibase_fetch_row</refname>
|
||||
<refpurpose></refpurpose>
|
||||
<refpurpose> Fetch a row from an Interbase database</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcdef> <function>ibase_fetch_row</function></funcdef>
|
||||
<paramdef> <parameter></parameter></paramdef>
|
||||
<funcdef>int <function>ibase_fetch_row</function></funcdef>
|
||||
<paramdef> <parameter>int result_identifier</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
<simpara>
|
||||
Returns the next row specified by the result identifier obtained using the <function>ibase_query</function>.
|
||||
</simpara>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.ibase-free-result">
|
||||
<refnamediv>
|
||||
<refname>ibase_free_result</refname>
|
||||
<refpurpose></refpurpose>
|
||||
<refpurpose> Free a result set</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcdef> <function>ibase_free_result</function></funcdef>
|
||||
<paramdef> <parameter></parameter></paramdef>
|
||||
<funcdef>int <function>ibase_free_result</function></funcdef>
|
||||
<paramdef> <parameter>int result_identifier</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
<simpara>
|
||||
Free's a result set the has been created by <function>ibase_query</function>.
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.ibase-prepare">
|
||||
<refnamediv>
|
||||
<refname>ibase_prepare</refname>
|
||||
<refpurpose></refpurpose>
|
||||
<refpurpose>Prepare a query for later binding of parameter placeholders and execution.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcdef> <function>ibase_prepare</function></funcdef>
|
||||
<paramdef> <parameter></parameter></paramdef>
|
||||
<funcdef>int <function>ibase_prepare</function></funcdef>
|
||||
<paramdef> <parameter><optional>int link_identifier</optional></parameter></paramdef>
|
||||
<paramdef> <parameter> string query</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
<simpara>
|
||||
Prepare a query for later binding of parameter placeholders (via <function>ibase_bind</function>) and execution
|
||||
(via <function>ibase_execute</function>).
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.ibase-bind">
|
||||
<refnamediv>
|
||||
<refname>ibase_bind</refname>
|
||||
<refpurpose></refpurpose>
|
||||
<refpurpose>Bind placeholder parameters from a previously prepared query</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcdef> <function>ibase_bind</function></funcdef>
|
||||
<paramdef> <parameter></parameter></paramdef>
|
||||
<paramdef> <parameter>int query</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
<simpara>
|
||||
Bind Parameters from a query prepared by <function>ibase_prepare</function>.
|
||||
</simpara>
|
||||
<note>
|
||||
<para><function>ibase_bind</function> is currently not functional </para>
|
||||
</note>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.ibase-execute">
|
||||
<refnamediv>
|
||||
<refname>ibase_execute</refname>
|
||||
<refpurpose></refpurpose>
|
||||
<refpurpose> Execute a previously prepared query</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcdef> <function>ibase_execute</function></funcdef>
|
||||
<paramdef> <parameter></parameter></paramdef>
|
||||
<funcdef>int <function>ibase_execute</function></funcdef>
|
||||
<paramdef> <parameter>int query</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
<simpara>
|
||||
Execute a query prepared (and perhaps binded) by <function>ibase_prepare</function> and <function>ibase_bind</function>.
|
||||
</simpara>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.ibase-free-query">
|
||||
<refnamediv>
|
||||
<refname>ibase_free_query</refname>
|
||||
<refpurpose></refpurpose>
|
||||
<refpurpose>Free memory allocated by a prepared query</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcdef> <function>ibase_free_query</function></funcdef>
|
||||
<paramdef> <parameter></parameter></paramdef>
|
||||
<paramdef> <parameter>int query</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
<simpara>
|
||||
Free a query prepared by <function>ibase_prepare</function>.
|
||||
</simpara>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.ibase-timefmt">
|
||||
<refnamediv>
|
||||
<refname>ibase_timefmt</refname>
|
||||
<refpurpose></refpurpose>
|
||||
<refpurpose>Sets the format of datetime columns returned from queries. </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcdef> <function>ibase_timefmt</function></funcdef>
|
||||
<paramdef> <parameter></parameter></paramdef>
|
||||
<paramdef> <parameter>string format</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
<simpara>
|
||||
Sets the format of the datetime columns returned from queries.
|
||||
</simpara>
|
||||
<note>
|
||||
<para><function>ibase_timefmt</function> is currently not functional </para>
|
||||
</note>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue