wez Sat Sep 10 12:39:22 2005 EDT
Added files:
/phpdoc/en/reference/pdo/functions PDOStatement-bindValue.xml
Modified files:
/phpdoc/en/reference/pdo/functions PDOStatement-bindParam.xml
Log:
Document new bindValue() method.
http://cvs.php.net/diff.php/phpdoc/en/reference/pdo/functions/PDOStatement-bindParam.xml?r1=1.8&r2=1.9&ty=u
Index: phpdoc/en/reference/pdo/functions/PDOStatement-bindParam.xml
diff -u phpdoc/en/reference/pdo/functions/PDOStatement-bindParam.xml:1.8
phpdoc/en/reference/pdo/functions/PDOStatement-bindParam.xml:1.9
--- phpdoc/en/reference/pdo/functions/PDOStatement-bindParam.xml:1.8 Mon Jul
11 08:31:57 2005
+++ phpdoc/en/reference/pdo/functions/PDOStatement-bindParam.xml Sat Sep
10 12:39:21 2005
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc.
-->
<refentry id="function.PDOStatement-bindParam">
<refnamediv>
@@ -20,8 +20,11 @@
</methodsynopsis>
&warn.experimental.func;
<para>
- Binds a parameter to a corresponding named or question mark placeholder
- in the SQL statement that was use to prepare the statement.
+ Binds a PHP variable to a corresponding named or question mark placeholder
+ in the SQL statement that was use to prepare the statement. Unlike
+ <function>PDOStatement::bindValue</function>, the variable is bound as a
+ reference and will only be evaluated at the time that
+ <function>PDOStatement::execute</function> is called.
</para>
<para>
Most parameters are input parameters, that is, parameters that are used
@@ -173,6 +176,7 @@
<simplelist>
<member><function>PDO::prepare</function></member>
<member><function>PDOStatement::execute</function></member>
+ <member><function>PDOStatement::bindValue</function></member>
</simplelist>
</para>
http://cvs.php.net/co.php/phpdoc/en/reference/pdo/functions/PDOStatement-bindValue.xml?r=1.1&p=1
Index: phpdoc/en/reference/pdo/functions/PDOStatement-bindValue.xml
+++ phpdoc/en/reference/pdo/functions/PDOStatement-bindValue.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<refentry id="function.PDOStatement-bindValue">
<refnamediv>
<refname>PDOStatement::bindValue</refname>
<refpurpose>
Binds a value to a parameter
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>PDOStatement::bindValue</methodname>
<methodparam><type>mixed</type><parameter>parameter</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>data_type</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Binds a value to a corresponding named or question mark placeholder
in the SQL statement that was use to prepare the statement.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>parameter</parameter></term>
<listitem>
<para>
Parameter identifier. For a prepared statement using named
placeholders, this will be a parameter name of the form
<varname>:name</varname>. For a prepared statement using
question mark placeholders, this will be the 1-indexed position of
the parameter.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
The value to bind to the parameter.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data_type</parameter></term>
<listitem>
<para>
Explicit data type for the parameter using the PDO_PARAM_*
constants.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example><title>Execute a prepared statement with named placeholders</title>
<programlisting role='php'>
<![CDATA[
<?php
/* Execute a prepared statement by binding PHP variables */
$calories = 150;
$colour = 'red';
$sth = $dbh->prepare('SELECT name, colour, calories
FROM fruit
WHERE calories < :calories AND colour = :colour');
$sth->bindValue(':calories', $calories, PDO_PARAM_INT);
$sth->bindValue(':colour', $colour, PDO_PARAM_STR);
$sth->execute();
?>
]]>
</programlisting>
</example>
<example><title>Execute a prepared statement with question mark
placeholders</title>
<programlisting role='php'>
<![CDATA[
<?php
/* Execute a prepared statement by binding PHP variables */
$calories = 150;
$colour = 'red';
$sth = $dbh->prepare('SELECT name, colour, calories
FROM fruit
WHERE calories < ? AND colour = ?');
$sth->bindValue(1, $calories, PDO_PARAM_INT);
$sth->bindValue(2, $colour, PDO_PARAM_STR);
$sth->execute();
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>PDO::prepare</function></member>
<member><function>PDOStatement::execute</function></member>
<member><function>PDOStatement::bindParam</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
