Files
doc-fr/reference/pgsql/functions/pg-escape-literal.xml
2022-05-27 17:46:58 -04:00

141 lines
4.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c2eca73ef79ebe78cebb34053e41b565af504c4f Maintainer: blanchonvincent Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id='function.pg-escape-literal' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pg_escape_literal</refname>
<refpurpose>
Protège une requête SQL littérale à insérer dans un champ texte
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_escape_literal</methodname>
<methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_escape_literal</function> protège une requête SQL littérale pour
le requêtage à la base de données PostgreSQL. Le résultats retournée est une chaîne de caractère protégé au format
PostgreSQL. <function>pg_escape_literal</function> ajoute des simples
quotes avant et après les données. Les utilisateurs ne doivent donc pas ajouter des simples quotes.
L'utilisation de cette fonction est recommandée à la place
de <function>pg_escape_string</function>. Si la
colonne est de type bytea, il convient d'utiliser à la place la fonction<function>pg_escape_bytea</function>.
Pour protéger les identifiants (par exemple les noms de table, nom de champs), il convient d'utiliser la fonction
<function>pg_escape_identifier</function>.
</para>
<note>
<para>
Cette fonction a une protection de code interne et peut être utilisée pour PostgreSQL 8.4 ou moins récent.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
&pgsql.parameter.connection-with-unspecified-default;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
Une &string; contenant du texte à protéger.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Une &string; contenant les données protégées.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.connection-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>pg_escape_literal</function></title>
<programlisting role="php">
<![CDATA[
<?php
// Connexion à la base de données
$dbconn = pg_connect('dbname=foo');
// Lecture d'un fichier (contenant apostrophes et antislashes)
$data = file_get_contents('letter.txt');
// Protection des données
$escaped = pg_escape_literal($data);
// Insertion en base de données. Notez qu'il n'y a pas de simple quotes autour de {$escaped}
pg_query("INSERT INTO correspondence (name, data) VALUES ('My letter', {$escaped})");
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>pg_escape_identifier</function></member>
<member><function>pg_escape_bytea</function></member>
<member><function>pg_escape_string</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->