mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
8807d406a7
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@189783 c90b9560-bf6c-de11-be94-00142212c4b1
111 lines
2.7 KiB
XML
111 lines
2.7 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.6 $ -->
|
|
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.61 -->
|
|
<refentry id='function.pg-escape-string'>
|
|
<refnamediv>
|
|
<refname>pg_escape_string</refname>
|
|
<refpurpose>
|
|
Escape a string for insertion into a text field
|
|
</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>pg_escape_string</methodname>
|
|
<methodparam><type>string</type><parameter>data</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>pg_escape_string</function> escapes a string for
|
|
insertion into the database. It returns an escaped string in the
|
|
PostgreSQL format. Use of this function is recommended instead of
|
|
<function>addslashes</function>. If the type of the column
|
|
is bytea, <function>pg_escape_bytea</function> must be used
|
|
instead.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
This function requires PostgreSQL 7.2 or later.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>data</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A <type>string</type> containing text to be escaped.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
A <type>string</type> containing the escaped data.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>pg_escape_string</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// Connect to the database
|
|
$dbconn = pg_connect('dbname=foo');
|
|
|
|
// Read in a text file (containing apostrophes and backslashes)
|
|
$data = file_get_contents('letter.txt');
|
|
|
|
// Escape the text data
|
|
$escaped = pg_escape_string($data);
|
|
|
|
// Insert it into the database
|
|
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_bytea</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:"../../../../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
|
|
-->
|