Php/docs/function.pg-escape-literal

提供:Dev Guides
< Php
移動先:案内検索

pg_escape_literal

(PHP 5 >= 5.4.4, PHP 7)

pg_escape_literal テキスト型フィールドに挿入するために、リテラルをエスケープする


説明

pg_escape_literal ([ resource $connection ], string $data ) : string

pg_escape_literal() は、 PostgreSQL データベースへの問い合わせに使うリテラルをエスケープします。 PostgreSQL フォーマットでエスケープされたリテラルを返します。 pg_escape_literal() は、データの前後にクォートを追加します。 ユーザーが自分で追加してはいけません。 pg_escape_string() ではなくこの関数を使うことを推奨します。 カラム型が bytea の場合は、代わりに pg_escape_bytea() を使わなければなりません。 識別子 (テーブル名やフィールド名など) のエスケープには pg_escape_identifier() を使わなければなりません。

注意:

この関数は内部的なエスケープコードを使い、PostgreSQL 8.4 より前のバージョンでも使えます。

パラメータ

connection
PostgreSQL データベース接続リソース。 connection が存在しない場合は、 デフォルトの接続を使用します。デフォルトの接続は、 pg_connect() あるいは pg_pconnect() で直近に作成されたものとなります。 デフォルトの接続がない場合は、E_WARNING が発生して false を返します。
data
エスケープするテキスト文字列。


返り値

エスケープされたデータを文字列で返します。


例1 pg_escape_literal() の例

<?php   // データベースに接続します  $dbconn = pg_connect('dbname=foo');    // (アポストロフィやバックスラッシュが含まれている) テキストファイルを読み込みます  $data = file_get_contents('letter.txt');    // テキストデータをエスケープします  $escaped = pg_escape_literal($data);    // それをデータベースに挿入します。{$escaped} の前後にクォートがないことに注目  pg_query("INSERT INTO correspondence (name, data) VALUES ('My letter', {$escaped})");?>

参考

  • pg_escape_identifier() - テキスト型フィールドに挿入するために、識別子をエスケープする
  • pg_escape_bytea() - bytea フィールドに挿入するために文字列をエスケープする
  • pg_escape_string() - クエリに使う文字列をエスケープする