pg-select.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 18aa2012f6fa1e5b09733147e02911d16e06d4a1 Maintainer: conni Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: c2eca73ef79ebe78cebb34053e41b565af504c4f Maintainer: samesch -->
<refentry xml:id="function.pg-select" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_select</refname>
  <refpurpose>Wählt Datensätze aus</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>string</type><type>false</type></type><methodname>pg_select</methodname>
   <methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
   <methodparam><type>string</type><parameter>table_name</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>conditions</parameter><initializer>[]</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>PGSQL_DML_EXEC</constant></initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>PGSQL_ASSOC</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_select</function> wählt die Datensätze aus der Tabelle
   <parameter>table_name</parameter> aus, die den Elementen
   (<literal>field=&gt;value</literal>) in <parameter>conditions</parameter>
   entsprechen. Wenn die Abfrage erfolgreich war, wird ein assoziatives Array
   mit allen Datensätzen und Werten aus <parameter>table_name</parameter>
   zurückgegeben, die mit den Datensätzen und Werten in
   <parameter>conditions</parameter> identisch sind.
  </para>
  <para>
   Falls <parameter>flags</parameter> gesetzt ist, wird
   <function>pg_convert</function> mit den angegebenen Flags auf
   <parameter>conditions</parameter> angewendet.
  </para>
  <para>
   Wenn <parameter>mode</parameter> gesetzt ist, ist der Rückgabewert bei
   <constant>PGSQL_NUM</constant> ein Array, bei
   <constant>PGSQL_ASSOC</constant> (Standard) ein assoziatives Array und bei
   <constant>PGSQL_BOTH</constant> beides.
  </para>
  <para>
   Standardmäßig übergibt <function>pg_select</function> Rohwerte. Die Werte
   müssen entweder maskiert werden oder es muss die Option PGSQL_DML_ESCAPE
   angegeben werden. PGSQL_DML_ESCAPE 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, aus der die Datensätze ausgewählt werden.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>conditions</parameter></term>
     <listitem>
      <para>
       Ein <type>&array;</type>, dessen Schlüssel Feldnamen von
       <parameter>table_name</parameter> sind und dessen Werte mit den
       entsprechenden Werten in <parameter>table_name</parameter>
       übereinstimmen müssen, damit der Datensatz zurückgegeben werden kann.
       Seit PHP 8.4.0 gelten keine Bedingungen mehr, wenn ein leeres Array
       angegeben wird.
       Zuvor schlug die Funktion fehl, wenn das Argument für
       <parameter>conditions</parameter> leer war.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Eine beliebige Kombination aus
       <constant>PGSQL_CONV_FORCE_NULL</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> in den
       <parameter>options</parameter> enthalten ist, wird der Abfragestring
       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>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       Eine beliebige Kombination aus <constant>PGSQL_ASSOC</constant>,
       <constant>PGSQL_NUM</constant> und <constant>PGSQL_BOTH</constant>.
       Wenn <constant>PGSQL_ASSOC</constant> gesetzt ist, ist der Rückgabewert
       ein assoziatives <type>Array</type>, bei <constant>PGSQL_NUM</constant>
       ist es ein <type>Array</type>, und bei <constant>PGSQL_BOTH</constant>
       ist es ein sowohl assoziativ als auch numerisch indiziertes
       <type>Array</type>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt einen <type>&string;</type> zurück, falls
   <constant>PGSQL_DML_STRING</constant> im Parameter
   <parameter>flags</parameter> übergeben wurde, andernfalls wird bei Erfolg
   ein <type>Array</type> zurückgegeben. &return.falseforfailure;
  </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>8.4.0</entry>
       <entry>
        <parameter>conditions</parameter> ist nun optional.
       </entry>
      </row>
      &pgsql.changelog.connection-object;
      <row>
       <entry>7.1.0</entry>
       <entry>
        Der Parameter <parameter>mode</parameter> wurde hinzugefügt.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pg_select</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
$db = 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.
$rec = pg_select($db, 'post_log', $_POST, PG_DML_ESCAPE);
if ($rec) {
    echo "Datensätze ausgewählt\n";
    var_dump($rec);
} else {
    echo "Falsche Eingabe\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
-->