pg-escape-bytea.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c2eca73ef79ebe78cebb34053e41b565af504c4f Maintainer: conni Status: ready -->
<refentry xml:id='function.pg-escape-bytea' xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_escape_bytea</refname>
  <refpurpose>
   Maskiert Zeichenketten zum Einfügen in ein Feld vom Typ bytea
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>pg_escape_bytea</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_bytea</function> maskiert <parameter>data</parameter>
   für den Datentyp bytea und gibt den maskierten String zurück.
  </para>
  <note>
   <para>
    Wenn Daten vom Typ bytea mit <literal>SELECT</literal> abgefragt werden,
    gibt PostgreSQL die Oktalwerte der einzelnen Datenbytes zurück, denen ein
    Backslash vorangestellt ist (&zb; \032). Diese Werte müssen vom Benutzer
    in das Binärformat zurückkonvertiert werden.
   </para>
   <para>
    Diese Funktion setzt PostgreSQL 7.2 oder höher voraus. Bei PostgreSQL
    7.2.0 und 7.2.1 muss der Typ bytea konvertiert werden, falls die
    multi-byte-Unterstützung benutzt wird, &zb; <literal>INSERT INTO
    test_table (image) VALUES ('$image_escaped'::bytea);</literal>. Ab
    PostgreSQL 7.2.2 und höher, muss keine Typkonvertierung mehr durchgeführt
    werden. Es sei denn, die Codierungen von Client und Server passen nicht
    zusammen, was zu einem multi-byte Streamfehler führen kann. Um diesen
    Fehler zu vermeiden, muss der Stream in den Typ bytea konvertiert werden.
   </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>
       Ein <type>string</type>, der Text oder Binärdaten enthält, die in eine
       Spalte vom Typ bytea eingefügt werden sollen.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Ein <type>string</type> mit den maskierten Daten.
  </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><function>pg_escape_bytea</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
  // Zur Datenbank verbinden
  $dbconn = pg_connect('dbname=foo');

  // eine Binärdatei auslesen
  $data = file_get_contents('image1.jpg');

  // Die Binärdaten maskieren
  $escaped = pg_escape_bytea($data);

  // und in die Datenbank einfügen
  pg_query("INSERT INTO gallery (name, data) VALUES ('Pine trees', '{$escaped}')");
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_unescape_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
-->