PHP マニュアル: パラメータを変数にバインドする

説明

public bool SQLite3Stmt::bindParam(stringint $param, mixed &$var, int $type = SQLITE3_TEXT)

パラメータを変数にバインドします。

警告

PHP 7.2.14 と 7.3.0 より前のバージョンでは、バインドされた値が適切に後の SQLite3Stmt::execute の呼び出しで更新されるべき場合、 SQLite3Stmt::execute をはじめて呼んだ後に SQLite3Stmt::reset を呼び出さなければなりませんでした。 SQLite3Stmt::reset が呼び出されなかった場合、 SQLite3Stmt::bindParam に渡された変数に代入された値が変化したり、 SQLite3Stmt::bindParam を再度呼び出したりしても、バインドされた値は決して変わりませんでした。

パラメータ

param

バインドされるべき文中の値を識別する string (名前付きパラメータの場合) または (位置パラメータの場合) int。名前付きパラメータがコロン (:) やアットマーク (@) ではじまっていない場合、コロンが自動的に名前の前に付加されます。位置パラメータは 1 から始まります。

var

変数にバインドするパラメータ。

type

バインドするパラメータのデータ型。

SQLITE3_INTEGER: 符号付き整数。値の大きさに応じて 1, 2, 3, 4, 6, あるいは 8 バイトで格納されます。
SQLITE3_FLOAT: 浮動小数点数値。 8 バイトの IEEE 浮動小数点数値として格納されます。
SQLITE3_TEXT: テキスト文字列。データベースのエンコーディング (UTF-8, UTF-16BE あるいは UTF-16-LE) を用いて格納されます。
SQLITE3_BLOB: blob データ。入力がそのままの形式で格納されます。
SQLITE3_NULL: NULL 値。

PHP 7.0.7 以降では、 type が省略されると、自動的に var の型から検出します: bool と int 型は SQLITE3_INTEGER として扱われ、 float は SQLITE3_FLOAT、 null は SQLITE3_NULL、そして、これら以外は全て SQLITE3_TEXT として扱われます。これより前のバージョンでは、type が省略されると、デフォルトの型 SQLITE3_TEXT になっていました。

注意:
var が null の場合、与えられた type に関わらず、常に SQLITE3_NULL として扱われます。

戻り値

パラメータを変数にバインドした場合に true、失敗した場合に false を返します。

変更履歴

バージョン	説明
7.4.0	`param` は、 `@param` 記法もサポートするようになりました。

例

例1 SQLite3Stmt::bindParam の使い方

この例は、バインドするパラメータがひとつだけのプリペアドステートメントを使い、どのようにして異なる値を持つ複数の行を挿入するかを示しています。

<?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);
}
?>

上の例の出力は以下となります。

array(1) {
  ["bar"]=>
  string(3) "baz"
}
array(1) {
  ["bar"]=>
  string(2) "42"
}

参考

SQLite3Stmt::bindValue
SQLite3::prepare