Files
2024-12-03 09:41:34 -03:00

208 lines
6.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 855bfee2f3db70d7dbb4c60c7c4a4efa567f1c60 Maintainer: fernandowobeto Status: ready --><!-- CREDITS: fernandowobeto -->
<refentry xml:id="sqlite3stmt.bindvalue" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SQLite3Stmt::bindValue</refname>
<refpurpose>Vincula o valor de um parâmetro a uma variável de instrução</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SQLite3Stmt">
<modifier>public</modifier> <type>bool</type><methodname>SQLite3Stmt::bindValue</methodname>
<methodparam><type class="union"><type>string</type><type>int</type></type><parameter>param</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>type</parameter><initializer><constant>SQLITE3_TEXT</constant></initializer></methodparam>
</methodsynopsis>
<para>
Vincula o valor de um parâmetro a uma variável de instrução.
</para>
<caution>
<para>
Antes do PHP 7.2.14 e 7.3.0, respectivamente, uma vez que a instrução foi
executada, <methodname>SQLite3Stmt::reset</methodname> precisa ser chamado para
poder alterar o valor dos parâmetros vinculados.
</para>
</caution>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>param</parameter></term>
<listitem>
<para>
Ou uma <type>string</type> (para parâmetros nomeados) ou um <type>int</type>
(para parâmetros posicionais) identificando a variável de instrução à qual o
valor deve ser vinculado.
Se um parâmetro nomeado não começar com dois pontos (<literal>:</literal>) ou
um sinal de arroba (<literal>@</literal>), dois pontos (<literal>:</literal>) são automaticamente adicionados.
Parâmetros posicionais começam com <literal>1</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
O valor a ser vinculado a uma variável de instrução.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<para>
O tipo de dados do valor a ser vinculado.
<itemizedlist>
<listitem>
<para>
<constant>SQLITE3_INTEGER</constant>: O valor é um inteiro assinado,
armazenado em 1, 2, 3, 4, 6 ou 8 bytes, dependendo da magnitude
do valor.
</para>
</listitem>
<listitem>
<para>
<constant>SQLITE3_FLOAT</constant>: O valor é um valor de ponto flutuante,
armazenado como um número de ponto flutuante IEEE de 8 bytes.
</para>
</listitem>
<listitem>
<para>
<constant>SQLITE3_TEXT</constant>: O valor é uma string de texto, armazenada
usando a codificação do banco de dados (UTF-8, UTF-16BE ou UTF-16-LE).
</para>
</listitem>
<listitem>
<para>
<constant>SQLITE3_BLOB</constant>: O valor é um blob de dados, armazenado
exatamente como foi inserido.
</para>
</listitem>
<listitem>
<para>
<constant>SQLITE3_NULL</constant>: O valor é um valor NULL.
</para>
</listitem>
</itemizedlist>
</para>
<para>
A partir do PHP 7.0.7, se <parameter>type</parameter> for omitido, ele é
automaticamente detectado a partir do tipo do <parameter>value</parameter>: <type>bool</type>
e <type>int</type> são tratados como <constant>SQLITE3_INTEGER</constant>,
<type>float</type> como <constant>SQLITE3_FLOAT</constant>, <type>null</type>
como <constant>SQLITE3_NULL</constant> e todos os outros como <constant>SQLITE3_TEXT</constant>.
Anteriormente, se <parameter>type</parameter> fosse omitido, ele era predefinido
como <constant>SQLITE3_TEXT</constant>.
</para>
<note>
<para>
Se <parameter>value</parameter> for &null;, ele é sempre tratado como
<constant>SQLITE3_NULL</constant>, independentemente do <parameter>type</parameter>
fornecido.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retorna &true; se o valor for vinculado à variável de instrução, &return.falseforfailure;.
</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>param</parameter> agora também suporta a notação
<literal>@param</literal>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemplo de <function>SQLite3Stmt::bindValue</function></title>
<programlisting role="php">
<![CDATA[
<?php
$db = new SQLite3(':memory:');
$db->exec('CREATE TABLE foo (id INTEGER, bar STRING)');
$db->exec("INSERT INTO foo (id, bar) VALUES (1, 'Isto é um teste')");
$stmt = $db->prepare('SELECT bar FROM foo WHERE id=:id');
$stmt->bindValue(':id', 1, SQLITE3_INTEGER);
$result = $stmt->execute();
var_dump($result->fetchArray(SQLITE3_ASSOC));
?>
]]>
</programlisting>
&example.outputs;
<screen role="php">
<![CDATA[
array(1) {
["bar"]=>
string(14) "Isto é um teste"
}
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>SQLite3Stmt::bindParam</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
-->