pg-insert.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 39bb8a868935a56cfce438b0169e13c02c93211c Maintainer: conni Status: ready -->
<refentry xml:id="function.pg-insert" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_insert</refname>
  <refpurpose>Überträgt Werte aus einem Array in eine Tabelle</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>PgSql\Result</type><type>string</type><type>bool</type></type><methodname>pg_insert</methodname>
   <methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
   <methodparam><type>string</type><parameter>table_name</parameter></methodparam>
   <methodparam><type>array</type><parameter>values</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>PGSQL_DML_EXEC</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_insert</function> fügt die Werte des
   <parameter>values</parameter> in die Tabelle
   <parameter>table_name</parameter> ein.
  </para>
  <para>
   Falls <parameter>flags</parameter> angegeben wurde, wird
   <function>pg_convert</function> mit den angegebenen Flags auf das Array
   <parameter>values</parameter> angewendet.
  </para>
  <para>
   Standardmäßig übergibt <function>pg_insert</function> Rohwerte. Die Werte
   müssen entweder maskiert werden oder es muss die Option <constant>PGSQL_DML_ESCAPE</constant>
   angegeben werden. <constant>PGSQL_DML_ESCAPE</constant> maskiert Parameter und Bezeichner und
   setzt sie in Anführungszeichen. Daher muss bei Tabellen- und Spaltennamen
   zwischen Groß- und Kleinschreibung unterschieden werden.
  </para>
  <para>
   Es ist zu beachten, dass weder die Maskierung noch eine vorbereitete
   Abfrage LIKE-Abfragen, JSON, Array, Regex usw. schützen können. Diese
   Parameter sollten im Kontext behandelt werden, &dh; Werte maskieren und
   validieren.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      &pgsql.parameter.connection;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>table_name</parameter></term>
     <listitem>
      <para>
       Der Name der Tabelle, in die die Zeilen eingefügt werden sollen.
       <parameter>table_name</parameter> muss mindestens soviele Spalten
       haben, wie das <parameter>values</parameter> Elemente.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>values</parameter></term>
     <listitem>
      <para>
       Ein <type>array</type>, dessen Indizes die Feldnamen der Tabelle
       <parameter>table_name</parameter> sind und dessen Werte die Werte sind,
       die in die entprechenden Spalten eingefügt werden sollen.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Jede Kombination aus <constant>PGSQL_CONV_OPTS</constant>,
       <constant>PGSQL_DML_NO_CONV</constant>,
       <constant>PGSQL_DML_ESCAPE</constant>,
       <constant>PGSQL_DML_EXEC</constant>,
       <constant>PGSQL_DML_ASYNC</constant> und
       <constant>PGSQL_DML_STRING</constant>. Falls
       <constant>PGSQL_DML_STRING</constant> bei den
       <parameter>flags</parameter> angegeben wurde, wird der Abfrage-String
       zurückgegeben. Werden <constant>PGSQL_DML_NO_CONV</constant> oder
       <constant>PGSQL_DML_ESCAPE</constant> angegeben, wird
       <function>pg_convert</function> intern nicht aufgerufen.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;. Oder gibt bei Erfolg einen &string; zurück, wenn
   <constant>PGSQL_DML_STRING</constant> über <parameter>flags</parameter>
   übergeben wird.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Wenn die angegebene Tabelle ungültig ist, wird ein
   <classname>ValueError</classname> geworfen.
  </para>
  <para>
   Wenn der Wert oder der Typ eines Feldes nicht mit einem PostgreSQL-Typ
   übereinstimmt, wird ein <classname>ValueError</classname> oder
   <classname>TypeError</classname> geworfen.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.3.0</entry>
      <entry>
       Wenn die angegebene Tabelle ungültig ist, wird nun ein
       <classname>ValueError</classname> geworfen; zuvor wurde ein
       <constant>E_WARNING</constant> ausgegeben.
      </entry>
     </row>
     <row>
      <entry>8.3.0</entry>
      <entry>
       Wenn der Wert oder Typ eines Feldes nicht mit einem PostgreSQL-Typ
       übereinstimmt, wird nun ein <classname>ValueError</classname> oder
       <classname>TypeError</classname> geworfen; zuvor wurde ein
       <constant>E_WARNING</constant> ausgegeben.
      </entry>
     </row>
     &pgsql.changelog.return-result-object;
     &pgsql.changelog.connection-object;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pg_insert</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
  $dbconn = pg_connect('dbname=foo');
  // Das ist einigermaßen sicher, da alle Werte maskiert werden.
  // Allerdings unterstützt PostgreSQL JSON/Array. Diese sind nicht
  // sicher, da sie Abfragen weder maskieren noch vorbereiten.
  $res = pg_insert($dbconn, 'post_log', $_POST, PGSQL_DML_ESCAPE);
  if ($res) {
      echo "Der Inhalt von $_POST wurde protokolliert\n";
  } else {
      echo "Vermutlich wurden falsche Eingabedaten gesendet\n";
  }
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

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