pg_escape_bytea

(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

pg_escape_bytea — Escapa uma string para inserção em um campo bytea

Descrição

pg_escape_bytea(PgSql\Connection $connection = ?, string $data): string

pg_escape_bytea() escapa string para o tipo de dados bytea. Ele retorna uma string com escape.

Nota:
Quando seleciona-se um tipo bytea com SELECT, o PostgreSQL retorna valores de bytes octais prefixados com '\' (por exemplo, \032). Os usuários devem converter de volta para o formato binário manualmente.

Esta função requer PostgreSQL 7.2 ou posterior. Com PostgreSQL 7.2.0 e 7.2.1, os valores bytea devem ser convertidos quando você ativa o suporte multibyte. ou seja, INSERT INTO test_table (image) VALUES ('$image_escaped'::bytea); PostgreSQL 7.2.2 ou posterior não precisa de conversão. A exceção é quando a codificação de caracteres do cliente e do backend não corresponde e pode haver erro de fluxo de vários bytes. O usuário deve então converter para bytea para evitar esse erro.

Parâmetros

connection

Uma instância de PgSql\Connection. Quando o parâmetro connection não for especificado, a conexão padrão será usada. A conexão padrão é a última conexão feita por pg_connect() ou pg_pconnect().

Aviso

A partir do PHP 8.1.0, usar a conexão padrão tornou-se defasado.

data

Uma string contendo texto ou dados binários a serem inseridos em uma coluna bytea.

Valor Retornado

Uma string contendo o dado escapado.

Registro de Alterações

Versão	Descrição
8.1.0	O parâmetro `connection` agora espera uma instância de PgSql\Connection; anteriormente, um resource era esperado.

Exemplos

Exemplo #1 Exemplo de pg_escape_bytea()

<?php
  // Conecta ao banco de dados
  $dbconn = pg_connect('dbname=foo');

  // Lê em um arquivo binário
  $data = file_get_contents('image1.jpg');

  // Escapa o dado binário
  $escaped = pg_escape_bytea($data);

  // Insere-o no banco de dados
  pg_query("INSERT INTO gallery (name, data) VALUES ('Pine trees', '{$escaped}')");
?>

Veja Também

pg_unescape_bytea() - Desfaz escape binário para tipo bytea
pg_escape_string() - Escapa uma string para consulta

Improve This Page

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 7 notes

down

ynzhang from lakeheadu of ca ¶

15 years ago

The reason pg_unescape_bytea() do not exactly reproduce the binary data created by pg_escape_bytea() is because the backslash \ and single quote ' are double escaped by the pg_escape_bytea() function. This will lead to image seems corrupted when retrieve from the bytea field. The proper way to escape&unescape a binary string into a PG bytea field as follow:



<?php

$escaped_data = str_replace(array("\\\\", "''"), array("\\", "'"), pg_escape_bytea($data));

/* and later unescape the escaped data from the bytea field with following to get the original binary data */



$original_data = pg_unescape_bytea($escaped_data));

?>



more details at: http://archives.postgresql.org/pgsql-php/2007-02/msg00014.php

down

Hayley Watson ¶

6 years ago

PostgreSQL 9.0 introduced a new hexadecimal-based representation for bytea data that is preferred over the escaping mechanism implemented by this function.

<?php
function pg_escape_byteahex($binary)
{
    return "E'\\\\x".bin2hex($binary)."'";
}
?>

down

Mike-RaWare ¶

13 years ago

To prevent any problems with encoding you could use hexadecimal or base64 input to save and retrieve data to the database:

<?php 
  // Connect to the database
  $dbconn = pg_connect( 'dbname=foo' );
  
  // Read in a binary file
  $data = file_get_contents( 'image1.jpg' );
  
  // Escape the binary data
  $escaped = bin2hex( $data );
  
  // Insert it into the database
  pg_query( "INSERT INTO gallery (name, data) VALUES ('Pine trees', decode('{$escaped}' , 'hex'))" );

  // Get the bytea data
  $res = pg_query("SELECT encode(data, 'base64') AS data FROM gallery WHERE name='Pine trees'");  
  $raw = pg_fetch_result($res, 'data');
  
  // Convert to binary and send to the browser
  header('Content-type: image/jpeg');
  echo base64_decode($raw);
?>

down

Mocha ¶

20 years ago

to unescape_bytea use stripcslashes(). If you need to escape bytea and don't have pg_escape_bytea() function then use:



<?php

function escByteA($binData) {

  /**

   * \134 = 92 = backslash, \000 = 00 = NULL, \047 = 39 = Single Quote

   *

   * str_replace() replaces the searches array in order. Therefore, we must

   * process the 'backslash' character first. If we process it last, it'll

   * replace all the escaped backslashes from the other searches that came

   * before.

   */

  $search = array(chr(92), chr(0), chr(39));

  $replace = array('\\\134', '\\\000', '\\\047');

  $binData = str_replace($search, $replace, $binData);

  return $binData;

  //echo "<pre>$binData</pre>";

  //exit;

}

?>

down

Michael ¶

10 years ago

using  pg_escape_bytea without 'E' escape tag
<?php 
  // Die Binärdaten maskieren
  $escaped = pg_escape_bytea($data);

  // und in die Datenbank einfügen (falsch/wrong)
  pg_query("INSERT INTO gallery (name, data) VALUES ('Pine trees', E'$escaped')");

  // und in die Datenbank einfügen (richtig/right)
  pg_query("INSERT INTO gallery (name, data) VALUES ('Pine trees', '$escaped')");
?>

down

gglockner AT NOSPAMdwaffler DOT com ¶

14 years ago

If you're getting errors about nonstandard use of \\ in a string literal, then you need to escape the encoded bytea as follows:



<?php

$escaped = pg_escape_bytea($data);

pg_query("INSERT INTO gallery (name, data) VALUES ('Pine trees', E'$escaped'::bytea)");

?>

down

-3

php at tobias dot olsson dot be ¶

21 years ago

if you need to change back bytea from the db to normal data, this will do that:



<?php

function pg_unescape_bytea($bytea) {

return eval("return \"".str_replace('$', '\\$', str_replace('"', '\\"', $bytea))."\";");

}



// use like this

$rs = pg_query($conn, "SELECT image from images LIMIT 1");

$image = pg_unescape_bytea(pg_fetch_result($rs, 0, 0));

?>



/Tobias

＋add a note