implemented new doc style, changelog, parameter info, and general cleanup.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@260047 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2008-05-20 14:59:05 +00:00
parent 891e1f15b2
commit 2fb51efc71

View file

@ -1,55 +1,50 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.5 -->
<!-- $Revision: 1.11 $ -->
<refentry xml:id="function.odbc-execute" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_execute</refname>
<refpurpose>Execute a prepared statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>odbc_execute</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>parameters_array</parameter></methodparam>
</methodsynopsis>
<para>
Executes a statement prepared with
<function>odbc_prepare</function>.&return.success; The array
<parameter>parameters_array</parameter> only needs to be given if
you really have parameters in your statement.
Executes a statement prepared with <function>odbc_prepare</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
Parameters in <parameter>parameter_array</parameter> will be
substituted for placeholders in the prepared statement in order.
Elements of this array will be converted to strings by calling this
function.
</para>
<para>
Any parameters in <parameter>parameter_array</parameter> which
start and end with single quotes will be taken as the name of a
file to read and send to the database server as the data for the
appropriate placeholder.
</para>
<note>
<para>
As of PHP 4.1.1, this file reading functionality has the
following restrictions:
<itemizedlist>
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<simpara>
File reading is <emphasis>not</emphasis> subject to any
&safemode; or <link linkend="ini.open-basedir">open-basedir</link>
restrictions. This is fixed in PHP 4.2.0.
</simpara>
</listitem>
<listitem>
<simpara>
<link linkend="features.remote-files">Remote files</link>
are not supported.
</simpara>
<para>
The result id <type>resource</type>, from <function>odbc_prepare</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>parameters_array</parameter></term>
<listitem>
<para>
Parameters in <parameter>parameter_array</parameter> will be
substituted for placeholders in the prepared statement in order.
Elements of this array will be converted to strings by calling this
function.
</para>
<para>
Any parameters in <parameter>parameter_array</parameter> which
start and end with single quotes will be taken as the name of a
file to read and send to the database server as the data for the
appropriate placeholder.
</para>
<simpara>
If you wish to store a string which actually begins and ends with
single quotes, you must add a space or other non-single-quote character
@ -59,10 +54,51 @@
executing the query directly with <function>odbc_exec</function>).
</simpara>
</listitem>
</itemizedlist>
</para>
</note>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>4.2.0</entry>
<entry>
File reading is now subject to &safemode; and
<link linkend="ini.open-basedir">open-basedir</link> restrictions
in <parameter>parameters_array</parameter>.
</entry>
</row>
<row>
<entry>4.1.1</entry>
<entry>
<link linkend="features.remote-files">Remote files</link>
are no longer supported in <parameter>parameters_array</parameter>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file