php-doc-en/reference/sqlite3/sqlite3stmt/bindparam.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="sqlite3stmt.bindparam" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>SQLite3Stmt::bindParam</refname>
  <refpurpose>Binds a parameter to a statement variable</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>SQLite3Stmt::bindParam</methodname>
   <methodparam><type>mixed</type><parameter>sql_param</parameter></methodparam>
   <methodparam><type>mixed</type><parameter role="reference">param</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam>
  </methodsynopsis>
  <para>
   Binds a parameter to a statement variable.
  </para>
  <caution>
   <para>
    Before PHP 7.2.14 and 7.3.0, respectively,
    <methodname>SQLite3Stmt::reset</methodname> must be called after the first call to
    <methodname>SQLite3Stmt::execute</methodname> if the bound value should be properly
    updated on following calls to <methodname>SQLite3Stmt::execute</methodname>.
    If <methodname>SQLite3Stmt::reset</methodname> is not called, the bound value will
    not change, even if the value assigned to the variable passed to
    <methodname>SQLite3Stmt::bindParam</methodname> has changed, or
    <methodname>SQLite3Stmt::bindParam</methodname> has been called again.
   </para>
  </caution>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>sql_param</parameter></term>
     <listitem>
      <para>
       Either a <type>string</type> (for named parameters) or an <type>int</type>
       (for positional parameters) identifying the statement variable to which the
       value should be bound.
       If a named parameter does not start with a colon (<literal>:</literal>) or an
       at sign (<literal>@</literal>), a colon (<literal>:</literal>) is automatically preprended.
       Positional parameters start with <literal>1</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>param</parameter></term>
     <listitem>
      <para>
       The parameter to bind to a statement variable.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>type</parameter></term>
     <listitem>
      <para>
       The data type of the parameter to bind.
       <itemizedlist>
        <listitem>
         <para>
          <constant>SQLITE3_INTEGER</constant>: The value is a signed integer,
          stored in 1, 2, 3, 4, 6, or 8 bytes depending on the magnitude of
          the value.
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>SQLITE3_FLOAT</constant>: The value is a floating point
          value, stored as an 8-byte IEEE floating point number.
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>SQLITE3_TEXT</constant>: The value is a text string, stored
          using the database encoding (UTF-8, UTF-16BE or UTF-16-LE).
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>SQLITE3_BLOB</constant>: The value is a blob of data, stored
          exactly as it was input.
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>SQLITE3_NULL</constant>: The value is a NULL value.
         </para>
        </listitem>
       </itemizedlist>
      </para>
      <para>
       As of PHP 7.0.7, if <parameter>type</parameter> is omitted, it is automatically
       detected from the type of the <parameter>param</parameter>: <type>boolean</type>
       and <type>integer</type> are treated as <constant>SQLITE3_INTEGER</constant>,
       <type>float</type> as <constant>SQLITE3_FLOAT</constant>, <type>null</type>
       as <constant>SQLITE3_NULL</constant> and all others as <constant>SQLITE3_TEXT</constant>.
       Formerly, if <parameter>type</parameter> has been omitted, it has defaulted
       to <constant>SQLITE3_TEXT</constant>.
      </para>
      <note>
       <para>
        If <parameter>param</parameter> is &null;, it is always treated as
        <constant>SQLITE3_NULL</constant>, regardless of the given
        <parameter>type</parameter>.
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns &true; if the parameter is bound to the statement variable, &false;
   on failure.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>7.4.0</entry>
      <entry>
       <parameter>sql_param</parameter> now also supports the <literal>@param</literal>
       notation.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>SQLite3Stmt::bindParam</function> Usage</title>
    <para>
     This example shows how a single prepared statement with a single parameter
     binding can be used to insert multiple rows with different values.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$db = new SQLite3(':memory:');
$db->exec("CREATE TABLE foo (bar TEXT)");

$stmt = $db->prepare("INSERT INTO foo VALUES (:bar)");
$stmt->bindParam(':bar', $bar, SQLITE3_TEXT);

$bar = 'baz';
$stmt->execute();

$bar = 42;
$stmt->execute();

$res = $db->query("SELECT * FROM foo");
while (($row = $res->fetchArray(SQLITE3_ASSOC))) {
    var_dump($row);
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen role="php">
<![CDATA[
array(1) {
  ["bar"]=>
  string(3) "baz"
}
array(1) {
  ["bar"]=>
  string(2) "42"
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>SQLite3Stmt::bindValue</methodname></member>
   <member><methodname>SQLite3::prepare</methodname></member>
  </simplelist>
 </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:"~/.phpdoc/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
-->