PDO::quote

(PHP 5 >= 5.1.0, PHP 7, PHP 8, PECL pdo >= 0.2.1)

PDO::quote — クエリ用の文字列をクオートする

説明

public PDO::quote(string $string, int $type = PDO::PARAM_STR): string|false

PDO::quote() は入力文字列のまわりに引用符を付け、入力文字列にあるシングルクオートをエスケープします。その場合、構成しているドライバに適したクオート形式が使用されます。

この関数を SQL の構築に使用する場合、 SQL ステートメントにユーザーの入力値を埋め込むための PDO::quote() を使用する代わりに、バインドパラメータを用いて SQL を準備するための PDO::prepare() を使用することが強く推奨されます。バインドパラメータを用いるプリペアドステートメントは、補間されたクエリした場合に比べ、移植性や利便性に優れ、SQL インジェクションに対する免疫力を持つだけでなくしばしばより高速で、サーバーやクライアント側でコンパイル済みの形式でクエリをキャッシュする事が可能です。

全ての PDO ドライバがこのメソッドを実装しているわけではありません (たとえば PDO_ODBC などの例があります)。代わりにプリペアドステートメントを使用することを検討してください。

警告

セキュリティ: デフォルトの文字セット

サーバーレベルで設定するなりデータベース接続自身に設定させる (ドライバに依存します) なりして、文字セットを明示しておく必要があります。この文字セットが PDO::quote() に影響を及ぼします。詳細は各ドライバのドキュメントを参照ください。

パラメータ

string: クオートされる文字列を指定します。
type: クオートするスタイルを変更するため、ドライバにデータ型のヒントを提供します。たとえば PDO_PARAM_LOB は、ドライバにバイナリデータをエスケープするように伝えます。

戻り値

理論上安全なクオートされた SQL ステートメントの文字列を返します。ドライバがこの方法での引用符付けをサポートしていない場合は false を返します。

例

例1 通常の文字列をクオートする

<?php
$conn = new PDO('sqlite:/home/lynn/music.sql3');

/* 単純な文字列 */
$string = 'Nice';
print "Unquoted string: $string\n";
print "Quoted string: " . $conn->quote($string) . "\n";
?>

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

Unquoted string: Nice
Quoted string: 'Nice'

例2 危険な文字列をクオートする

<?php
$conn = new PDO('sqlite:/home/lynn/music.sql3');

/* 危険な文字列 */
$string = 'Naughty \' string';
print "Unquoted string: $string\n";
print "Quoted string:" . $conn->quote($string) . "\n";
?>

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

Unquoted string: Naughty ' string
Quoted string: 'Naughty '' string'

例3 複雑な文字列をクオートする

<?php
$conn = new PDO('sqlite:/home/lynn/music.sql3');

/* 複雑な文字列 */
$string = "Co'mpl''ex \"st'\"ring";
print "Unquoted string: $string\n";
print "Quoted string: " . $conn->quote($string) . "\n";
?>

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

Unquoted string: Co'mpl''ex "st'"ring
Quoted string: 'Co''mpl''''ex "st''"ring'

参考

PDO::prepare() - 文を実行する準備を行い、文オブジェクトを返す
PDOStatement::execute() - プリペアドステートメントを実行する