mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
aebf045bfb
Detected by codespell Patch provided by tandre@php.net. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@349708 c90b9560-bf6c-de11-be94-00142212c4b1
152 lines
4 KiB
XML
152 lines
4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.61 -->
|
|
<refentry xml:id='function.pg-escape-identifier' xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>pg_escape_identifier</refname>
|
|
<refpurpose>
|
|
Escape a identifier for insertion into a text field
|
|
</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>pg_escape_identifier</methodname>
|
|
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>data</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>pg_escape_identifier</function> escapes a identifier
|
|
(e.g. table, field names) for querying the database. It returns an
|
|
escaped identifier string for PostgreSQL
|
|
server. <function>pg_escape_identifier</function> adds double
|
|
quotes before and after data. Users should not add double
|
|
quotes. Use of this function is recommended for identifier
|
|
parameters in query. For SQL literals (i.e. parameters except
|
|
bytea), <function>pg_escape_literal</function>
|
|
or <function>pg_escape_string</function> must be used. For bytea
|
|
type fields, <function>pg_escape_bytea</function> must be used
|
|
instead.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
This function has internal escape code and can also be used with
|
|
PostgreSQL 8.4 or less.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>connection</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
PostgreSQL database connection resource. When
|
|
<parameter>connection</parameter> is not present, the default connection
|
|
is used. The default connection is the last connection made by
|
|
<function>pg_connect</function> or <function>pg_pconnect</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<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="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>5.5.0</entry>
|
|
<entry>added function</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
-->
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>pg_escape_identifier</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// Connect to the database
|
|
$dbconn = pg_connect('dbname=foo');
|
|
|
|
// Escape the table name data
|
|
$escaped = pg_escape_identifier($table_name);
|
|
|
|
// Select rows from $table_name
|
|
pg_query("SELECT * FROM {$escaped};");
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>pg_escape_literal</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
|
|
-->
|