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

# pg_escape_literal

(PHP 5 >= 5.4.4, PHP 7, PHP 8)

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

### 説明

function pg_escape_literal(PgSql\Connection `$connection` = ?, string `$string`): string|false

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

### パラメータ

`connection`

  PgSql\Connection クラスのインスタンス。 `connection` が指定されない場合は、デフォルトの接続を使います。 デフォルトの接続とは、pg_connect() または pg_pconnect() によって確立された直近の接続です。

  警告

  PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりました。

`string`

  エスケープするテキスト文字列。

### 戻り値

エスケープされたデータを文字列で返します。 失敗した場合に `false` を返します。

### 変更履歴

バージョン | 説明
--- | ---
8.1.0 | `connection` は、PgSql\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、resource を期待していました。

### 例

例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() - クエリに使う文字列をエスケープする

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open