<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.pgsql.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'de',
  ),
  'this' => 
  array (
    0 => 'function.pg-escape-literal.php',
    1 => 'pg_escape_literal',
    2 => 'Escape a literal for insertion into a text field',
  ),
  'up' => 
  array (
    0 => 'ref.pgsql.php',
    1 => 'PostgreSQL-Funktionen',
  ),
  'prev' => 
  array (
    0 => 'function.pg-escape-identifier.php',
    1 => 'pg_escape_identifier',
  ),
  'next' => 
  array (
    0 => 'function.pg-escape-string.php',
    1 => 'pg_escape_string',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/pgsql/functions/pg-escape-literal.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.pg-escape-literal" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">pg_escape_literal</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.4.4, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">pg_escape_literal</span> &mdash; <span class="dc-title">
   Escape a literal for insertion into a text field
  </span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.pg-escape-literal-description">
  <h3 class="title">Beschreibung</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>pg_escape_literal</strong></span>(<span class="methodparam"><span class="type"><a href="class.pgsql-connection.php" class="type PgSql\Connection">PgSql\Connection</a></span> <code class="parameter">$connection</code><span class="initializer"> = ?</span></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$string</code></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   <span class="function"><strong>pg_escape_literal()</strong></span> escapes a literal for
   querying the PostgreSQL database. It returns an escaped literal in
   the PostgreSQL format. <span class="function"><strong>pg_escape_literal()</strong></span> adds
   quotes before and after data. Users should not add quotes. Use of
   this function is recommended instead
   of <span class="function"><a href="function.pg-escape-string.php" class="function">pg_escape_string()</a></span>.  If the type of the
   column is bytea, <span class="function"><a href="function.pg-escape-bytea.php" class="function">pg_escape_bytea()</a></span> must be used
   instead. For escaping identifiers (e.g. table, field
   names), <span class="function"><a href="function.pg-escape-identifier.php" class="function">pg_escape_identifier()</a></span> must be used.
  </p>
 </div>


<div class="refsect1 parameters" id="refsect1-function.pg-escape-literal-parameters">
  <h3 class="title">Parameter-Liste</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">connection</code></dt>
     <dd>
      <p class="para">Eine <span class="classname"><a href="class.pgsql-connection.php" class="classname">PgSql\Connection</a></span>-Instanz.
Falls <code class="parameter">connection</code> nicht angegeben wurde, wird die Standardverbindung benutzt.
Das ist die zuletzt mit <span class="function"><a href="function.pg-connect.php" class="function">pg_connect()</a></span> oder <span class="function"><a href="function.pg-pconnect.php" class="function">pg_pconnect()</a></span> aufgebaute Verbindung.
<div class="warning"><strong class="warning">Warnung</strong><p class="simpara">Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.</p></div></p>
     </dd>
    
    
     <dt><code class="parameter">string</code></dt>
     <dd>
      <p class="para">
       A <span class="type"><a href="language.types.string.php" 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-literal-returnvalues">
  <h3 class="title">Rückgabewerte</h3>
  <p class="para">
   A <span class="type"><a href="language.types.string.php" class="type string">string</a></span> containing the escaped data, or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on failure.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.pg-escape-literal-changelog">
  <h3 class="title">Changelog</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Version</th>
      <th>Beschreibung</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
 <td>8.1.0</td>
 <td>
  Der Parameter <code class="parameter">connection</code> erwartet nun eine <span class="classname"><a href="class.pgsql-connection.php" class="classname">PgSql\Connection</a></span>-Instanz;
  vorher wurde eine <a href="language.types.resource.php" class="link">Ressource</a> erwartet.
 </td>
</tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.pg-escape-literal-examples">
  <h3 class="title">Beispiele</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Beispiel #1 <span class="function"><strong>pg_escape_literal()</strong></span> example</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php <br />  </span><span style="color: #FF8000">// Connect to the database<br />  </span><span style="color: #0000BB">$dbconn </span><span style="color: #007700">= </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 />  <br />  </span><span style="color: #FF8000">// Read in a text file (containing apostrophes and backslashes)<br />  </span><span style="color: #0000BB">$data </span><span style="color: #007700">= </span><span style="color: #0000BB">file_get_contents</span><span style="color: #007700">(</span><span style="color: #DD0000">'letter.txt'</span><span style="color: #007700">);<br />  <br />  </span><span style="color: #FF8000">// Escape the text data<br />  </span><span style="color: #0000BB">$escaped </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_escape_literal</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">);<br />  <br />  </span><span style="color: #FF8000">// Insert it into the database. Note that no quotes around {$escaped}<br />  </span><span style="color: #0000BB">pg_query</span><span style="color: #007700">(</span><span style="color: #DD0000">"INSERT INTO correspondence (name, data) VALUES ('My letter', </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></code></div>
    </div>

   </div>
  </p>
 </div>

 
 <div class="refsect1 seealso" id="refsect1-function.pg-escape-literal-seealso">
  <h3 class="title">Siehe auch</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.pg-escape-identifier.php" class="function" rel="rdfs-seeAlso">pg_escape_identifier()</a> - Escape an identifier for insertion into a text field</span></li>
    <li><span class="function"><a href="function.pg-escape-bytea.php" class="function" rel="rdfs-seeAlso">pg_escape_bytea()</a> - Maskiert Zeichenketten zum Einf&uuml;gen in ein Feld vom Typ bytea</span></li>
    <li><span class="function"><a href="function.pg-escape-string.php" class="function" rel="rdfs-seeAlso">pg_escape_string()</a> - Maskiert einen String f&uuml;r Abfragen</span></li>
   </ul>
  </p>
 </div>

</div><?php manual_footer($setup); ?>