uTools-Manuals/docs/php/pg_escape_identifier.html
2019-04-28 19:00:34 +08:00

123 lines
6.2 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Escape a identifier for insertion into a text field</title>
</head>
<body class="docs"><div id="layout">
<div id="layout-content"><div id="function.pg-escape-identifier" class="refentry">
<div class="refnamediv">
<h1 class="refname">pg_escape_identifier</h1>
<p class="verinfo">(PHP 5 &gt;= 5.4.4, PHP 7)</p><p class="refpurpose"><span class="refname">pg_escape_identifier</span> &mdash; <span class="dc-title">
Escape a identifier for insertion into a text field
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.pg-escape-identifier-description">
<h3 class="title">说明</h3>
<div class="methodsynopsis dc-description">
<span class="methodname"><strong>pg_escape_identifier</strong></span>
([ <span class="methodparam"><span class="type">resource</span> <code class="parameter">$connection</code></span>
], <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code></span>
) : <span class="type">string</span></div>
<p class="para rdfs-comment">
<span class="function"><strong>pg_escape_identifier()</strong></span> escapes a identifier
(e.g. table, field names) for quering the database. It returns an
escaped identifier string for PostgreSQL
server. <span class="function"><strong>pg_escape_identifier()</strong></span> 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), <span class="function"><a href="pg_escape_literal.html" class="function">pg_escape_literal()</a></span>
or <span class="function"><a href="pg_escape_string.html" class="function">pg_escape_string()</a></span> must be used. For bytea
type fields, <span class="function"><a href="pg_escape_bytea.html" class="function">pg_escape_bytea()</a></span> must be used
instead.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This function has internal escape code and can also be used with
PostgreSQL 8.4 or less.
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-function.pg-escape-identifier-parameters">
<h3 class="title">参数</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">connection</code></dt>
<dd>
<p class="para">
PostgreSQL database connection resource. When
<code class="parameter">connection</code> is not present, the default connection
is used. The default connection is the last connection made by
<span class="function"><a href="pg_connect.html" class="function">pg_connect()</a></span> or <span class="function"><a href="pg_pconnect.html" class="function">pg_pconnect()</a></span>.
</p>
</dd>
<dt>
<code class="parameter">data</code></dt>
<dd>
<p class="para">
A <span class="type"><a href="language.types.string.html" class="type string">string</a></span> containing text to be escaped.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.pg-escape-identifier-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
A <span class="type"><a href="language.types.string.html" class="type string">string</a></span> containing the escaped data.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.pg-escape-identifier-examples">
<h3 class="title">范例</h3>
<p class="para">
<div class="example" id="example-2484">
<p><strong>Example #1 <span class="function"><strong>pg_escape_identifier()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><pre><span style="color: #000000">
<span style="color: #0000BB">&lt;?php&nbsp;<br />&nbsp;&nbsp;</span><span style="color: #FF8000">//&nbsp;Connect&nbsp;to&nbsp;the&nbsp;database<br />&nbsp;&nbsp;</span><span style="color: #0000BB">$dbconn&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">pg_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'dbname=foo'</span><span style="color: #007700">);<br />&nbsp;&nbsp;<br />&nbsp;&nbsp;</span><span style="color: #FF8000">//&nbsp;Escape&nbsp;the&nbsp;table&nbsp;name&nbsp;data<br />&nbsp;&nbsp;</span><span style="color: #0000BB">$escaped&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">pg_escape_identifier</span><span style="color: #007700">(</span><span style="color: #0000BB">$table_name</span><span style="color: #007700">);<br />&nbsp;&nbsp;<br />&nbsp;&nbsp;</span><span style="color: #FF8000">//&nbsp;Select&nbsp;rows&nbsp;from&nbsp;$table_name<br />&nbsp;&nbsp;</span><span style="color: #0000BB">pg_query</span><span style="color: #007700">(</span><span style="color: #DD0000">"SELECT&nbsp;*&nbsp;FROM&nbsp;</span><span style="color: #007700">{</span><span style="color: #0000BB">$escaped</span><span style="color: #007700">}</span><span style="color: #DD0000">;"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.pg-escape-identifier-seealso">
<h3 class="title">参见</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="pg_escape_literal.html" class="function" rel="rdfs-seeAlso">pg_escape_literal()</a> - Escape a literal for insertion into a text field</span></li>
<li class="member"><span class="function"><a href="pg_escape_bytea.html" class="function" rel="rdfs-seeAlso">pg_escape_bytea()</a> - 转义 bytea 类型的二进制数据</span></li>
<li class="member"><span class="function"><a href="pg_escape_string.html" class="function" rel="rdfs-seeAlso">pg_escape_string()</a> - 转义 text/char 类型的字符串</span></li>
</ul>
</p>
</div>
</div></div></div></body></html>