# php_manual

id: pg_field_size
type: function
doc:
<comment>Description:</comment>
  Liefert die interne Größe des belegten Speichers für ein Feld
  
  <strong>pg_field_size()</strong> gibt die interne Größe (in Bytes) des Feldes mit der Nummer <strong>$field_number</strong> im
  PostgreSQL-Abfrageergebnis <strong>$result</strong> zurück.
  
  Diese Funktion ersetzt die Funktion <strong>pg_fieldsize()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Eine <class>PgSql\Result</class>-Instanz, die von <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> oder <strong>pg_execute()</strong> (unter anderen) zurückgegeben wurde.
  <info>int</info>           <strong>$field</strong>   Die Feldnummer, beginnend bei 0.

<comment>Return:</comment>
  <info>int</info>  Die interne Größe des Feldes in Byte. Eine Feldgröße von -1 beschreibt ein Feld mit variabler
       Länge.

<comment>See Also:</comment>
   * <strong>pg_field_prtlen()</strong>
   * <strong>pg_field_type()</strong>


id: pg_field_table
type: function
doc:
<comment>Description:</comment>
  Gibt zu einem Feldnamen den Namen der Tabelle oder deren oid zurück, in der das Feld definiert ist
  
  <strong>pg_field_table()</strong> gibt den Namen der Tabelle zurück, in der das Feld definiert ist, oder den oid
  (Object Identifier) der Tabelle, falls der Parameter <strong>$oid_only</strong> <info>true</info> ist.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>    Eine <class>PgSql\Result</class>-Instanz, die von <strong>pg_query()</strong>,
                           <strong>pg_query_params()</strong> oder <strong>pg_execute()</strong> (unter anderen) zurückgegeben wurde.
  <info>int</info>           <strong>$field</strong>     Index des Feldes, beginnend bei 0.
  <info>bool</info>          <strong>$oid_only</strong>  In der Standardeinstellung wird der Name der Tabelle zurückgegeben, zu
                           der dieses Feld gehört. Wenn der Parameter <strong>$oid_only</strong> den Wert <info>true</info> hat,
                           wird stattdessen der oid der Tabelle zurückgegeben.

<comment>Return:</comment>
  <info>string|int|false</info>  Bei Erfolg wird entweder der Name oder der oid der Tabelle zurückgegeben. Bei
                    einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_field_name()</strong>
   * <strong>pg_field_type()</strong>


id: pg_field_type
type: function
doc:
<comment>Description:</comment>
  Liefert den Datentyp eines Feldes
  
  <strong>pg_field_type()</strong> gibt den Basistyp des Feldes mit der Nummer <strong>$field</strong> in der PostgreSQL
  <strong>$result</strong>-Instanz zurück.
  
  Wenn das Feld anstatt eines Basis-Datentyps einen Typ einer PostgreSQL-Domain besitzt, wird der
  Name des Datentyps zurückgegeben, auf dem die Domain definiert ist und nicht der Name der Domain.
  
  Diese Funktion ersetzt die Funktion <strong>pg_fieldtype()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Eine <class>PgSql\Result</class>-Instanz, die von <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> oder <strong>pg_execute()</strong> (unter anderen) zurückgegeben wurde.
  <info>int</info>           <strong>$field</strong>   Die Feldnummer, beginnend bei 0.

<comment>Return:</comment>
  <info>string</info>  Ein <info>string</info>, der den Datentyp des Feldes enthält.

<comment>See Also:</comment>
   * <strong>pg_field_prtlen()</strong>
   * <strong>pg_field_name()</strong>
   * <strong>pg_field_type_oid()</strong>


id: pg_field_type_oid
type: function
doc:
<comment>Description:</comment>
  Liefert die ID des PostgreSQL-Datentyps (OID) eines Feldes
  
  <strong>pg_field_type_oid()</strong> gibt einen Integer zurück, der die OID des Datentyps für das Feld mit der
  Nummer <strong>$field</strong> in der PostgreSQL <strong>$result</strong>-Instanz enthält.
  
  Mehr Informationen über Feldtypen erhalten Sie, wenn Sie den PostgreSQL-Systemkatalog <return>pg_type</return> mit
  der OID, die von dieser Funktion zurückgegeben wird, abfragen. Die PostgreSQL-Funktion
  <strong>format_type()</strong> konvertiert diesen OID in einen Standard-SQL-Typnamen.
  
  Wenn das Feld anstatt eines Basis-Datentyps einen Typ einer PostgreSQL-Domain besitzt, wird der
  Name des Datentyps zurückgegeben, auf dem die Domain definiert ist und nicht der Name der Domain.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Eine <class>PgSql\Result</class>-Instanz, die von <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> oder <strong>pg_execute()</strong> (unter anderen) zurückgegeben wurde.
  <info>int</info>           <strong>$field</strong>   Die Feldnummer, beginnend bei 0.

<comment>Return:</comment>
  <info>string|int</info>  Den OID (Object Identifier) des Basistyps dieses Feldes.

<comment>See Also:</comment>
   * <strong>pg_field_type()</strong>
   * <strong>pg_field_prtlen()</strong>
   * <strong>pg_field_name()</strong>


id: pg_flush
type: function
doc:
<comment>Description:</comment>
  Flush outbound query data on the connection
  
  <strong>pg_flush()</strong> flushes any outbound query data waiting to be sent on the connection.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.

<comment>Return:</comment>
  <info>int|bool</info>  Returns <info>true</info> if the flush was successful or no data was waiting to be flushed, <return>0</return> if part
            of the pending data was flushed but more remainsBei einem Fehler wird <info>false</info>
            zurückgegeben..


id: pg_free_result
type: function
doc:
<comment>Description:</comment>
  Gibt den durch Ergebnisse belegten Speicher frei
  
  <strong>pg_free_result()</strong> gibt den Speicher und die Daten, die mit der <class>PgSql\Result</class>-Instanz assoziiert
  sind, frei.
  
  Die Funktion braucht nur aufgerufen zu werden, wenn man befürchten muss, dass während der
  Ausführung des Skripts zu viel Speicher verbraucht wird. Ansonsten wird der Speicherplatz, den
  Ergebnisse belegen, automatisch nach Beendigung des Skriptes freigegeben.
  
  Diese Funktion ersetzt die Funktion <strong>pg_freeresult()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Eine <class>PgSql\Result</class>-Instanz, die von <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> oder <strong>pg_execute()</strong> (unter anderen) zurückgegeben wurde.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_query_params()</strong>
   * <strong>pg_execute()</strong>


id: pg_get_notify
type: function
doc:
<comment>Description:</comment>
  Liefert eine SQL-NOTIFY-Nachricht
  
  <strong>pg_get_notify()</strong> gibt eine NOTIFY-Nachricht zurück, die vom SQL-Kommando <return>NOTIFY</return> gesendet wurde. Um
  diese Nachrichten zu erhalten, muss zuvor das SQL-Kommando <return>LISTEN</return> ausgeführt worden sein.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
  <info>int</info>               <strong>$mode</strong>        Ein optionaler Parameter, der bestimmt, wie das zurückgegebene
                                 <info>Array</info> indiziert werden soll.
                                 <strong>$mode</strong> ist eine Konstante, die einen der folgenden Werte annehmen
                                 kann:
                                 <info>PGSQL_ASSOC</info>, <info>PGSQL_NUM</info> und <info>PGSQL_BOTH</info>.
                                 Wenn die Funktion mit <info>PGSQL_NUM</info> aufgerufen wird, wird ein Array mit
                                 numerischen Indizes zurückgegeben,
                                 mit <info>PGSQL_ASSOC</info> wird ein Array mit assoziatives Indizes
                                 zurückgegeben
                                 und mit <info>PGSQL_BOTH</info> ein Array mit beiden Indizes.

<comment>Return:</comment>
  <info>array|false</info>  Ein <info>Array</info>, das die <return>NOTIFY</return>-Nachricht und die PID des Datenbankprozesses enthält. Falls
               vom Server unterstützt, enthält das Array ebenfalls die Serverversion und die
               Nutzdaten. Existiert kein <return>NOTIFY</return>, wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_get_pid()</strong>


id: pg_get_pid
type: function
doc:
<comment>Description:</comment>
  Prüft die Datenbankverbindung
  
  <strong>pg_get_pid()</strong> gibt die Prozess-ID (PID) des Datenbankservers zurück. Diese ist nützlich, wenn man
  mit <strong>pg_get_notify()</strong>  feststellen möchte, ob ein anderer Prozess eine <return>NOTIFY</return>-Benachrichtigung
  gesendet hat.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.

<comment>Return:</comment>
  <info>int</info>  Die Prozess-ID des Datenbankservers.

<comment>See Also:</comment>
   * <strong>pg_get_notify()</strong>


id: pg_get_result
type: function
doc:
<comment>Description:</comment>
  Liefert asynchrone Abfrageergebnisse
  
  <strong>pg_get_result()</strong> gibt die <class>PgSql\Result</class>-Instanz einer asynchronen Abfrage zurück, die mit
  <strong>pg_send_query()</strong>, <strong>pg_send_query_params()</strong> oder <strong>pg_send_execute()</strong> an den Datenbankserver gesendet
  wurde.
  
  Mit <strong>pg_send_query()</strong> und auch den anderen asynchronen Abfragefunktionen können mehrere Abfragen an
  den Server geschickt werden. Deren Ergebnisse können mit <strong>pg_get_result()</strong> nacheinander abgefragt
  werden.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.

<comment>Return:</comment>
  <info>PgSql\Result|false</info>  Bei Erfolg wird eine <class>PgSql\Result</class>-Instanz zurückgegeben oder <info>false</info>, falls es
                      keine Ergebnisse gibt.

<comment>See Also:</comment>
   * <strong>pg_send_query()</strong>


id: pg_host
type: function
doc:
<comment>Description:</comment>
  Liefert den Namen des Host, zu dem verbunden wurde
  
  <strong>pg_host()</strong> gibt den Namen des Hosts zurück, zu dem mit der angegebenen PostgreSQL
  <strong>$connection</strong>-Instanz verbunden wurde.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                      Falls <strong>$connection</strong> <info>null</info> ist, wird die Standardverbindung
                                      benutzt.
                                      Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong>
                                      aufgebaute Verbindung.
                                      Seit PHP 8.1.0 ist die Verwendung der Standardverbindung
                                      veraltet.
                                      
                                      Seit PHP 8.1.0 ist die Verwendung der Standardverbindung
                                      veraltet.

<comment>Return:</comment>
  <info>string</info>  Ein <info>string</info>, der den Namen des Hosts enthält, zu dem die <strong>$connection</strong> besteht oder ein
          leerer String, falls ein Fehler auftrat.

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>
   * <strong>pg_pconnect()</strong>


id: pg_insert
type: function
doc:
<comment>Description:</comment>
  Überträgt Werte aus einem Array in eine Tabelle
  
  <strong>pg_insert()</strong> fügt die Werte des <strong>$values</strong> in die Tabelle <strong>$table_name</strong> ein.
  
  Falls <strong>$flags</strong> angegeben wurde, wird <strong>pg_convert()</strong> mit den angegebenen Flags auf das Array <strong>$values</strong>
  angewendet.
  
  Standardmäßig übergibt <strong>pg_insert()</strong> Rohwerte. Die Werte müssen entweder maskiert werden oder es
  muss die Option <info>PGSQL_DML_ESCAPE</info> angegeben werden. <info>PGSQL_DML_ESCAPE</info> maskiert Parameter und
  Bezeichner und setzt sie in Anführungszeichen. Daher muss bei Tabellen- und Spaltennamen zwischen
  Groß- und Kleinschreibung unterschieden werden.
  
  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, d. h.
  Werte maskieren und validieren.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
  <info>string</info>            <strong>$table_name</strong>  Der Name der Tabelle, in die die Zeilen eingefügt werden sollen.
                                 <strong>$table_name</strong> muss mindestens soviele Spalten haben, wie das <strong>$values</strong>
                                 Elemente.
  <info>array</info>             <strong>$values</strong>      Ein <info>array</info>, dessen Indizes die Feldnamen der Tabelle <strong>$table_name</strong>
                                 sind und dessen Werte die Werte sind, die in die entprechenden
                                 Spalten eingefügt werden sollen.
  <info>int</info>               <strong>$flags</strong>       Jede Kombination aus <info>PGSQL_CONV_OPTS</info>, <info>PGSQL_DML_NO_CONV</info>,
                                 <info>PGSQL_DML_ESCAPE</info>, <info>PGSQL_DML_EXEC</info>, <info>PGSQL_DML_ASYNC</info> und
                                 <info>PGSQL_DML_STRING</info>. Falls <info>PGSQL_DML_STRING</info> bei den <strong>$flags</strong> angegeben
                                 wurde, wird der Abfrage-String zurückgegeben. Werden
                                 <info>PGSQL_DML_NO_CONV</info> oder <info>PGSQL_DML_ESCAPE</info> angegeben, wird
                                 <strong>pg_convert()</strong> intern nicht aufgerufen.

<comment>Return:</comment>
  <info>PgSql\Result|string|bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben..
                            Oder gibt bei Erfolg einen String zurück, wenn <info>PGSQL_DML_STRING</info> über
                            <strong>$flags</strong> übergeben wird.

<comment>See Also:</comment>
   * <strong>pg_convert()</strong>


id: pg_last_error
type: function
doc:
<comment>Description:</comment>
  Liefert die letzte Fehlermeldung einer Verbindung
  
  <strong>pg_last_error()</strong> gibt die letzte Fehlermeldung der durch <strong>$connection</strong> gegebenen Verbindung als
  String zurück.
  
  Fehlermeldungen können durch interne PostgreSQL- (libpq) Funktionsaufrufe überschrieben werden.
  Falls mehrere Fehler innerhalb einer internen PostgreSQL-Funktion auftreten, wird möglicherweise
  keine passende Fehlermeldung angezeigt.
  
  Verwenden Sie <strong>pg_result_error()</strong>, <strong>pg_result_error_field()</strong>, <strong>pg_result_status()</strong> und
  <strong>pg_connection_status()</strong> um genauere Fehlermeldungen zu erhalten.
  
  Diese Funktion ersetzt die Funktion <strong>pg_errormessage()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                      Falls <strong>$connection</strong> <info>null</info> ist, wird die Standardverbindung
                                      benutzt.
                                      Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong>
                                      aufgebaute Verbindung.
                                      Seit PHP 8.1.0 ist die Verwendung der Standardverbindung
                                      veraltet.
                                      
                                      Seit PHP 8.1.0 ist die Verwendung der Standardverbindung
                                      veraltet.

<comment>Return:</comment>
  <info>string</info>  Ein <info>string</info>, der die letzte Fehlermeldung der aktuellen <strong>$connection</strong> enthält.

<comment>See Also:</comment>
   * <strong>pg_result_error()</strong>
   * <strong>pg_result_error_field()</strong>


id: pg_last_notice
type: function
doc:
<comment>Description:</comment>
  Liefert die letzte NOTICE-Meldung des PostgreSQL-Servers
  
  <strong>pg_last_notice()</strong> gibt die letzte NOTICE-Meldung des PostgreSQL-Servers für die angegebene
  <strong>$connection</strong> zurück. Der PostgreSQL-Server sendet zu unterschiedlichen Anlässen NOTICE-Meldungen an
  den Client, beispielsweise, wenn in einer Tabelle eine Spalte vom Typ <return>SERIAL</return> erzeugt wurde.
  
  Mit <strong>pg_last_notice()</strong> kann das Senden überflüssiger Abfragen vermieden werden, indem man prüft, ob
  eine NOTICE-Meldung sich auf die aktuelle Transaktion bezieht oder nicht.
  
  Die Verfolgung von NOTICE-Benachrichtigungen kann auf optional gesetzt werden, indem die Direktive
  <return>pgsql.ignore_notice</return> in php.ini den Wert 1 erhält.
  
  Die Protokollierung von Notice-Benachrichtigungen kann auf optional gesetzt werden, indem die
  Direktive <return>pgsql.log_notice</return> in php.ini den Wert 0 erhält. Nur wenn die Direktive
  <return>pgsql.ignore_notice</return> den Wert 0 hat, können Notice-Benachrichtigungen protokolliert werden.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
  <info>int</info>               <strong>$mode</strong>        Entweder <info>PGSQL_NOTICE_LAST</info> (um die letzte Notice zu erhalten),
                                 <info>PGSQL_NOTICE_ALL</info> (um alle Notices zu erhalten) oder
                                 <info>PGSQL_NOTICE_CLEAR</info> (um die Notices zu löschen).

<comment>Return:</comment>
  <info>array|string|bool</info>  Ein <info>String</info>, der die letzte NOTICE-Meldung für die übergebene <strong>$connection</strong>
                     enthält bei <info>PGSQL_NOTICE_LAST</info>, ein <info>Array</info> bei <info>PGSQL_NOTICE_ALL</info>, ein <info>bool</info> bei
                     <info>PGSQL_NOTICE_CLEAR</info>.

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_last_error()</strong>


id: pg_last_oid
type: function
doc:
<comment>Description:</comment>
  Liefert den Objektbezeichner (OID) des zuletzt eingefügten Datensatzes
  
  <strong>pg_last_oid()</strong> wird benutzt, um den Object-Identifier OID des zuletzt eingefügten Datensatzes zu
  ermitteln.
  
  Ab PostgreSQL 7.2 ist das Feld OID optional und ab der Version 8.1 wird es nicht mehr
  standardmäßig in den Tabellen enthalten sein. Falls eine Tabelle ohne OID definiert wurde, muss
  mit der Funktion <strong>pg_result_status()</strong> geprüft werden, ob ein Datensatz korrekt eingefügt wurde.
  
  Um den Wert eines <return>SERIAL</return>-Feldes in einem gerade eingefügten Datensatz zu erhalten, ist der Aufruf
  der PostgreSQL-Funktion <return>CURRVAL</return> notwendig. Dem Aufruf muss der Name der in dieser Datenbanksitzung
  zuletzt benutzten Sequenz übergeben werden. Ist der Name dieser Sequenz unbekannt, muss er ab
  PostgreSQL 8.0 mittels der Funktion <return>pg_get_serial_sequence</return> ermittelt werden.
  
  PostgreSQL enthält eine Funktion <return>LASTVAL</return>, die den Wert der zuletzt benutzten Sequenz der aktuellen
  Datenbanksitzung zurückgibt. Sie macht die Angabe von Sequenz, Tabelle und Spalte überflüssig.
  
  Diese Funktion ersetzt die Funktion <strong>pg_getlastoid()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Eine <class>PgSql\Result</class>-Instanz, die von <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> oder <strong>pg_execute()</strong> (unter anderen) zurückgegeben wurde.

<comment>Return:</comment>
  <info>string|int|false</info>  Ein <info>int</info> oder <info>string</info> mit der OID des zuletzt eingefügten Datensatzes für die
                    angegebene <strong>$connection</strong> oder <info>false</info>, falls ein Fehler auftrat oder falls es keine
                    OID gibt.

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_result_status()</strong>


id: pg_lo_close
type: function
doc:
<comment>Description:</comment>
  Schließt ein Large Object
  
  <strong>pg_lo_close()</strong> schließt ein Large Object.
  
  Um die Large Object (lo) Schnittstelle benutzen zu können,  müssen die Kommandos innerhalb einer
  Transaktion ausgeführt werden.
  
  Diese Funktion ersetzt die Funktion <strong>pg_loclose()</strong>.

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>  Eine <class>PgSql\Lob</class>-Instanz, die von <strong>pg_lo_open()</strong> zurückgegeben wurde.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_lo_open()</strong>
   * <strong>pg_lo_create()</strong>
   * <strong>pg_lo_import()</strong>


id: pg_lo_create
type: function
doc:
<comment>Description:</comment>
  Erzeugt ein Large Object
  
  <strong>pg_lo_create()</strong> erzeugt ein Large Object und gibt dessen OID zurück. Die <info>INV_READ</info>-, <info>INV_WRITE</info>- und
  <info>INV_ARCHIVE</info>-Zugriffsmodi von PostgreSQL werden nicht unterstützt. Ein Large Object wird immer mit
  Lese- und Schreibzugriff erzeugt. <info>INV_ARCHIVE</info> wurde aus PostgreSQL (ab Version 6.3 und höher)
  entfernt.
  
  Um die Large Object (lo) Schnittstelle benutzen zu können, müssen die Kommandos innerhalb einer
  Transaktion ausgeführt werden.
  
  Anstelle der Large-Object-Schnittstelle (für die es keine Zugriffssteuerung gibt und deren
  Benutzung etwas schwerfällig ist) können Sie den PostgreSQL-Datentyp bytea und die Funktion
  <strong>pg_escape_bytea()</strong> benutzen.
  
  Diese Funktion ersetzt die Funktion <strong>pg_locreate()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                 Falls <strong>$connection</strong> nicht angegeben wurde, wird die
                                 Standardverbindung benutzt.
                                 Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong> aufgebaute
                                 Verbindung.
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
                                 
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
  <info>mixed</info>             <strong>$object_id</strong>   Wenn es einen Parameter <strong>$object_id</strong> gibt, wird diese Funktion
                                 versuchen, ein Large Object mit dieser ID zu erzeugen. Anderenfalls
                                 wird dem Large Object vom Server eine freie ID zugewiesen. Dieser
                                 Parameter basiert auf Funktionalitäten, die seit PostgreSQL 8.1
                                 implementiert sind.

<comment>Return:</comment>
  <info>int</info>  Ein Large Object OID. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: pg_lo_export
type: function
doc:
<comment>Description:</comment>
  Exportiert ein Large Object in eine Datei
  
  <strong>pg_lo_export()</strong> liest die Inhalte eines Large Objects aus einer PostgreSQL Datenbank aus und
  speichert sie in einer Datei im lokalen Dateisystem.
  
  Um die Large Object (lo) Schnittstelle benutzen zu können, müssen  die Kommandos innerhalb einer
  Transaktion ausgeführt werden.
  
  Diese Funktion ersetzt die Funktion <strong>pg_loexport()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                 Falls <strong>$connection</strong> nicht angegeben wurde, wird die
                                 Standardverbindung benutzt.
                                 Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong> aufgebaute
                                 Verbindung.
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
                                 
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
  <info>int</info>               <strong>$oid</strong>         Der OID des Large Objects in der Datenbank.
  <info>string</info>            <strong>$pathname</strong>    Der vollständige Pfad und Dateiname der Datei, in der die Inhalte
                                 des  Large Objects im lokalen Dateisystem gespeichert werden.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_lo_import()</strong>


id: pg_lo_import
type: function
doc:
<comment>Description:</comment>
  Importiert ein Large Object aus einer Datei
  
  <strong>pg_lo_import()</strong> erzeugt aus einer Datei im Dateisystem als Datenquelle ein neues Large Object in
  der Datenbank.
  
  Um die Large Object- (lo) Schnittstelle benutzen zu können, müssen die Kommandos innerhalb einer
  Transaktion ausgeführt werden.
  
  Diese Funktion ersetzt die Funktion <strong>pg_loimport()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                 Falls <strong>$connection</strong> nicht angegeben wurde, wird die
                                 Standardverbindung benutzt.
                                 Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong> aufgebaute
                                 Verbindung.
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
                                 
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
  <info>string</info>            <strong>$pathname</strong>    Der vollständige Pfad- und Dateiname der Datei im lokalen
                                 Dateisystem des Clients, aus der die Daten des Large Objects
                                 gelesen werden.
  <info>mixed</info>             <strong>$object_id</strong>   Wenn es einen Parameter <strong>$object_id</strong> gibt, wird diese Funktion
                                 versuchen, ein Large Object mit dieser ID zu erzeugen. Anderenfalls
                                 wird dem Large Object vom Server eine freie ID zugewiesen. Dieser
                                 Parameter basiert auf Funktionalitäten, die seit PostgreSQL 8.1
                                 implementiert sind.

<comment>Return:</comment>
  <info>int</info>  Die OID des neu erzeugten Large Objects. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_lo_export()</strong>
   * <strong>pg_lo_open()</strong>


id: pg_lo_open
type: function
doc:
<comment>Description:</comment>
  Öffnet ein Large Object
  
  <strong>pg_lo_open()</strong> öffnet ein Large Object in einer Datenbank und gibt eine <class>PgSql\Lob</class>-Instanz zurück,
  über die das Large Object modifiziert werden kann.
  
  Bevor die Datenbankverbindung geschlossen wird, müssen die <class>PgSql\Lob</class>-Instanzen wieder geschlossen
  werden.
  
  Um die Large Object- (lo) Schnittstelle benutzen zu können, müssen die Kommandos innerhalb einer
  Transaktion ausgeführt werden.
  
  Diese Funktion ersetzt die Funktion <strong>pg_loopen()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                 Falls <strong>$connection</strong> nicht angegeben wurde, wird die
                                 Standardverbindung benutzt.
                                 Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong> aufgebaute
                                 Verbindung.
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
                                 
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
  <info>int</info>               <strong>$oid</strong>         Die OID des Large Objects in der Datenbank.
  <info>string</info>            <strong>$mode</strong>        Dies kann entweder "r" für nur lesen, "w" für nur schreiben oder
                                 "rw" für lesen und schreiben sein.

<comment>Return:</comment>
  <info>PgSql\Lob|false</info>  Eine <class>PgSql\Lob</class>-Instanz. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_lo_close()</strong>
   * <strong>pg_lo_create()</strong>


id: pg_lo_read
type: function
doc:
<comment>Description:</comment>
  Liest ein Large Object
  
  <strong>pg_lo_read()</strong> liest höchstens <strong>$length</strong> Bytes eines Large Objects und gibt die gelesenen Daten als
  String zurück.
  
  Um die Large Object (lo) Schnittstelle benutzen zu können, müssen die Kommandos innerhalb einer
  Transaktion ausgeführt werden.
  
  Diese Funktion ersetzt die Funktion <strong>pg_loread()</strong>.

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>     Eine <class>PgSql\Lob</class>-Instanz, die von <strong>pg_lo_open()</strong> zurückgegeben wurde.
  <info>int</info>        <strong>$length</strong>  Die (optionale) maximale Anzahl der zu lesenden Bytes.

<comment>Return:</comment>
  <info>string|false</info>  Ein <info>string</info>, der <strong>$length</strong> Bytes aus dem Large Object enthält, oder <info>false</info>, falls ein
                Fehler auftritt.

<comment>See Also:</comment>
   * <strong>pg_lo_read_all()</strong>


id: pg_lo_read_all
type: function
doc:
<comment>Description:</comment>
  Liest ein ganzes Large Object und reicht es direkt an den Browser weiter
    
  
  <strong>pg_lo_read_all()</strong> liest ein ganzes Large Object und übergibt es direkt an den Browser, nachdem alle
  entsprechenden Header gesendet wurden. Die Funktion wird hauptsächlich für Binärdaten wie Bilder
  oder Audiodaten genutzt.
  
  Um die Large Object-Schnittstelle benutzen zu können, müssen die Kommandos innerhalb einer
  Transaktion ausgeführt werden.
  
  Diese Funktion ersetzt die Funktion <strong>pg_loreadall()</strong>.

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>  Eine <class>PgSql\Lob</class>-Instanz, die von <strong>pg_lo_open()</strong> zurückgegeben wurde.

<comment>Return:</comment>
  <info>int</info>  Die Anzahl der gelesenen Bytes.

<comment>See Also:</comment>
   * <strong>pg_lo_read()</strong>


id: pg_lo_seek
type: function
doc:
<comment>Description:</comment>
  Setzt die Lese- oder Schreibposition in einem Large Object
    
  
  <strong>pg_lo_seek()</strong> setzt den internen Zeiger einer <class>PgSql\Lob</class>-Instanz auf die angegebenen Position.
  
  Um die Large Object (lo) Schnittstelle benutzen zu können, müssen die Kommandos innerhalb einer
  Transaktion ausgeführt werden.

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>     Eine <class>PgSql\Lob</class>-Instanz, die von <strong>pg_lo_open()</strong> zurückgegeben wurde.
  <info>int</info>        <strong>$offset</strong>  Die Anzahl der Bytes, hinter die der interne Zeiger gesetzt wird.
  <info>int</info>        <strong>$whence</strong>  Eine der Konstanten <info>PGSQL_SEEK_SET</info> (bewegt den internen Zeiger vom Anfang
                      ausgehend), <info>PGSQL_SEEK_CUR</info> (bewegt den internen Zeiger ab der aktuellen
                      Position) oder <info>PGSQL_SEEK_END</info> (bewegt den internen Zeiger vom Ende ausgehend).

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_lo_tell()</strong>


id: pg_lo_tell
type: function
doc:
<comment>Description:</comment>
  Liefert die aktuelle Lese- oder Schreibposition in einem Large Object
    
  
  <strong>pg_lo_tell()</strong> gibt die aktuelle Position (Offset vom Anfang des Large Objects aus) des internen
  Zeigers zurück.
  
  Um die Large Object (lo) Schnittstelle benutzen zu können, müssen die Kommandos innerhalb einer
  Transaktion ausgeführt werden.

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>  Eine <class>PgSql\Lob</class>-Instanz, die von <strong>pg_lo_open()</strong> zurückgegeben wurde.

<comment>Return:</comment>
  <info>int</info>  Die aktuelle Lese- oder Schreibposition in einem (in Bytes) vom Anfang des Large Objects aus.
       Falls ein Fehler auftritt, ist der Rückgabewert negativ.

<comment>See Also:</comment>
   * <strong>pg_lo_seek()</strong>


id: pg_lo_truncate
type: function
doc:
<comment>Description:</comment>
  Truncates a large object
    
  
  <strong>pg_lo_truncate()</strong> truncates an <class>PgSql\Lob</class> instance.
  
  To use the large object interface, it is necessary to enclose it within a transaction block.

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>   Eine <class>PgSql\Lob</class>-Instanz, die von <strong>pg_lo_open()</strong> zurückgegeben wurde.
  <info>int</info>        <strong>$size</strong>  The number of bytes to truncate.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_lo_tell()</strong>


id: pg_lo_unlink
type: function
doc:
<comment>Description:</comment>
  Löscht ein Large Object
  
  <strong>pg_lo_unlink()</strong> löscht das Large Object mit dem Objektbezeichner <strong>$oid</strong>. Gibt bei Erfolg <info>true</info> zurück.
  Bei einem Fehler wird <info>false</info> zurückgegeben.
  
  Um die Large Object (lo) Schnittstelle benutzen zu können, müssen die Kommandos innerhalb einer
  Transaktion ausgeführt werden.
  
  Diese Funktion ersetzt die Funktion <strong>pg_lounlink()()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                 Falls <strong>$connection</strong> nicht angegeben wurde, wird die
                                 Standardverbindung benutzt.
                                 Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong> aufgebaute
                                 Verbindung.
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
                                 
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
  <info>int</info>               <strong>$oid</strong>         Der OID des Large Objects in der Datenbank.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_lo_create()</strong>
   * <strong>pg_lo_import()</strong>


id: pg_lo_write
type: function
doc:
<comment>Description:</comment>
  Schreibt in ein Large Object
  
  <strong>pg_lo_write()</strong> schreibt Daten ab der aktuellen Position der internen Schreib-Lese-Marke in ein
  Large Object.
  
  Um die Large Object- (lo) Schnittstelle benutzen zu können, müssen die Kommandos innerhalb einer
  Transaktion ausgeführt werden.
  
  Diese Funktion ersetzt die Funktion <strong>pg_lowrite()</strong>.

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>     Eine <class>PgSql\Lob</class>-Instanz, die von <strong>pg_lo_open()</strong> zurückgegeben wurde.
  <info>string</info>     <strong>$data</strong>    Die Daten, die in das Large Object geschrieben werden. Falls <strong>$length</strong> vom Typ
                      <info>int</info> ist und kleiner als die Länge von <strong>$data</strong>, werden nur <strong>$length</strong> Bytes
                      geschrieben.
  <info>int|null</info>   <strong>$length</strong>  Die maximale Anzahl der Bytes, die geschrieben werden. Die Anzahl muss größer
                      als 0 und kleiner als die Länge von <strong>$data</strong> sein. Der Vorgabewert ist die Länge
                      von <strong>$data</strong>. Diese Angabe ist optional.

<comment>Return:</comment>
  <info>int|false</info>  Die Anzahl der Bytes, die in das Large Object geschrieben wurden, oder <info>false</info>, falls ein
             Fehler auftrat.

<comment>See Also:</comment>
   * <strong>pg_lo_create()</strong>
   * <strong>pg_lo_open()</strong>


id: pg_meta_data
type: function
doc:
<comment>Description:</comment>
  Liefert die Metadaten einer Tabelle als Array
  
  <strong>pg_meta_data()</strong> gibt die Tabellendefinition für <return>table_name</return> in einem Array zurück.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
  <info>string</info>            <strong>$table_name</strong>  Der Tabellenname.
  <info>bool</info>              <strong>$extended</strong>    Das Flag, um erweiterte Metadaten zurückzugeben. Vorgabewert ist
                                 <info>false</info>.

<comment>Return:</comment>
  <info>array|false</info>  Ein Array, das die Tabellendefinition enthält. Bei einem Fehler wird <info>false</info>
               zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_convert()</strong>


id: pg_num_fields
type: function
doc:
<comment>Description:</comment>
  Gibt die Anzahl der Felder in einem Abfrageergebnis zurück
  
  <strong>pg_num_fields()</strong> gibt die Anzahl der Felder (Spalten) in einer PostgreSQL <class>PgSql\Result</class>-Instanz
  zurück.
  
  Diese Funktion ersetzt die Funktion <strong>pg_numfields()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Eine <class>PgSql\Result</class>-Instanz, die von <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> oder <strong>pg_execute()</strong> (unter anderen) zurückgegeben wurde.

<comment>Return:</comment>
  <info>int</info>  Die Anzahl der Felder (Spalten) in einem Abfrageergebnis. Tritt ein Fehler auf, wird -1
       zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_num_rows()</strong>
   * <strong>pg_affected_rows()</strong>


id: pg_num_rows
type: function
doc:
<comment>Description:</comment>
  Gibt die Anzahl der Zeilen in einem Abfrageergebnis zurück
  
  <strong>pg_num_rows()</strong> gibt die Anzahl der Zeilen in einer PostgreSQL <class>PgSql\Result</class>-Instanz zurück.
  
  Diese Funktion ersetzt die Funktion <strong>pg_numrows()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Eine <class>PgSql\Result</class>-Instanz, die von <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> oder <strong>pg_execute()</strong> (unter anderen) zurückgegeben wurde.

<comment>Return:</comment>
  <info>int</info>  Die Anzahl der Zeilen in einem Abfrageergebnis. Tritt ein Fehler auf, wird <return>-1</return> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_num_fields()</strong>
   * <strong>pg_affected_rows()</strong>


id: pg_options
type: function
doc:
<comment>Description:</comment>
  Liefert die Verbindungsoptionen der aktuellen Verbindung
  
  <strong>pg_options()</strong> gibt einen <info>string</info> zurück, der die Verbindungsoptionen der angegebenen PostgreSQL
  <strong>$connection</strong>-Instanz enthält.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                      Falls <strong>$connection</strong> <info>null</info> ist, wird die Standardverbindung
                                      benutzt.
                                      Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong>
                                      aufgebaute Verbindung.
                                      Seit PHP 8.1.0 ist die Verwendung der Standardverbindung
                                      veraltet.
                                      
                                      Seit PHP 8.1.0 ist die Verwendung der Standardverbindung
                                      veraltet.

<comment>Return:</comment>
  <info>string</info>  Ein <info>string</info>, der die Verbindungsoptionen von <strong>$connection</strong> enthält.

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>


id: pg_parameter_status
type: function
doc:
<comment>Description:</comment>
  Liefert den aktuellen Wert eines Parameters des Servers
  
  Ermittelt die aktuelle Einstellung eines Parameters des Servers.
  
  Bestimmte Servereinstellungen (Parameter) werden beim Verbindungsaufbau oder, wenn sich ihr Wert
  ändert, automatich vom Server gemeldet. Mit <strong>pg_parameter_status()</strong> können Sie diese Einstellungen
  abfragen. Zurückgegeben wird der aktuelle Wert des Parameters, falls dieser bekannt ist,
  anderenfalls <info>false</info>.
  
  In PostgreSQL 8.0 werden die Werte für folgende Parameter zurückgegeben: <return>server_version</return>,
  <return>server_encoding</return>, <return>client_encoding</return>, <return>is_superuser</return>, <return>session_authorization</return>, <return>DateStyle</return>, <return>TimeZone</return> und
  <return>integer_datetimes</return>. (<return>server_encoding</return>, <return>TimeZone</return> und <return>integer_datetimes</return> werden von PostgreSQL vor 8.0
  nicht zurückgegeben.) Beachten Sie, dass <return>server_version</return>, <return>server_encoding</return> und <return>integer_datetimes</return>
  nach dem Start von PostgreSQL nicht mehr verändert werden können.
  
  PostgreSQL 7.3 oder darunter geben gar keine Servereinstellungen zurück. <strong>pg_parameter_status()</strong>
  kann trotzdem benutzt werden, um die Werte von <return>server_version</return> und <return>client_encoding</return> zu ermitteln. Es
  wird empfohlen, in Anwendungen <strong>pg_parameter_status()</strong> zu verwenden, anstatt speziellen Code zu
  schreiben, um diese Werte zu erhalten.
  
  In PostgreSQL-Versionen vor 7.4 wird ein nachträgliches (nach dem Start des Servers) Ändern von
  <return>client_encoding</return> mit dem Kommando <return>SET</return> von <strong>pg_parameter_status()</strong> ignoriert.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                 Falls <strong>$connection</strong> nicht angegeben wurde, wird die
                                 Standardverbindung benutzt.
                                 Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong> aufgebaute
                                 Verbindung.
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
                                 
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
  <info>string</info>            <strong>$param_name</strong>  Mögliche Werte für <strong>$param_name</strong> sind: <return>server_version</return>,
                                 <return>server_encoding</return>, <return>client_encoding</return>, <return>is_superuser</return>,
                                 <return>session_authorization</return>, <return>DateStyle</return>, <return>TimeZone</return> und <return>integer_datetimes</return>.
                                 Es ist zu beachten, dass bei diesem Wert zwischen Groß- und
                                 Kleinschreibung unterschieden wird.

<comment>Return:</comment>
  <info>string</info>  Ein <info>string</info>, der den Wert des Parameters enthält, oder <info>false</info>, falls ein Fehler auftrat oder
          der Parameter <strong>$param_name</strong> ungültig ist.


id: pg_pconnect
type: function
doc:
<comment>Description:</comment>
  Öffnet eine persistente PostgreSQL-Verbindung
  
  <strong>pg_pconnect()</strong> öffnet eine persistente Verbindung zu einer PostgreSQL-Datenbank. Zurückgegeben wird
  eine <class>PgSql\Connection</class>-Instanz, die von anderen PostgreSQL-Funktionen benötigt wird.
  
  Falls <strong>pg_pconnect()</strong> ein zweites Mal mit demselben <strong>$connection_string</strong> einer bereits existierenden
  Verbindung aufgerufen wird, wird die Verbindungskennung dieser existierenden Verbindung
  zurückgegeben, es sei denn, die Konstante <info>PGSQL_CONNECT_FORCE_NEW</info> wird als <strong>$flags</strong> übergeben.
  
  Um persistente Verbindungen zu ermöglichen, muss die pgsql.allow_persistent-Direktive in php.ini
  auf den Wert "On" gesetzt sein (was der Standardeinstellung entspricht). Die maximale Anzahl
  geöffneter persistenter Verbindungen kann mit der Direktive pgsql.max_persistent in php.ini
  definiert werden (der Standardwert ist -1, der für unbegrenzt steht). Die Gesamtanzahl der
  Verbindungen kann mit der pgsql.max_links-Direktive in php.ini gesetzt werden.
  
  <strong>pg_close()</strong> schließt keine persistenten Verbindungen, die mit <strong>pg_pconnect()</strong> erzeugt wurden.

<comment>Param:</comment>
  <info>string</info>  <strong>$connection_string</strong>  Der <strong>$connection_string</strong> kann leer sein, um die Standardwerte für die
                              Parameter zu benutzen. Er kann auch einen oder mehrere durch
                              Whitespace-Zeichen getrennte Parameter enthalten. Jeder Parameter wird
                              in der Form <return>keyword = Wert</return> angegeben, Leerzeichen vor und nach dem
                              Gleichheitszeichen sind optional. Um einen leeren Wert oder einen
                              Wert, der Leerzeichen enthält, anzugeben, müssen Sie den Wert in
                              einfache Anführungszeichen einschließen, zum Beispiel <return>keyword = 'ein
                              Wert'</return>. Einfache Anführungszeichen und Backslashes innerhalb des Wertes
                              müssen mit einem Backslash maskiert werden, beispielsweise \' und \\.
                              
                              Gegenwärtig werden die folgenden Schlüsselwörter als Parameter
                              erkannt: <strong>$host</strong>, <strong>$hostaddr</strong>, <strong>$port</strong>, <strong>$dbname</strong>, <strong>$user</strong>, <strong>$password</strong>,
                              <strong>$connect_timeout</strong>, <strong>$options</strong>, <strong>$tty</strong> (wird ignoriert), <strong>$sslmode</strong>,
                              <strong>$requiressl</strong> (veraltet zugunsten von <strong>$sslmode</strong>) und <strong>$service</strong>. Welche
                              dieser Parameter zur Verfügung stehen, hängt von Ihrer
                              PostgreSQL-Version ab.
  <info>int</info>     <strong>$flags</strong>              Falls <info>PGSQL_CONNECT_FORCE_NEW</info> übergeben wurde, wird eine neue
                              Verbindung aufgebaut, auch wenn der <strong>$connection_string</strong> identisch zu
                              dem einer existierenden Verbindung ist.

<comment>Return:</comment>
  <info>PgSql\Connection|false</info>  Bei Erfolg wird eine <class>PgSql\Connection</class>-Instanz zurückgegeben. Bei einem
                          Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>
   * 
     Persistente Datenbankverbindungen


id: pg_ping
type: function
doc:
<comment>Description:</comment>
  Prüft die Datenbankverbindung
  
  <strong>pg_ping()</strong> prüft eine Datenbankverbindung und versucht einen erneuten Verbindungsaufbau, falls die
  Verbindung abbricht.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                      Falls <strong>$connection</strong> <info>null</info> ist, wird die Standardverbindung
                                      benutzt.
                                      Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong>
                                      aufgebaute Verbindung.
                                      Seit PHP 8.1.0 ist die Verwendung der Standardverbindung
                                      veraltet.
                                      
                                      Seit PHP 8.1.0 ist die Verwendung der Standardverbindung
                                      veraltet.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_connection_status()</strong>
   * <strong>pg_connection_reset()</strong>


id: pg_port
type: function
doc:
<comment>Description:</comment>
  Liefert die Portnummer, über die die Verbindung aufgebaut wurde
    
  
  <strong>pg_port()</strong> gibt die Nummer des Ports zurück, über die die angegebene <strong>$connection</strong> zum
  PostgreSQL-Datenbankserver aufgebaut wurde.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                      Falls <strong>$connection</strong> <info>null</info> ist, wird die Standardverbindung
                                      benutzt.
                                      Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong>
                                      aufgebaute Verbindung.
                                      Seit PHP 8.1.0 ist die Verwendung der Standardverbindung
                                      veraltet.
                                      
                                      Seit PHP 8.1.0 ist die Verwendung der Standardverbindung
                                      veraltet.

<comment>Return:</comment>
  <info>string</info>  Ein Wert vom Typ <info>string</info>, der die Portnummer angibt, über die die <strong>$connection</strong> zum
          PostgreSQL-Datenbankserver aufgebaut wurde oder ein leerer String, falls ein Fehler
          auftrat.


id: pg_prepare
type: function
doc:
<comment>Description:</comment>
  Sendet eine Aufforderung an den Server, eine vorbereitete Anfrage mit den
     übergebenen Parametern zu erzeugen und wartet auf ihre Beendigung
    
  
  <strong>pg_prepare()</strong> erzeugt eine vorbereitete Abfrage, die später mit <strong>pg_execute()</strong> oder <strong>pg_send_execute()</strong>
  ausgeführt werden kann. Dank dieser Eigenschaft brauchen wiederholt ausgeführte Abfragen nur ein
  einziges Mal geparst und geplant werden, anstatt bei jeder Ausführung. <strong>pg_prepare()</strong> wird nur für
  Verbindungen zu PostgreSQL ab der Version 7.4 unterstützt und schlägt bei allen niedrigeren
  Versionen fehl.
  
  Diese Funktion erzeugt aus der Abfrage <strong>$query</strong> eine vorbereitete Abfrage mit dem Namen <strong>$stmtname</strong>.
  <strong>$query</strong> darf nur ein einzelnes SQL-Kommando enthalten. <strong>$stmtname</strong> kann "" sein, um eine unbenannte
  Abfrage zu erzeugen, wobei zuvor definierte unbenannte Abfragen automatisch überschrieben werden.
  Falls der Name der vorbereiteten Abfrage in der aktuellen Datenbanksitzung schon vergeben ist,
  wird ein Fehler zurückgegeben. Falls irgendwelche Parameter übergeben wurden, werden diese in
  <strong>$query</strong> als $1, $2 usw. referenziert.
  
  Vorbereitete Abfragen, die mit <strong>pg_prepare()</strong> erzeugt wurden, können ebenso mit dem SQL-Kommando
  <return>PREPARE</return> erzeugt werden (allerdings ist <strong>pg_prepare()</strong> flexibler, weil Parametertypen nicht vorab
  deklariert werden müssen). Obwohl es keine PHP-Funktion zum Löschen vorbereiteter Anfragen gibt,
  können diese mit dem SQL-Kommando <return>DEALLOCATE</return> gelöscht werden.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                 Falls <strong>$connection</strong> nicht angegeben wurde, wird die
                                 Standardverbindung benutzt.
                                 Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong> aufgebaute
                                 Verbindung.
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
                                 
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
  <info>string</info>            <strong>$stmtname</strong>    Der Name, unter dem die vorbereitete Abfrage gespeichert wird.
                                 Dieser muss für jede Verbindung eindeutig sein. Falls "" angegeben
                                 wurde, wird eine unbenannte Abfrage erzeugt, die alle zuvor
                                 definierten unbenannten Abfragen überschreibt.
  <info>string</info>            <strong>$query</strong>       Die parametrisierte vorbereitete Abfrage. Diese darf nur ein
                                 einziges SQL-Kommando enthalten (mehrere Kommandos, durch Semikolon
                                 getrennt, sind nicht zulässig). Falls Parameter übergeben werden,
                                 werden sie als $1, $2, ... referenziert.

<comment>Return:</comment>
  <info>PgSql\Result|false</info>  Bei Erfolg wird eine <class>PgSql\Result</class>-Instanz zurückgegeben. Bei einem Fehler wird
                      <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_execute()</strong>
   * <strong>pg_send_execute()</strong>


id: pg_put_line
type: function
doc:
<comment>Description:</comment>
  Sendet eine NULL-terminierte Zeichenkette zum PostgreSQL-Server
  
  <strong>pg_put_line()</strong> sendet eine NULL-terminierte Zeichenkette an den PostgreSQL-Server. Das ist in
  Verbindung mit  dem PostgreSQL-Befehl <return>COPY FROM</return> notwendig.
  
  <return>COPY</return> ist eine PostgreSQL-Anweisung, mit der Daten mit hoher Geschwindigkeit in eine Tabelle
  eingefügt werden können. Die Daten werden ungeparst und in einer einzigen Transaktion übertragen.
  
  Alternativ zu <strong>pg_put_line()</strong> kann <strong>pg_copy_from()</strong> verwendet werden. Dies ist weitaus einfacher.
  
  Eine Anwendung muss explizit die beiden Zeichen "\." in der letzten Zeile an PostgreSQL
  übertragen, um anzuzeigen, dass die Datenübertragung beendet ist, bevor <strong>pg_end_copy()</strong> aufgerufen
  wird.
  
  Die Verwendung von <strong>pg_put_line()</strong> führt bei den meisten Operationen mit Large Objects zu Fehlern.
  So etwa bei <strong>pg_lo_read()</strong> und <strong>pg_lo_tell()</strong>. Stattdessen sollten Sie <strong>pg_copy_from()</strong> und <strong>pg_copy_to()</strong>
  benutzen.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                 Falls <strong>$connection</strong> nicht angegeben wurde, wird die
                                 Standardverbindung benutzt.
                                 Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong> aufgebaute
                                 Verbindung.
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
                                 
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
  <info>string</info>            <strong>$data</strong>        Eine Textzeile, die direkt an den PostgreSQL Datenbankserver
                                 gesendet wird. Dabei wird automatisch ein <return>NULL</return> an das Zeilenende
                                 angehängt.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_end_copy()</strong>


id: pg_query
type: function
doc:
<comment>Description:</comment>
  Führt eine Abfrage aus
  
  <strong>pg_query()</strong> führt die <strong>$query</strong> auf der angegebenen Datenbank-Verbindung <strong>$connection</strong> aus. In der Regel
  sollte <strong>pg_query_params()</strong> bevorzugt werden.
  
  Falls ein Fehler auftritt und <info>false</info> zurückgegeben wird, können Sie Details zu diesem Fehler mit
  <strong>pg_last_error()</strong> anzeigen, vorausgesetzt, die Verbindungskennung ist gültig.
  
   Obwohl der Parameter <strong>$connection</strong> weggelassen werden kann, ist dies nicht empfehlenswert, da es
  die Fehlersuche in Skripten erschweren kann.
  
  Obwohl der Parameter <strong>$connection</strong> weggelassen werden kann, ist dies nicht empfehlenswert, da es die
  Fehlersuche in Skripten erschweren kann.
  
  Diese Funktion ersetzt die Funktion <strong>pg_exec()</strong>. <strong>pg_exec()</strong> wird aus Gründen der Kompatibilität immer
  noch unterstützt, es wird jedoch empfohlen, den neuen Funktionsnamen zu verwenden.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                 Falls <strong>$connection</strong> nicht angegeben wurde, wird die
                                 Standardverbindung benutzt.
                                 Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong> aufgebaute
                                 Verbindung.
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
                                 
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
  <info>string</info>            <strong>$query</strong>       Die auszuführende(n) SQL-Anweisung(en). Werden mehrere Anweisungen
                                 an <strong>pg_query()</strong> übergeben, werden sie automatisch in einer einzigen
                                 Transaktion ausgeführt, es sei denn, die Anweisungsfolge enthält
                                 explizite BEGIN/COMMIT-Anweisungen. Von der Ausführung mehrerer
                                 Transaktionen innerhalb eines Funktionsaufrufs wird abgeraten.
                                 
                                 String-Interpolation von Anwenderdaten ist sehr gefährlich, und
                                 führt wahrscheinlich zu SQL-Injection-Sicherheistlücken. In der
                                 Regel sollte <strong>pg_query_params()</strong> bevorzugt werden, wobei
                                 Anwenderdaten als Parameter übergeben werden anstatt sie in der
                                 Abfragezeichenkette zu ersetzen.
                                 
                                 Jegliche Anwenderdaten, die direkt in eine Abfragezeichenkette
                                 interpoliert werden, sollten ordnungsgemäß maskiert werden.

<comment>Return:</comment>
  <info>PgSql\Result|false</info>  Bei Erfolg wird eine <class>PgSql\Result</class>-Instanz zurückgegeben. Bei einem Fehler wird
                      <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>
   * <strong>pg_pconnect()</strong>
   * <strong>pg_fetch_array()</strong>
   * <strong>pg_fetch_object()</strong>
   * <strong>pg_num_rows()</strong>
   * <strong>pg_affected_rows()</strong>


id: pg_query_params
type: function
doc:
<comment>Description:</comment>
  Sendet ein Kommando zum Server und wartet seine Ausführung ab. Getrennt vom
     SQL-Kommando können dabei Parameter übergeben werden
    
  
  Sendet ein Kommando zum Server und wartet seine Ausführung ab. Getrennt vom SQL-Kommando können
  dabei Parameter übergeben werden.
  
  <strong>pg_query_params()</strong> ist ähnlich wie <strong>pg_query()</strong>, bietet aber zusätzlich die Möglichkeit,
  Parameterwerte ausserhalb des SQL-Kommandos separat zu übergeben. <strong>pg_query_params()</strong> wird nur für
  Verbindungen zu PostgreSQL ab der Version 7.4 unterstützt und schlägt bei allen niedrigeren
  Versionen fehl.
  
  Falls irgendwelche Parameter übergeben wurden, werden diese in <strong>$query</strong> als $1, $2 usw.
  referenziert. Der gleiche Parameter darf mehrmals in <strong>$query</strong> auftauchen; in diesem Fall wird der
  selbe Wert verwendet. Im Array <strong>$params</strong> werden die aktuellen Parameterwerte übergeben. Der Wert
  <info>null</info> in diesem Array repräsentiert den SQL-Wert <return>NULL</return>.
  
  Der Hauptvorteil von <strong>pg_query_params()</strong> gegenüber <strong>pg_query()</strong> liegt darin, dass Parameterwerte vom
  SQL-Kommando getrennt übergeben werden können und damit das fehlerträchtige und lästige Maskieren
  und Setzen von Anführungszeichen vermieden werden kann. Im Unterschied zu <strong>pg_query()</strong> ist bei
  <strong>pg_query_params()</strong> nur ein einziges SQL-Kommando erlaubt. (Es können auch Semikolons enthalten
  sein, aber nicht mehr als ein nichtleeres Kommando.)

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                 Falls <strong>$connection</strong> nicht angegeben wurde, wird die
                                 Standardverbindung benutzt.
                                 Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong> aufgebaute
                                 Verbindung.
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
                                 
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
  <info>string</info>            <strong>$query</strong>       Die parametrisierte Abfrage. Diese darf nur ein einziges
                                 SQL-Kommando enthalten (mehrere Kommandos, durch Semikolon
                                 getrennt, sind nicht zulässig). Falls Parameter übergeben werden,
                                 werden sie als $1, $2, ... referenziert.
                                 
                                 Anwenderdaten sollten immer als Parameter übergeben werden, und
                                 nicht in die Abfragezeichenkette interpoliert werden, wo sie
                                 mögliche SQL-Injection-Angriffsvektoren bilden und Bugs einführen,
                                 wenn die zu behandelnden Daten Anführungszeichen enthalten. Wenn
                                 aus irgendeinem Grund Parameter nicht verwendet werden können, ist
                                 sicherzustellen, dass Werte ordnungsgemäß maskiert sind.
  <info>array</info>             <strong>$params</strong>      Ein Array mit Parameterwerten, mit denen die Platzhalter $1, $2
                                 usw. in der ursprünglichen vorbereiteten Abfrage ersetzt werden.
                                 Die Anzahl der Elemente dieses Arrays muss mit der Anzahl der
                                 Platzhalter übereinstimmen.
                                 
                                 Werte, die für <return>bytea</return> Felder vorgesehen sind, werden nicht als
                                 Parameter unterstützt. Statt dessen sind <strong>pg_escape_bytea()</strong> oder die
                                 Funktionen für große Objekte zu verwenden.

<comment>Return:</comment>
  <info>PgSql\Result|false</info>  Bei Erfolg wird eine <class>PgSql\Result</class>-Instanz zurückgegeben. Bei einem Fehler wird
                      <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_query()</strong>


id: pg_result_error
type: function
doc:
<comment>Description:</comment>
  Liefert die mit der Ergebniskennung verknüpfte Fehlermeldung
    
  
  <strong>pg_result_error()</strong> gibt alle Fehlermeldungen zurück, die mit der <strong>$result</strong>-Instanz verknüpft ist. Aus
  diesem Grund bekommt man mit <strong>pg_result_error()</strong> viel eher eine korrekte Fehlermeldung als mit
  <strong>pg_last_error()</strong>.
  
  Mit <strong>pg_result_error_field()</strong> bekommt man weitaus genauere Informationen über Fehler als mit
  <strong>pg_result_error()</strong>.
  
  Weil <strong>pg_query()</strong> bei einem Fehlschlag nur <info>false</info> zurückgibt, muss man <strong>pg_send_query()</strong> und
  <strong>pg_get_result()</strong> benutzen, um die Ergebniskennung zu erhalten.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Eine <class>PgSql\Result</class>-Instanz, die von <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> oder <strong>pg_execute()</strong> (unter anderen) zurückgegeben wurde.

<comment>Return:</comment>
  <info>string|false</info>  Gibt einen <info>string</info> zurück. Ist kein Fehler aufgetreten, ist dies eine leere
                Zeichenkette. Falls ein Fehler mit dem Parameter <strong>$result</strong> verknüpft ist wird <info>false</info>
                zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_result_error_field()</strong>
   * <strong>pg_query()</strong>
   * <strong>pg_send_query()</strong>
   * <strong>pg_get_result()</strong>
   * <strong>pg_last_error()</strong>
   * <strong>pg_last_notice()</strong>


id: pg_result_error_field
type: function
doc:
<comment>Description:</comment>
  Liefert den Inhalt eines bestimmtes Feldes zu einer Fehlermeldung
  
  <strong>pg_result_error_field()</strong> gibt ein Feld der ausführlichen Fehlerbeschreibung zurück, die mit der
  <strong>$result</strong>-Instanz verbunden ist. Die Funktion wird nur für Verbindungen zu PostgreSQL ab der Version
  7.4 unterstützt. Das gewünschte Feld wird im Parameter <strong>$field_code</strong> übergeben.
  
  Da <strong>pg_query()</strong> und <strong>pg_query_params()</strong> <info>false</info> zurückgeben, wenn eine Abfrage fehlschlägt, müssen Sie
  <strong>pg_send_query()</strong> und <strong>pg_get_result()</strong> benutzen, um eine Ergebniskennung zu erhalten.
  
  Falls Sie weitergehende Informationen über einen aufgetretenen Fehler bei <strong>pg_query()</strong> brauchen,
  können Sie <strong>pg_set_error_verbosity()</strong> oder <strong>pg_last_error()</strong> aufrufen und deren Ergebnisse
  analysieren.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>      Eine <class>PgSql\Result</class>-Instanz, die von <strong>pg_query()</strong>,
                             <strong>pg_query_params()</strong> oder <strong>pg_execute()</strong> (unter anderen) zurückgegeben
                             wurde.
  <info>int</info>           <strong>$field_code</strong>  Mögliche Werte von <strong>$field_code</strong> sind: <info>PGSQL_DIAG_SEVERITY</info>,
                             <info>PGSQL_DIAG_SQLSTATE</info>, <info>PGSQL_DIAG_MESSAGE_PRIMARY</info>,
                             <info>PGSQL_DIAG_MESSAGE_DETAIL</info>, <info>PGSQL_DIAG_MESSAGE_HINT</info>,
                             <info>PGSQL_DIAG_STATEMENT_POSITION</info>, <info>PGSQL_DIAG_INTERNAL_POSITION</info> (nur
                             PostgreSQL ab Version 8.0), <info>PGSQL_DIAG_INTERNAL_QUERY</info> (nur PostgreSQL
                             ab Version 8.0), <info>PGSQL_DIAG_CONTEXT</info>, <info>PGSQL_DIAG_SOURCE_FILE</info>,
                             <info>PGSQL_DIAG_SOURCE_LINE</info> und <info>PGSQL_DIAG_SOURCE_FUNCTION</info>.

<comment>Return:</comment>
  <info>string|false|null</info>  Ein <info>string</info>, der den Inhalt des Fehlerfeldes enthält, oder <info>null</info>, falls das Feld
                     nicht existiert. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_result_error()</strong>


id: pg_result_seek
type: function
doc:
<comment>Description:</comment>
  Setzt den internen Datensatzzeiger auf die angegebene
    Position in einem Abfrageergebnis
  
  <strong>pg_result_seek()</strong> setzt den internen Datensatzzeiger auf die angegebene Zeile in einer
  <strong>$result</strong>-Instanz.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Eine <class>PgSql\Result</class>-Instanz, die von <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> oder <strong>pg_execute()</strong> (unter anderen) zurückgegeben wurde.
  <info>int</info>           <strong>$row</strong>     Die Zeile in der <class>PgSql\Result</class>-Instanz, auf die der interne Datensatzzeiger
                         gesetzt werden soll. Die Zeilennummern beginnen bei null.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_fetch_row()</strong>
   * <strong>pg_fetch_assoc()</strong>
   * <strong>pg_fetch_array()</strong>
   * <strong>pg_fetch_object()</strong>
   * <strong>pg_fetch_result()</strong>


id: pg_result_status
type: function
doc:
<comment>Description:</comment>
  Liefert den Status eines Abfrageergebnisses
  
  <strong>pg_result_status()</strong> gibt den Status einer <class>PgSql\Result</class>-Instanz zurück oder das mit dem Ergebnis
  verknüpfte PostgreSQL-Kommandoabschluss-Tag.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Eine <class>PgSql\Result</class>-Instanz, die von <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> oder <strong>pg_execute()</strong> (unter anderen) zurückgegeben wurde.
  <info>int</info>           <strong>$mode</strong>    Entweder <info>PGSQL_STATUS_LONG</info>, um die Statusnummer von <strong>$result</strong> zu erhalten,
                         oder <info>PGSQL_STATUS_STRING</info>, um das PostgreSQL-Kommando-Tag für <strong>$result</strong> zu
                         erhalten. Falls nichts angegeben wurde, wird der Vorgabewert
                         <info>PGSQL_STATUS_LONG</info> zurückgegeben.

<comment>Return:</comment>
  <info>string|int</info>  Mögliche Rückgabewerte sind <info>PGSQL_EMPTY_QUERY</info>, <info>PGSQL_COMMAND_OK</info>, <info>PGSQL_TUPLES_OK</info>,
              <info>PGSQL_COPY_OUT</info>, <info>PGSQL_COPY_IN</info>, <info>PGSQL_BAD_RESPONSE</info>, <info>PGSQL_NONFATAL_ERROR</info> und
              <info>PGSQL_FATAL_ERROR</info>, falls <info>PGSQL_STATUS_LONG</info> angegeben wurde. Anderenfalls wird ein
              <info>String</info> zurückgegeben, der das PostgreSQL-Kommando-Tag enthält.

<comment>See Also:</comment>
   * <strong>pg_connection_status()</strong>


id: pg_select
type: function
doc:
<comment>Description:</comment>
  Wählt Datensätze aus
  
  <strong>pg_select()</strong> wählt die Datensätze aus der Tabelle <strong>$table_name</strong> aus, die den Elementen
  (<return>field=&gt;value</return>) in <strong>$conditions</strong> entsprechen. Wenn die Abfrage erfolgreich war, wird ein
  assoziatives Array mit allen Datensätzen und Werten aus <strong>$table_name</strong> zurückgegeben, die mit den
  Datensätzen und Werten in <strong>$conditions</strong> identisch sind.
  
  Falls <strong>$flags</strong> gesetzt ist, wird <strong>pg_convert()</strong> mit den angegebenen Flags auf <strong>$conditions</strong> angewendet.
  
  Wenn <strong>$mode</strong> gesetzt ist, ist der Rückgabewert bei <info>PGSQL_NUM</info> ein Array, bei <info>PGSQL_ASSOC</info> (Standard)
  ein assoziatives Array und bei <info>PGSQL_BOTH</info> beides.
  
  Standardmäßig übergibt <strong>pg_select()</strong> 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.
  
  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, d. h.
  Werte maskieren und validieren.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
  <info>string</info>            <strong>$table_name</strong>  Der Name der Tabelle, aus der die Datensätze ausgewählt werden.
  <info>array</info>             <strong>$conditions</strong>  Ein <info>Array</info>, dessen Schlüssel Feldnamen von <strong>$table_name</strong> sind und
                                 dessen Werte mit den entsprechenden Werten in <strong>$table_name</strong>
                                 übereinstimmen müssen, damit der Datensatz zurückgegeben werden
                                 kann.
  <info>int</info>               <strong>$flags</strong>       Eine beliebige Kombination aus <info>PGSQL_CONV_FORCE_NULL</info>,
                                 <info>PGSQL_DML_NO_CONV</info>, <info>PGSQL_DML_ESCAPE</info>, <info>PGSQL_DML_EXEC</info>,
                                 <info>PGSQL_DML_ASYNC</info> und <info>PGSQL_DML_STRING</info>. Falls <info>PGSQL_DML_STRING</info> in den
                                 <strong>$options</strong> enthalten ist, wird der Abfragestring zurückgegeben.
                                 Werden <info>PGSQL_DML_NO_CONV</info> oder <info>PGSQL_DML_ESCAPE</info> angegeben, wird
                                 <strong>pg_convert()</strong> intern nicht aufgerufen.
  <info>int</info>               <strong>$mode</strong>        Eine beliebige Kombination aus <info>PGSQL_ASSOC</info>, <info>PGSQL_NUM</info> und
                                 <info>PGSQL_BOTH</info>. Wenn <info>PGSQL_ASSOC</info> gesetzt ist, ist der Rückgabewert ein
                                 assoziatives <info>Array</info>, bei <info>PGSQL_NUM</info> ist es ein <info>Array</info>, und bei
                                 <info>PGSQL_BOTH</info> ist es ein sowohl assoziativ als auch numerisch
                                 indiziertes <info>Array</info>.

<comment>Return:</comment>
  <info>array|string|false</info>  Gibt einen <info>String</info> zurück, falls <info>PGSQL_DML_STRING</info> im Parameter <strong>$flags</strong> übergeben
                      wurde, andernfalls wird bei Erfolg ein <info>Array</info> zurückgegeben. Bei einem Fehler
                      wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pg_convert()</strong>


id: pg_send_execute
type: function
doc:
<comment>Description:</comment>
  Sendet eine Aufforderung an den Server, eine vorbereitete Abfrage mit den
     übergebenen Parametern auszuführen, ohne auf die Ergebnisse zu warten
    
  
  Sendet eine Aufforderung an den Server, eine vorbereitete Anfrage mit den übergebenen Parametern
  auszuführen, ohne auf die Ergebnisse zu warten.
  
  Dies ist ähnlich wie die Funktion <strong>pg_send_query_params()</strong>, aber das auszuführende Kommando wird
  statt durch einen Abfragestring durch den Namen einer zuvor vorbereiteten Anweisung angegeben. Die
  Parameter der Funktion werden genauso verarbeitet, wie bei der Funktion <strong>pg_execute()</strong> beschrieben
  und genau wie diese kann <strong>pg_send_execute()</strong> nicht mit PostgreSQL-Versionen vor 7.4 benutzt werden.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>      Eine <class>PgSql\Connection</class>-Instanz.
  <info>string</info>            <strong>$statement_name</strong>  Der Name der auszuführenden vorbereiteten Anweisung. Falls ""
                                     angegeben wird, wird eine unbenannte Abfrage ausgeführt. Der
                                     Name muss zuvor mit <strong>pg_prepare()</strong>, <strong>pg_send_prepare()</strong> oder dem
                                     SQL-Kommando <return>PREPARE</return> definiert worden sein.
  <info>array</info>             <strong>$params</strong>          Ein Array mit Parameterwerten, mit denen die Platzhalter $1, $2
                                     usw. in der ursprünglichen vorbereiteten Anweisung ersetzt
                                     werden. Die Anzahl der Elemente dieses Arrays muss mit der
                                     Anzahl der Platzhalter übereinstimmen.

<comment>Return:</comment>
  <info>int|bool</info>  Gibt bei Erfolg <info>true</info> zurück und <info>false</info> oder <return>0</return>, falls ein Fehler auftrat. Benutzen Sie
            <strong>pg_get_result()</strong>, um das Abfrageergebnis zu erhalten.

<comment>See Also:</comment>
   * <strong>pg_prepare()</strong>
   * <strong>pg_send_prepare()</strong>
   * <strong>pg_execute()</strong>


id: pg_send_prepare
type: function
doc:
<comment>Description:</comment>
  Sendet eine Aufforderung an den Server, eine vorbereitete Abfrage mit den
     übergebenen Parametern zu erzeugen, ohne auf ihre Beendigung zu warten
    
  
  Sendet eine Aufforderung an den Server, eine vorbereitete Anfrage mit den     übergebenen
  Parametern zu erzeugen, ohne auf ihre Beendigung zu warten.
  
  Dies ist eine asynchrone Version von <strong>pg_prepare()</strong>: Sie gibt <info>true</info> zurück, falls es möglich war, die
  Aufforderung abzusenden, ansonsten <info>false</info>. Nach einem erfolgreichen Absenden rufen Sie
  <strong>pg_get_result()</strong> auf, um festzustellen, ob der Server die vorbereitete Abfrage erfolgreich erzeugt
  hat. Die Parameter der Funktion werden genauso verarbeitet, wie bei der Funktion <strong>pg_prepare()</strong>
  beschrieben und genau wie diese kann <strong>pg_send_prepare()</strong> nicht mit PostgreSQL Versionen vor 7.4
  benutzet werden.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>      Eine <class>PgSql\Connection</class>-Instanz.
  <info>string</info>            <strong>$statement_name</strong>  Der Name der vorbereiteten Abfrage. Dieser Name muss in der
                                     aktuellen Datenbanksitzung eindeutig sein. Falls "" angegeben
                                     wird, wird eine unbenannte Abfrage erzeugt, die alle zuvor
                                     definierten unbenannten Abfragen überschreibt.
  <info>string</info>            <strong>$query</strong>           Die parametrisierte Abfrage. Diese darf nur ein einziges
                                     SQL-Kommando enthalten (mehrere Kommandos, durch Semikolon
                                     getrennt, sind nicht zulässig). Falls Parameter übergeben
                                     werden, werden sie als $1, $2, ... referenziert.

<comment>Return:</comment>
  <info>int|bool</info>  Gibt bei Erfolg <info>true</info> zurück und <info>false</info> oder <return>0</return>, falls ein Fehler auftrat. Benutzen Sie
            <strong>pg_get_result()</strong>, um das Abfrageergebnis zu erhalten.

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>
   * <strong>pg_pconnect()</strong>
   * <strong>pg_execute()</strong>
   * <strong>pg_send_execute()</strong>
   * <strong>pg_send_query_params()</strong>


id: pg_send_query
type: function
doc:
<comment>Description:</comment>
  Sendet eine asynchrone Abfrage
    
  
  <strong>pg_send_query()</strong> sendet eine oder mehrere asynchrone Abfragen über die Verbindung <strong>$connection</strong>. Im
  Unterschied zu <strong>pg_query()</strong> können hier mehrere Abfragen auf einmal an PostgreSQL gesendet und die
  Ergebnisse nacheinander mit <strong>pg_get_result()</strong> geholt werden.
  
  Die Ausführung eines Skripts wird während der Abarbeitung der Anfragen nicht blockiert. Benutzen
  Sie die Funktion <strong>pg_connection_busy()</strong>, um zu prüfen, ob die Verbindung gerade benutzt wird (z. B.
  ob gerade eine Abfrage ausgeführt wird). Mit der Funktion <strong>pg_cancel_query()</strong> können Abfragen
  gelöscht werden.
  
  Obwohl man mehrere Abfragen auf einmal an den Server senden kann, können die Abfragen nicht über
  eine gerade benutzte Verbindung geschickt werden. Falls eine Abfrage gesendet wird, während die
  Verbindung benutzt wird, wird abgewartet, bis die letzte Abfrage fertig ist, und alle Ergebnisse
  werden verworfen.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
  <info>string</info>            <strong>$query</strong>       Das oder die SQL-Anweisung(en), die ausgeführt werden sollen.
                                 
                                 Daten innerhalb der Abfrage sollten ordnungsgemäß maskiert sein.

<comment>Return:</comment>
  <info>int|bool</info>  Gibt bei Erfolg <info>true</info> zurück und <info>false</info> oder <return>0</return>, falls ein Fehler auftrat. Benutzen Sie
            <strong>pg_get_result()</strong> um die Abfrageergebnisse zu ermitteln.

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_cancel_query()</strong>
   * <strong>pg_get_result()</strong>
   * <strong>pg_connection_busy()</strong>


id: pg_send_query_params
type: function
doc:
<comment>Description:</comment>
  Sendet ein Kommando und separate Parameter zum Server,
    ohne auf die Rückgabe der Ergebnisse zu warten
  
  Sendet ein Kommando und separate Parameter zum Server ohne auf die Rückgabe der Ergebnisse zu
  warten.
  
  Diese Funktion ist gleichwertig zu <strong>pg_send_query()</strong> mit dem Unterschied, dass Parameter für die
  Abfrage außerhalb des <strong>$query</strong>-Strings übergeben werden können. Diese Parameter werden genauso
  verarbeitet, wie bei <strong>pg_query_params()</strong> beschrieben. Genau wie <strong>pg_query_params()</strong> kann diese
  Funktion nur mit PostgreSQL ab der Version 7.4 verwendet werden und es darf nur ein einziges
  Kommando im Abfragestring enthalten sein.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
  <info>string</info>            <strong>$query</strong>       Die parametrisierte Abfrage. Diese darf nur ein einziges
                                 SQL-Kommando enthalten (mehrere Kommandos, durch Semikolon
                                 getrennt, sind nicht zulässig). Falls Parameter übergeben werden,
                                 werden sie als $1, $2, ... referenziert.
  <info>array</info>             <strong>$params</strong>      Ein Array mit Parameterwerten, mit denen die Platzhalter $1, $2
                                 usw. in der ursprünglichen vorbereiteten Abfrage ersetzt werden.
                                 Die Anzahl der Elemente dieses Arrays muss mit der Anzahl der
                                 Platzhalter übereinstimmen.

<comment>Return:</comment>
  <info>int|bool</info>  Gibt bei Erfolg <info>true</info> zurück und <info>false</info> oder <return>0</return>, falls ein Fehler auftrat. Benutzen Sie
            <strong>pg_get_result()</strong>, um das Abfrageergebnis zu erhalten.

<comment>See Also:</comment>
   * <strong>pg_send_query()</strong>


id: pg_set_client_encoding
type: function
doc:
<comment>Description:</comment>
  Setzt die Kodierung des Clients
    
  
  <strong>pg_set_client_encoding()</strong> setzt die Kodierung des Clients und gibt bei Erfolg 0 zurück,
  anderenfalls -1.
  
  PostgreSQL konvertiert Daten automatisch aus der Kodierung des Backends in die des Frontends.
  
  Diese Funktion ersetzt die Funktion <strong>pg_setclientencoding()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                 Falls <strong>$connection</strong> nicht angegeben wurde, wird die
                                 Standardverbindung benutzt.
                                 Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong> aufgebaute
                                 Verbindung.
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
                                 
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
  <info>string</info>            <strong>$encoding</strong>    Die gewünschte Kodierung des Clients. Sie können aus den folgenden
                                 Kodierungen wählen: <return>SQL_ASCII</return>, <return>EUC_JP</return>,  <return>EUC_CN</return>, <return>EUC_KR</return>, <return>EUC_TW</return>,
                                 <return>UNICODE</return>, <return>MULE_INTERNAL</return>,  <return>LATINX</return> (X=1...9), <return>KOI8</return>, <return>WIN</return>, <return>ALT</return>, <return>SJIS</return>,
                                 <return>BIG5</return> or <return>WIN1250</return>.
                                 
                                 Welche Kodierungen genau verfügbar sind, hängt von der verwendeten
                                 PostgreSQL-Version  ab. Schauen Sie daher im PostgreSQL-Handbuch,
                                 welche Kodierungen unterstützt werden.

<comment>Return:</comment>
  <info>int</info>  Gibt bei Erfolg <return>0</return> zurück oder <return>-1</return> bei einem Fehler.

<comment>See Also:</comment>
   * <strong>pg_client_encoding()</strong>


id: pg_set_error_context_visibility
type: function
doc:
<comment>Description:</comment>
  Determines the visibility of the context's error messages returned by pg_last_error
     and pg_result_error
    
  
  Determines the visibility of the context's error messages returned by <strong>pg_last_error()</strong> and
  <strong>pg_result_error()</strong>

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
  <info>int</info>               <strong>$visibility</strong>  The required visibility: <info>PGSQL_SHOW_CONTEXT_NEVER</info>,
                                 <info>PGSQL_SHOW_CONTEXT_ERRORS</info> or <info>PGSQL_SHOW_CONTEXT_ALWAYS</info>.

<comment>Return:</comment>
  <info>int</info>  The previous visibility level: <info>PGSQL_SHOW_CONTEXT_NEVER</info>, <info>PGSQL_SHOW_CONTEXT_ERRORS</info> or
       <info>PGSQL_SHOW_CONTEXT_ALWAYS</info>.

<comment>See Also:</comment>
   * <strong>pg_last_error()</strong>
   * <strong>pg_result_error()</strong>


id: pg_set_error_verbosity
type: function
doc:
<comment>Description:</comment>
  Bestimmt den Detaillierungsgrad von Fehlermeldungen, die von
     pg_last_error und pg_result_error zurückgegeben werden
    
  
  Bestimmt den Detaillierungsgrad von Fehlermeldungen, die von <strong>pg_last_error()</strong> und <strong>pg_result_error()</strong>
  zurückgegeben werden.
  
  <strong>pg_set_error_verbosity()</strong> setzt einen neuen Modus für Fehlermeldungen und gibt die zuvor gesetzte
  Einstellung zurück. Im Modus <info>PGSQL_ERRORS_TERSE</info> enthalten die Meldungen nur Angaben über den
  Detaillierungsgrad, einen Kurztext, sowie die Position des Fehlers. Dies passt normalerweise in
  eine Zeile. Im Standard-Modus, <info>PGSQL_ERRORS_DEFAULT</info>, wird das obige samt aller Einzelheiten,
  Hinweise oder Kontextfelder des Fehlers ausgegeben (was mehrere Zeilen in Anspruch nehmen kann).
  Der Modus <info>PGSQL_ERRORS_VERBOSE</info> schließt alle verfügbaren Felder ein. Eine Änderung des
  Detaillierungsgrads hat keine Auswirkung auf Meldungen bereits existierender Ergebnisse, sondern
  nur auf die, die danach erzeugt wurden.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                 Falls <strong>$connection</strong> nicht angegeben wurde, wird die
                                 Standardverbindung benutzt.
                                 Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong> aufgebaute
                                 Verbindung.
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
                                 
                                 Seit PHP 8.1.0 ist die Verwendung der Standardverbindung veraltet.
  <info>int</info>               <strong>$verbosity</strong>   Der gewünschte Detaillierungsgrad: <info>PGSQL_ERRORS_TERSE</info>,
                                 <info>PGSQL_ERRORS_DEFAULT</info> oder <info>PGSQL_ERRORS_VERBOSE</info>.

<comment>Return:</comment>
  <info>int</info>  Der vorher eingestellte Detaillierungsgrad: <info>PGSQL_ERRORS_TERSE</info>, <info>PGSQL_ERRORS_DEFAULT</info> oder
       <info>PGSQL_ERRORS_VERBOSE</info>.

<comment>See Also:</comment>
   * <strong>pg_last_error()</strong>
   * <strong>pg_result_error()</strong>


id: pg_socket
type: function
doc:
<comment>Description:</comment>
  Get a read only handle to the socket underlying a PostgreSQL connection
    
  
  <strong>pg_socket()</strong> returns a read only <info>resource</info> corresponding to the socket underlying the given
  PostgreSQL connection.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.

<comment>Return:</comment>
  <info>resource|false</info>  A socket resource on successBei einem Fehler wird <info>false</info> zurückgegeben..


id: pg_trace
type: function
doc:
<comment>Description:</comment>
  Ermöglicht die Ablaufverfolgung einer Verbindung
  
  <strong>pg_trace()</strong> ermöglicht die Protokollierung der frontend/backend Kommunikation in eine Datei, die
  durch den Pfadnamen <strong>$pathname</strong> bestimmt wurde. Um die Ergebnisse ganz zu verstehen, sollte man sich
  mit den Interna des PostgreSQL-Kommunikationsprotokolls auskennen.
  
  Für diejenigen, die sich damit nicht auskennen kann es trotzdem hilfreich sein, um Fehler in
  Abfragen zu finden, die an den Server gesendet wurden. Beispielsweise können Sie das Kommando grep
  '^To backend' trace.log eingeben und schauen, welche Abfrage gerade an den PostgreSQL Server
  geschickt wurde. Weitere Informationen finden Sie in der PostgreSQL Documentation.

<comment>Param:</comment>
  <info>string</info>                 <strong>$filename</strong>    Der vollständige Pfad- und Dateiname der Datei, in die das
                                      Ablauf-Protokoll geschrieben werden soll. Genau wie bei
                                      <strong>fopen()</strong>.
  <info>string</info>                 <strong>$mode</strong>        Optional kann ein Zugriffsmodus übergeben werden, genauso wie
                                      bei <strong>fopen()</strong>.
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                      Falls <strong>$connection</strong> <info>null</info> ist, wird die Standardverbindung
                                      benutzt.
                                      Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong>
                                      aufgebaute Verbindung.
                                      Seit PHP 8.1.0 ist die Verwendung der Standardverbindung
                                      veraltet.
                                      
                                      Seit PHP 8.1.0 ist die Verwendung der Standardverbindung
                                      veraltet.
  <info>int</info>                    <strong>$trace_mode</strong>  Ein optionaler Modus für die Ablaufverfolgung mit den
                                      Konstanten <info>PGSQL_TRACE_SUPPRESS_TIMESTAMPS</info> und
                                      <info>PGSQL_TRACE_REGRESS_MODE</info>

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>fopen()</strong>
   * <strong>pg_untrace()</strong>


id: pg_transaction_status
type: function
doc:
<comment>Description:</comment>
  Gibt den aktuellen Transaktionsstatus des Servers zurück
  
  Gibt den aktuellen Transaktionsstatus des Servers zurück.
  
  Die Funktion <strong>pg_transaction_status()</strong> gibt ungültige Ergebnisse zurück, wenn sie für einen
  PostgreSQL-Server der Version 7.3 aufgerufen wird, bei dem der Parameter <return>autocommit</return> auf off
  gesetzt ist. Die serverseitige Eigenschaft autocommit ist veraltet und existiert in den neueren
  PostgreSQL-Versionen nicht mehr.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.

<comment>Return:</comment>
  <info>int</info>  Mögliche Stati sind: <info>PGSQL_TRANSACTION_IDLE</info> (zur Zeit untätig), <info>PGSQL_TRANSACTION_ACTIVE</info> (ein
       Kommando wird abgearbeitet), <info>PGSQL_TRANSACTION_INTRANS</info> (untätig, aber innerhalb eines
       gültigen Transaktionsblocks) oder <info>PGSQL_TRANSACTION_INERROR</info> (untätig, innerhalb einer
       fehlgeschlagenen Transaktion). <info>PGSQL_TRANSACTION_UNKNOWN</info> wird zurückgegeben, falls eine
       Transaktion ungültig ist. <info>PGSQL_TRANSACTION_ACTIVE</info> wird nur dann zurückgegeben, wenn eine
       Abfrage zum Server gesendet wurde und noch nicht fertig abgearbeitet ist.


id: pg_tty
type: function
doc:
<comment>Description:</comment>
  Liefert den TTY-Namen für die Verbindung
  
  <strong>pg_tty()</strong> gibt den TTY-Namen zurück, an den Debug-Meldungen der übergebenen <strong>$connection</strong> gesendet
  werden.
  
  <strong>pg_tty()</strong> ist überflüssig geworden, da der Server TTY-Einstellungen ignoriert. Wegen der
  Abwärtskompatibilität bleibt die Funktion dennoch erhalten.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                      Falls <strong>$connection</strong> <info>null</info> ist, wird die Standardverbindung
                                      benutzt.
                                      Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong>
                                      aufgebaute Verbindung.
                                      Seit PHP 8.1.0 ist die Verwendung der Standardverbindung
                                      veraltet.
                                      
                                      Seit PHP 8.1.0 ist die Verwendung der Standardverbindung
                                      veraltet.

<comment>Return:</comment>
  <info>string</info>  Ein <info>string</info>, der die TTY-Debugmeldungen für die <strong>$connection</strong> enthält.


id: pg_unescape_bytea
type: function
doc:
<comment>Description:</comment>
  Entfernt Maskierungen für den Typ bytea
  
  <strong>pg_unescape_bytea()</strong> entfernt Maskierungen von Daten des PostgreSQL-Typs bytea. Zurückgegeben wird
  ein String ohne Maskierungen, der möglicherweise Binärdaten enthält.
  
  Wenn Daten vom Typ bytea mit <return>SELECT</return> ausgewählt werden, gibt PostgreSQL Bytewerte als Oktalzahlen
  zurück, denen ein '\' vorangestellt ist (z. B. \032). Benutzer müssen diese Werte manuell in ein
  binäres Format konvertieren.
  
  Diese Funktion setzt PostgreSQL ab der Version 7.2 voraus. Bei PostgreSQ; 7.2.0 und 7.2.1 müssen
  bytea-Werte konvertiert werden, falls die Multibyte-Unterstützung aktiviert ist, z. B. <return>INSERT INTO
  test_table (image) VALUES ('$image_escaped'::bytea);</return>. Ab PostgreSQL 7.2.2 müssen die Daten nicht
  mehr konvertiert werden. Eine Ausnahme gibt es allerdings: wenn die Codierung des Clients und des
  Datenbankservers einander nicht entsprechen, kann es zu Multibyte-Fehlern kommen. Um diesen Fehler
  zu vermeiden, muss der Anwender einen Typecast zu bytea machen.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Ein String, der Daten vom PostgreSQL-Typ bytea enthält, die in einen
                   PHP-Binärstring konvertiert werden.

<comment>Return:</comment>
  <info>string</info>  Ein String, der die unmaskierten Daten enthält.

<comment>See Also:</comment>
   * <strong>pg_escape_bytea()</strong>
   * <strong>pg_escape_string()</strong>


id: pg_untrace
type: function
doc:
<comment>Description:</comment>
  Beendet die Ablaufverfolgung einer PostgreSQL-Verbindung
  
  Beendet die Ablaufverfolgung, die mit <strong>pg_trace()</strong> aktiviert wurde.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                      Falls <strong>$connection</strong> <info>null</info> ist, wird die Standardverbindung
                                      benutzt.
                                      Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong>
                                      aufgebaute Verbindung.
                                      Seit PHP 8.1.0 ist die Verwendung der Standardverbindung
                                      veraltet.
                                      
                                      Seit PHP 8.1.0 ist die Verwendung der Standardverbindung
                                      veraltet.

<comment>Return:</comment>
  <info>true</info>  Gibt immer <info>true</info> zurück.

<comment>See Also:</comment>
   * <strong>pg_trace()</strong>


id: pg_update
type: function
doc:
<comment>Description:</comment>
  Aktualisiert eine Tabelle
  
  <strong>pg_update()</strong> überschreibt alle Datensätze in <strong>$table_name</strong>, die die Bedingungen in <strong>$conditions</strong>
  erfüllen, mit den Werten aus <strong>$values</strong>.
  
  Falls <strong>$flags</strong> angegeben wurde, wird <strong>pg_convert()</strong> mit den angegebenen Flags auf <strong>$values</strong> angewendet.
  
  Standardmäßig übergibt <strong>pg_update()</strong> Rohwerte. Die Werte müssen entweder maskiert werden oder das
  Flag <info>PGSQL_DML_ESCAPE</info> muss in <strong>$flags</strong> angegeben werden. <info>PGSQL_DML_ESCAPE</info> maskiert Parameter und
  Bezeichner und setzt sie in Anführungszeichen. Daher muss bei Tabellen- und Spaltennamen zwischen
  Groß- und Kleinschreibung unterschieden werden.
  
  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, d. h.
  Werte maskieren und validieren.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
  <info>string</info>            <strong>$table_name</strong>  Der Name der Tabelle, die aktualisiert werden soll.
  <info>array</info>             <strong>$values</strong>      Ein <info>Array</info>, dessen Schlüssel Feldnamen von <strong>$table_name</strong> sind und mit
                                 dessen Werten die entsprechenden Datensätze aktualisiert werden.
  <info>array</info>             <strong>$conditions</strong>  Ein <info>Array</info>, dessen Schlüssel Feldnamen von <strong>$table_name</strong> sind und
                                 dessen Werte die Bedingungen sind, die ein Datensatz erfüllen muss,
                                 um aktualisiert zu werden.
  <info>int</info>               <strong>$flags</strong>       Jede Kombination aus <info>PGSQL_CONV_FORCE_NULL</info>, <info>PGSQL_DML_NO_CONV</info>,
                                 <info>PGSQL_DML_ESCAPE</info>, <info>PGSQL_DML_EXEC</info>, <info>PGSQL_DML_ASYNC</info> und
                                 <info>PGSQL_DML_STRING</info>. Falls <info>PGSQL_DML_STRING</info> in den <strong>$flags</strong> enthalten
                                 ist, wird der Abfragestring zurückgegeben. Werden <info>PGSQL_DML_NO_CONV</info>
                                 oder <info>PGSQL_DML_ESCAPE</info> angegeben, wird <strong>pg_convert()</strong> intern nicht
                                 aufgerufen.

<comment>Return:</comment>
  <info>string|bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben. Gibt einen
               <info>String</info> zurück, falls <info>PGSQL_DML_STRING</info> mit dem Parameter <strong>$flags</strong> übergeben wurde.

<comment>See Also:</comment>
   * <strong>pg_convert()</strong>


id: pg_version
type: function
doc:
<comment>Description:</comment>
  Liefert ein Array, das die Versionen von Client, Protokoll und Server
     enthält (falls verfügbar).
    
  
  <strong>pg_version()</strong> Gibt ein Array zurück, das die Versionen von Client, Protokoll und Server enthält.
  Protokoll- und Serverversion sind nur verfügbar, wenn PHP mit PostgreSQL 7.4 und neuer kompiliert
  wurde.
  
  Um genauere Informationen über den Server zu erhalten, verwenden Sie <strong>pg_parameter_status()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Eine <class>PgSql\Connection</class>-Instanz.
                                      Falls <strong>$connection</strong> <info>null</info> ist, wird die Standardverbindung
                                      benutzt.
                                      Das ist die zuletzt mit <strong>pg_connect()</strong> oder <strong>pg_pconnect()</strong>
                                      aufgebaute Verbindung.
                                      Seit PHP 8.1.0 ist die Verwendung der Standardverbindung
                                      veraltet.
                                      
                                      Seit PHP 8.1.0 ist die Verwendung der Standardverbindung
                                      veraltet.

<comment>Return:</comment>
  <info>array</info>  Gibt ein Array mit den Schlüsseln <return>client</return>, <return>protocol</return> und <return>server</return> zurück, in dem die
         entsprechenden Werte gespeichert sind, falls sie verfügbar sind.

<comment>See Also:</comment>
   * <strong>pg_parameter_status()</strong>


id: php_ini_loaded_file
type: function
doc:
<comment>Description:</comment>
  Retrieve a path to the loaded php.ini file
  
  Check if a php.ini file is loaded, and retrieve its path.

<comment>Return:</comment>
  <info>string|false</info>  The loaded php.ini path, or <info>false</info> if one is not loaded.

<comment>See Also:</comment>
   * <strong>php_ini_scanned_files()</strong>
   * <strong>phpinfo()</strong>
   * The configuration file


id: php_ini_scanned_files
type: function
doc:
<comment>Description:</comment>
  Liefert eine Liste von analysierten .ini-Dateien aus einem zusätzlichen
     ini-Verzeichnis
    
  
  <strong>php_ini_scanned_files()</strong> gibt eine durch Kommata getrennte Liste von Konfigurationsdateien zurück,
  die nach php.ini analysiert wurden. Die durchsuchten Verzeichnisse werden mittels Option während
  des Kompilierens angegeben und optional zur Laufzeit mittels Umgebungsvariable. Weitere
  Informationen gibt es in der Installationsanleitung.
  
  Die zurückgegebenen Konfigurationsdateien enthalten den kompletten Pfad.

<comment>Return:</comment>
  <info>string|false</info>  Gibt bei Erfolg eine durch Kommata getrennte Liste von .ini-Dateien zurück. Jedes
                Komma wird gefolgt von einem Zeilenumbruch. Falls die Konfigurationsanweisung
                --with-config-file-scan-dir und die Umgebungsvariable PHP_INI_SCAN_DIR nicht gesetzt
                wurden, wird <info>false</info> zurückgegeben. Falls sie gesetzt wurden und das Verzeichnis leer
                ist, wird eine leere Zeichenkette zurückgegeben. Falls eine Datei unkenntlich ist,
                erscheint sie trotzdem in der Liste, erzeugt aber auch einen PHP-Fehler. Dieser
                PHP-Fehler wird sowohl bei der Kompilierung als auch bei der Verwendung von
                <strong>php_ini_scanned_files()</strong> angezeigt.

<comment>See Also:</comment>
   * <strong>ini_set()</strong>
   * <strong>phpinfo()</strong>
   * <strong>php_ini_loaded_file()</strong>


id: php_sapi_name
type: function
doc:
<comment>Description:</comment>
  Liefert das zwischen PHP und Webserver verwendete Interface
  
  Gibt eine Zeichenkette in Kleinbuchstaben zurück, die die von PHP verwendete Schnittstelle (das
  Server-API, SAPI) beschreibt. Diese Zeichenkette ist z. B. "cli" für den
  PHP-Kommandozeileninterpreter CLI, während beim Einsatz mit Apache unterschiedliche Werte
  zurückgegeben werden können, je nachdem welches SAPI verwendet wird. Die möglichen Rückgabewerte
  sind weiter unten aufgelistet.

<comment>Return:</comment>
  <info>string|false</info>  Gibt den Schnittstellentyp als Zeichenkette in Kleinbuchstaben zurück. Bei einem
                Fehler wird <info>false</info> zurückgegeben.
                
                Mögliche Werte sind unter anderem <return>apache</return>, <return>apache2handler</return>, <return>cgi</return> (bis PHP 5.3),
                <return>cgi-fcgi</return>, <return>cli</return>, <return>cli-server</return>, <return>embed</return>, <return>fpm-fcgi</return>, <return>litespeed</return> und <return>phpdbg</return>.

<comment>See Also:</comment>
   * PHP_SAPI


id: php_strip_whitespace
type: function
doc:
<comment>Description:</comment>
  Return source with stripped comments and whitespace
  
  Returns the PHP source code in <strong>$filename</strong> with PHP comments and whitespace removed. This may be
  useful for determining the amount of actual code in your scripts compared with the amount of
  comments. This is similar to using php -w from the commandline.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Path to the PHP file.

<comment>Return:</comment>
  <info>string</info>  The stripped source code will be returned on success, or an empty string on failure.
          
          This function respects the value of the short_open_tag ini directive.


id: php_uname
type: function
doc:
<comment>Description:</comment>
  Returns information about the operating system PHP is running on
  
  <strong>php_uname()</strong> returns a description of the operating system PHP is running on.  This is the same
  string you see at the very top of the <strong>phpinfo()</strong> output.  For the name of just the operating
  system, consider using the <info>PHP_OS</info> constant, but keep in mind this constant will contain the
  operating system PHP was built on.
  
  On some older UNIX platforms, it may not be able to determine the current OS information in which
  case it will revert to displaying the OS PHP was built on.  This will only happen if your uname()
  library call either doesn't exist or doesn't work.

<comment>Param:</comment>
  <info>string</info>  <strong>$mode</strong>  <strong>$mode</strong> is a single character that defines what information is returned: <return>'a'</return>: This is
                 the default. Contains all modes in the sequence <return>"s n r v m"</return>. <return>'s'</return>: Operating system
                 name. eg. <return>FreeBSD</return>. <return>'n'</return>: Host name. eg.  <return>localhost.example.com</return>. <return>'r'</return>: Release name.
                 eg.  <return>5.1.2-RELEASE</return>. <return>'v'</return>: Version information. Varies a lot between operating
                 systems. <return>'m'</return>: Machine type. eg. <return>i386</return>.
                 
                 <return>'a'</return>: This is the default. Contains all modes in the sequence <return>"s n r v m"</return>.
                 
                 <return>'s'</return>: Operating system name. eg. <return>FreeBSD</return>.
                 
                 <return>'n'</return>: Host name. eg.  <return>localhost.example.com</return>.
                 
                 <return>'r'</return>: Release name. eg.  <return>5.1.2-RELEASE</return>.
                 
                 <return>'v'</return>: Version information. Varies a lot between operating systems.
                 
                 <return>'m'</return>: Machine type. eg. <return>i386</return>.

<comment>Return:</comment>
  <info>string</info>  Returns the description, as a string.

<comment>See Also:</comment>
   * <strong>phpversion()</strong>
   * <strong>php_sapi_name()</strong>
   * <strong>phpinfo()</strong>


id: php_user_filter
type: class
doc:
<comment>Description:</comment>
  Children of this class are passed to <strong>stream_filter_register()</strong>. Note that the __construct method is
  not called; instead, php_user_filter::onCreate should be used for initialization.


id: php_user_filter::filter
type: function
doc:
<comment>Description:</comment>
  Called when applying the filter
  
  This method is called whenever data is read from or written to the attached stream (such as with
  <strong>fread()</strong> or <strong>fwrite()</strong>).

<comment>Param:</comment>
  <info>resource</info>  <strong>$in</strong>        <strong>$in</strong> is a resource pointing to a <return>bucket brigade</return> which contains one or more
                       <return>bucket</return> objects containing data to be filtered.
  <info>resource</info>  <strong>$out</strong>       <strong>$out</strong> is a resource pointing to a second <return>bucket brigade</return> into which your
                       modified buckets should be placed.
  <info>int</info>       <strong>$consumed</strong>  <strong>$consumed</strong>, which must always be declared by reference, should be incremented
                       by the length of the data which your filter reads in and alters.  In most
                       cases this means you will increment <strong>$consumed</strong> by <return>$bucket-&gt;datalen</return> for each
                       <return>$bucket</return>.
  <info>bool</info>      <strong>$closing</strong>   If the stream is in the process of closing (and therefore this is the last
                       pass through the filterchain), the <strong>$closing</strong> parameter will be set to <info>true</info>.

<comment>Return:</comment>
  <info>int</info>  The filter method must return one of three values upon completion. Return
       ValueMeaning<info>PSFS_PASS_ON</info> Filter processed successfully with data available in the <strong>$out</strong> <return>bucket
       brigade</return>. <info>PSFS_FEED_ME</info> Filter processed successfully, however no data was available to return.
       More data is required from the stream or prior filter. <info>PSFS_ERR_FATAL</info> (default) The filter
       experienced an unrecoverable error and cannot continue.


id: php_user_filter::onClose
type: function
doc:
<comment>Description:</comment>
  Called when closing the filter
  
  This method is called upon filter shutdown (typically, this is also during stream shutdown), and
  is executed after the <return>flush</return> method is called.  If any resources were allocated or initialized
  during <return>onCreate()</return> this would be the time to destroy or dispose of them.

<comment>Return:</comment>
  <info>void</info>  Return value is ignored.


id: php_user_filter::onCreate
type: function
doc:
<comment>Description:</comment>
  Called when creating the filter
  
  This method is called during instantiation of the filter class object.  If your filter allocates
  or initializes any other resources (such as a buffer), this is the place to do it.
  
  When your filter is first instantiated, and <return>yourfilter-&gt;onCreate()</return> is called, a number of
  properties will be available as shown in the table below.
  
  PropertyContents<return>FilterClass-&gt;filtername</return> A string containing the name the filter was
  instantiated with. Filters may be registered under multiple names or under wildcards. Use this
  property to determine which name was used. <return>FilterClass-&gt;params</return> The contents of the <strong>$params</strong>
  parameter passed to <strong>stream_filter_append()</strong> or <strong>stream_filter_prepend()</strong>. <return>FilterClass-&gt;stream</return> The
  stream resource being filtered. Maybe available only during filter calls when the  <return>closing</return>
  parameter is set to <info>false</info>.

<comment>Return:</comment>
  <info>bool</info>  Your implementation of this method should return <info>false</info> on failure, or <info>true</info> on success.


id: phpcredits
type: function
doc:
<comment>Description:</comment>
  Prints out the credits for PHP
  
  This function prints out the credits listing the PHP developers, modules, etc. It generates the
  appropriate HTML codes to insert the information in a page.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  To generate a custom credits page, you may want to use the <strong>$flags</strong> parameter.
               
               Pre-defined <strong>phpcredits()</strong> flagsnamedescriptionCREDITS_ALL All the credits, equivalent
               to using: <info>CREDITS_DOCS</info> + <info>CREDITS_GENERAL</info> + <info>CREDITS_GROUP</info> + <info>CREDITS_MODULES</info> +
               <info>CREDITS_FULLPAGE</info>. It generates a complete stand-alone HTML page with the appropriate
               tags. CREDITS_DOCSThe credits for the documentation teamCREDITS_FULLPAGE Usually used
               in combination with the other flags.  Indicates that a complete stand-alone HTML page
               needs to be printed including the information indicated by the other flags.
               CREDITS_GENERAL General credits: Language design and concept, PHP authors  and SAPI
               module. CREDITS_GROUPA list of the core developersCREDITS_MODULES A list of the
               extension modules for PHP, and their authors CREDITS_SAPI A list of the server API
               modules for PHP, and their authors

<comment>Return:</comment>
  <info>true</info>  Gibt immer <info>true</info> zurück.

<comment>See Also:</comment>
   * <strong>phpversion()</strong>
   * <strong>phpinfo()</strong>


id: phpdbg_break_file
type: function
doc:
<comment>Description:</comment>
  Inserts a breakpoint at a line in a file
  
  Insert a breakpoint at the given <strong>$line</strong> in the given <strong>$file</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>  The name of the file.
  <info>int</info>     <strong>$line</strong>  The line number.

<comment>Return:</comment>
  <info>void</info>  Es wird kein Wert zurückgegeben.

<comment>See Also:</comment>
   * <strong>phpdbg_break_function()</strong>
   * <strong>phpdbg_break_method()</strong>
   * <strong>phpdbg_break_next()</strong>
   * <strong>phpdbg_clear()</strong>


id: phpdbg_break_function
type: function
doc:
<comment>Description:</comment>
  Inserts a breakpoint at entry to a function
  
  Insert a breakpoint at the entry to the given <strong>$function</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$function</strong>  The name of the function.

<comment>Return:</comment>
  <info>void</info>  Es wird kein Wert zurückgegeben.

<comment>See Also:</comment>
   * <strong>phpdbg_break_file()</strong>
   * <strong>phpdbg_break_method()</strong>
   * <strong>phpdbg_break_next()</strong>
   * <strong>phpdbg_clear()</strong>


id: phpdbg_break_method
type: function
doc:
<comment>Description:</comment>
  Inserts a breakpoint at entry to a method
  
  Insert a breakpoint at the entry to the given <strong>$method</strong> of the given <strong>$class</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>   The name of the class.
  <info>string</info>  <strong>$method</strong>  The name of the method.

<comment>Return:</comment>
  <info>void</info>  Es wird kein Wert zurückgegeben.

<comment>See Also:</comment>
   * <strong>phpdbg_break_file()</strong>
   * <strong>phpdbg_break_function()</strong>
   * <strong>phpdbg_break_next()</strong>
   * <strong>phpdbg_clear()</strong>


id: phpdbg_break_next
type: function
doc:
<comment>Description:</comment>
  Inserts a breakpoint at the next opcode
  
  Insert a breakpoint at the next opcode.

<comment>Return:</comment>
  <info>void</info>  Es wird kein Wert zurückgegeben.

<comment>See Also:</comment>
   * <strong>phpdbg_break_file()</strong>
   * <strong>phpdbg_break_function()</strong>
   * <strong>phpdbg_break_method()</strong>
   * <strong>phpdbg_clear()</strong>


id: phpdbg_clear
type: function
doc:
<comment>Description:</comment>
  Clears all breakpoints
  
  Clear all breakpoints that have been set, either via one of the <strong>phpdbg_break_*()</strong> functions or
  interactively in the console.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>void</info>  Es wird kein Wert zurückgegeben.

<comment>See Also:</comment>
   * <strong>phpdbg_break_file()</strong>
   * <strong>phpdbg_break_function()</strong>
   * <strong>phpdbg_break_method()</strong>
   * <strong>phpdbg_break_next()</strong>


id: phpdbg_color
type: function
doc:
<comment>Description:</comment>
  Sets the color of certain elements
  
  Set the <strong>$color</strong> of the given <strong>$element</strong>.

<comment>Param:</comment>
  <info>int</info>     <strong>$element</strong>  One of the <info>PHPDBG_COLOR_*</info> constants.
  <info>string</info>  <strong>$color</strong>    The name of the color. One of <return>white</return>, <return>red</return>, <return>green</return>, <return>yellow</return>, <return>blue</return>, <return>purple</return>, <return>cyan</return> or
                    <return>black</return>, optionally with either a trailing <return>-bold</return> or <return>-underline</return>, for instance,
                    <return>white-bold</return> or <return>green-underline</return>.

<comment>Return:</comment>
  <info>void</info>  Es wird kein Wert zurückgegeben.

<comment>See Also:</comment>
   * <strong>phpdbg_prompt()</strong>


id: phpdbg_end_oplog
type: function
doc:
<comment>Description:</comment>
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  

<comment>Return:</comment>
  <info>array|null</info>  


id: phpdbg_exec
type: function
doc:
<comment>Description:</comment>
  Attempts to set the execution context
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>string</info>  <strong>$context</strong>  

<comment>Return:</comment>
  <info>string|bool</info>  If the execution context was set previously it is returned. If the execution context
               was not set previously <info>true</info> is returned. If the request to set the context fails,
               <info>false</info> is returned, and an <info>E_WARNING</info> raised.


id: phpdbg_get_executable
type: function
doc:
<comment>Description:</comment>
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  

<comment>Return:</comment>
  <info>array</info>  


id: phpdbg_prompt
type: function
doc:
<comment>Description:</comment>
  Sets the command prompt
  
  Set the command prompt to the given <strong>$string</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The string to use as command prompt.

<comment>Return:</comment>
  <info>void</info>  Es wird kein Wert zurückgegeben.

<comment>See Also:</comment>
   * <strong>phpdbg_color()</strong>


id: phpdbg_start_oplog
type: function
doc:
<comment>Description:</comment>
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>void</info>  Es wird kein Wert zurückgegeben.


id: phpinfo
type: function
doc:
<comment>Description:</comment>
  Liefert Informationen zur PHP-Konfiguration
  
  Zeigt eine große Anzahl von Informationen über den aktuellen Zustand von PHP an. Dies umfasst
  Informationen über die Optionen während des Kompilierens und die Erweiterungen, die PHP-Version,
  Server-Informationen und -Umgebung (falls als Modul kompiliert), die PHP-Umgebung,
  Versionsinformationen zum Betriebssystem, Pfade, Master- und lokale Werte der
  Konfigurationsoptionen, HTTP-Header und die PHP-Lizenz.
  
  Weil jedes System anders installiert ist, wird <strong>phpinfo()</strong> oft genutzt, um die
  Konfigurationseinstellungen und die verfügbaren vordefinierten Variablen auf einem System zu
  prüfen.
  
  <strong>phpinfo()</strong> ist außerdem ein wertvolles Debugging-Tool, da es alle EGPCS-Daten (Environment, GET,
  POST, Cookie, Server) enthält.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Die Ausgabe kann durch die bitweise summierte Angabe von einer oder mehrerer der
               folgenden Konstanten im optionalen Parameter <strong>$flags</strong> angepasst werden. Die Konstanten
               oder Bitwerte können auch mit dem binären Oder-Operator kombiniert werden.
               
               <strong>phpinfo()</strong>-OptionenName (Konstante)WertBeschreibungINFO_GENERAL1 Die
               Konfigurationszeile, der Ort der php.ini, das Übersetzungsdatum, der Webserver, das
               System und mehr. INFO_CREDITS2 PHP-Credits. Siehe auch <strong>phpcredits()</strong>.
               INFO_CONFIGURATION4 Aktueller lokaler und Master-Wert der PHP-Direktiven. Siehe auch
               <strong>ini_get()</strong>. INFO_MODULES8 Die geladenenen Module und ihre jeweiligen Einstellungen.
               Siehe auch <strong>get_loaded_extensions()</strong>. INFO_ENVIRONMENT16 Informationen über die
               Umgebungsvariablen, die auch in $_ENV verfügbar sind. INFO_VARIABLES32 Zeigt alle
               vordefinierten Variablen aus EGPCS (Environment, GET, POST, Cookie, Server).
               INFO_LICENSE64 PHP-Lizenz-Informationen. Siehe auch Lizenz-FAQ. INFO_ALL-1 Zeigt alle
               genannten Informationen.

<comment>Return:</comment>
  <info>true</info>  Gibt immer <info>true</info> zurück.

<comment>See Also:</comment>
   * <strong>phpversion()</strong>
   * <strong>phpcredits()</strong>
   * <strong>ini_get()</strong>
   * <strong>ini_set()</strong>
   * <strong>get_loaded_extensions()</strong>
   * vordefinierte Variable


id: phpversion
type: function
doc:
<comment>Description:</comment>
  Liefert die aktuelle PHP-Version
  
  Gibt die Versionsnummer der gerade laufenden PHP-Version oder der angegebenen Erweiterung als
  Zeichenkette zurück.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$extension</strong>  Der optionale Name einer Erweiterung.

<comment>Return:</comment>
  <info>string|false</info>  Gibt die Versionsnummer der gerade laufenden PHP-Version als <info>String</info> zurück. Wenn ein
                <info>String</info>-Argument für den Parameter <strong>$extension</strong> angegeben wurde, wird die
                Versionsnummer dieser Erweiterung zurückgegeben, oder <info>false</info>, falls die Erweiterung
                nicht geladen ist oder keine Versionsinformationen enthält.

<comment>See Also:</comment>
   * PHP_VERSION-Konstanten
   * <strong>version_compare()</strong>
   * <strong>phpinfo()</strong>
   * <strong>phpcredits()</strong>
   * <strong>zend_version()</strong>


id: pi
type: function
doc:
<comment>Description:</comment>
  Liefert den Wert von Pi
  
  Die Funktion gibt einen Näherungswert von Pi zurück. Sie können auch die Konstante <info>M_PI</info> verwenden,
  die das gleiche Resultat liefert wie <strong>pi()</strong>.

<comment>Return:</comment>
  <info>float</info>  Der Wert von Pi als <info>float</info>.


id: png2wbmp
type: function
doc:
<comment>Description:</comment>
  Convert PNG image file to WBMP image file
  
  Converts a PNG file into a WBMP file.

<comment>Param:</comment>
  <info>string</info>  <strong>$pngname</strong>      Path to PNG file.
  <info>string</info>  <strong>$wbmpname</strong>     Path to destination WBMP file.
  <info>int</info>     <strong>$dest_height</strong>  Destination image height.
  <info>int</info>     <strong>$dest_width</strong>   Destination image width.
  <info>int</info>     <strong>$threshold</strong>    Threshold value, between 0 and 8 (inclusive).

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.
        
        Wenn libgd das Bild nicht ausgeben kann, gibt diese Funktion <info>true</info> zurück.

<comment>See Also:</comment>
   * <strong>jpeg2wbmp()</strong>


id: popen
type: function
doc:
<comment>Description:</comment>
  Öffnet einen Dateizeiger für einen Prozess
  
  Öffnet eine Pipe zu einem Prozess durch Forken des Befehls, der durch <strong>$command</strong> angegeben wurde.

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>  Das Kommando
  <info>string</info>  <strong>$mode</strong>     Der Modus. Entweder <return>'r'</return> zum Lesen, oder <return>'w'</return> zum Schreiben.
                    
                    Unter Windows ist <strong>popen()</strong> standardmäßig auf den Textmodus eingestellt, d. h.
                    alle in die Pipe geschriebenen oder aus ihr gelesenen <return>\n</return>-Zeichen werden in <return>\r\n</return>
                    übersetzt. Wenn dies nicht gewünscht ist, kann der Binärmodus erzwungen werden,
                    indem <strong>$mode</strong> auf <return>'rb'</return> bzw. <return>'wb'</return> gesetzt wird.

<comment>Return:</comment>
  <info>resource|false</info>  Gibt einen Dateizeiger zurück, der identisch ist mit dem, der bei der Funktion
                  <strong>fopen()</strong> zurückgegeben wird, außer dass dieser nur in eine Richtung funktioniert
                  (entweder lesend oder schreibend) und mit der Funktion <strong>pclose()</strong> geschlossen werden
                  muss. Dieser Zeiger kann mit den Funktionen <strong>fgets()</strong>, <strong>fgetss()</strong> und <strong>fwrite()</strong> benutzt
                  werden. Ist der Modus 'r', ist der zurückgegebene Dateizeiger das STDOUT des
                  Kommandos; ist der Modus 'w', ist der zurückgegebene Dateizeiger das STDIN des
                  Kommandos.
                  
                  Wenn ein Fehler auftritt, wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>pclose()</strong>
   * <strong>fopen()</strong>
   * <strong>proc_open()</strong>


id: pos
type: function
doc:
<comment>Description:</comment>
  Alias von current
  
  Diese Funktion ist ein Alias für:  <strong>current()</strong>


id: posix_access
type: function
doc:
<comment>Description:</comment>
  Ermittelt die Zugriffsberechtigungen einer Datei
  
  <strong>posix_access()</strong> überprüft, welche Zugriffsberechtigungen der Benutzer für eine Datei hat.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Der Name der zu überprüfenden Datei.
  <info>int</info>     <strong>$flags</strong>     Eine Maske, die aus einer oder mehr der Konstanten <info>POSIX_F_OK</info>, <info>POSIX_R_OK</info>,
                     <info>POSIX_W_OK</info> und <info>POSIX_X_OK</info> besteht.
                     
                     <info>POSIX_R_OK</info>, <info>POSIX_W_OK</info> und <info>POSIX_X_OK</info> fordern eine Überprüfung an, ob die Datei
                     existiert und ob dafür Lese-, Schreib-, bzw. Ausführungsrechte vorliegen.
                     <info>POSIX_F_OK</info> fordert nur eine Überprüfung der Existenz der Datei an.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>posix_get_last_error()</strong>
   * <strong>posix_strerror()</strong>


id: posix_ctermid
type: function
doc:
<comment>Description:</comment>
  Liefert den Pfad des kontrollierenden Terminals
  
  Gibt den Pfadnamen des aktuell kontrollierenden Terminals des Prozesses als <info>String</info> zurück. Falls
  ein Fehler auftritt, wird errno (Fehlernummer) gesetzt, das mittels <strong>posix_get_last_error()</strong>
  abgerufen werden kann.

<comment>Return:</comment>
  <info>string|false</info>  Gibt bei erfolgreicher Beendigung den Pfadnamen des aktuell kontrollierenden
                Terminals als <info>String</info> zurück. Andernfalls wird <info>false</info> zurückgegeben und errno gesetzt,
                das mittels <strong>posix_get_last_error()</strong> überprüft werden kann.

<comment>See Also:</comment>
   * <strong>posix_ttyname()</strong>
   * <strong>posix_get_last_error()</strong>


id: posix_eaccess
type: function
doc:
<comment>Description:</comment>
  Determine accessibility of a file
    
  
  <strong>posix_eaccess()</strong> checks the effective user's permission of a file

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The name of a file to be tested.
  <info>int</info>     <strong>$flags</strong>     A mask consisting of one or more of <info>POSIX_F_OK</info>, <info>POSIX_R_OK</info>, <info>POSIX_W_OK</info> and
                     <info>POSIX_X_OK</info>.
                     
                     <info>POSIX_R_OK</info>, <info>POSIX_W_OK</info> and <info>POSIX_X_OK</info> request checking whether the file exists
                     and has read, write and execute permissions, respectively. <info>POSIX_F_OK</info> just
                     requests checking for the existence of the file.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>posix_get_last_error()</strong>
   * <strong>posix_strerror()</strong>
   * <strong>posix_access()</strong>


id: posix_errno
type: function
doc:
<comment>Description:</comment>
  Alias von posix_get_last_error
  
  Diese Funktion ist ein Alias für:  <strong>posix_get_last_error()</strong>.


id: posix_fpathconf
type: function
doc:
<comment>Description:</comment>
  Returns the value of a configurable limit
  
  Returns the value of a configurable limit from <strong>$name</strong> for a file descriptor <strong>$resource</strong>

<comment>Param:</comment>
  <info>resource|int</info>  <strong>$file_descriptor</strong>  Der Datei-Deskriptor, welcher entweder eine Datei-<info>Ressource</info> oder
                                  ein Wert vom Typ <info>int</info> sein sollte. Ist dies ein <info>int</info>, dann wird
                                  davon ausgegangen, dass es sich um einen Dateideskriptor handelt,
                                  welcher direkt an den zugrundeliegenden Systemaufruf übergeben
                                  werden kann.
  <info>int</info>           <strong>$name</strong>             The name of the configurable limit, one of the following.
                                  <info>POSIX_PC_LINK_MAX</info>, <info>POSIX_PC_MAX_CANON</info> <info>POSIX_PC_MAX_INPUT</info>,
                                  <info>POSIX_PC_NAME_MAX</info> <info>POSIX_PC_PATH_MAX</info>, <info>POSIX_PC_PIPE_BUF</info>
                                  <info>POSIX_PC_CHOWN_RESTRICTED</info>, <info>POSIX_PC_NO_TRUNC</info>
                                  <info>POSIX_PC_ALLOC_SIZE_MIN</info>, <info>POSIX_PC_SYMLINK_MAX</info>

<comment>Return:</comment>
  <info>int|false</info>  Returns the configurable limit or <info>false</info>.

<comment>See Also:</comment>
   * <strong>posix_pathconf()</strong>


id: posix_get_last_error
type: function
doc:
<comment>Description:</comment>
  Liefert die von der letzten fehlgeschlagenen Posix-Funktion gesetzte Fehlernummer
  
  Gibt die Fehlernummer zurück, die von der letzten fehlgeschlagenen Posix-Funktion gesetzt wurde.
  Die zu errno gehörende Fehlermeldung des Systems kann mit <strong>posix_strerror()</strong> abgerufen werden.

<comment>Return:</comment>
  <info>int</info>  Gibt die errno (Fehlernummer) zurück, die von der letzten fehlgeschlagenen Posix-Funktion
       gesetzt wurde. Falls keine Fehler aufgetreten sind, wird 0 zurückgegeben.

<comment>See Also:</comment>
   * <strong>posix_strerror()</strong>


id: posix_getcwd
type: function
doc:
<comment>Description:</comment>
  Liefert den Pfadnamen des aktuellen Verzeichnisses
  
  Gibt den absoluten Pfadnamen des aktuellen Arbeitsverzeichnisses des Skripts zurück. Falls ein
  Fehler auftritt, wird errno (Fehlernummer) gesetzt, das mittels <strong>posix_get_last_error()</strong> abgerufen
  werden kann.

<comment>Return:</comment>
  <info>string|false</info>  Gibt bei Erfolg den absoluten Pfadnamen als <info>String</info> zurück. Falls ein Fehler
                auftritt, wird <info>false</info> zurückgegeben und errno gesetzt, das mittels
                <strong>posix_get_last_error()</strong> überprüft werden kann.


id: posix_getegid
type: function
doc:
<comment>Description:</comment>
  Liefert die effektive Gruppen-ID des aktuellen Prozesses
  
  Gibt die effektive numerische Gruppen-ID des aktuellen Prozesses zurück.

<comment>Return:</comment>
  <info>int</info>  Gibt die effektive Gruppen-ID als <info>int</info> zurück.

<comment>See Also:</comment>
   * <strong>posix_getgrgid()</strong>
   * <strong>posix_getgid()</strong>
   * <strong>posix_setgid()</strong>


id: posix_geteuid
type: function
doc:
<comment>Description:</comment>
  Liefert die effektive Benutzer-ID des aktuellen Prozesses
  
  Gibt die effektive numerische Benutzer-ID des aktuellen Prozesses zurück. Für Informationen
  darüber, wie die Benutzer-ID in einen gebräuchlichen Benutzernamen umgewandelt werden kann, siehe
  auch <strong>posix_getpwuid()</strong>.

<comment>Return:</comment>
  <info>int</info>  Gibt die Benutzer-ID als <info>int</info> zurück.

<comment>See Also:</comment>
   * <strong>posix_getpwuid()</strong>
   * <strong>posix_getuid()</strong>
   * <strong>posix_setuid()</strong>
   * POSIX GETEUID(2)-Manpage


id: posix_getgid
type: function
doc:
<comment>Description:</comment>
  Liefert die reale Gruppen-ID des aktuellen Prozesses
  
  Gibt die reale numerische Gruppen-ID des aktuellen Prozesses zurück.

<comment>Return:</comment>
  <info>int</info>  Gibt die reale Gruppen-ID als <info>int</info> zurück.

<comment>See Also:</comment>
   * <strong>posix_getgrgid()</strong>
   * <strong>posix_getegid()</strong>
   * <strong>posix_setgid()</strong>
   * POSIX GETGID(2)-Manpage


id: posix_getgrgid
type: function
doc:
<comment>Description:</comment>
  Liefert zu einer Gruppen-ID Informationen über diese Gruppe
  
  Gibt Informationen über die Gruppe mit der angegebenen ID zurück.

<comment>Param:</comment>
  <info>int</info>  <strong>$group_id</strong>  Die Gruppen-ID

<comment>Return:</comment>
  <info>array|false</info>  Die Elemente des zurückgegebenen Arrays sind: Das Array mit
               GruppeninformationenElementBeschreibungname Das name-Element enthält den Namen der
               Gruppe. Es handelt sich dabei nicht um den wirklichen, kompletten Namen, sondern um
               einen kurzen "Bezeichner" der Gruppe mit normalerweise weniger als 16 Zeichen. passwd
               Das passwd-Element enthält das Passwort der Gruppe in verschlüsselter Form. Häufig,
               zum Beispiel wenn auf einem System "shadow"-Passwörter verwendet werden, wird
               stattdessen ein Sternchen zurückgegeben. gid Die Gruppen-ID - sollte dieselbe sein
               wie der Parameter <strong>$group_id</strong>, der beim Aufruf der Funktion verwendet wurde und ist von
               daher redundant. members Besteht aus einem <info>Array</info> von <info>Zeichenketten</info> aller
               Gruppenmitglieder.  Falls ein Fehler auftritt, gibt die Funktion <info>false</info> zurück.

<comment>See Also:</comment>
   * <strong>posix_getegid()</strong>
   * <strong>posix_getgrnam()</strong>
   * <strong>filegroup()</strong>
   * <strong>stat()</strong>
   * POSIX GETGRNAM(3)-Manpage


id: posix_getgrnam
type: function
doc:
<comment>Description:</comment>
  Liefert zu einem Gruppennamen Informationen über diese Gruppe
  
  Gibt Informationen über die durch Gruppenname angegebene Gruppe zurück.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Der Name der Gruppe

<comment>Return:</comment>
  <info>array|false</info>  Gibt im Erfolgsfall ein <info>Array</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben. Die
               Elemente des zurückgegebenen Arrays sind: Das Array mit
               GruppeninformationenElementBeschreibungname Das name-Element enthält den Namen der
               Gruppe. Es handelt sich dabei nicht um den wirklichen, kompletten Namen, sondern um
               einen kurzen "Bezeichner" der Gruppe mit normalerweise weniger als 16 Zeichen. Er
               sollte derselbe sein wie der Parameter <strong>$name</strong>, der beim Aufruf der Funktion verwendet
               wurde und ist von daher redundant. passwd Das passwd-Element enthält das Passwort der
               Gruppe in verschlüsselter Form. Häufig, zum Beispiel wenn auf einem System
               "shadow"-Passwörter verwendet werden, wird stattdessen ein Sternchen zurückgegeben.
               gidDie Gruppen-ID in numerischem Formatmembers Besteht aus einem <info>Array</info> von <info>String</info>s
               aller Gruppenmitglieder.

<comment>See Also:</comment>
   * <strong>posix_getegid()</strong>
   * <strong>posix_getgrgid()</strong>
   * <strong>filegroup()</strong>
   * <strong>stat()</strong>
   * POSIX GETGRNAM(3)-Manpage


id: posix_getgroups
type: function
doc:
<comment>Description:</comment>
  Liefert die Gruppenliste des aktuellen Prozesses
  
  Gibt die Gruppenliste des aktuellen Prozesses zurück.

<comment>Return:</comment>
  <info>array|false</info>  Gibt ein Array von Ganzzahlen zurück, das die numerischen Gruppen-IDs der
               Gruppenliste des aktuellen Prozesses enthält. Bei einem Fehler wird <info>false</info>
               zurückgegeben.

<comment>See Also:</comment>
   * <strong>posix_getgrgid()</strong>


id: posix_getlogin
type: function
doc:
<comment>Description:</comment>
  Liefert den Loginnamen
  
  Gibt den Loginnamen der Benutzerin zurück, der der aktuelle Prozess gehört.

<comment>Return:</comment>
  <info>string|false</info>  Gibt den Loginnamen der Benutzerin als <info>String</info> zurück. Bei einem Fehler wird <info>false</info>
                zurückgegeben.

<comment>See Also:</comment>
   * <strong>posix_getpwnam()</strong>
   * POSIX GETLOGIN(3)-Manpage


id: posix_getpgid
type: function
doc:
<comment>Description:</comment>
  Liefert die Prozessgruppenkennung (Process Group ID) für die Job-Kontrolle
  
  Gibt die Prozessgruppenkennung des Prozzesses <strong>$process_id</strong> zurück. Bei einem Fehler wird <info>false</info>
  zurückgegeben.

<comment>Param:</comment>
  <info>int</info>  <strong>$process_id</strong>  Die Prozess-ID

<comment>Return:</comment>
  <info>int|false</info>  Gibt die Kennung als <info>int</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>posix_getppid()</strong>
   *  SETPGID(2)-Manpage


id: posix_getpgrp
type: function
doc:
<comment>Description:</comment>
  Liefert die Prozessgruppenkennung des aktuellen Prozesses
  
  Gibt die Prozessgruppenkennung des aktuellen Prozesses zurück.

<comment>Return:</comment>
  <info>int</info>  Gibt die Kennung als <info>int</info> zurück.

<comment>See Also:</comment>
   * 
     Die POSIX.1- und die getpgrp(2)-Manpage auf dem POSIX-System, um mehr
     Informationen über Prozessgruppen zu erhalten.
    


id: posix_getpid
type: function
doc:
<comment>Description:</comment>
  Liefert die aktuelle Prozesskennung
  
  Gibt die Prozesskennung des aktuellen Prozesses zurück.

<comment>Return:</comment>
  <info>int</info>  Gibt die Kennung als <info>int</info> zurück.

<comment>See Also:</comment>
   * <strong>posix_kill()</strong>
   * POSIX GETPID(2)-Manpage


id: posix_getppid
type: function
doc:
<comment>Description:</comment>
  Liefert die Prozesskennung des Elternprozesses
  
  Diese Funktion gibt die Prozesskennung des Elternprozesses des aktuellen Prozesses zurück.

<comment>Return:</comment>
  <info>int</info>  Gibt die Kennung als <info>int</info> zurück.


id: posix_getpwnam
type: function
doc:
<comment>Description:</comment>
  Liefert zu einem Benutzernamen Informationen über diesen Benutzer
  
  Gibt ein <info>Array</info> mit Informationen über den angegebenen Benutzer zurück.

<comment>Param:</comment>
  <info>string</info>  <strong>$username</strong>  Ein alphanumerischer Benutzername

<comment>Return:</comment>
  <info>array|false</info>  Bei Erfolg wird ein Array mit den folgenden Elementen zurückgegeben, andernfalls
               <info>false</info>: Das Benutzerinformation-ArrayElementBeschreibungname Das name-Element enthält
               den Benutzernamen. Es handelt sich dabei nicht um den wirklichen, kompletten Namen,
               sondern um einen kurzen "Bezeichner" des Benutzers mit normalerweise weniger als 16
               Zeichen. Der Benutzername sollte derselbe wie der bei Aufruf der Funktion verwendete
               Parameter <strong>$username</strong> sein und ist von daher redundant. passwd Das passwd-Element
               enthält das verschlüsselte Passwort des Benutzers. Häufig, zum Beispiel wenn auf
               einem System "shadow"-Passwörter verwendet werden, wird stattdessen ein Sternchen
               zurückgegeben. uidDie Benutzer-ID in numerischem Format.gid Die Gruppen-ID des
               Benutzers. Benutzen Sie die Funktion <strong>posix_getgrgid()</strong>, um den Gruppennamen und eine
               Liste der Gruppenmitglieder aufzulösen. gecos GECOS ist ein veralteter Begriff, der
               sich auf das finger-Informationsfeld auf einem Honeywell-Stapelverarbeitungssystem
               bezieht. Das Feld gibt es aber immer noch und sein Inhalt wurde durch POSIX
               formalisiert. Es enthält eine durch Komma getrennte Liste, bestehend aus dem
               kompletten Namen der Benutzerin, der Telefonnummer des Büros, der Zimmernummer des
               Büros und der privaten Telefonnummer. Auf den meisten Systemen ist nur der komplette
               Name des Benutzers verfügbar. dir Dieses Element enthält den absoluten Pfad des
               Homeverzeichnisses des Benutzers. shell Das shell-Element enthält den absoluten Pfad
               zur standardmäßigen Shell des Benutzers.

<comment>See Also:</comment>
   * <strong>posix_getpwuid()</strong>
   * POSIX GETPWNAM(3)-Manpage


id: posix_getpwuid
type: function
doc:
<comment>Description:</comment>
  Liefert zu einer Benutzer-ID Informationen über diesen Benutzer
  
  Gibt ein <info>Array</info> mit Informationen über den Benutzer zurück, auf die die angegebene ID verweist.

<comment>Param:</comment>
  <info>int</info>  <strong>$user_id</strong>  Die Benutzerkennung

<comment>Return:</comment>
  <info>array|false</info>  Gibt ein assoziatives Array mit den folgenden Elementen zurück: Das
               Benutzerinformation-ArrayElementBeschreibungname Das name-Element enthält den
               Benutzernamen. Es handelt sich dabei nicht um den wirklichen, kompletten Namen,
               sondern um einen kurzen "Bezeichner" des Benutzers mit normalerweise weniger als 16
               Zeichen. passwd Das passwd-Element enthält das verschlüsselte Passwort des Benutzers.
               Häufig, zum Beispiel wenn auf einem System "shadow"-Passwörter verwendet werden, wird
               stattdessen ein Sternchen zurückgegeben. uid Die Benutzer-ID sollte die selbe wie der
               Parameter <strong>$user_id</strong> sein und ist von daher redundant. gid Die Gruppen-ID des
               Benutzers. Benutzen Sie die Funktion <strong>posix_getgrgid()</strong>, um den Gruppennamen und eine
               Liste der Gruppenmitglieder aufzulösen. gecos GECOS ist ein veralteter Begriff, der
               sich auf das finger-Informationsfeld auf einem Honeywell-Stapelverarbeitungssystem
               bezieht. Das Feld gibt es aber immer noch und sein Inhalt wurde durch POSIX
               formalisiert. Es enthält eine durch Komma getrennte Liste, bestehend aus dem
               kompletten Namen des Benutzers, der Telefonnummer des Büros, der Zimmernummer des
               Büros und der privaten Telefonnummer. Auf den meisten Systemen ist nur der komplette
               Name des Benutzers verfügbar. dir Dieses Element enthält den absoluten Pfad des
               Homeverzeichnisses des Benutzers. shell Das shell-Element enthält den absoluten Pfad
               zur standardmäßigen Shell des Benutzers.  Falls ein Fehler auftritt, gibt die
               Funktion <info>false</info> zurück.

<comment>See Also:</comment>
   * <strong>posix_getpwnam()</strong>
   * POSIX GETPWNAM(3)-Manpage


id: posix_getrlimit
type: function
doc:
<comment>Description:</comment>
  Liefert Informationen über Systemressourcen-Limits
  
  <strong>posix_getrlimit()</strong> gibt ein <info>Array</info> mit Informationen über die aktuellen weichen und harten Limits
  der Ressourcen zurück.
  
  Zu jeder Ressource gehören ein weicher und ein harter Grenzwert. Der weiche Grenzwert ist der
  Wert, den der Kernel für die entsprechende Ressource erzwingt. Der harte Grenzwert wirkt als
  Obergrenze für den weichen Grenzwert. Ein unprivilegierter Prozess darf seinen weichen Grenzwert
  nur auf einen Wert von 0 bis zum harten Grenzwert setzen und seinen harten Grenzwert
  unwiderruflich verringern.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$resource</strong>  Falls <info>null</info>, werden die Limits aller Ressourcen abgerufen. Andernfalls werden
                       nur die Limits des angegebenen Ressourcentyps zurückgegeben.

<comment>Return:</comment>
  <info>array|false</info>  Gibt ein assioziatives <info>Array</info> mit Elementen für jedes definierte Limit zurück. Jede
               Ressource hat ein weiches und ein hartes Limit. Liste möglicher Limits, die
               zurückgegeben werdenName des LimitsBeschreibung des Limitscore Die maximale Größe der
               Core-Datei. 0 bedeutet, dass keine Core-Datei angelegt wird. Wenn Core-Dateien diese
               Größe überschreiten, werden sie auf diese Größe abgeschnitten. totalmem Die maximale
               Größe des Speichers für den Prozess in Bytes. virtualmem Die maximale Größe des
               virtuellen Speichers für den Prozess in Bytes. data Die maximale Größe des
               Datensegments für den Prozess in Bytes. stack Die maximale Stackgröße des Prozesses
               in Bytes. rss Die maximale Anzahl virtueller Speicherseiten, die im RAM resident
               sind. maxproc Die maximale Anzahl von Prozessen, die für die reale Benutzer-ID des
               aufrufenden Prozesses erzeugt werden können. memlock Die maximale Anzahl Bytes, die
               im RAM blockiert werden können. cpu Die Zeit, die ein Prozess die CPU nutzen darf.
               filesize Die maximale Größe des Datensegments für den Prozess in Bytes. openfiles
               Einer mehr als die maximale Anzahl offener Dateideskriptoren.  Falls ein Fehler
               auftritt, gibt die Funktion <info>false</info> zurück.

<comment>See Also:</comment>
   * GETRLIMIT(2)-Manpage
   * <strong>posix_setrlimit()</strong>


id: posix_getsid
type: function
doc:
<comment>Description:</comment>
  Liefert die aktuelle Session-ID (sid) des Prozesses
  
  Gibt die Session-ID des Prozesses <strong>$process_id</strong> zurück. Die Session-ID eines Prozesses ist die
  Prozessgruppen-ID des Session-Managers.

<comment>Param:</comment>
  <info>int</info>  <strong>$process_id</strong>  Die Prozesskennung. Falls sie auf 0 gesetzt ist, wird der aktuelle Prozess
                    angenommen. Falls eine ungültige <strong>$process_id</strong> angegeben wurde, wird <info>false</info>
                    zurückgegeben und ein Fehler gesetzt, der mittels <strong>posix_get_last_error()</strong>
                    überprüft werden kann.

<comment>Return:</comment>
  <info>int|false</info>  Gibt die Kennung als <info>int</info> zurück.

<comment>See Also:</comment>
   * <strong>posix_getpgid()</strong>
   * <strong>posix_setsid()</strong>
   * POSIX GETSID(2)-Manpage


id: posix_getuid
type: function
doc:
<comment>Description:</comment>
  Liefert die reale Benutzer-ID des aktuellen Prozesses
  
  Gibt die reale numerische Benutzer-ID des aktuellen Prozesses zurück.

<comment>Return:</comment>
  <info>int</info>  Gibt die Kennung als <info>int</info> zurück.

<comment>See Also:</comment>
   * <strong>posix_getpwuid()</strong>
   * POSIX GETUID(2)-Manpage


id: posix_initgroups
type: function
doc:
<comment>Description:</comment>
  Ermittelt die Gruppenzugriffsliste
  
  Ermittelt die Gruppenzugriffsliste für den in <strong>$username</strong> angegebenen Benutzer.

<comment>Param:</comment>
  <info>string</info>  <strong>$username</strong>  Der Benutzer, für den die Liste ermittelt werden soll.
  <info>int</info>     <strong>$group_id</strong>  Üblicherweise die Gruppennummer aus der Passwort-Datei.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * Die Unix-Manpage für initgroups(3)


id: posix_isatty
type: function
doc:
<comment>Description:</comment>
  Ermittelt, ob ein Dateideskriptor ein interaktives Terminal ist
  
  Ermittelt, ob der Dateideskriptor <strong>$file_descriptor</strong> auf ein gültiges terminalartiges Gerät
  verweist.

<comment>Param:</comment>
  <info>resource|int</info>  <strong>$file_descriptor</strong>  Der Datei-Deskriptor, welcher entweder eine Datei-<info>Ressource</info> oder
                                  ein Wert vom Typ <info>int</info> sein sollte. Ist dies ein <info>int</info>, dann wird
                                  davon ausgegangen, dass es sich um einen Dateideskriptor handelt,
                                  welcher direkt an den zugrundeliegenden Systemaufruf übergeben
                                  werden kann.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, falls <strong>$file_descriptor</strong> ein offener Deskriptor ist, der mit einem Terminal
        verbunden ist, und andernfalls <info>false</info>.

<comment>See Also:</comment>
   * <strong>posix_ttyname()</strong>
   * <strong>stream_isatty()</strong>


id: posix_kill
type: function
doc:
<comment>Description:</comment>
  Sendet einem Prozess ein Signal
  
  Sendet das Signal <strong>$signal</strong> zum Prozess mit der Prozesskennung <strong>$process_id</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$process_id</strong>  Die Prozesskennung
  <info>int</info>  <strong>$signal</strong>      Eine der PCNTL-Signalkonstanten.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * 
     Die kill(2)-Manpage des POSIX-Systems, die zusätzliche Informationen über
     negative Prozess-IDs, die speziellen pid 0 und -1 und die Signalnummer 0
     enthält.
    


id: posix_mkfifo
type: function
doc:
<comment>Description:</comment>
  Erzeugt eine "FIFO special"-Datei (named pipe)
  
  <strong>posix_mkfifo()</strong> erzeugt eine spezielle <return>FIFO</return>-Datei, die im Dateisystem existiert und als
  bidirektionaler Kommunikationsendpunkt für Prozesse agiert.

<comment>Param:</comment>
  <info></info>     <strong>$pfilename</strong>    Der Pfad zur <return>FIFO</return>-Datei.
  <info>int</info>  <strong>$permissions</strong>  Der zweite Parameter <strong>$permissions</strong> muss in oktaler Schreibweise angegeben werden
                     (z. B. 0644). Die Zugriffsberechtigungen des neu erzeugten <return>FIFO</return> hängen auch von
                     der Einstellung der aktuellen <strong>umask()</strong> ab. Die Zugriffsberechtigungen der
                     erzeugten Datei sind (mode & ~umask).

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: posix_mknod
type: function
doc:
<comment>Description:</comment>
  Erzeugt eine spezielle oder eine gewöhnliche Datei (POSIX.1)
  
  Erzeugt eine spezielle oder eine gewöhnliche Datei.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Die zu erzeugende Datei
  <info>int</info>     <strong>$flags</strong>     Dieser Parameter wird zusammengesetzt aus einer bitweisen ODER-Verknüpfung
                     zwischen dem Dateityp (eine der folgenden Konstanten: <info>POSIX_S_IFREG</info>,
                     <info>POSIX_S_IFCHR</info>, <info>POSIX_S_IFBLK</info>, <info>POSIX_S_IFIFO</info> oder <info>POSIX_S_IFSOCK</info>) und den
                     Zugriffsberechtigungen.
  <info>int</info>     <strong>$major</strong>     Die Major-Device-Nummer (Hauptgerätenummer); wird bei der Verwendung von
                     <info>S_IFCHR</info> oder <info>S_IFBLK</info> benötigt.
  <info>int</info>     <strong>$minor</strong>     Die Minor-Device-Nummer (Untergerätenummer).

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>posix_mkfifo()</strong>


id: posix_pathconf
type: function
doc:
<comment>Description:</comment>
  Returns the value of a configurable limit
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.
  
  Returns the value of a configurable limit from <strong>$name</strong> for a <strong>$file</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  The name of the file whose limit you want to get.
  <info>int</info>     <strong>$name</strong>  The name of the configurable limit, one of the following. <info>POSIX_PC_LINK_MAX</info>,
                 <info>POSIX_PC_MAX_CANON</info> <info>POSIX_PC_MAX_INPUT</info>, <info>POSIX_PC_NAME_MAX</info> <info>POSIX_PC_PATH_MAX</info>,
                 <info>POSIX_PC_PIPE_BUF</info> <info>POSIX_PC_CHOWN_RESTRICTED</info>, <info>POSIX_PC_NO_TRUNC</info>
                 <info>POSIX_PC_ALLOC_SIZE_MIN</info>, <info>POSIX_PC_SYMLINK_MAX</info>

<comment>Return:</comment>
  <info>int|false</info>  Returns the configurable limit or <info>false</info>.

<comment>See Also:</comment>
   * <strong>posix_fpathconf()</strong>


id: posix_setegid
type: function
doc:
<comment>Description:</comment>
  Setzt die effektive Gruppen-ID des aktuellen Prozesses
  
  Setzt die effektive Gruppen-ID des aktuellen Prozesses. Es handelt sich um eine privilegierte
  Funktion, die entsprechende Berechtigungen (normalerweise root) auf dem System benötigt, damit sie
  ausgeführt werden kann.

<comment>Param:</comment>
  <info>int</info>  <strong>$group_id</strong>  Die Gruppen-ID

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>posix_getgrgid()</strong>
   * <strong>posix_getgid()</strong>
   * <strong>posix_setgid()</strong>


id: posix_seteuid
type: function
doc:
<comment>Description:</comment>
  Setzt die effektive Benutzer-ID des aktuellen Prozesses
  
  Setzt die effektive Benutzer-ID des aktuellen Prozesses. Es handelt sich um eine privilegierte
  Funktion, die entsprechende Berechtigungen (normalerweise root) auf dem System benötigt, damit sie
  ausgeführt werden kann.

<comment>Param:</comment>
  <info>int</info>  <strong>$user_id</strong>  Die Benutzer-ID

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>posix_geteuid()</strong>
   * <strong>posix_setuid()</strong>
   * <strong>posix_getuid()</strong>


id: posix_setgid
type: function
doc:
<comment>Description:</comment>
  Setzt die Gruppen-ID des aktuellen Prozesses
  
  Setzt die reale Gruppen-ID des aktuellen Prozesses. Es handelt sich um eine privilegierte
  Funktion, die entsprechende Berechtigungen (normalerweise root) auf dem System benötigt, damit sie
  ausgeführt werden kann. Die sachgemäße Reihenfolge der Funktionsaufrufe ist zuerst <strong>posix_setgid()</strong>
  und zuletzt <strong>posix_setuid()</strong>.
  
  Falls die Funktion von einem Superuser aufgerufen wurde, setzt sie auch die effektive Gruppen-ID.

<comment>Param:</comment>
  <info>int</info>  <strong>$group_id</strong>  Die Gruppen-ID

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>posix_getgrgid()</strong>
   * <strong>posix_getgid()</strong>


id: posix_setpgid
type: function
doc:
<comment>Description:</comment>
  Setzt die Prozessgruppenkennung (Process Group ID) für die Job-Kontrolle
  
  Fügt den Prozess <strong>$process_id</strong> der Prozessgruppe <strong>$process_group_id</strong> hinzu.

<comment>Param:</comment>
  <info>int</info>  <strong>$process_id</strong>        Die Prozess-ID
  <info>int</info>  <strong>$process_group_id</strong>  Die Prozessgruppen-ID

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * 
     Die POSIX.1- und die setpgid(2)-Manpage auf dem POSIX-System um mehr
     Informationen über Prozessgruppen und Job-Kontrolle zu erhalten.
    


id: posix_setrlimit
type: function
doc:
<comment>Description:</comment>
  Set system resource limits
  
  <strong>posix_setrlimit()</strong> sets the soft and hard limits for a given system resource.
  
  Zu jeder Ressource gehören ein weicher und ein harter Grenzwert. Der weiche Grenzwert ist der
  Wert, den der Kernel für die entsprechende Ressource erzwingt. Der harte Grenzwert wirkt als
  Obergrenze für den weichen Grenzwert. Ein unprivilegierter Prozess darf seinen weichen Grenzwert
  nur auf einen Wert von 0 bis zum harten Grenzwert setzen und seinen harten Grenzwert
  unwiderruflich verringern.

<comment>Param:</comment>
  <info>int</info>  <strong>$resource</strong>    The resource limit constant corresponding to the limit that is being set.
  <info>int</info>  <strong>$soft_limit</strong>  The soft limit, in whatever unit the resource limit requires, or
                    <info>POSIX_RLIMIT_INFINITY</info>.
  <info>int</info>  <strong>$hard_limit</strong>  The hard limit, in whatever unit the resource limit requires, or
                    <info>POSIX_RLIMIT_INFINITY</info>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * man page SETRLIMIT(2)
   * <strong>posix_getrlimit()</strong>


id: posix_setsid
type: function
doc:
<comment>Description:</comment>
  Macht den aktuellen Prozess zum Leiter der Session
  
  Macht den aktuellen Prozess zum Leiter der Session.

<comment>Return:</comment>
  <info>int</info>  Gibt die Session-ID zurück oder -1 falls ein Fehler auftrat.

<comment>See Also:</comment>
   * 
     Die POSIX.1- und die setsid(2)-Manpage auf dem POSIX-System, um mehr
     Informationen über Prozessgruppen und Job-Kontrolle zu erhalten.
    


id: posix_setuid
type: function
doc:
<comment>Description:</comment>
  Setzt die Benutzer-ID des aktuellen Prozesses
  
  Setzt die Benutzer-ID des aktuellen Prozesses. Es handelt sich um eine privilegierte Funktion, die
  entsprechende Berechtigungen (normalerweise root) auf dem System benötigt, damit sie ausgeführt
  werden kann.

<comment>Param:</comment>
  <info>int</info>  <strong>$user_id</strong>  Die Benutzer-ID

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>posix_setgid()</strong>
   * <strong>posix_seteuid()</strong>
   * <strong>posix_getuid()</strong>
   * <strong>posix_geteuid()</strong>


id: posix_strerror
type: function
doc:
<comment>Description:</comment>
  Liefert die System-Fehlermeldung, die zur angegebenen Fehlernummer gehört
  
  Gibt die POSIX System-Fehlermeldung zurück, die zur angegebenen Fehlernummer <strong>$error_code</strong> gehört.
  Der Parameter <strong>$error_code</strong> kann mit <strong>posix_get_last_error()</strong> ermittelt werden.

<comment>Param:</comment>
  <info>int</info>  <strong>$error_code</strong>  Die POSIX-Fehlernummer, die von <strong>posix_get_last_error()</strong> zurückgegeben wurde.
                    Falls sie auf 0 gesetzt wird, wird die Zeichenkette "Success" zurückgegeben.

<comment>Return:</comment>
  <info>string</info>  Gibt die Fehlermeldung als Zeichenkette zurück.

<comment>See Also:</comment>
   * <strong>posix_get_last_error()</strong>


id: posix_sysconf
type: function
doc:
<comment>Description:</comment>
  Returns system runtime information
  
  Returns system runtime information.

<comment>Param:</comment>
  <info>int</info>  <strong>$conf_id</strong>  Identifier of the variable with the following constants <info>POSIX_SC_ARG_MAX</info>,
                 <info>POSIX_SC_PAGESIZE</info> <info>POSIX_SC_NPROCESSORS_CONF</info>, <info>POSIX_SC_NPROCESSORS_ONLN</info>

<comment>Return:</comment>
  <info>int</info>  Returns the numeric value related to <strong>$conf_id</strong>


id: posix_times
type: function
doc:
<comment>Description:</comment>
  Liefert Rechenzeiten
  
  Gibt Informationen über die aktuelle Auslastung der CPU zurück.

<comment>Return:</comment>
  <info>array|false</info>  Gibt eine Reihe von Zahlenwerten mit Informationen über die Auslastung der CPU durch
               den aktuellen Prozess zurück. Die Indizes dieser Zahlenwerte sind:  ticks - die
               Anzahl von Clock-Ticks, die seit dem Reboot verstrichen sind.  utime - Benutzerzeit,
               die vom aktuellen Prozess verbraucht wurde.  stime - Systemzeit, die vom aktuellen
               Prozess verbraucht wurde.  cutime - Benutzerzeit, die vom aktuellen Prozess und
               dessen Kindprozessen verbraucht wurde.  cstime - Systemzeit, die vom aktuellen
               Prozess und dessen Kindprozessen verbraucht wurde.  Falls ein Fehler auftritt, gibt
               die Funktion <info>false</info> zurück.
               
               ticks - die Anzahl von Clock-Ticks, die seit dem Reboot verstrichen sind.
               
               utime - Benutzerzeit, die vom aktuellen Prozess verbraucht wurde.
               
               stime - Systemzeit, die vom aktuellen Prozess verbraucht wurde.
               
               cutime - Benutzerzeit, die vom aktuellen Prozess und dessen Kindprozessen verbraucht
               wurde.
               
               cstime - Systemzeit, die vom aktuellen Prozess und dessen Kindprozessen verbraucht
               wurde.


id: posix_ttyname
type: function
doc:
<comment>Description:</comment>
  Ermittelt den Namen des Terminal-Devices
  
  Gibt den absoluten Pfad zum aktuellen Terminal-Device, das mit dem Dateideskriptor
  <strong>$file_descriptor</strong> geöffnet ist, als <info>String</info> zurück.

<comment>Param:</comment>
  <info>resource|int</info>  <strong>$file_descriptor</strong>  Der Datei-Deskriptor, welcher entweder eine Datei-<info>Ressource</info> oder
                                  ein Wert vom Typ <info>int</info> sein sollte. Ist dies ein <info>int</info>, dann wird
                                  davon ausgegangen, dass es sich um einen Dateideskriptor handelt,
                                  welcher direkt an den zugrundeliegenden Systemaufruf übergeben
                                  werden kann.

<comment>Return:</comment>
  <info>string|false</info>  Gibt bei Erfolg den absoluten Pfad des Dateideskriptors <strong>$file_descriptor</strong> als <info>String</info>
                zurück. Falls ein Fehler auftrat, wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>posix_isatty()</strong>
   * <strong>stream_isatty()</strong>


id: posix_uname
type: function
doc:
<comment>Description:</comment>
  Liefert Auskunft über das System
  
  Gibt Informationen über das System zurück.
  
  Posix erfordert, dass bezüglich des Formats der Werte nichts vorausgesetzt werden darf, z. B. die
  Annahme, dass die Versionsnummer aus drei Ziffern besteht oder bezüglich irgendetwas anderem, das
  von dieser Funktion zurückgegeben wird.

<comment>Return:</comment>
  <info>array|false</info>  Gibt eine Reihe von Daten mit Informationen über das System zurück. Die Indizes
               dieser Daten sind:  sysname - Name des Betriebssystems (z. B. Linux)  nodename - Name
               des Systems (z. B. valiant)  release - Release des Betriebssystems (z. B. 2.2.10)
               version - Version des Betriebssystems (z. B. #4 Tue Jul 20 17:01:36 MEST 1999)
               machine - Systemarchitektur (z. B. i586)  domainname - DNS Domainname (z. B.
               example.com)
               
               sysname - Name des Betriebssystems (z. B. Linux)
               
               nodename - Name des Systems (z. B. valiant)
               
               release - Release des Betriebssystems (z. B. 2.2.10)
               
               version - Version des Betriebssystems (z. B. #4 Tue Jul 20 17:01:36 MEST 1999)
               
               machine - Systemarchitektur (z. B. i586)
               
               domainname - DNS Domainname (z. B. example.com)
               
               domainname ist eine GNU-Erweiterung und nicht Teil von POSIX.1. Deshalb steht dieses
               Feld nur auf GNU-Systemen oder bei Verwendung der GNU libc zur Verfügung.
               
               Falls ein Fehler auftritt, gibt die Funktion <info>false</info> zurück.


id: pow
type: function
doc:
<comment>Description:</comment>
  Potenzfunktion
  
  Berechnet die Potenz von <strong>$exponent</strong> zur Basis <strong>$num</strong> oder kurz <strong>$num</strong>exponent.
  
  Alternativ kann der **-Operator verwendet werden.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$num</strong>       Die zu potenzierende Basis.
  <info>mixed</info>  <strong>$exponent</strong>  Der Exponent.

<comment>Return:</comment>
  <info>int|float|object</info>  <strong>$num</strong> in der Potenz <strong>$exponent</strong>. Sind beide Argumente nichtnegative Ganzzahlen und
                    kann das Ergebnis als Ganzzahl dargestellt werden, wird das Ergebnis als <info>int</info>
                    zurückgegeben, andernfalls als <info>float</info>.

<comment>See Also:</comment>
   * <strong>exp()</strong>
   * <strong>sqrt()</strong>
   * <strong>bcpow()</strong>
   * <strong>gmp_pow()</strong>


id: preg_filter
type: function
doc:
<comment>Description:</comment>
  Sucht und ersetzt mit regulären Ausdrücken
  
  Davon abgesehen, dass <strong>preg_filter()</strong> bei Übereinstimmungen die (möglicherweise umgewandelten)
  Zeichenketten nur zurückgibt, ist sie mit <strong>preg_replace()</strong> identisch. Details über die
  Funktionsweise dieser Funktion sind in in der Dokumentation zu <strong>preg_replace()</strong> zu finden.

<comment>Return:</comment>
  <info>string|array|null</info>  Gibt ein <info>Array</info> zurück, falls <strong>$subject</strong> ein <info>Array</info> ist, andernfalls eine
                     <info>Zeichenkette</info>.
                     
                     Falls keine Übereinstimmungen gefunden wurden oder ein Fehler auftrat, wird ein
                     leeres <info>Array</info> zurückgegeben, wenn <strong>$subject</strong> ein <info>Array</info> ist, andernfalls <info>null</info>.

<comment>See Also:</comment>
   * PCRE-Suchmuster
   * <strong>preg_quote()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_replace_callback()</strong>
   * <strong>preg_grep()</strong>
   * <strong>preg_last_error()</strong>


id: preg_grep
type: function
doc:
<comment>Description:</comment>
  Liefert Array-Elemente, die auf ein Suchmuster passen
  
  Gibt ein Array zurück, das aus den Elementen des Arrays <strong>$array</strong> besteht, die auf das angegebene
  Suchmuster <strong>$pattern</strong> passen.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  Der Ausdruck, nach dem gesucht werden soll, als Zeichenkette
  <info>array</info>   <strong>$array</strong>    Das Eingabe-Array
  <info>int</info>     <strong>$flags</strong>    Falls auf <info>PREG_GREP_INVERT</info> gesetzt, gibt die Funktion die Elemente des
                    Eingabe-Arrays zurück, die nicht auf das angegebene Suchmuster <strong>$pattern</strong> passen.

<comment>Return:</comment>
  <info>array|false</info>  Gibt ein Array zurück, das mit den Schlüsseln des Arrays <strong>$array</strong> indiziert ist. Bei
               einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * PCRE-Suchmuster
   * <strong>preg_quote()</strong>
   * <strong>preg_match_all()</strong>
   * <strong>preg_filter()</strong>
   * <strong>preg_last_error()</strong>


id: preg_last_error
type: function
doc:
<comment>Description:</comment>
  Liefert den Fehlercode der letzten PCRE-RegEx-Auswertung
  
  Gibt den Fehlercode der letzten PCRE-RegEx-Auswertung zurück.
  
  <strong>preg_last_error()</strong>-Beispiel
  ]]>Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
  
  Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

<comment>Return:</comment>
  <info>int</info>  Diese Funktion gibt eine der folgenden Konstanten zurück:
       <info>PREG_NO_ERROR</info><info>PREG_INTERNAL_ERROR</info><info>PREG_BACKTRACK_LIMIT_ERROR</info> (siehe auch
       pcre.backtrack_limit)<info>PREG_RECURSION_LIMIT_ERROR</info> (siehe auch
       pcre.recursion_limit)<info>PREG_BAD_UTF8_ERROR</info><info>PREG_BAD_UTF8_OFFSET_ERROR</info><info>PREG_JIT_STACKLIMIT_ERROR</info>

<comment>See Also:</comment>
   * <strong>preg_last_error_msg()</strong>


id: preg_last_error_msg
type: function
doc:
<comment>Description:</comment>
  Returns the error message of the last PCRE regex execution
  
  Returns the error message of the last PCRE regex execution.

<comment>Return:</comment>
  <info>string</info>  Returns the error message on success, or <return>"No error"</return> if no error has occurred.

<comment>See Also:</comment>
   * <strong>preg_last_error()</strong>


id: preg_match
type: function
doc:
<comment>Description:</comment>
  Führt eine Suche mit einem regulären Ausdruck durch
  
  Durchsucht <strong>$subject</strong> nach Übereinstimmungen mit dem in <strong>$pattern</strong> angegebenen regulären Ausdruck.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  Der Ausdruck, nach dem gesucht werden soll, als Zeichenkette.
  <info>string</info>  <strong>$subject</strong>  Die zu durchsuchende Zeichenkette.
  <info>array</info>   <strong>$matches</strong>  Falls der Parameter <strong>$matches</strong> angegeben wurde, wird er mit den Suchergebnissen
                    gefüllt. $matches[0] enthält dann den Text, der auf das komplette Suchmuster
                    passt, $matches[1] den Text, der auf das erste eingeklammerte Teilsuchmuster
                    passt und so weiter.
  <info>int</info>     <strong>$flags</strong>    <strong>$flags</strong> kann eine Kombination der folgenden Flags sein: <info>PREG_OFFSET_CAPTURE</info> Wenn
                    dieses Flag gesetzt ist, wird mit jeder gefundenen Übereinstimmung die
                    dazugehörige Position in der Zeichenkette (in Bytes) zurückgegeben. Zu beachten
                    ist, dass dies den Wert von <strong>$matches</strong> in ein Array ändert, in dem jedes Element
                    ein Array ist, das aus der übereinstimmenden Zeichenkette als Element <return>0</return> und
                    deren Stelle in <strong>$subject</strong> als Element <return>1</return> besteht.
                    ]]>Das oben gezeigte Beispiel erzeugt folgende Ausgabe: Array ( [0] => foobarbaz
                    [1] => 0 )
                     [1] => Array ( [0] => foo [1] => 0 )
                     [2] => Array ( [0] => bar [1] => 3 )
                     [3] => Array ( [0] => baz [1] => 6 )
                    
                    )
                    ]]> <info>PREG_UNMATCHED_AS_NULL</info> Wird dieses Flag angegeben, werden nicht gefundene
                    Teilsuchmuster als <info>null</info> zurückgegeben; andernfalls werden sie als eine leere
                    Zeichenkette (<info>String</info>) zurückgegeben.
                    ]]>Das oben gezeigte Beispiel erzeugt folgende Ausgabe: string(2) "ac" [1]=>
                    string(1) "a" [2]=> string(0) "" [3]=> string(1) "c"
                    }
                    array(4) { [0]=> string(2) "ac" [1]=> string(1) "a" [2]=> NULL [3]=> string(1)
                    "c"
                    }
                    ]]> 
                    
                    Wenn dieses Flag gesetzt ist, wird mit jeder gefundenen Übereinstimmung die
                    dazugehörige Position in der Zeichenkette (in Bytes) zurückgegeben. Zu beachten
                    ist, dass dies den Wert von <strong>$matches</strong> in ein Array ändert, in dem jedes Element
                    ein Array ist, das aus der übereinstimmenden Zeichenkette als Element <return>0</return> und
                    deren Stelle in <strong>$subject</strong> als Element <return>1</return> besteht.
                    ]]>Das oben gezeigte Beispiel erzeugt folgende Ausgabe: Array ( [0] => foobarbaz
                    [1] => 0 )
                     [1] => Array ( [0] => foo [1] => 0 )
                     [2] => Array ( [0] => bar [1] => 3 )
                     [3] => Array ( [0] => baz [1] => 6 )
                    
                    )
                    ]]>
                    
                    Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
                    
                    Wird dieses Flag angegeben, werden nicht gefundene Teilsuchmuster als <info>null</info>
                    zurückgegeben; andernfalls werden sie als eine leere Zeichenkette (<info>String</info>)
                    zurückgegeben.
                    ]]>Das oben gezeigte Beispiel erzeugt folgende Ausgabe: string(2) "ac" [1]=>
                    string(1) "a" [2]=> string(0) "" [3]=> string(1) "c"
                    }
                    array(4) { [0]=> string(2) "ac" [1]=> string(1) "a" [2]=> NULL [3]=> string(1)
                    "c"
                    }
                    ]]>
                    
                    Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
  <info>array</info>   <strong>$matches</strong>  Wenn dieses Flag gesetzt ist, wird mit jeder gefundenen Übereinstimmung die
                    dazugehörige Position in der Zeichenkette (in Bytes) zurückgegeben. Zu beachten
                    ist, dass dies den Wert von <strong>$matches</strong> in ein Array ändert, in dem jedes Element
                    ein Array ist, das aus der übereinstimmenden Zeichenkette als Element <return>0</return> und
                    deren Stelle in <strong>$subject</strong> als Element <return>1</return> besteht.
                    ]]>Das oben gezeigte Beispiel erzeugt folgende Ausgabe: Array ( [0] => foobarbaz
                    [1] => 0 )
                     [1] => Array ( [0] => foo [1] => 0 )
                     [2] => Array ( [0] => bar [1] => 3 )
                     [3] => Array ( [0] => baz [1] => 6 )
                    
                    )
                    ]]>
                    
                    Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
  <info>int</info>     <strong>$offset</strong>   Normalerweise beginnt die Suche am Anfang der Zeichenkette. Der optionale
                    Parameter <strong>$offset</strong> kann verwendet werden, um eine andere Stelle in Bytes
                    anzugeben, ab der gesucht werden soll.
                    
                    Die Verwendung von <strong>$offset</strong> entspricht nicht der Übergabe von substr($subject,
                    $offset) an Stelle der Zeichenkette an <strong>preg_match()</strong>, weil <strong>$pattern</strong> Angaben wie
                    ^, $ oder (?\<=x) enthalten kann. Vergleiche:
                    ]]>Das oben gezeigte Beispiel erzeugt folgende Ausgabe: während dieses Beispiel 
                    ]]> folgende Ausgabe erzeugt  Array ( [0] => def [1] => 0 )
                    )
                    ]]> Als Alternative, um die Verwendung von <strong>substr()</strong> zu vermeiden, kann die
                    Assertion <return>\G</return> statt des Ankers <return>^</return> verwendet werden, oder stattdessen der
                    Modifikator <return>A</return>; beide funktionieren in Kombination mit dem Parameter <strong>$offset</strong>.
                    
                    Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
                    
                    während dieses Beispiel
                    
                    folgende Ausgabe erzeugt
                    
                    Als Alternative, um die Verwendung von <strong>substr()</strong> zu vermeiden, kann die Assertion
                    <return>\G</return> statt des Ankers <return>^</return> verwendet werden, oder stattdessen der Modifikator <return>A</return>;
                    beide funktionieren in Kombination mit dem Parameter <strong>$offset</strong>.

<comment>Return:</comment>
  <info>int|false</info>  <strong>preg_match()</strong> gibt 1 zurück, falls eine Übereinstimmung zwischen <strong>$pattern</strong> und <strong>$subject</strong>
             gefunden wurde, 0, falls nicht. Bei einem Fehler wird <info>false</info> zurückgegeben.
             
             Diese Funktion kann sowohl das
             boolsche <info>false</info> zurückliefern, als auch einen nicht-boolschen Wert, welcher zu <info>false</info>
             ausgewertet wird.
             Weitere Informationen entnehmen Sie bitte dem Abschnitt über die
              boolschen Typen. Benutzen Sie deshalb
             den === Operator,
             um den Rückgabewert dieser Funktion zu überprüfen.

<comment>See Also:</comment>
   * PCRE-Suchmuster
   * <strong>preg_quote()</strong>
   * <strong>preg_match_all()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_split()</strong>
   * <strong>preg_last_error()</strong>
   * <strong>preg_last_error_msg()</strong>


id: preg_match_all
type: function
doc:
<comment>Description:</comment>
  Führt eine vollständige Suche mit einem regulären Ausdruck durch
    
  
  Durchsucht <strong>$subject</strong> nach allen Übereinstimmungen mit dem in <strong>$pattern</strong> angegebenen regulären
  Ausdruck und legt sie in der durch <strong>$flags</strong> festgelegten Reihenfolge in <strong>$matches</strong> ab.
  
  Nachdem die erste Übereinstimmung gefunden wurde, wird die nachfolgende Suche jeweils am Ende der
  letzten Übereinstimmung fortgesetzt.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  Der Ausdruck, nach dem gesucht werden soll, als Zeichenkette.
  <info>string</info>  <strong>$subject</strong>  Die zu durchsuchende Zeichenkette.
  <info>array</info>   <strong>$matches</strong>  Ein mehrdimensionales Array mit allen gefundenen Übereinstimmungen, das den
                    <strong>$flags</strong> entsprechend sortiert ist.
  <info>int</info>     <strong>$flags</strong>    Kann eine Kombination folgender Flags sein (es ist zu beachten, dass es keinen
                    Sinn hat, <info>PREG_PATTERN_ORDER</info> zusammen mit <info>PREG_SET_ORDER</info> zu verwenden):
                    <info>PREG_PATTERN_ORDER</info> Ordnet die Ergebnisse so an, dass $matches[0] ein Array von
                    Übereinstimmungen mit dem kompletten Suchmuster ist, $matches[1] ein Array von
                    Zeichenketten, die auf das erste eingeklammerte Teilsuchmuster passen und so
                    weiter.
                    ]]>Das oben gezeigte Beispiel erzeugt folgende Ausgabe:Beispiel: , das ist ein
                    Test
                    Beispiel: , das ist ein Test
                    ]]> Also enthält $ausgabe[0] ein Array von Zeichenketten, die auf das komplette
                    Suchmuster passen und $ausgabe[1] ein Array von Zeichenketten, die sich zwischen
                    Tags befinden.  Enthält das Suchmuster benannte Teilsuchmuster, dann enthält
                    $matches zusätzlich Elemente mit dem Namen der Teilsuchmuster als Schlüssel.
                    Enthält das Suchmuster doppelt benannte Teilsuchmuster, wird nur das letzte
                    Teilsuchmuster in $matches[NAME] gespeichert.
                    ]]>Das oben gezeigte Beispiel erzeugt folgende Ausgabe: [1] => bar
                    )
                    ]]> <info>PREG_SET_ORDER</info> Ordnet die Ergebnisse so an, dass $matches[0] ein Array aus
                    dem ersten Satz von Übereinstimmungen ist, $matches[1] ein Array aus dem zweiten
                    Satz von Übereinstimmungen und so weiter.
                    ]]>Das oben gezeigte Beispiel erzeugt folgende Ausgabe:Beispiel: , Beispiel:
                    das ist ein Test, das ist ein Test
                    ]]> <info>PREG_OFFSET_CAPTURE</info> Wenn dieses Flag gesetzt ist, wird mit jeder gefundenen
                    Übereinstimmung die dazugehörige Position (in Bytes) in der Zeichenkette
                    zurückgegeben. Zu beachten ist, dass dies den Wert von <strong>$matches</strong> in ein Array von
                    Arrays ändert, in dem jedes Element ein Array ist, das aus der übereinstimmenden
                    Zeichenkette als Element <return>0</return> und deren Stelle in <strong>$subject</strong> als Element <return>1</return> besteht.
                    ]]>Das oben gezeigte Beispiel erzeugt folgende Ausgabe: Array ( [0] => Array (
                    [0] => foobarbaz [1] => 0 )
                     )
                     [1] => Array ( [0] => Array ( [0] => foo [1] => 0 )
                     )
                     [2] => Array ( [0] => Array ( [0] => bar [1] => 3 )
                     )
                     [3] => Array ( [0] => Array ( [0] => baz [1] => 6 )
                     )
                    
                    )
                    ]]> <info>PREG_UNMATCHED_AS_NULL</info> Wird dieses Flag angegeben werden nicht gefundene
                    Teilsuchmuster als <info>null</info> zurückgegeben; andernfalls werden sie als eine leere
                    Zeichenkette (<info>String</info>) zurückgegeben.
                    
                    Ordnet die Ergebnisse so an, dass $matches[0] ein Array von Übereinstimmungen
                    mit dem kompletten Suchmuster ist, $matches[1] ein Array von Zeichenketten, die
                    auf das erste eingeklammerte Teilsuchmuster passen und so weiter.
                    
                    
                    ]]>Das oben gezeigte Beispiel erzeugt folgende Ausgabe:Beispiel: , das ist ein
                    Test
                    Beispiel: , das ist ein Test
                    ]]> Also enthält $ausgabe[0] ein Array von Zeichenketten, die auf das komplette
                    Suchmuster passen und $ausgabe[1] ein Array von Zeichenketten, die sich zwischen
                    Tags befinden.
                    
                    Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
                    
                    Also enthält $ausgabe[0] ein Array von Zeichenketten, die auf das komplette
                    Suchmuster passen und $ausgabe[1] ein Array von Zeichenketten, die sich zwischen
                    Tags befinden.
                    
                    Enthält das Suchmuster benannte Teilsuchmuster, dann enthält $matches zusätzlich
                    Elemente mit dem Namen der Teilsuchmuster als Schlüssel.
                    
                    Enthält das Suchmuster doppelt benannte Teilsuchmuster, wird nur das letzte
                    Teilsuchmuster in $matches[NAME] gespeichert.
                    ]]>Das oben gezeigte Beispiel erzeugt folgende Ausgabe: [1] => bar
                    )
                    ]]>
                    
                    Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
                    
                    Ordnet die Ergebnisse so an, dass $matches[0] ein Array aus dem ersten Satz von
                    Übereinstimmungen ist, $matches[1] ein Array aus dem zweiten Satz von
                    Übereinstimmungen und so weiter.
                    ]]>Das oben gezeigte Beispiel erzeugt folgende Ausgabe:Beispiel: , Beispiel:
                    das ist ein Test, das ist ein Test
                    ]]>
                    
                    Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
                    
                    Wenn dieses Flag gesetzt ist, wird mit jeder gefundenen Übereinstimmung die
                    dazugehörige Position (in Bytes) in der Zeichenkette zurückgegeben. Zu beachten
                    ist, dass dies den Wert von <strong>$matches</strong> in ein Array von Arrays ändert, in dem
                    jedes Element ein Array ist, das aus der übereinstimmenden Zeichenkette als
                    Element <return>0</return> und deren Stelle in <strong>$subject</strong> als Element <return>1</return> besteht.
                    ]]>Das oben gezeigte Beispiel erzeugt folgende Ausgabe: Array ( [0] => Array (
                    [0] => foobarbaz [1] => 0 )
                     )
                     [1] => Array ( [0] => Array ( [0] => foo [1] => 0 )
                     )
                     [2] => Array ( [0] => Array ( [0] => bar [1] => 3 )
                     )
                     [3] => Array ( [0] => Array ( [0] => baz [1] => 6 )
                     )
                    
                    )
                    ]]>
                    
                    Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
                    
                    Wird dieses Flag angegeben werden nicht gefundene Teilsuchmuster als <info>null</info>
                    zurückgegeben; andernfalls werden sie als eine leere Zeichenkette (<info>String</info>)
                    zurückgegeben.
                    
                    Falls kein Flag für die Anordnung angegeben wurde, wird <info>PREG_PATTERN_ORDER</info>
                    angenommen.
  <info>array</info>   <strong>$matches</strong>  Wenn dieses Flag gesetzt ist, wird mit jeder gefundenen Übereinstimmung die
                    dazugehörige Position (in Bytes) in der Zeichenkette zurückgegeben. Zu beachten
                    ist, dass dies den Wert von <strong>$matches</strong> in ein Array von Arrays ändert, in dem
                    jedes Element ein Array ist, das aus der übereinstimmenden Zeichenkette als
                    Element <return>0</return> und deren Stelle in <strong>$subject</strong> als Element <return>1</return> besteht.
                    ]]>Das oben gezeigte Beispiel erzeugt folgende Ausgabe: Array ( [0] => Array (
                    [0] => foobarbaz [1] => 0 )
                     )
                     [1] => Array ( [0] => Array ( [0] => foo [1] => 0 )
                     )
                     [2] => Array ( [0] => Array ( [0] => bar [1] => 3 )
                     )
                     [3] => Array ( [0] => Array ( [0] => baz [1] => 6 )
                     )
                    
                    )
                    ]]>
                    
                    Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
  <info>int</info>     <strong>$offset</strong>   Normalerweise beginnt die Suche am Anfang der Zeichenkette. Der optionale
                    Parameter <strong>$offset</strong> kann verwendet werden, um eine andere Stelle in Bytes
                    anzugeben, ab der gesucht werden soll.
                    
                    Die Verwendung von <strong>$offset</strong> entspricht nicht der Übergabe von
                    substr($zeichenkette, $versatz) an Stelle der Zeichenkette an <strong>preg_match_all()</strong>,
                    weil <strong>$pattern</strong> Angaben wie ^, $ oder (?\<=x) enthalten kann. Für Beispiele siehe <strong>preg_match()</strong>.

<comment>Return:</comment>
  <info>int|false</info>  Gibt die Anzahl der Übereinstimmungen mit dem kompletten Suchmuster zurück (die auch
             Null sein kann). Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * PCRE-Suchmuster
   * <strong>preg_quote()</strong>
   * <strong>preg_match()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_split()</strong>
   * <strong>preg_last_error()</strong>


id: preg_quote
type: function
doc:
<comment>Description:</comment>
  Maskiert Zeichen regulärer Ausdrücke
  
  <strong>preg_quote()</strong> setzt einen Backslash vor jedes Zeichen von <strong>$str</strong>, das zur Syntax eines regulären
  Ausdrucks gehört. Das ist nützlich, wenn Sie einen Text nach Übereinstimmungen mit einer zur
  Laufzeit erzeugten Zeichenkette durchsuchen müssen, die spezielle RegEx-Zeichen enthalten könnte.
  
  Spezielle Zeichen regulärer Ausdrücke sind: <return>. \ + * ? [ ^ ] $ ( ) { } = ! \< &gt; | : - #</return>
  
  Es ist zu beachten, dass <return>/</return> kein besonderes RegEx-Zeichen ist.
  
  Es ist zu beachten, dass <strong>preg_quote()</strong> nicht dazu gedacht ist, auf die $replacement Zeichenkette(n)
  von <strong>preg_replace()</strong> etc. angewendet zu werden.

<comment>Param:</comment>
  <info>string</info>       <strong>$str</strong>        Die zu durchsuchende Zeichenkette
  <info>string|null</info>  <strong>$delimiter</strong>  Falls der optionale <strong>$delimiter</strong> angegeben wurde, wird dieser ebenfalls
                           maskiert. Das ist nützlich, um den Begrenzer zu maskieren, der von den
                           PCRE-Funktionen benötigt wird. Der <return>/</return> ist der am häufigsten verwendete
                           Begrenzer.

<comment>Return:</comment>
  <info>string</info>  Gibt die maskierte Zeichenkette zurück.

<comment>See Also:</comment>
   * PCRE-Suchmuster
   * <strong>escapeshellcmd()</strong>


id: preg_replace
type: function
doc:
<comment>Description:</comment>
  Sucht und ersetzt mit regulären Ausdrücken
  
  Durchsucht die Zeichenkette <strong>$subject</strong> nach Übereinstimmungen mit <strong>$pattern</strong> und ersetzt sie mit
  <strong>$replacement</strong>.
  
  Um eine konkrete Zeichenkette anstelle eines Musters zu finden, sollte <strong>str_replace()</strong> oder
  <strong>str_ireplace()</strong> anstelle dieser Funktion verwendet werden.

<comment>Param:</comment>
  <info>string|array</info>  <strong>$pattern</strong>      Der Ausdruck, nach dem gesucht wird. Es kann entweder eine
                              Zeichenkette oder ein Array mit Zeichenketten sein.
                              
                              Es stehen auch einige PCRE-Modifikatoren zur Verfügung.
  <info>string|array</info>  <strong>$replacement</strong>  Die Zeichenkette oder das Array mit Zeichenketten zum Ersetzen. Falls
                              dieser Parameter eine Zeichenkette ist und der Parameter <strong>$pattern</strong> ein
                              Array, werden alle Suchmuster durch diese Zeichenkette ersetzt. Falls
                              sowohl <strong>$pattern</strong> als auch <strong>$replacement</strong> Arrays sind, wird jedes
                              Suchmuster <strong>$pattern</strong> durch das Gegenstück aus <strong>$replacement</strong> ersetzt.
                              Wenn das <strong>$replacement</strong>-Array weniger Elemente hat als das
                              <strong>$pattern</strong>-Array, wird jedes überzählige <strong>$pattern</strong> durch die leere
                              Zeichenkette ersetzt.
                              
                              <strong>$replacement</strong> darf Referenzen in der Form <return>\n</return> oder <return>$n</return> enthalten, wobei
                              Letztere vorzuziehen ist. Jede dieser Referenzen wird mit dem Text
                              ersetzt, der vom n-ten eingeklammerten Suchmuster erfasst wurde. n
                              kann einen Wert von 0 bis 99 haben. <return>\0</return> oder <return>$0</return> beziehen sich auf den
                              Text, der auf das komplette Suchmuster passt. Um die Nummer des
                              erfassenden Teil-Suchmusters zu erhalten, werden öffnende Klammern mit
                              1 beginnend von links nach rechts gezählt. Es ist zu beachten, dass
                              Rückwärtsschrägstriche in String-Literalen ggf. maskiert werden
                              müssen.
                              
                              Wenn Sie mit einer Ersetzung arbeiten wollen, in der auf eine
                              Rückreferenzierung direkt eine weitere Zahl folgt (d. h. direkt nach
                              der Übereinstimmmung mit einem Suchmuster soll eine Zahl kommen),
                              können Sie für Ihre Rückreferenzierung nicht die Schreibweise <return>\1</return>
                              verwenden. So würde z. B. <return>\11</return> die Funktion <strong>preg_replace()</strong> verwirren,
                              weil sie nicht weiß, ob Sie die Rückreferenzierung <return>\1</return> gefolgt von der
                              Zahl <return>1</return> wollen oder nur die Rückreferenzierung <return>\11</return>. In diesem Fall ist
                              die Lösung, <return>${1}1</return> zu verwenden. Damit wird eine isolierte
                              Rückreferenzierung <return>$1</return> erzeugt und die <return>1</return> bleibt ein Buchstabensymbol.
                              
                              Wenn Sie den veralteten Modifikator <return>e</return> verwenden, maskiert diese
                              Funktion ein paar Zeichen (nämlich <return>'</return>, <return>"</return>, <return>\</return> und NULL) in den
                              Zeichenketten, mit denen die Rückreferenzierungen ersetzen werden. Das
                              wird gemacht, um sicherzustellen, dass keine Syntaxfehler entstehen,
                              wenn Rückreferenzierungen verwendet werden, die einfache oder doppelte
                              Anführungszeichen enthalten (z. B. <return>'strlen(\'$1\')+strlen("$2")'</return>).
                              Vergewissern Sie sich, dass Sie die Zeichenketten-Syntax von PHP
                              kennen, um genau zu wissen, wie die ausgewertete Zeichenkette
                              aussieht.
  <info>string|array</info>  <strong>$subject</strong>      Die Zeichenkette oder ein Array mit Zeichenketten zum Durchsuchen.
                              
                              Falls <strong>$subject</strong> ein Array ist, wird das Suchen und Ersetzen auf jedes
                              Element von <strong>$subject</strong> angewandt und der Rückgabewert ist ebenfalls ein
                              Array.
                              
                              Wenn das <strong>$subject</strong>-Array assoziativ ist, bleiben die Schlüssel im
                              zurückgegebenen Wert erhalten.
  <info>int</info>           <strong>$limit</strong>        Die maximal mögliche Anzahl von Ersetzungen für jedes Suchmuster in
                              jeder <strong>$subject</strong>. Standardmäßiger Wert: <return>-1</return> (kein Limit).
  <info>int</info>           <strong>$count</strong>        Falls angegeben, wird dieser Variable die Anzahl vorgenommener
                              Ersetzungen zugewiesen.

<comment>Return:</comment>
  <info>string|array|null</info>  <strong>preg_replace()</strong> gibt ein Array zurück, falls <strong>$subject</strong> ein Array ist, andernfalls
                     eine Zeichenkette.
                     
                     Falls Übereinstimmungen gefunden wurden, wird die neue Zeichenkette <strong>$subject</strong>
                     zurückgegeben, andernfalls wird <strong>$subject</strong> unverändert zurückgegeben oder <info>null</info>,
                     falls ein Fehler auftrat.

<comment>See Also:</comment>
   * PCRE-Suchmuster
   * <strong>preg_quote()</strong>
   * <strong>preg_filter()</strong>
   * <strong>preg_match()</strong>
   * <strong>preg_replace_callback()</strong>
   * <strong>preg_split()</strong>
   * <strong>preg_last_error()</strong>
   * <strong>str_replace()</strong>


id: preg_replace_callback
type: function
doc:
<comment>Description:</comment>
  Sucht und ersetzt mit regulären Ausdrücken unter Verwendung eines Callbacks
  
  Abgesehen von der Tatsache, dass statt des Parameters <strong>$replacement</strong> ein <strong>$callback</strong> angegeben werden
  soll, ist das Verhalten dieser Funktion identisch zu <strong>preg_replace()</strong>.

<comment>Param:</comment>
  <info>string|array</info>  <strong>$pattern</strong>   Der Ausdruck, nach dem gesucht werden soll. Es kann entweder eine
                           Zeichenkette oder ein Array mit Zeichenketten sein.
  <info>callable</info>      <strong>$callback</strong>  Ein Callback, dem ein Array von Übereinstimmungen mit <strong>$subject</strong> übergeben
                           wird. Der Callback sollte die Ersetzungs-Zeichenkette liefern. Dies ist
                           die Callback-Signatur:
                           
                           <info>string</info>handler<info>array</info><strong>$matches</strong>
                           
                           Häufig werden Sie die <strong>$callback</strong>-Funktion für <strong>preg_replace_callback()</strong> nur
                           an einer Stelle benötigen. In diesem Fall können Sie eine Anonyme
                           Funktion verwenden, um innerhalb des Aufrufs von <strong>preg_replace_callback()</strong>
                           den Callback zu deklarieren. Auf diese Weise haben Sie alle Informationen
                           für den Aufruf an einer Stelle und füllen den Namensraum für Funktionen
                           nicht mit Namen für Callback-Funktionen, die sonst nirgends verwendet
                           werden.
                           
                           <strong>preg_replace_callback()</strong> und Anonyme Funktion
                           ]]>
  <info>string|array</info>  <strong>$subject</strong>   Die Zeichenkette oder ein Array mit Zeichenketten zum Suchen und
                           Ersetzen.
  <info>int</info>           <strong>$limit</strong>     Die Höchstzahl der Ersetzungen für jedes Suchmuster in jeder
                           <strong>$subject</strong>-Zeichenkette. Standardmäßig <return>-1</return> (unbegrenzt).
  <info>int</info>           <strong>$count</strong>     Falls angegeben, wird dieser Variable die Anzahl vorgenommener
                           Ersetzungen zugewiesen.
  <info>int</info>           <strong>$flags</strong>     <strong>$flags</strong> ist eine Kombination der Flags <info>PREG_OFFSET_CAPTURE</info> und
                           <info>PREG_UNMATCHED_AS_NULL</info>, die das Format des matches-Arrays beeinflussen.
                           Details sind der Beschreibung in <strong>preg_match()</strong> zu entnehmen.

<comment>Return:</comment>
  <info>string|array|null</info>  Falls <strong>$subject</strong> ein Array ist, gibt <strong>preg_replace_callback()</strong> ein Array zurück und
                     andernfalls eine Zeichenkette. Bei einem Fehler ist der Rückgabewert <info>null</info>.
                     
                     Falls Übereinstimmungen gefunden werden, wird die neue Zeichenkette
                     zurückgegeben und andernfalls die unveränderte Zeichenkette <strong>$subject</strong>

<comment>See Also:</comment>
   * PCRE-Suchmuster
   * <strong>preg_replace_callback_array()</strong>
   * <strong>preg_quote()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_last_error()</strong>
   * Anonymous functions


id: preg_replace_callback_array
type: function
doc:
<comment>Description:</comment>
  Perform a regular expression search and replace using callbacks
  
  The behavior of this function is similar to <strong>preg_replace_callback()</strong>, except that callbacks are
  executed on a per-pattern basis.

<comment>Param:</comment>
  <info>array</info>         <strong>$pattern</strong>  An associative array mapping patterns (keys) to <info>callable</info>s (values).
  <info>string|array</info>  <strong>$subject</strong>  The string or an array with strings to search and replace.
  <info>int</info>           <strong>$limit</strong>    The maximum possible replacements for each pattern in each <strong>$subject</strong>
                          string. Defaults to <return>-1</return> (no limit).
  <info>int</info>           <strong>$count</strong>    If specified, this variable will be filled with the number of replacements
                          done.
  <info>int</info>           <strong>$flags</strong>    <strong>$flags</strong> can be a combination of the <info>PREG_OFFSET_CAPTURE</info> and
                          <info>PREG_UNMATCHED_AS_NULL</info> flags, which influence the format of the matches
                          array. See the description in <strong>preg_match()</strong> for more details.

<comment>Return:</comment>
  <info>string|array|null</info>  <strong>preg_replace_callback_array()</strong> returns an array if the <strong>$subject</strong> parameter is an
                     array, or a string otherwise. On errors the return value is <info>null</info>
                     
                     If matches are found, the new subject will be returned, otherwise <strong>$subject</strong> will
                     be returned unchanged.

<comment>See Also:</comment>
   * PCRE Patterns
   * <strong>preg_replace_callback()</strong>
   * <strong>preg_quote()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_last_error()</strong>
   * Anonymous functions


id: preg_split
type: function
doc:
<comment>Description:</comment>
  Zerlegt eine Zeichenkette anhand eines regulären Ausdrucks
  
  Zerlegt die angegebene Zeichenkette anhand eines regulären Ausdrucks.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  Der Ausdruck, nach dem gesucht werden soll, als Zeichenkette.
  <info>string</info>  <strong>$subject</strong>  Die zu zerlegende Zeichenkette.
  <info>int</info>     <strong>$limit</strong>    Falls angegeben, werden maximal <strong>$limit</strong> Teilzeichenketten zurückgegeben, wobei
                    der Rest der Zeichenkette in der letzten Teilzeichenkette abgelegt wird. Ein
                    <strong>$limit</strong> von -1 oder 0 bedeutet "kein Limit".
  <info>int</info>     <strong>$flags</strong>    <strong>$flags</strong> kann jede Kombination der folgenden Flags sein (verknüpft mit dem
                    bitweisen <return>|</return> Operator): <info>PREG_SPLIT_NO_EMPTY</info> Falls dieses Flag gesetzt ist, werden
                    von <strong>preg_split()</strong> nur die Teile zurückgegeben, die nicht leer sind.
                    <info>PREG_SPLIT_DELIM_CAPTURE</info> Falls dieses Flag gesetzt ist, werden auch die
                    eingeklammerten Ausdrücke des Trennsymbol-Suchmusters erfasst und zurückgegeben.
                    <info>PREG_SPLIT_OFFSET_CAPTURE</info> Falls dieses Flag gesetzt ist, wird mit jeder
                    gefundenen Übereinstimmung die dazugehörige Position in der Zeichenkette
                    zurückgegeben. Zu beachten ist, dass dies die Rückgabewerte in einem Array
                    dahingehend ändert, dass jedes Element ein Array ist, das aus der
                    übereinstimmenden Zeichenkette als Element <return>0</return> und deren Stelle in <strong>$subject</strong> als
                    Element <return>1</return> besteht.
                    
                    Falls dieses Flag gesetzt ist, werden von <strong>preg_split()</strong> nur die Teile
                    zurückgegeben, die nicht leer sind.
                    
                    Falls dieses Flag gesetzt ist, werden auch die eingeklammerten Ausdrücke des
                    Trennsymbol-Suchmusters erfasst und zurückgegeben.
                    
                    Falls dieses Flag gesetzt ist, wird mit jeder gefundenen Übereinstimmung die
                    dazugehörige Position in der Zeichenkette zurückgegeben. Zu beachten ist, dass
                    dies die Rückgabewerte in einem Array dahingehend ändert, dass jedes Element ein
                    Array ist, das aus der übereinstimmenden Zeichenkette als Element <return>0</return> und deren
                    Stelle in <strong>$subject</strong> als Element <return>1</return> besteht.
  <info>string</info>  <strong>$subject</strong>  Falls dieses Flag gesetzt ist, wird mit jeder gefundenen Übereinstimmung die
                    dazugehörige Position in der Zeichenkette zurückgegeben. Zu beachten ist, dass
                    dies die Rückgabewerte in einem Array dahingehend ändert, dass jedes Element ein
                    Array ist, das aus der übereinstimmenden Zeichenkette als Element <return>0</return> und deren
                    Stelle in <strong>$subject</strong> als Element <return>1</return> besteht.

<comment>Return:</comment>
  <info>array|false</info>  Gibt ein Array zurück, bestehend aus Teilzeichenketten der Zeichenkette <strong>$subject</strong>, die
               an den auf das Suchmuster <strong>$pattern</strong> passenden Stellen zerlegt wurde. Bei einem Fehler
               wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * PCRE-Suchmuster
   * <strong>preg_quote()</strong>
   * <strong>implode()</strong>
   * <strong>preg_match()</strong>
   * <strong>preg_match_all()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_last_error()</strong>


id: prev
type: function
doc:
<comment>Description:</comment>
  Setzt den internen Arrayzeiger um ein Element zurück
  
  Setzt den internen Zeiger eines Arrays um ein Element zurück.
  
  <strong>prev()</strong> verhält sich genauso wie <strong>next()</strong>, abgesehen davon, dass es den Zeiger um ein Element
  zurücksetzt, nicht nach vorne.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>  Das Eingabe-Array.

<comment>Return:</comment>
  <info>mixed</info>  Gibt den Wert des  Array-Elements vor der Position zurück, auf die der interne Zeiger
         gerade zeigt. Sind keine Elemente mehr vorhanden, wird <info>false</info> zurückgegeben.
         
         Diese Funktion kann sowohl das
         boolsche <info>false</info> zurückliefern, als auch einen nicht-boolschen Wert, welcher zu <info>false</info>
         ausgewertet wird.
         Weitere Informationen entnehmen Sie bitte dem Abschnitt über die
          boolschen Typen. Benutzen Sie deshalb
         den === Operator,
         um den Rückgabewert dieser Funktion zu überprüfen.

<comment>See Also:</comment>
   * <strong>current()</strong>
   * <strong>end()</strong>
   * <strong>next()</strong>
   * <strong>reset()</strong>
   * <strong>each()</strong>


id: print
type: function
doc:
<comment>Description:</comment>
  Ausgabe eines Strings
  
  Gibt <strong>$expression</strong> aus.
  
  <return>print</return> ist keine Funktion, sondern ein Sprachkonstrukt. Sein Argument ist der Ausdruck, der auf das
  Schlüsselwort <return>print</return> folgt, und wird nicht durch Klammern abgegrenzt.
  
  Der Hauptunterschied zu <return>echo</return> besteht darin, dass <return>print</return> nur ein einziges Argument entgegennimmt,
  und immer <return>1</return> zurückgibt.

<comment>Param:</comment>
  <info>string</info>  <strong>$expression</strong>  Der Ausdruck, der ausgegeben werden soll. Nicht-String-Werte werden in
                       Strings umgewandelt, auch wenn  die Direktive <return>strict_types</return> aktiviert ist.

<comment>Return:</comment>
  <info>int</info>  Gibt immer <return>1</return> zurück.

<comment>See Also:</comment>
   * <strong>echo()</strong>
   * <strong>printf()</strong>
   * <strong>flush()</strong>
   * Möglichkeiten literale Strings anzugeben


id: print_r
type: function
doc:
<comment>Description:</comment>
  Gibt Variablen-Informationen in lesbarer Form aus
  
  <strong>print_r()</strong> zeigt Informationen über eine Variable in menschenlesbarer Form an.
  
  <strong>print_r()</strong>, <strong>var_dump()</strong> und <strong>var_export()</strong> zeigen auch private und geschützte Eigenschaften von
  Objekten an. Statische Klasseneigenschaften werden hingegen nicht angezeigt.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>   Der auszugebende Ausdruck.
  <info>bool</info>   <strong>$return</strong>  Wenn Sie die Ausgabe von <strong>print_r()</strong> zum Weiterverarbeiten abfangen möchten,
                  benutzen Sie dazu den Parameter <strong>$return</strong>. Wenn dieser auf <info>true</info> gesetzt ist, gibt
                  <strong>print_r()</strong> die Information zurück, statt sie auszugeben.

<comment>Return:</comment>
  <info>string|bool</info>  Wenn die Funktion für eine Variable vom Typ <info>string</info>, <info>int</info> oder <info>float</info> aufgerufen wird,
               wird der Wert der Variablen angezeigt. Falls ein <info>array</info> übergeben wurde, werden die
               Werte in einem Format angezeigt, das sowohl die Schlüssel als auch die Elemente
               darstellt. Für Variablen vom Typ <info>object</info> gilt das Gleiche.
               
               Wenn der Parameter <strong>$return</strong> den Wert <info>true</info> hat, gibt die Funktion einen <info>String</info> zurück,
               andernfalls ist der Rückgabewert <info>true</info>.

<comment>See Also:</comment>
   * <strong>ob_start()</strong>
   * <strong>var_dump()</strong>
   * <strong>var_export()</strong>


id: printf
type: function
doc:
<comment>Description:</comment>
  Liefert einen formatierten String
  
  Erzeugt eine Ausgabe abhängig von <strong>$format</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  Der Formatstring setzt sich aus keiner oder mehreren Anweisungen zusammen:
                   Normale Zeichen (abgesehen von <return>%</return>), die direkt in das Ergebnis kopiert werden und
                   Konvertierungsanweisungen, die jeweils ihre eigenen Parameter abrufen.
                   
                   Eine Konvertierungsanweisung folgt diesem Prototypen:
                   <return>%[ArgNum$][Flags][Weite][.Präzision]Spezifizierer</return>.
                   
                   Eine Ganzzahl gefolgt von einem Dollarzeichen <return>$</return>, die die Nummer des Arguments
                   angibt, das für die Konversion verwendet werden soll.
                   
                   FlagsFlagBeschreibung<return>-</return> Linksbündig innerhalb der angegebenen Feldbreite;
                   Rechtsbündig ist der Standard <return>+</return> Positive Zahlen mit einem Pluszeichen <return>+</return>;
                   Standardmäßig werden nur negative Zahlen mit negativen Vorzeichen ausgegeben <return>
                   </return>(Leerzeichen) Füllt das Ergebnis mit Leerzeichen auf. Dies ist der Standard. <return>0</return>
                   Füllt nach Links mit Nullen auf. Mit dem <return>s</return>-Spezifizierer kann dies auch nach
                   rechts mit Nullen auffüllen. <return>'</return>(Zeichen) Füllt das Ergebnis mit dem angegebenen
                   Zeichen auf.
                   
                   Entweder eine Ganzzahl die angibt, wie viele Zeichen (Minimum) das
                   Konvertierungsergebnis haben soll oder <return>*</return>. Wenn <return>*</return> verwendet wird, wird die Breite
                   als zusätzlicher ganzzahliger Wert angegeben, der bestimmt, wie viele Zeichen vor
                   dem durch den Spezifizierer formatierten Wert stehen sollen.
                   
                   Ein Punkt <return>.</return>, optional gefolgt von einer Ganzzahl oder <return>*</return>, dessen Bedeutung vom
                   Spezifizierer abhängt:  Für die Spezifizierer <return>e</return>, <return>E</return>, <return>f</return> und <return>F</return>: Dies stellt die
                   Anzahl der Nachkommastellen an, die nach dem Dezimaltrennzeichen ausgegeben
                   werden soll (Standardmäßig ist dies 6).  Für die Spezifizierer <return>g</return>, <return>G</return>, <return>h</return> und <return>H</return>: Die
                   maximale Anzahl der auszugebenenden signifikanten Nachkommastellen.  Für den <return>s</return>
                   Spezifizierer: Verhält sich wie ein Abschneidepunkt, der eine maximale Anzahl an
                   Zeichen in der Zeichenkette angibt.   Wenn der Punkt ohne einen expliziten Wert
                   für die Genauigkeit angegeben wird, wird 0 angenommen. Wenn <return>*</return> verwendet wird,
                   wird die Genauigkeit als zusätzliche Ganzzahl vor dem durch den Bezeichner
                   formatierten Wert angegeben.
                   
                   Für die Spezifizierer <return>e</return>, <return>E</return>, <return>f</return> und <return>F</return>: Dies stellt die Anzahl der Nachkommastellen
                   an, die nach dem Dezimaltrennzeichen ausgegeben werden soll (Standardmäßig ist
                   dies 6).
                   
                   Für die Spezifizierer <return>g</return>, <return>G</return>, <return>h</return> und <return>H</return>: Die maximale Anzahl der auszugebenenden
                   signifikanten Nachkommastellen.
                   
                   Für den <return>s</return> Spezifizierer: Verhält sich wie ein Abschneidepunkt, der eine maximale
                   Anzahl an Zeichen in der Zeichenkette angibt.
                   
                   Wenn der Punkt ohne einen expliziten Wert für die Genauigkeit angegeben wird,
                   wird 0 angenommen. Wenn <return>*</return> verwendet wird, wird die Genauigkeit als zusätzliche
                   Ganzzahl vor dem durch den Bezeichner formatierten Wert angegeben.
                   
                   SpezifiziererSpezifiziererBeschreibung<return>%</return> Ein Prozentzeichen. Kein Parameter nötig.
                   <return>b</return> Der Parameter wird als Ganzzahl behandelt und als Binärzahl ausgegeben. <return>c</return> Der
                   Parameter wird als Ganzzahl behandelt und als Zeichen aus dem ASCII-Zeichensatz
                   ausgegeben. <return>d</return> Der Parameter wird als Ganzzahl behandelt und als
                   (vorzeichenbehaftete) Dezimalzahl ausgegeben. <return>e</return> Der Parameter wird als Zahl in
                   wissenschaftlicher Schreibweise (z. B. 1.2e+2) behandelt. <return>E</return> Wie der Spezifizierer
                   <return>e</return>, aber schreibt einen Großbuchstaben (z. B. 1.2E+2). <return>f</return> Der Parameter wird als
                   Gleitkommazahl betrachtet und als Gleitkommazahl ausgegeben (abhängig von der
                   Locale). <return>F</return> Der Parameter wird als Gleitkommazahl betrachtet und als
                   Gleitkommazahl (unabhängig von der Locale) ausgegeben. <return>g</return> Generelles Format.  Sei
                   P gleich der Genauigkeit, wenn nicht Null, 6, wenn die Genauigkeit nicht
                   angegeben ist, oder 1 wenn die Genauigkeit Null ist. Dann, wenn eine
                   Konvertierung mittels E einen Exponenten von X hätte:  Wenn P &gt; X ≥ −4,
                   erfolgt die Konvertierung mit Spezifizierer f und Genauigkeit P - (X + 1),
                   andernfalls mit Spezifizierer e und Genauigkeit P - 1. <return>G</return> Wie der Spezifizierer <return>g</return>,
                   aber es wird <return>E</return> und <return>f</return> verwendet. <return>h</return> Wie der Spezifizierer <return>g</return>, aber es werden <return>F</return>
                   verwendet. Verfügbar ab PHP 8.0.0. <return>H</return> Wie der Spezifizierer <return>g</return>, aber es werden <return>E</return>
                   und <return>F</return> verwendet. Verfügbar ab PHP 8.0.0. <return>o</return> Der Parameter wird als Ganzzahl
                   betrachtet und als Oktalzahl ausgegeben. <return>s</return> Der Parameter wird als Zeichenkette
                   betrachtet und ausgegeben. <return>u</return> Der Parameter wird als Ganzzahl betrachtet und als
                   vorzeichenlose Dezimalzahl ausgegeben. <return>x</return> Der Parameter wird als Ganzzahl
                   betrachtet und als Hexadezimalzahl (mit Kleinbuchstaben) ausgegeben. <return>X</return> Der
                   Parameter wird als Ganzzahl betrachtet und als Hexadezimalzahl (mit
                   Großbuchstaben) ausgegeben.
                   
                   Generelles Format.
                   
                   Sei P gleich der Genauigkeit, wenn nicht Null, 6, wenn die Genauigkeit nicht
                   angegeben ist, oder 1 wenn die Genauigkeit Null ist. Dann, wenn eine
                   Konvertierung mittels E einen Exponenten von X hätte:
                   
                   Wenn P &gt; X ≥ −4, erfolgt die Konvertierung mit Spezifizierer f und Genauigkeit
                   P - (X + 1), andernfalls mit Spezifizierer e und Genauigkeit P - 1.
                   
                   Der Spezifizierer <return>c</return> ignoriert Auffüllung und Weite.
                   
                   Der Versuch, die Kombination aus Zeichenketten mit Weite-Spezifizierern und
                   Zeichensätzen die mehr als ein Byte pro zeichen erwarten zu verwenden, führt zu
                   unvorhersehbaren Ergebnissen.
                   
                   Variablen werden auf einen für den Spezifizier passenden Typen umgewandelt:
                   Typ-BehandlungTypSpezifizierer<info>string</info><return>s</return><info>int</info><return>d</return>, <return>u</return>, <return>c</return>, <return>o</return>, <return>x</return>, <return>X</return>, <return>b</return><info>float</info><return>e</return>, <return>E</return>, <return>f</return>, <return>F</return>, <return>g</return>, <return>G</return>,
                   <return>h</return>, <return>H</return>
  <info>mixed</info>   <strong>$values</strong>  

<comment>Return:</comment>
  <info>int</info>  Gibt die Länge des ausgegebenen Strings zurück.

<comment>See Also:</comment>
   * <strong>print()</strong>
   * <strong>sprintf()</strong>
   * <strong>fprintf()</strong>
   * <strong>vprintf()</strong>
   * <strong>vsprintf()</strong>
   * <strong>vfprintf()</strong>
   * <strong>sscanf()</strong>
   * <strong>fscanf()</strong>
   * <strong>number_format()</strong>
   * <strong>date()</strong>
   * <strong>flush()</strong>


id: proc_close
type: function
doc:
<comment>Description:</comment>
  Schließt einen Prozess, der mit proc_open
     gestartet wurde und gibt den Exitcode dieses Prozesses zurück
  
  <strong>proc_close()</strong> entspricht <strong>pclose()</strong>, außer dass Die Funktion nur mit Prozessen arbeitet, die von
  <strong>proc_open()</strong> gestartet wurden. <strong>proc_close()</strong> wartet auf den zu beendenden Prozess und gibt seinen
  Exitcode zurück. Offene Pipes zu diesem Prozess werden geschlossen, wenn diese Funktion aufgerufen
  wird, um Deadlocks vorzubeugen - der Child-Prozess kann sich nicht beenden, solange noch Pipes
  geöffnet sind.

<comment>Param:</comment>
  <info>resource</info>  <strong>$process</strong>  Die zu schließende <strong>proc_open()</strong>-<info>Ressource</info>.

<comment>Return:</comment>
  <info>int</info>  Gibt den Termination-Status des gelaufenen Prozesses zurück. Falls ein Fehler auftritt wird
       <return>-1</return> zurückgegeben.
       
       Falls PHP mit der Option --enable-sigchild kompiliert wurde, ist die Rückgabe dieser Funktion
       nicht definiert.


id: proc_get_status
type: function
doc:
<comment>Description:</comment>
  Liefert Informationen über einen mit proc_open
     gestarteten Prozess
  
  <strong>proc_get_status()</strong> liefert Daten über einen Prozess, der unter Verwendung von <strong>proc_open()</strong> gestartet
  wurde.

<comment>Param:</comment>
  <info>resource</info>  <strong>$process</strong>  Die zu untersuchende <strong>proc_open()</strong>-<info>Ressource</info>.

<comment>Return:</comment>
  <info>array</info>  Im Erfolgsfall wird ein <info>Array</info> der gesammelten Informationen zurückgegeben. Das
         zurückgegebene Array enthält die folgenden Elemente:
         
         ElementTypBeschreibungcommand<info>string</info> Der Kommandostring, der an <strong>proc_open()</strong> übergeben wurde.
         pid<info>int</info>ProzessIDrunning<info>bool</info> Ist <info>true</info>, wenn der Prozess noch läuft, und <info>false</info> wenn er beendet
         wurde. signaled<info>bool</info> Ist <info>true</info>, wenn der Child-Prozess durch ein nicht erkanntes Signal
         beendet wurde. Unter Windows hat das Element immer den Wert <info>false</info>. stopped<info>bool</info> Ist <info>true</info>,
         wenn der Child-Prozess durch ein Signal gestoppt wurde. Unter Windows hat das Element immer
         den Wert <info>false</info>. exitcode<info>int</info> Der Exitcode, der vom Prozess zurückgegeben wurde (dieser ist
         nur aussagekräftig, wenn <return>running</return> <info>false</info> ist). Nur der erste Aufruf der Funktion gibt den
         richtigen Wert zurück, alle weiteren Aufrufe resultieren im Wert <return>-1</return>. termsig<info>int</info> Die
         Signalnummer die den Child-Prozess veranlasst hat, seine Ausführung abzubrechen (nur
         aussagekräftig, wenn <return>signaled</return> <info>true</info> ist). stopsig<info>int</info> Die Signalnummer, die den Child-Prozess
         veranlasst hat, seine Ausführung zu stoppen (nur aussagekräftig, wenn <return>stopped</return> <info>true</info> ist).

<comment>See Also:</comment>
   * <strong>proc_open()</strong>


id: proc_nice
type: function
doc:
<comment>Description:</comment>
  Ändert die Priorität des aktuellen Prozesses
  
  <strong>proc_nice()</strong> ändert die Priorität des aktuellen Prozesses um den in <strong>$priority</strong> angegebenen Betrag.
  Ein positives <strong>$priority</strong> vermindert die Priorität des aktuellen Prozesses, während ein negatives
  <strong>$priority</strong> die Priorität erhöht.
  
  <strong>proc_nice()</strong> ist in keiner Weise verwandt mit <strong>proc_open()</strong> und der dazugehörigen Funktionen.

<comment>Param:</comment>
  <info>int</info>  <strong>$priority</strong>  Der neue Prioritätswert; dieser Wert ist plattformabhängig.
                  
                  Unter Unix bedeutet ein niedriger Wert, wie beispielsweise <return>-20</return>, eine hohe
                  Priorität, wohingegen ein positiver Wert eine niedrigere Priorität hat.
                  
                  Unter Windows hat der Parameter <strong>$priority</strong> die folgende Bedeutung:

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben. Wenn ein Fehler
        auftritt, zum Beispiel weil der User keine Berechtigung hat, die Priorität eines Prozesses
        zu ändern, wird ein Fehler der Stufe <info>E_WARNING</info> erzeugt.

<comment>See Also:</comment>
   * <strong>pcntl_setpriority()</strong>


id: proc_open
type: function
doc:
<comment>Description:</comment>
  Führt ein Kommando aus und öffnet Dateizeiger für die Ein- und Ausgabe
    
  
  <strong>proc_open()</strong> ist äquivalent zu <strong>popen()</strong>, ermöglicht aber einen höheren Grad von Kontrolle über die
  Programmausführung.

<comment>Param:</comment>
  <info>array|string</info>  <strong>$command</strong>          Das auszuführende Kommandozeile als String. Sonderzeichen müssen
                                  ordnungsgemäß maskiert und Argumente ggf. in Anführungszeichen
                                  eingeschlossen werden.
                                  
                                  Unter Windows wird, falls <return>bypass_shell</return> in <strong>$options</strong> nicht auf <info>true</info>
                                  gesetzt ist, das <strong>$command</strong> mit dem Flag <return>/c</return> als nicht in
                                  Anführungszeichen eingeschlossene Zeichenkette (d. h. genau wie an
                                  <strong>proc_open()</strong> übergeben) an cmd.exe übergeben (genauer gesagt an
                                  <return>%ComSpec%</return>). Dies kann dazu führen, dass cmd.exe die umschließenden
                                  Anführungszeichen von <strong>$command</strong> entfernt (Details sind der
                                  Dokumentation von cmd.exe zu entnehmen), was zu unerwartetem und
                                  potentiell sogar gefährlichem Verhalten führen kann, da
                                  Fehlermeldungen von cmd.exe das übergebene <strong>$command</strong> oder Teile
                                  davon enthalten können (siehe Beispiel weiter unten).
                                  
                                  Von PHP 7.4.0 an kann <strong>$command</strong> als Array von Befehlsparametern
                                  übergeben werden. In diesem Fall wird der Prozess direkt gestartet
                                  (ohne Umweg über die Shell) und PHP kümmert sich um das nötige
                                  Maskieren der Argumente.
                                  
                                  Unter Windows erfolgt die Argumentenmaskierung der Array-Elemente
                                  unter der Annahme, dass das Parsen der Kommandozeile des
                                  auszuführenden Kommandos kompatibel ist mit dem Parsen der
                                  Kommandozeile durch die VC-Laufzeitumgebung.
  <info>array</info>         <strong>$descriptor_spec</strong>  Ein indexiertes Array, in dem die Schlüssel die Descriptornummer
                                  repräsentieren und die Werte die Art und Weise, in der PHP die
                                  Descriptoren an die Child-Prozesse übergibt. 0 steht dabei für
                                  stdin, 1 für stdout und 2 für stderr.
                                  
                                  Jedes Element kann sein:  Ein Array, das die Pipe beschreibt, die
                                  an den Prozess übergeben wird. Das erste Element ist der
                                  Descriptortyp, das zweite Element ist eine Option für den
                                  angegebenen Typ. Gültige Typen sind <return>pipe</return> (das zweite Element ist
                                  entweder <return>r</return>, um das Ende des Leseprozesses der Pipe an den Prozess
                                  zu übergeben, oder <return>w</return>, um das Ende des Schreibprozesses zu
                                  übergeben) und <return>file</return> (das zweite Element ist ein Dateiname). Es ist
                                  zu beachten, dass alles außer w wie r behandelt wird.  Eine
                                  Streamressource, die einen echten Filedescriptor repräsentiert
                                  (z. B. geöffnete Dateien, Sockets, <info>STDIN</info>).
                                  
                                  Die Filedescriptor-Nummern sind nicht limitiert auf 0, 1 und 2 -
                                  Sie können jede gültige Filedescriptor-Nummer angeben, die an den
                                  Kindprozess übergeben wird. Dies erlaubt es Ihrem Skript, mit
                                  anderen Skripten zu interagieren, die als "Co-Prozesse" laufen.
                                  Dies ist insbesondere dann nützlich, wenn Passwörter auf sichere
                                  Weise an Programme wie PGP, GPG und openssl übergeben werden
                                  sollen. Es ist ebenfalls nützlich, um Lesestatus-Informationen zu
                                  erhalten, die von diesen Programmen für zusätzliche
                                  Filedescriptoren ermittelt werden.
  <info>array</info>         <strong>$pipes</strong>            Enthält ein numerisches Array von Dateizeigern, die der PHP-Seite
                                  jeder erstellten Pipe entsprechen.
  <info>string|null</info>   <strong>$cwd</strong>              Das initiale Arbeitsverzeichnis des Kommandos. Dies muss ein
                                  absoluter Pfadname sein. Wenn Sie den Standardwert verwenden
                                  möchten (dies wäre das Arbeitsverzeichnis des aktuellen
                                  PHP-Prozesses), muss der Wert <info>null</info> sein.
  <info>array|null</info>    <strong>$env_vars</strong>         Ein Array mit den Umgebungsvariablen für das auszuführende
                                  Kommando, oder <info>null</info>, wenn Sie die gleiche Umgebung wie der
                                  aktuelle PHP-Prozess nutzen wollen.
  <info>array|null</info>    <strong>$options</strong>          Erlaubt Ihnen, zusätzliche Optionen anzugeben. Derzeit
                                  unterstützte Optionen sind: <return>suppress_errors</return> (nur unter Windows):
                                  Unterdrückt Fehlermeldungen, die durch diese Funktion
                                  hervorgerufen werden, sofern der Wert auf <info>true</info> gesetzt wurde.
                                  <return>bypass_shell</return> (nur unter Windows): umgeht die <return>cmd.exe</return>-Shell, wenn
                                  der Wert auf <info>true</info> gesetzt wurde. <return>blocking_pipes</return> (nur unter
                                  Windows): erzwingt blockierende Pipes, wenn der Wert auf <info>true</info>
                                  gesetzt wurde. <return>create_process_group</return> (nur unter Windows):
                                  ermöglicht dem Kindprozess <return>CTRL</return> Ereignisse zu behandeln, wenn der
                                  Wert auf <info>true</info> gesetzt wurde. <return>create_new_console</return> (nur unter
                                  Windows): der neue Prozess hat eine neue Konsole anstatt die
                                  Konsole des Elternprozesses zu erben

<comment>Return:</comment>
  <info>resource|false</info>  Gibt eine Ressource zurück, die den Prozess repräsentiert, der unter Verwendung
                  von <strong>proc_close()</strong> freigegeben werden soll, wenn Sie ihn beenden. Im Fehlerfall wird
                  <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>popen()</strong>
   * <strong>exec()</strong>
   * <strong>system()</strong>
   * <strong>passthru()</strong>
   * <strong>stream_select()</strong>
   * Der Backtick-Operator


id: proc_terminate
type: function
doc:
<comment>Description:</comment>
  Beendet einen von proc_open gestarteten Prozess
  
  Signalisiert dem <strong>$process</strong> (der mittels <strong>proc_open()</strong> gestartet wurde), dass er sich beenden soll.
  <strong>proc_terminate()</strong> kommt sofort zurück und wartet nicht auf den zu terminierenden Prozess.
  
  <strong>proc_terminate()</strong> erlaubt es Ihnen, einen Prozess zu beenden und mit anderen Tasks fortzufahren.
  Sie können den Prozess unter Verwendung der Funktion <strong>proc_get_status()</strong> pollen (wenn Sie sehen
  wollen, ob er bereits beendet wurde).

<comment>Param:</comment>
  <info>resource</info>  <strong>$process</strong>  Die <strong>proc_open()</strong>-<info>Ressource</info>, die geschlossen werden soll.
  <info>int</info>       <strong>$signal</strong>   Dieser optionale Parameter ist nur sinnvoll auf POSIX-basierten
                      Betriebssystemen; Sie können ein Signal angeben, das unter Verwendung des
                      <return>kill(2)</return>-Systemaufrufs an den Prozess gesendet wird. Der Standardwert ist
                      <return>SIGTERM</return>.

<comment>Return:</comment>
  <info>bool</info>  Gibt den Terminationstatus des laufenden Prozesses zurück.

<comment>See Also:</comment>
   * <strong>proc_open()</strong>
   * <strong>proc_close()</strong>
   * <strong>proc_get_status()</strong>


id: property_exists
type: function
doc:
<comment>Description:</comment>
  Prüft auf die Existenz einer Eigenschaft eines Objektes bzw. einer Klasse
  
  Prüft ob die Eigenschaft <strong>$property</strong> in der angegebenen Klasse existiert.
  
  Anders als <strong>isset()</strong> gibt  <strong>property_exists()</strong> auch dann <info>true</info> zurück, wenn eine Eigenschaft den Wert
  <info>null</info> hat.

<comment>Param:</comment>
  <info>object|string</info>  <strong>$object_or_class</strong>  Objektexemplar oder Name der Klasse.
  <info>string</info>         <strong>$property</strong>         Name der zu prüfenden Eigenschaft.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn die Eigenschaft existiert, <info>false</info> wenn nicht, und <info>null</info> im Fehlerfall.

<comment>See Also:</comment>
   * <strong>method_exists()</strong>


id: ps_add_bookmark
type: function
doc:
<comment>Description:</comment>
  Add bookmark to current page
  
  Adds a bookmark for the current page. Bookmarks usually appear in PDF-Viewers left of the page in
  a hierarchical tree. Clicking on a bookmark will jump to the given page.
  
  Diese Notiz
  wird nicht sichtbar sein, wenn das Dokument gedruckt oder betrachtet wird. Sie
  wird aber sichtbar sein, wenn das Dokument entweder mit Acrobat Distiller™
  oder Ghostview zu PDF konvertiert wird.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>    The text used for displaying the bookmark.
  <info>int</info>       <strong>$parent</strong>  A bookmark previously created by this function which is used as the parent of
                     the new bookmark.
  <info>int</info>       <strong>$open</strong>    If <strong>$open</strong> is unequal to zero the bookmark will be shown open by the pdf viewer.

<comment>Return:</comment>
  <info>int</info>  The returned value is a reference for the bookmark. It is only used if the bookmark shall be
       used as a parent. The value is greater zero if the function succeeds. In case of an error
       zero will be returned.

<comment>See Also:</comment>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_pdflink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_launchlink
type: function
doc:
<comment>Description:</comment>
  Adds link which launches file
  
  Places a hyperlink at the given position pointing to a file program which is being started when
  clicked on. The hyperlink's source position is a rectangle with its lower left corner at (llx,
  lly) and its upper right corner at (urx, ury). The rectangle has by default a thin blue border.
  
  Diese Notiz
  wird nicht sichtbar sein, wenn das Dokument gedruckt oder betrachtet wird. Sie
  wird aber sichtbar sein, wenn das Dokument entweder mit Acrobat Distiller™
  oder Ghostview zu PDF konvertiert wird.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$llx</strong>       The x-coordinate of the lower left corner.
  <info>float</info>     <strong>$lly</strong>       The y-coordinate of the lower left corner.
  <info>float</info>     <strong>$urx</strong>       The x-coordinate of the upper right corner.
  <info>float</info>     <strong>$ury</strong>       The y-coordinate of the upper right corner.
  <info>string</info>    <strong>$filename</strong>  The path of the program to be started, when the link is clicked on.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_add_locallink()</strong>
   * <strong>ps_add_pdflink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_locallink
type: function
doc:
<comment>Description:</comment>
  Adds link to a page in the same document
  
  Places a hyperlink at the given position pointing to a page in the same document. Clicking on the
  link will jump to the given page. The first page in a document has number 1.
  
  The hyperlink's source position is a rectangle with its lower left corner at (<strong>$llx</strong>, <strong>$lly</strong>) and its
  upper right corner at (<strong>$urx</strong>, <strong>$ury</strong>). The rectangle has by default a thin blue border.
  
  Diese Notiz
  wird nicht sichtbar sein, wenn das Dokument gedruckt oder betrachtet wird. Sie
  wird aber sichtbar sein, wenn das Dokument entweder mit Acrobat Distiller™
  oder Ghostview zu PDF konvertiert wird.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$llx</strong>    The x-coordinate of the lower left corner.
  <info>float</info>     <strong>$lly</strong>    The y-coordinate of the lower left corner.
  <info>float</info>     <strong>$urx</strong>    The x-coordinate of the upper right corner.
  <info>float</info>     <strong>$ury</strong>    The y-coordinate of the upper right corner.
  <info>int</info>       <strong>$page</strong>   The number of the page displayed when clicking on the link.
  <info>string</info>    <strong>$dest</strong>   The parameter <strong>$dest</strong> determines how the document is being viewed. It can be
                    <return>fitpage</return>, <return>fitwidth</return>, <return>fitheight</return>, or <return>fitbbox</return>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_pdflink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_note
type: function
doc:
<comment>Description:</comment>
  Adds note to current page
  
  Adds a note at a certain position on the page. Notes are like little rectangular sheets with text
  on it, which can be placed anywhere on a page. They are shown either folded or unfolded. If
  folded, the specified icon is used as a placeholder.
  
  Diese Notiz
  wird nicht sichtbar sein, wenn das Dokument gedruckt oder betrachtet wird. Sie
  wird aber sichtbar sein, wenn das Dokument entweder mit Acrobat Distiller™
  oder Ghostview zu PDF konvertiert wird.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$llx</strong>       The x-coordinate of the lower left corner.
  <info>float</info>     <strong>$lly</strong>       The y-coordinate of the lower left corner.
  <info>float</info>     <strong>$urx</strong>       The x-coordinate of the upper right corner.
  <info>float</info>     <strong>$ury</strong>       The y-coordinate of the upper right corner.
  <info>string</info>    <strong>$contents</strong>  The text of the note.
  <info>string</info>    <strong>$title</strong>     The title of the note as displayed in the header of the note.
  <info>string</info>    <strong>$icon</strong>      The icon shown if the note is folded. This parameter can be set to <return>comment</return>,
                       <return>insert</return>, <return>note</return>, <return>paragraph</return>, <return>newparagraph</return>, <return>key</return>, or <return>help</return>.
  <info>int</info>       <strong>$open</strong>      If <strong>$open</strong> is unequal to zero the note will be shown unfolded after opening the
                       document with a pdf viewer.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_add_pdflink()</strong>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_locallink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_pdflink
type: function
doc:
<comment>Description:</comment>
  Adds link to a page in a second pdf document
  
  Places a hyperlink at the given position pointing to a second pdf document. Clicking on the link
  will branch to the document at the given page. The first page in a document has number 1.
  
  The hyperlink's source position is a rectangle with its lower left corner at (<strong>$llx</strong>, <strong>$lly</strong>) and its
  upper right corner at (<strong>$urx</strong>, <strong>$ury</strong>). The rectangle has by default a thin blue border.
  
  Diese Notiz
  wird nicht sichtbar sein, wenn das Dokument gedruckt oder betrachtet wird. Sie
  wird aber sichtbar sein, wenn das Dokument entweder mit Acrobat Distiller™
  oder Ghostview zu PDF konvertiert wird.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$llx</strong>       The x-coordinate of the lower left corner.
  <info>float</info>     <strong>$lly</strong>       The y-coordinate of the lower left corner.
  <info>float</info>     <strong>$urx</strong>       The x-coordinate of the upper right corner.
  <info>float</info>     <strong>$ury</strong>       The y-coordinate of the upper right corner.
  <info>string</info>    <strong>$filename</strong>  The name of the pdf document to be opened when clicking on this link.
  <info>int</info>       <strong>$page</strong>      The page number of the destination pdf document
  <info>string</info>    <strong>$dest</strong>      The parameter <strong>$dest</strong> determines how the document is being viewed. It can be
                       <return>fitpage</return>, <return>fitwidth</return>, <return>fitheight</return>, or <return>fitbbox</return>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_locallink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_weblink
type: function
doc:
<comment>Description:</comment>
  Adds link to a web location
  
  Places a hyperlink at the given position pointing to a web page. The  hyperlink's source position
  is a rectangle with its lower left corner at (<strong>$llx</strong>, <strong>$lly</strong>) and its upper right corner at (<strong>$urx</strong>,
  <strong>$ury</strong>). The rectangle has by default a thin blue border.
  
  Diese Notiz
  wird nicht sichtbar sein, wenn das Dokument gedruckt oder betrachtet wird. Sie
  wird aber sichtbar sein, wenn das Dokument entweder mit Acrobat Distiller™
  oder Ghostview zu PDF konvertiert wird.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$llx</strong>    The x-coordinate of the lower left corner.
  <info>float</info>     <strong>$lly</strong>    The y-coordinate of the lower left corner.
  <info>float</info>     <strong>$urx</strong>    The x-coordinate of the upper right corner.
  <info>float</info>     <strong>$ury</strong>    The y-coordinate of the upper right corner.
  <info>string</info>    <strong>$url</strong>    The url of the hyperlink to be opened when clicking on this link, e.g.
                    <return>http://www.php.net</return>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_locallink()</strong>
   * <strong>ps_add_pdflink()</strong>


id: ps_arc
type: function
doc:
<comment>Description:</comment>
  Draws an arc counterclockwise
  
  Draws a portion of a circle with at middle point at (<strong>$x</strong>, <strong>$y</strong>). The arc starts at an angle of <strong>$alpha</strong>
  and ends at an angle of <strong>$beta</strong>. It is drawn counterclockwise (use <strong>ps_arcn()</strong> to draw clockwise). The
  subpath added to the current path starts on the arc at angle <strong>$alpha</strong> and ends on the arc at angle
  <strong>$beta</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>       The x-coordinate of the circle's middle point.
  <info>float</info>     <strong>$y</strong>       The y-coordinate of the circle's middle point.
  <info>float</info>     <strong>$radius</strong>  The radius of the circle
  <info>float</info>     <strong>$alpha</strong>   The start angle given in degrees.
  <info>float</info>     <strong>$beta</strong>    The end angle given in degrees.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_arcn()</strong>


id: ps_arcn
type: function
doc:
<comment>Description:</comment>
  Draws an arc clockwise
  
  Draws a portion of a circle with at middle point at (<strong>$x</strong>, <strong>$y</strong>). The arc starts at an angle of <strong>$alpha</strong>
  and ends at an angle of <strong>$beta</strong>. It is drawn clockwise (use <strong>ps_arc()</strong> to draw counterclockwise). The
  subpath added to the current path starts on the arc at angle <strong>$beta</strong> and ends on the arc at angle
  <strong>$alpha</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>       The x-coordinate of the circle's middle point.
  <info>float</info>     <strong>$y</strong>       The y-coordinate of the circle's middle point.
  <info>float</info>     <strong>$radius</strong>  The radius of the circle
  <info>float</info>     <strong>$alpha</strong>   The starting angle given in degrees.
  <info>float</info>     <strong>$beta</strong>    The end angle given in degrees.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_arc()</strong>


id: ps_begin_page
type: function
doc:
<comment>Description:</comment>
  Start a new page
  
  Starts a new page. Although the parameters <strong>$width</strong> and <strong>$height</strong> imply a different page size for each
  page, this is not possible in PostScript. The first call of <strong>ps_begin_page()</strong> will set the page size
  for the whole document. Consecutive calls will have no effect, except for creating a new page. The
  situation is different if you intent to convert the PostScript document into PDF. This function
  places pdfmarks into the document which can set the size for each page indiviually. The resulting
  PDF document will have different page sizes.
  
  Though PostScript does not know different page sizes, pslib places a bounding box for each page
  into the document. This size is evaluated by some PostScript viewers and will have precedence over
  the BoundingBox in the Header of the document. This can lead to unexpected results when you set a
  BoundingBox whose lower left corner is not (0, 0), because the bounding box of the page will
  always have a lower left corner (0, 0) and overwrites the global setting.
  
  Each page is encapsulated into save/restore. This means, that most of the settings made on one
  page will not be retained on the next page.
  
  If there is up to the first call of <strong>ps_begin_page()</strong> no call of <strong>ps_findfont()</strong>, then the header of
  the PostScript document will be output and the bounding box will be set to the size of the first
  page. The lower left corner of the bounding box is set to (0, 0). If <strong>ps_findfont()</strong> was called
  before, then the header has been output already, and the document will not have a valid bounding
  box. In order to prevent this, one should call <strong>ps_set_info()</strong> to set the info field <return>BoundingBox</return> and
  possibly <return>Orientation</return> before any <strong>ps_findfont()</strong> or <strong>ps_begin_page()</strong> calls.
  
  Up to version 0.2.6 of pslib, this function will always overwrite the BoundingBox and Orientation,
  if it has been set before with <strong>ps_set_info()</strong> and <strong>ps_findfont()</strong> has not been called before.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$width</strong>   The width of the page in pixel, e.g. 596 for A4 format.
  <info>float</info>     <strong>$height</strong>  The height of the page in pixel, e.g. 842 for A4 format.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_end_page()</strong>
   * <strong>ps_findfont()</strong>
   * <strong>ps_set_info()</strong>


id: ps_begin_pattern
type: function
doc:
<comment>Description:</comment>
  Start a new pattern
  
  Starts a new pattern. A pattern is like a page containing e.g. a drawing which can be used for
  filling areas. It is used like a color by calling <strong>ps_setcolor()</strong> and setting the color space to
  <return>pattern</return>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>      Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$width</strong>      The width of the pattern in pixel.
  <info>float</info>     <strong>$height</strong>     The height of the pattern in pixel.
  <info></info>          <strong>$x-step</strong>     The distance in pixel of placements of the pattern in horizontal direction.
  <info></info>          <strong>$y-step</strong>     The distance in pixel of placements of the pattern in vertical direction.
  <info>int</info>       <strong>$painttype</strong>  Must be 1 or 2.

<comment>Return:</comment>
  <info>int|false</info>  The identifier of the pattern Bei einem Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>ps_end_pattern()</strong>
   * <strong>ps_setcolor()</strong>
   * <strong>ps_shading_pattern()</strong>


id: ps_begin_template
type: function
doc:
<comment>Description:</comment>
  Start a new template
  
  Starts a new template. A template is called a form in the postscript language. It is created
  similar to a pattern but used like an image. Templates are often used for drawings which are
  placed several times through out the document, e.g. like a company logo. All drawing functions may
  be used within a template. The template will not be drawn until it is placed by <strong>ps_place_image()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$width</strong>   The width of the template in pixel.
  <info>float</info>     <strong>$height</strong>  The height of the template in pixel.

<comment>Return:</comment>
  <info>int</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_end_template()</strong>


id: ps_circle
type: function
doc:
<comment>Description:</comment>
  Draws a circle
  
  Draws a circle with its middle point at (<strong>$x</strong>, <strong>$y</strong>). The circle starts and ends at position
  (<strong>$x</strong>+<strong>$radius</strong>, <strong>$y</strong>). If this function is called outside a path it will start a new path. If it is
  called within a path it will add the circle as a subpath. If the last drawing operation does not
  end in point (<strong>$x</strong>+<strong>$radius</strong>, <strong>$y</strong>) then there will be a gap in the path.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>       The x-coordinate of the circle's middle point.
  <info>float</info>     <strong>$y</strong>       The y-coordinate of the circle's middle point.
  <info>float</info>     <strong>$radius</strong>  The radius of the circle

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_arc()</strong>
   * <strong>ps_arcn()</strong>


id: ps_clip
type: function
doc:
<comment>Description:</comment>
  Clips drawing to current path
  
  Takes the current path and uses it to define the border of a clipping area. Everything drawn
  outside of that area will not be visible.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_closepath()</strong>


id: ps_close
type: function
doc:
<comment>Description:</comment>
  Closes a PostScript document
  
  Closes the PostScript document.
  
  This function writes the trailer of the PostScript document. It also writes the bookmark tree.
  <strong>ps_close()</strong> does not free any resources, which is done by <strong>ps_delete()</strong>.
  
  This function is also called by <strong>ps_delete()</strong> if it has not been called before.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_open_file()</strong>
   * <strong>ps_delete()</strong>


id: ps_close_image
type: function
doc:
<comment>Description:</comment>
  Closes image and frees memory
  
  Closes an image and frees its resources. Once an image is closed it cannot be used anymore.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>    Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$imageid</strong>  Resource identifier of the image as returned by <strong>ps_open_image()</strong> or
                      <strong>ps_open_image_file()</strong>.

<comment>Return:</comment>
  <info>void|false</info>  Returns <info>null</info> on successBei einem Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>ps_open_image()</strong>
   * <strong>ps_open_image_file()</strong>


id: ps_closepath
type: function
doc:
<comment>Description:</comment>
  Closes path
  
  Connects the last point with the first point of a path. The resulting path can be used for
  stroking, filling, clipping, etc..

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_clip()</strong>
   * <strong>ps_closepath_stroke()</strong>


id: ps_closepath_stroke
type: function
doc:
<comment>Description:</comment>
  Closes and strokes path
  
  Connects the last point with first point of a path and draws the resulting closed line.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_closepath()</strong>


id: ps_continue_text
type: function
doc:
<comment>Description:</comment>
  Continue text in next line
  
  Output a text one line below the last line. The line spacing is taken from the value "leading"
  which must be set with <strong>ps_set_value()</strong>. The actual position of the text is determined by the values
  "textx" and "texty" which can be requested with <strong>ps_get_value()</strong>

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>   The text to output.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_show()</strong>
   * <strong>ps_show_xy()</strong>
   * <strong>ps_show_boxed()</strong>


id: ps_curveto
type: function
doc:
<comment>Description:</comment>
  Draws a curve
  
  Add a section of a cubic Bézier curve described by the three given control points to the current
  path.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x1</strong>     x-coordinate of first control point.
  <info>float</info>     <strong>$y1</strong>     y-coordinate of first control point.
  <info>float</info>     <strong>$x2</strong>     x-coordinate of second control point.
  <info>float</info>     <strong>$y2</strong>     y-coordinate of second control point.
  <info>float</info>     <strong>$x3</strong>     x-coordinate of third control point.
  <info>float</info>     <strong>$y3</strong>     y-coordinate of third control point.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_lineto()</strong>


id: ps_delete
type: function
doc:
<comment>Description:</comment>
  Deletes all resources of a PostScript document
  
  Mainly frees memory used by the document. Also closes a file, if it was not closed before with
  <strong>ps_close()</strong>. You should in any case close the file with <strong>ps_close()</strong> before, because <strong>ps_close()</strong> not
  just closes the file but also outputs a trailor containing PostScript comments like the number of
  pages in the document and adding the bookmark hierarchy.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_close()</strong>


id: ps_end_page
type: function
doc:
<comment>Description:</comment>
  End a page
  
  Ends a page which was started with <strong>ps_begin_page()</strong>. Ending a page will leave the current drawing
  context, which e.g. requires to reload fonts if they were loading within the page, and to set many
  other drawing parameters like the line width, or color.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_begin_page()</strong>


id: ps_end_pattern
type: function
doc:
<comment>Description:</comment>
  End a pattern
  
  Ends a pattern which was started with <strong>ps_begin_pattern()</strong>. Once a pattern has been ended, it can be
  used like a color to fill areas.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_begin_pattern()</strong>


id: ps_end_template
type: function
doc:
<comment>Description:</comment>
  End a template
  
  Ends a template which was started with <strong>ps_begin_template()</strong>. Once a template has been ended, it can
  be used like an image.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_begin_template()</strong>


id: ps_fill
type: function
doc:
<comment>Description:</comment>
  Fills the current path
  
  Fills the path constructed with previously called drawing functions like <strong>ps_lineto()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_fill_stroke()</strong>
   * <strong>ps_stroke()</strong>


id: ps_fill_stroke
type: function
doc:
<comment>Description:</comment>
  Fills and strokes the current path
  
  Fills and draws the path constructed with previously called drawing functions like <strong>ps_lineto()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_fill()</strong>
   * <strong>ps_stroke()</strong>


id: ps_findfont
type: function
doc:
<comment>Description:</comment>
  Loads a font
  
  Loads a font for later use. Before text is output with a loaded font it must be set with
  <strong>ps_setfont()</strong>. This function needs the adobe font metric file in order to calculate the space used
  up by the characters. A font which is loaded within a page will only be available on that page.
  Fonts which are to be used in the complete document have to be loaded before the first call of
  <strong>ps_begin_page()</strong>. Calling <strong>ps_findfont()</strong> between pages will make that font available for all
  following pages.
  
  The name of the afm file must be <strong>$fontname</strong><return>.afm</return>. If the font shall be embedded the file
  <strong>$fontname</strong><return>.pfb</return> containing the font outline must be present as well.
  
  Calling <strong>ps_findfont()</strong> before the first page requires to output the postscript header which
  includes the BoundingBox for the whole document. Usually the BoundingBox is set with the first
  call of <strong>ps_begin_page()</strong> which now comes after <strong>ps_findfont()</strong>. Consequently the BoundingBox has not
  been set and a warning will be issued when <strong>ps_findfont()</strong> is called. In order to prevent this
  situation, one should call <strong>ps_set_parameter()</strong> to set the BoundingBox before <strong>ps_findfont()</strong> is
  called.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$fontname</strong>  The name of the font.
  <info>string</info>    <strong>$encoding</strong>  <strong>ps_findfont()</strong> will try to load the file passed in the parameter <strong>$encoding</strong>.
                       Encoding files are of the same syntax as those used by dvips(1). They contain
                       a font encoding vector (which is currently not used but must be present) and
                       a list of extra ligatures to extend the list of ligatures derived from the
                       afm file.
                       
                       <strong>$encoding</strong> can be <info>null</info> or the empty string if the default encoding (TeXBase1)
                       shall be used.
                       
                       If the encoding is set to <return>builtin</return> then there will be no reencoding and the
                       font specific encoding will be used. This is very useful with symbol fonts.
  <info>bool</info>      <strong>$embed</strong>     If set to a value &gt;0 the font will be embedded into the document. This
                       requires the font outline (.pfb file) to be present.

<comment>Return:</comment>
  <info>int</info>  Returns the identifier of the font or zero in case of an error. The identifier is a positive
       number.

<comment>See Also:</comment>
   * <strong>ps_begin_page()</strong>
   * <strong>ps_setfont()</strong>


id: ps_get_buffer
type: function
doc:
<comment>Description:</comment>
  Fetches the full buffer containig the generated PS data
  
  This function is not implemented yet. It will always return an empty string. The idea for a later
  implementation is to write the contents of the postscript file into an internal buffer if in
  memory creation is requested, and retrieve the buffer content with this function. Currently,
  documents created in memory are send to the browser without buffering.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>string</info>  

<comment>See Also:</comment>
   * <strong>ps_open_file()</strong>


id: ps_get_parameter
type: function
doc:
<comment>Description:</comment>
  Gets certain parameters
  
  Gets several parameters which were directly set by <strong>ps_set_parameter()</strong> or indirectly by one of the
  other functions. Parameters are by definition string values. This function cannot be used to
  retrieve resources which were also set by <strong>ps_set_parameter()</strong>.
  
  The parameter <strong>$name</strong> can have the following values.
  
  <return>fontname</return> The name of the currently active font or the font whose identifier is passed in parameter
  <strong>$modifier</strong>. <return>fontencoding</return> The encoding of the currently active font. <return>dottedversion</return> The version of
  the underlying pslib library in the format \<major&gt;.\<minor&gt;.\<subminor&gt; <return>scope</return> The current drawing scope. Can be object, document, null, page, pattern, path, template, prolog, font, glyph. <return>ligaturedisolvechar</return> The character which dissolves a ligature. If your are using a font which contains the ligature `ff' and `|' is the char to dissolve the ligature, then `f|f' will result in two `f' instead of the ligature `ff'. <return>imageencoding</return> The encoding used for encoding images. Can be either <return>hex</return> or <return>85</return>. hex encoding uses two bytes in the postscript file each byte in the image. 85 stand for Ascii85 encoding. <return>linenumbermode</return> Set to <return>paragraph</return> if lines are numbered within a paragraph or <return>box</return> if they are numbered within the surrounding box. <return>linebreak</return> Only used if text is output with <strong>ps_show_boxed()</strong>. If set to <info>true</info> a carriage return will add a line break. <return>parbreak</return> Only used if text is output with <strong>ps_show_boxed()</strong>. If set to <info>true</info> a carriage return will start a new paragraph. <return>hyphenation</return> Only used if text is output with <strong>ps_show_boxed()</strong>. If set to <info>true</info> the paragraph will be hyphenated if a hypen dictionary is set and exists. <return>hyphendict</return> Filename of the dictionary used for hyphenation pattern.
  
  The name of the currently active font or the font whose identifier is passed in parameter
  <strong>$modifier</strong>.
  
  The encoding of the currently active font.
  
  The version of the underlying pslib library in the format \<major&gt;.\<minor&gt;.\<subminor&gt;
  
  The current drawing scope. Can be object, document, null, page, pattern, path, template, prolog,
  font, glyph.
  
  The character which dissolves a ligature. If your are using a font which contains the ligature
  `ff' and `|' is the char to dissolve the ligature, then `f|f' will result in two `f' instead of
  the ligature `ff'.
  
  The encoding used for encoding images. Can be either <return>hex</return> or <return>85</return>. hex encoding uses two bytes in the
  postscript file each byte in the image. 85 stand for Ascii85 encoding.
  
  Set to <return>paragraph</return> if lines are numbered within a paragraph or <return>box</return> if they are numbered within the
  surrounding box.
  
  Only used if text is output with <strong>ps_show_boxed()</strong>. If set to <info>true</info> a carriage return will add a line
  break.
  
  Only used if text is output with <strong>ps_show_boxed()</strong>. If set to <info>true</info> a carriage return will start a
  new paragraph.
  
  Only used if text is output with <strong>ps_show_boxed()</strong>. If set to <info>true</info> the paragraph will be hyphenated
  if a hypen dictionary is set and exists.
  
  Filename of the dictionary used for hyphenation pattern.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$name</strong>      Name of the parameter.
  <info>float</info>     <strong>$modifier</strong>  An identifier needed if a parameter of a resource is requested, e.g. the size
                       of an image. In such a case the resource id is passed.

<comment>Return:</comment>
  <info>string|false</info>  Returns the value of the parameter Bei einem Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>ps_set_parameter()</strong>


id: ps_get_value
type: function
doc:
<comment>Description:</comment>
  Gets certain values
  
  Gets several values which were set by <strong>ps_set_value()</strong>. Values are by definition float values.
  
  The parameter <strong>$name</strong> can have the following values.
  
  <return>fontsize</return> The size of the currently active font or the font whose identifier is passed in parameter
  <strong>$modifier</strong>. <return>font</return> The currently active font itself. <return>imagewidth</return> The width of the image whose id is
  passed in the parameter <strong>$modifier</strong>. <return>imageheight</return> The height of the image whose id is passed in the
  parameter <strong>$modifier</strong>. <return>capheight</return> The height of a capital M in the currently active font or the font
  whose identifier is passed in parameter <strong>$modifier</strong>. <return>ascender</return> The ascender of the currently active
  font or the font whose identifier is passed in parameter <strong>$modifier</strong>. <return>descender</return> The descender of the
  currently active font or the font whose identifier is passed in parameter <strong>$modifier</strong>. <return>italicangle</return>
  The italicangle of the currently active font or the font whose identifier is passed in parameter
  <strong>$modifier</strong>. <return>underlineposition</return> The underlineposition of the currently active font or the font whose
  identifier is passed in parameter <strong>$modifier</strong>. <return>underlinethickness</return> The underlinethickness of the
  currently active font or the font whose identifier is passed in parameter <strong>$modifier</strong>. <return>textx</return> The
  current x-position for text output. <return>texty</return> The current y-position for text output. <return>textrendering</return>
  The current mode for text rendering. <return>textrise</return> The space by which text is risen above the base
  line. <return>leading</return> The distance between text lines in points. <return>wordspacing</return> The space between words as a
  multiple of the width of a space char. <return>charspacing</return> The space between chars. If charspacing is !=
  0.0 ligatures will always be dissolved. <return>hyphenminchars</return> Minimum number of chars hyphenated at the
  end of a word. <return>parindent</return> Indention of the first n line in a paragraph. <return>numindentlines</return> Number of
  line in a paragraph to indent if parindent != 0.0. <return>parskip</return> Distance between paragraphs.
  <return>linenumberspace</return> Overall space in front of each line for the line number. <return>linenumbersep</return> Space
  between the line and the line number. <return>major</return> The major version number of pslib. <return>minor</return> The minor
  version number of pslib. <return>subminor</return>, <return>revision</return> The subminor version number of pslib.
  
  The size of the currently active font or the font whose identifier is passed in parameter
  <strong>$modifier</strong>.
  
  The currently active font itself.
  
  The width of the image whose id is passed in the parameter <strong>$modifier</strong>.
  
  The height of the image whose id is passed in the parameter <strong>$modifier</strong>.
  
  The height of a capital M in the currently active font or the font whose identifier is passed in
  parameter <strong>$modifier</strong>.
  
  The ascender of the currently active font or the font whose identifier is passed in parameter
  <strong>$modifier</strong>.
  
  The descender of the currently active font or the font whose identifier is passed in parameter
  <strong>$modifier</strong>.
  
  The italicangle of the currently active font or the font whose identifier is passed in parameter
  <strong>$modifier</strong>.
  
  The underlineposition of the currently active font or the font whose identifier is passed in
  parameter <strong>$modifier</strong>.
  
  The underlinethickness of the currently active font or the font whose identifier is passed in
  parameter <strong>$modifier</strong>.
  
  The current x-position for text output.
  
  The current y-position for text output.
  
  The current mode for text rendering.
  
  The space by which text is risen above the base line.
  
  The distance between text lines in points.
  
  The space between words as a multiple of the width of a space char.
  
  The space between chars. If charspacing is != 0.0 ligatures will always be dissolved.
  
  Minimum number of chars hyphenated at the end of a word.
  
  Indention of the first n line in a paragraph.
  
  Number of line in a paragraph to indent if parindent != 0.0.
  
  Distance between paragraphs.
  
  Overall space in front of each line for the line number.
  
  Space between the line and the line number.
  
  The major version number of pslib.
  
  The minor version number of pslib.
  
  The subminor version number of pslib.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$name</strong>      Name of the value.
  <info>float</info>     <strong>$modifier</strong>  The parameter <strong>$modifier</strong> specifies the resource for which the value is to be
                       retrieved. This can be the id of a font or an image.

<comment>Return:</comment>
  <info>float</info>  Returns the value of the parameter or <info>false</info>.

<comment>See Also:</comment>
   * <strong>ps_set_value()</strong>


id: ps_hyphenate
type: function
doc:
<comment>Description:</comment>
  Hyphenates a word
  
  Hyphenates the passed word. <strong>ps_hyphenate()</strong> evaluates the value hyphenminchars (set by
  <strong>ps_set_value()</strong>) and the parameter hyphendict (set by <strong>ps_set_parameter()</strong>). hyphendict must be set
  before calling this function.
  
  This function requires the locale category LC_CTYPE to be set properly. This is done when the
  extension is initialized by using the environment variables. On Unix systems read the man page of
  locale for more information.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>   <strong>$text</strong> should not contain any non alpha characters. Possible positions for breaks
                    are returned in an array of interger numbers. Each number is the position of the
                    char in  <strong>$text</strong> after which a hyphenation can take place.

<comment>Return:</comment>
  <info>array|false</info>  An array of integers indicating the position of possible breaks in the text Bei einem
               Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>ps_show_boxed()</strong>
   * locale(1)


id: ps_include_file
type: function
doc:
<comment>Description:</comment>
  Reads an external file with raw PostScript code
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$file</strong>   

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: ps_lineto
type: function
doc:
<comment>Description:</comment>
  Draws a line
  
  Adds a straight line from the current point to the given coordinates to the current path. Use
  <strong>ps_moveto()</strong> to set the starting point of the line.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>      x-coordinate of the end point of the line.
  <info>float</info>     <strong>$y</strong>      y-coordinate of the end point of the line.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_moveto()</strong>


id: ps_makespotcolor
type: function
doc:
<comment>Description:</comment>
  Create spot color
  
  Creates a spot color from the current fill color. The fill color must be defined in rgb, cmyk or
  gray colorspace. The spot color name can be an arbitrary name. A spot color can be set as any
  color with <strong>ps_setcolor()</strong>. When the document is not printed but displayed by an postscript viewer
  the given color in the specified color space is use.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$name</strong>   Name of the spot color, e.g. Pantone 5565.

<comment>Return:</comment>
  <info>int</info>  The id of the new spot color or 0 in case of an error.

<comment>See Also:</comment>
   * <strong>ps_setcolor()</strong>


id: ps_moveto
type: function
doc:
<comment>Description:</comment>
  Sets current point
  
  Sets the current point to new coordinates. If this is the first call of <strong>ps_moveto()</strong> after a
  previous path has been ended then it will start a new path. If this function is called in the
  middle of a path it will just set the current point and start a subpath.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>      x-coordinate of the point to move to.
  <info>float</info>     <strong>$y</strong>      y-coordinate of the point to move to.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_lineto()</strong>


id: ps_new
type: function
doc:
<comment>Description:</comment>
  Creates a new PostScript document object
  
  Creates a new document instance. It does not create the file on disk or in memory, it just sets up
  everything. <strong>ps_new()</strong> is usually followed by a call of <strong>ps_open_file()</strong> to actually create the
  postscript document.

<comment>Return:</comment>
  <info>resource|false</info>  Resource of PostScript documentBei einem Fehler wird <info>false</info> zurückgegeben.. The
                  return value is passed to all other functions as the first argument.

<comment>See Also:</comment>
   * <strong>ps_delete()</strong>


id: ps_open_file
type: function
doc:
<comment>Description:</comment>
  Opens a file for output
  
  Creates a new file on disk and writes the PostScript document into it. The file will be closed
  when <strong>ps_close()</strong> is called.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$filename</strong>  The name of the postscript file. If <strong>$filename</strong> is not passed the document will
                       be created in memory and all output will go straight to the browser.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_close()</strong>


id: ps_open_image
type: function
doc:
<comment>Description:</comment>
  Reads an image for later placement
  
  Reads an image which is already available in memory. The parameter <strong>$source</strong> is currently not
  evaluated and assumed to be <return>memory</return>. The image data is a sequence of pixels starting in th upper
  left corner and ending in the lower right corner. Each pixel consists of <strong>$components</strong> color
  components, and each component has <strong>$bpc</strong> bits.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>       Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$type</strong>        The type of the image. Possible values are <return>png</return>, <return>jpeg</return>, or <return>eps</return>.
  <info>string</info>    <strong>$source</strong>      Not used.
  <info>string</info>    <strong>$data</strong>        The image data.
  <info></info>          <strong>$length</strong>      The length of the image data.
  <info>int</info>       <strong>$width</strong>       The width of the image.
  <info>int</info>       <strong>$height</strong>      The height of the image.
  <info>int</info>       <strong>$components</strong>  The number of components for each pixel. This can be 1 (gray scale images),
                         3 (rgb images), or 4 (cmyk, rgba images).
  <info>int</info>       <strong>$bpc</strong>         Number of bits per component (quite often 8).
  <info>string</info>    <strong>$params</strong>      

<comment>Return:</comment>
  <info>int</info>  Returns identifier of image or zero in case of an error. The identifier is a positive number
       greater than 0.

<comment>See Also:</comment>
   * <strong>ps_open_image_file()</strong>
   * <strong>ps_place_image()</strong>
   * <strong>ps_close_image()</strong>


id: ps_open_image_file
type: function
doc:
<comment>Description:</comment>
  Opens image from file
  
  Loads an image for later use.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>        Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$type</strong>         The type of the image. Possible values are <return>png</return>, <return>jpeg</return>, or <return>eps</return>.
  <info>string</info>    <strong>$filename</strong>     The name of the file containing the image data.
  <info>string</info>    <strong>$stringparam</strong>  Not used.
  <info>int</info>       <strong>$intparam</strong>     Not used.

<comment>Return:</comment>
  <info>int</info>  Returns identifier of image or zero in case of an error. The identifier is a positive number
       greater than 0.

<comment>See Also:</comment>
   * <strong>ps_open_image()</strong>
   * <strong>ps_place_image()</strong>
   * <strong>ps_close_image()</strong>


id: ps_open_memory_image
type: function
doc:
<comment>Description:</comment>
  Takes an GD image and returns an image for placement in a PS document
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$gd</strong>     

<comment>Return:</comment>
  <info>int</info>  


id: ps_place_image
type: function
doc:
<comment>Description:</comment>
  Places image on the page
  
  Places a formerly loaded image on the page. The image can be scaled. If the image shall be rotated
  as well, you will have to rotate the coordinate system before with <strong>ps_rotate()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>    Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$imageid</strong>  The resource identifier of the image as returned by  <strong>ps_open_image()</strong> or
                      <strong>ps_open_image_file()</strong>.
  <info>float</info>     <strong>$x</strong>        x-coordinate of the lower left corner of the image.
  <info>float</info>     <strong>$y</strong>        y-coordinate of the lower left corner of the image.
  <info>float</info>     <strong>$scale</strong>    The scaling factor for the image. A scale of 1.0 will result in a resolution
                      of 72 dpi, because each pixel is equivalent to 1 point.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_open_image()</strong>
   * <strong>ps_open_image_file()</strong>


id: ps_rect
type: function
doc:
<comment>Description:</comment>
  Draws a rectangle
  
  Draws a rectangle with its lower left corner at (<strong>$x</strong>, <strong>$y</strong>). The rectangle starts and ends in its
  lower left corner. If this function is called outside a path it will start a new path. If it is
  called within a path it will add the rectangle as a subpath. If the last drawing operation does
  not end in the lower left corner then there will be a gap in the path.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>       x-coordinate of the lower left corner of the rectangle.
  <info>float</info>     <strong>$y</strong>       y-coordinate of the lower left corner of the rectangle.
  <info>float</info>     <strong>$width</strong>   The width of the image.
  <info>float</info>     <strong>$height</strong>  The height of the image.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_arc()</strong>
   * <strong>ps_cirle()</strong>
   * <strong>ps_lineto()</strong>


id: ps_restore
type: function
doc:
<comment>Description:</comment>
  Restore previously save context
  
  Restores a previously saved graphics context. Any call of <strong>ps_save()</strong> must be accompanied by a call
  to <strong>ps_restore()</strong>. All coordinate transformations, line style settings, color settings, etc. are
  being restored to the state before the call of <strong>ps_save()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_save()</strong>


id: ps_rotate
type: function
doc:
<comment>Description:</comment>
  Sets rotation factor
  
  Sets the rotation of the coordinate system.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$rot</strong>    Angle of rotation in degree.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_scale()</strong>
   * <strong>ps_translate()</strong>


id: ps_save
type: function
doc:
<comment>Description:</comment>
  Save current context
  
  Saves the current graphics context, containing colors, translation and rotation settings and some
  more. A saved context can be restored with <strong>ps_restore()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_restore()</strong>


id: ps_scale
type: function
doc:
<comment>Description:</comment>
  Sets scaling factor
  
  Sets horizontal and vertical scaling of the coordinate system.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>      Scaling factor in horizontal direction.
  <info>float</info>     <strong>$y</strong>      Scaling factor in vertical direction.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_rotate()</strong>
   * <strong>ps_translate()</strong>


id: ps_set_border_color
type: function
doc:
<comment>Description:</comment>
  Sets color of border for annotations
  
  Links added with one of the functions <strong>ps_add_weblink()</strong>, <strong>ps_add_pdflink()</strong>, etc. will be displayed
  with a surounded rectangle when the postscript document is converted to pdf and viewed in a pdf
  viewer. This rectangle is not visible in the postscript document. This function sets the color of
  the rectangle's border line.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$red</strong>    The red component of the border color.
  <info>float</info>     <strong>$green</strong>  The green component of the border color.
  <info>float</info>     <strong>$blue</strong>   The blue component of the border color.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_set_border_dash()</strong>
   * <strong>ps_set_border_style()</strong>


id: ps_set_border_dash
type: function
doc:
<comment>Description:</comment>
  Sets length of dashes for border of annotations
  
  Links added with one of the functions <strong>ps_add_weblink()</strong>, <strong>ps_add_pdflink()</strong>, etc. will be displayed
  with a surounded rectangle when the postscript document is converted to pdf and viewed in a pdf
  viewer. This rectangle is not visible in the postscript document. This function sets the length of
  the black and white portion of a dashed border line.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$black</strong>  The length of the dash.
  <info>float</info>     <strong>$white</strong>  The length of the gap between dashes.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_set_border_color()</strong>
   * <strong>ps_set_border_style()</strong>


id: ps_set_border_style
type: function
doc:
<comment>Description:</comment>
  Sets border style of annotations
  
  Links added with one of the functions <strong>ps_add_weblink()</strong>, <strong>ps_add_pdflink()</strong>, etc. will be displayed
  with a surounded rectangle when the postscript document is converted to pdf and viewed in a pdf
  viewer. This rectangle is not visible in the postscript document. This function sets the
  appearance and width of the border line.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$style</strong>  <strong>$style</strong> can be <return>solid</return> or <return>dashed</return>.
  <info>float</info>     <strong>$width</strong>  The line width of the border.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_set_border_color()</strong>
   * <strong>ps_set_border_dash()</strong>


id: ps_set_info
type: function
doc:
<comment>Description:</comment>
  Sets information fields of document
  
  Sets certain information fields of the document. This fields will be shown as a comment in the
  header of the PostScript file. If the document is converted to pdf this fields will also be used
  for the document information.
  
  The <return>BoundingBox</return> is usually set to the value given to the first page. This only works if
  <strong>ps_findfont()</strong> has not been called before. In such cases the BoundingBox would be left unset unless
  you set it explicitly with this function.
  
  This function will have no effect anymore when the header of the postscript file has been already
  written. It must be called before the first page or the first call of <strong>ps_findfont()</strong>.

<comment>Param:</comment>
  <info></info>        <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>  <strong>$key</strong>    The name of the information field to set. The values which can be set are
                  <return>Keywords</return>, <return>Subject</return>, <return>Title</return>, <return>Creator</return>, <return>Author</return>, <return>BoundingBox</return>, and <return>Orientation</return>. Be aware
                  that some of them has a meaning to PostScript viewers.
  <info></info>        <strong>$value</strong>  The value of the information field. The field <return>Orientation</return> can be set to either
                  <return>Portrait</return> or <return>Landscape</return>. The <return>BoundingBox</return> is a string consisting of four numbers. The
                  first two numbers are the coordinates of the lower left corner of the page. The
                  last two numbers are the coordinates of the upper right corner.
                  
                  Up to version 0.2.6 of pslib, the BoundingBox and Orientation will be overwritten
                  by <strong>ps_begin_page()</strong>, unless <strong>ps_findfont()</strong> has been called before.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_findfont()</strong>
   * <strong>ps_begin_page()</strong>


id: ps_set_parameter
type: function
doc:
<comment>Description:</comment>
  Sets certain parameters
  
  Sets several parameters which are used by many functions. Parameters are by definition string
  values.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$name</strong>   For a list of possible names see <strong>ps_get_parameter()</strong>.
  <info>string</info>    <strong>$value</strong>  The value of the parameter.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_get_parameters()</strong>
   * <strong>ps_set_value()</strong>


id: ps_set_text_pos
type: function
doc:
<comment>Description:</comment>
  Sets position for text output
  
  Set the position for the next text output. You may alternatively set the x and y value separately
  by calling <strong>ps_set_value()</strong> and choosing <return>textx</return> respectively <return>texty</return> as the value name.
  
  If you want to output text at a certain position it is more convenient to use <strong>ps_show_xy()</strong> instead
  of setting the text position and calling <strong>ps_show()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>      x-coordinate of the new text position.
  <info>float</info>     <strong>$y</strong>      y-coordinate of the new text position.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_set_value()</strong>
   * <strong>ps_show()</strong>


id: ps_set_value
type: function
doc:
<comment>Description:</comment>
  Sets certain values
  
  Sets several values which are used by many functions. Parameters are by definition float values.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$name</strong>   The <strong>$name</strong> can be one of the following: textrendering The way how text is shown.
                    textx The x coordinate for text output. texty The y coordinate for text output.
                    wordspacing The distance between words relative to the width of a space. leading
                    The distance between lines in pixels.
                    
                    The way how text is shown.
                    
                    The x coordinate for text output.
                    
                    The y coordinate for text output.
                    
                    The distance between words relative to the width of a space.
                    
                    The distance between lines in pixels.
  <info>float</info>     <strong>$value</strong>  The value of the parameter.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_get_value()</strong>
   * <strong>ps_set_parameter()</strong>


id: ps_setcolor
type: function
doc:
<comment>Description:</comment>
  Sets current color
  
  Sets the color for drawing, filling, or both.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>       Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$type</strong>        The parameter <strong>$type</strong> can be  <return>both</return>, <return>fill</return>, or <return>fillstroke</return>.
  <info>string</info>    <strong>$colorspace</strong>  The colorspace should be one of <return>gray</return>, <return>rgb</return>, <return>cmyk</return>,  <return>spot</return>, <return>pattern</return>. Depending
                         on the colorspace either only the first, the first three or all parameters
                         will be used.
  <info>float</info>     <strong>$c1</strong>          Depending on the colorspace this is either the red component (rgb), the
                         cyan component (cmyk), the gray value (gray), the identifier of the spot
                         color or the identifier of the pattern.
  <info>float</info>     <strong>$c2</strong>          Depending on the colorspace this is either the green component (rgb), the
                         magenta component (cmyk).
  <info>float</info>     <strong>$c3</strong>          Depending on the colorspace this is either the blue component (rgb), the
                         yellow component (cmyk).
  <info>float</info>     <strong>$c4</strong>          This must only be set in cmyk colorspace and specifies the black component.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: ps_setdash
type: function
doc:
<comment>Description:</comment>
  Sets appearance of a dashed line
  
  Sets the length of the black and white portions of a dashed line.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$on</strong>     The length of the dash.
  <info>float</info>     <strong>$off</strong>    The length of the gap between dashes.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_setpolydash()</strong>


id: ps_setflat
type: function
doc:
<comment>Description:</comment>
  Sets flatness
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$value</strong>  The <strong>$value</strong> must be between 0.2 and 1.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: ps_setfont
type: function
doc:
<comment>Description:</comment>
  Sets font to use for following output
  
  Sets a font, which has to be loaded before with <strong>ps_findfont()</strong>. Outputting text without setting a
  font results in an error.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$fontid</strong>  The font identifier as returned by <strong>ps_findfont()</strong>.
  <info>float</info>     <strong>$size</strong>    The size of the font.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_findfont()</strong>
   * <strong>ps_set_text_pos()</strong> for an example.


id: ps_setgray
type: function
doc:
<comment>Description:</comment>
  Sets gray value
  
  Sets the gray value for all following drawing operations.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$gray</strong>   The value must be between 0 (white) and 1 (black).

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_setcolor()</strong>


id: ps_setlinecap
type: function
doc:
<comment>Description:</comment>
  Sets appearance of line ends
  
  Sets how line ends look like.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$type</strong>   The type of line ends. Possible values are <return>PS_LINECAP_BUTT</return>, <return>PS_LINECAP_ROUND</return>, or
                    <return>PS_LINECAP_SQUARED</return>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_setlinejoin()</strong>
   * <strong>ps_setlinewidth()</strong>
   * <strong>ps_setmiterlimit()</strong>


id: ps_setlinejoin
type: function
doc:
<comment>Description:</comment>
  Sets how contected lines are joined
  
  Sets how lines are joined.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$type</strong>   The way lines are joined. Possible values are <return>PS_LINEJOIN_MITER</return>,
                    <return>PS_LINEJOIN_ROUND</return>, or <return>PS_LINEJOIN_BEVEL</return>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_setlinecap()</strong>
   * <strong>ps_setlinewidth()</strong>
   * <strong>ps_setmiterlimit()</strong>


id: ps_setlinewidth
type: function
doc:
<comment>Description:</comment>
  Sets width of a line
  
  Sets the line width for all following drawing operations.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$width</strong>  The width of lines in points.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_setlinecap()</strong>
   * <strong>ps_setlinejoin()</strong>
   * <strong>ps_setmiterlimit()</strong>


id: ps_setmiterlimit
type: function
doc:
<comment>Description:</comment>
  Sets the miter limit
  
  If two lines join in a small angle and the line join is set to <return>PS_LINEJOIN_MITER</return>, then the
  resulting spike will be very long. The miter limit is the maximum ratio of the miter length (the
  length of the spike) and the line width.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$value</strong>  The maximum ratio between the miter length and the line width. Larger values
                    (&gt; 10) will result in very long spikes when two lines meet in a small angle.
                    Keep the default unless you know what you are doing.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_setlinecap()</strong>
   * <strong>ps_setlinejoin()</strong>
   * <strong>ps_setlinewidth()</strong>


id: ps_setoverprintmode
type: function
doc:
<comment>Description:</comment>
  Sets overprint mode
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$mode</strong>   

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: ps_setpolydash
type: function
doc:
<comment>Description:</comment>
  Sets appearance of a dashed line
  
  Sets the length of the black and white portions of a dashed line. <strong>ps_setpolydash()</strong> is used to set
  more complicated dash patterns.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$arr</strong>    <strong>$arr</strong> is a list of length elements alternately for the black and white portion.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_setdash()</strong>


id: ps_shading
type: function
doc:
<comment>Description:</comment>
  Creates a shading for later use
  
  Creates a shading, which can be used by <strong>ps_shfill()</strong> or <strong>ps_shading_pattern()</strong>.
  
  The color of the shading can be in any color space except for <return>pattern</return>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>           Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$type</strong>            The type of shading can be either <return>radial</return> or <return>axial</return>. Each shading starts
                             with the current fill color and ends with the given color values passed
                             in the parameters <strong>$c1</strong> to <strong>$c4</strong> (see <strong>ps_setcolor()</strong> for their meaning).
  <info></info>          <strong>$x0, x1, y0, y1</strong>  The coordinates <strong>$x0</strong>, <strong>$y0</strong>, <strong>$x1</strong>, <strong>$y1</strong> are the start and end point of the
                             shading. If the type of shading is <return>radial</return> the two points are the middle
                             points of a starting and ending circle.
  <info></info>          <strong>$c1, c2, c3, c4</strong>  See <strong>ps_setcolor()</strong> for their meaning.
  <info>string</info>    <strong>$optlist</strong>         If the shading is of type <return>radial</return> the <strong>$optlist</strong> must also contain the
                             parameters <return>r0</return> and <return>r1</return> with the radius of the start and end circle.

<comment>Return:</comment>
  <info>int|false</info>  Returns the identifier of the pattern Bei einem Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>ps_shading_pattern()</strong>
   * <strong>ps_shfill()</strong>


id: ps_shading_pattern
type: function
doc:
<comment>Description:</comment>
  Creates a pattern based on a shading
  
  Creates a pattern based on a shading, which has to be created before with <strong>ps_shading()</strong>. Shading
  patterns can be used like regular patterns.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>      Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$shadingid</strong>  The identifier of a shading previously created with <strong>ps_shading()</strong>.
  <info>string</info>    <strong>$optlist</strong>    This argument is not currently used.

<comment>Return:</comment>
  <info>int|false</info>  The identifier of the pattern Bei einem Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>ps_shading()</strong>
   * <strong>ps_shfill()</strong>


id: ps_shfill
type: function
doc:
<comment>Description:</comment>
  Fills an area with a shading
  
  Fills an area with a shading, which has to be created before with <strong>ps_shading()</strong>. This is an
  alternative way to creating a pattern from a shading <strong>ps_shading_pattern()</strong> and using the pattern as
  the filling color.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>      Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$shadingid</strong>  The identifier of a shading previously created with <strong>ps_shading()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_shading()</strong>
   * <strong>ps_shading_pattern()</strong>


id: ps_show
type: function
doc:
<comment>Description:</comment>
  Output text
  
  Output a text at the current text position. The text position can be set by storing the x and y
  coordinates into the values <return>textx</return> and <return>texty</return> with the function <strong>ps_set_value()</strong>. The function will
  issue an error if a font was not set before with <strong>ps_setfont()</strong>.
  
  <strong>ps_show()</strong> evaluates the following parameters and values as set by <strong>ps_set_parameter()</strong> and
  <strong>ps_set_value()</strong>.
  
  Distance between two consecutive glyphs. If this value is unequal to zero then all ligatures will
  be resolved. Values less than zero are allowed.
  
  Setting this parameter to "false" will turn off kerning. Kerning is turned on by default.
  
  Setting this parameter to "false" will turn off the use of ligatures.  Ligatures are turned on by
  default.
  
  Setting this parameter to "true" will turn on underlining. Underlining is turned off by default.
  
  Setting this parameter to "true" will turn on overlining. Overlining is turned off by default.
  
  Setting this parameter to "true" will turn on striking out. Striking out is turned off by default.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>   The text to be output.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_continue_text()</strong>
   * <strong>ps_show_xy()</strong>
   * <strong>ps_setfont()</strong>


id: ps_show2
type: function
doc:
<comment>Description:</comment>
  Output a text at current position
  
  Output text at the current position. Do not print more than <strong>$len</strong> characters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>   The text to be output.
  <info>int</info>       <strong>$len</strong>    The maximum number of characters to print.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: ps_show_boxed
type: function
doc:
<comment>Description:</comment>
  Output text in a box
  
  Outputs a text in a given box. The lower left corner of the box is at (<strong>$left</strong>, <strong>$bottom</strong>). Line
  breaks will be inserted where needed. Multiple spaces are treated as one. Tabulators are treated
  as spaces.
  
  The text will be hyphenated if the parameter <strong>$hyphenation</strong> is set to <info>true</info> and the parameter
  <strong>$hyphendict</strong> contains a valid filename for a hyphenation file. The line spacing is taken from the
  value <return>leading</return>. Paragraphs can be separated by an empty line just like in TeX. If the value
  <return>parindent</return> is set to value &gt; 0.0 then the first n lines will be indented. The number n of lines
  is set by the parameter <return>numindentlines</return>. In order to prevent indenting of the first m paragraphs
  set the value <return>parindentskip</return> to a positive number.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>       Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>        The text to be output into the given box.
  <info>float</info>     <strong>$left</strong>        x-coordinate of the lower left corner of the box.
  <info>float</info>     <strong>$bottom</strong>      y-coordinate of the lower left corner of the box.
  <info>float</info>     <strong>$width</strong>       Width of the box.
  <info>float</info>     <strong>$height</strong>      Height of the box.
  <info>string</info>    <strong>$hmode</strong>       The parameter <strong>$hmode</strong> can be <return>justify</return>, <return>fulljustify</return>, <return>right</return>, <return>left</return>, or <return>center</return>.
                         The difference of <return>justify</return> and <return>fulljustify</return> just affects the last line of the
                         box. In <return>fulljustify</return> mode the last line will be left and right justified
                         unless this is also the last line of paragraph. In <return>justify</return> mode it will
                         always be left justified.
  <info>string</info>    <strong>$feature</strong>     
  <info></info>          <strong>$hyphendict</strong>  Set to <info>true</info> in order to turn hyphenation on. This requires a dictionary to
                         be set with the parameter <strong>$hyphendict</strong>. Defaults to <info>false</info>.

<comment>Return:</comment>
  <info>int</info>  Number of characters that could not be written.

<comment>See Also:</comment>
   * <strong>ps_continue_text()</strong>


id: ps_show_xy
type: function
doc:
<comment>Description:</comment>
  Output text at given position
  
  Output a text at the given text position.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>   The text to be output.
  <info>float</info>     <strong>$x</strong>      x-coordinate of the lower left corner of the box surrounding the text.
  <info>float</info>     <strong>$y</strong>      y-coordinate of the lower left corner of the box surrounding the text.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_continue_text()</strong>
   * <strong>ps_show()</strong>


id: ps_show_xy2
type: function
doc:
<comment>Description:</comment>
  Output text at position
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: ps_string_geometry
type: function
doc:
<comment>Description:</comment>
  Gets geometry of a string
  
  This function is similar to <strong>ps_stringwidth()</strong> but returns an array of dimensions containing the
  width, ascender, and descender of the text.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>    The text for which the geometry is to be calculated.
  <info>int</info>       <strong>$fontid</strong>  The identifier of the font to be used. If not font is specified the current
                     font will be used.
  <info>float</info>     <strong>$size</strong>    The size of the font. If no size is specified the current size is used.

<comment>Return:</comment>
  <info>array</info>  An array of the dimensions of a string. The element 'width' contains the width of the
         string as returned by <strong>ps_stringwidth()</strong>. The element 'descender' contains the maximum
         descender and 'ascender' the maximum ascender of the string.

<comment>See Also:</comment>
   * <strong>ps_continue_text()</strong>
   * <strong>ps_stringwidth()</strong>


id: ps_stringwidth
type: function
doc:
<comment>Description:</comment>
  Gets width of a string
  
  Calculates the width of a string in points if it was output in the given font and font size. This
  function needs an Adobe font metrics file to calculate the precise width. If kerning is turned on,
  it will be taken into account.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>    The text for which the width is to be calculated.
  <info>int</info>       <strong>$fontid</strong>  The identifier of the font to be used. If not font is specified the current
                     font will be used.
  <info>float</info>     <strong>$size</strong>    The size of the font. If no size is specified the current size is used.

<comment>Return:</comment>
  <info>float</info>  Width of a string in points.

<comment>See Also:</comment>
   * <strong>ps_string_geometry()</strong>


id: ps_stroke
type: function
doc:
<comment>Description:</comment>
  Draws the current path
  
  Draws the path constructed with previously called drawing functions like <strong>ps_lineto()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_closepath_stroke()</strong>
   * <strong>ps_fill()</strong>
   * <strong>ps_fill_stroke()</strong>


id: ps_symbol
type: function
doc:
<comment>Description:</comment>
  Output a glyph
  
  Output the glyph at position <strong>$ord</strong> in the font encoding vector of the current font. The font
  encoding for a font can be set when loading the font with <strong>ps_findfont()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$ord</strong>    The position of the glyph in the font encoding vector.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_symbol_name()</strong>
   * <strong>ps_symbol_width()</strong>


id: ps_symbol_name
type: function
doc:
<comment>Description:</comment>
  Gets name of a glyph
  
  This function needs an Adobe font metrics file to know which glyphs are available.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$ord</strong>     The parameter <strong>$ord</strong> is the position of the glyph in the font encoding vector.
  <info>int</info>       <strong>$fontid</strong>  The identifier of the font to be used. If not font is specified the current
                     font will be used.

<comment>Return:</comment>
  <info>string</info>  The name of a glyph in the given font.

<comment>See Also:</comment>
   * <strong>ps_symbol()</strong>
   * <strong>ps_symbol_width()</strong>


id: ps_symbol_width
type: function
doc:
<comment>Description:</comment>
  Gets width of a glyph
  
  Calculates the width of a glyph in points if it was output in the given font and font size.  This
  function needs an Adobe font metrics file to calculate the precise width.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>int</info>       <strong>$ord</strong>     The position of the glyph in the font encoding vector.
  <info>int</info>       <strong>$fontid</strong>  The identifier of the font to be used. If not font is specified the current
                     font will be used.
  <info>float</info>     <strong>$size</strong>    The size of the font. If no size is specified the current size is used.

<comment>Return:</comment>
  <info>float</info>  The width of a glyph in points.

<comment>See Also:</comment>
   * <strong>ps_symbol()</strong>
   * <strong>ps_symbol_name()</strong>


id: ps_translate
type: function
doc:
<comment>Description:</comment>
  Sets translation
  
  Sets a new initial point of the coordinate system.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Resource identifier of the postscript file as returned by <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>      x-coordinate of the origin of the translated coordinate system.
  <info>float</info>     <strong>$y</strong>      y-coordinate of the origin of the translated coordinate system.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>ps_scale()</strong>
   * <strong>ps_rotate()</strong>


id: pspell_add_to_personal
type: function
doc:
<comment>Description:</comment>
  Fügt der persönlichen Wortliste ein Wort hinzu
  
  <strong>pspell_add_to_personal()</strong> fügt der persönlichen Wortliste ein Wort hinzu. Falls <strong>pspell_new_config()</strong>
  mit <strong>pspell_config_personal()</strong> verwendet wurde, um das Wörterbuch zu öffnen, kann die Wortliste
  später mit <strong>pspell_save_wordlist()</strong> gespeichert werden.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Eine <class>PSpell\Dictionary</class>-Instanz.
  <info>string</info>             <strong>$word</strong>        Das hinzugefügte Wort.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: pspell_add_to_session
type: function
doc:
<comment>Description:</comment>
  Fügt der Wortliste der aktuellen Sitzung ein Wort hinzu
  
  <strong>pspell_add_to_session()</strong> fügt der Wortliste, die zur aktuellen Sitzung gehört, ein Wort hinzu.
  Diese Funktion ist der Funktion <strong>pspell_add_to_personal()</strong> sehr ähnlich.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Eine <class>PSpell\Dictionary</class>-Instanz.
  <info>string</info>             <strong>$word</strong>        Das hinzugefügte Wort

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: pspell_check
type: function
doc:
<comment>Description:</comment>
  Überprüft ein Wort
  
  <strong>pspell_check()</strong> überprüft die Schreibweise eines Wortes.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Eine <class>PSpell\Dictionary</class>-Instanz.
  <info>string</info>             <strong>$word</strong>        Das zu überprüfende Wort.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn die Schreibweise korrekt ist, oder <info>false</info>, wenn nicht.


id: pspell_clear_session
type: function
doc:
<comment>Description:</comment>
  Löscht die aktuelle Sitzung
  
  <strong>pspell_clear_session()</strong> löscht die aktuelle Sitzung. Die aktuelle Wortliste wird geleert und wenn
  zum Beispiel versucht wird, sie mit <strong>pspell_save_wordlist()</strong> zu speichern, passiert gar nichts.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Eine <class>PSpell\Dictionary</class>-Instanz.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: pspell_config_create
type: function
doc:
<comment>Description:</comment>
  Erzeugt eine Konfiguration zum Öffnen eines Wörterbuchs
  
  Erzeugt eine Konfiguration zum Öffnen eines Wörterbuchs.
  
  <strong>pspell_config_create()</strong> hat eine sehr ähnliche Syntax wie <strong>pspell_new()</strong>. Wenn <strong>pspell_config_create()</strong>
  direkt gefolgt von <strong>pspell_new_config()</strong> verwendet wird, hat das in der Tat genau das gleiche
  Ergebnis. Allerdings können nach dem Erzeugen einer neuen Konfiguration die
  <strong>pspell_config_*()</strong>-Funktionen verwendet werden, bevor <strong>pspell_new_config()</strong> aufgerufen wird, um von
  einer erweiterten Funktionalität zu profitieren.
  
  Weitere Informationen und Beispiele sind im Online-Handbuch der pspell-Webseite zu finden:
  http://aspell.net/.

<comment>Param:</comment>
  <info>string</info>  <strong>$language</strong>  Der Sprachencode, der aus dem zweibuchstabigen ISO-639-Sprachencode und, nach
                     einem Binde- oder Unterstrich, einem optionalen zweibuchstabigen
                     ISO-3166-Ländercode besteht.
  <info>string</info>  <strong>$spelling</strong>  Die angeforderte Schreibweise für Sprachen mit mehr als einer Schreibweise, wie
                     zum Beispiel Englisch. Bekannte Werte sind 'american', 'british' und
                     'canadian'.
  <info>string</info>  <strong>$jargon</strong>    Enthält zusätzliche Informationen, um zwischen zwei Wortlisten mit derselben
                     Sprache und denselben Parametern für die Schreibweise zu unterscheiden.
  <info>string</info>  <strong>$encoding</strong>  Die Kodierung, in der die Wörter voraussichtlich sind. Gültige Werte sind
                     'utf-8', 'iso8859-*', 'koi8-r', 'viscii', 'cp1252', 'machine unsigned 16' und
                     'machine unsigned 32'. Dieser Parameter ist weitgehend ungetestet, weshalb bei
                     dessen Verwendung Vorsicht geboten ist.

<comment>Return:</comment>
  <info>PSpell\Config</info>  Gibt eine <class>PSpell\Config</class>-Instanz zurück.


id: pspell_config_data_dir
type: function
doc:
<comment>Description:</comment>
  Ort der Dateien mit den Daten für die Sprachen
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: pspell_config_dict_dir
type: function
doc:
<comment>Description:</comment>
  Ort der Haupt-Wortliste
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: pspell_config_ignore
type: function
doc:
<comment>Description:</comment>
  Ignoriert Wörter mit weniger als N Buchstaben
  
  <strong>pspell_config_ignore()</strong> sollte auf die Konfiguration angewendet werden, bevor <strong>pspell_new_config()</strong>
  aufgerufen wird. Diese Funktion erlaubt der Rechtschreibprüfung, kurze Wörter zu überspringen.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>      Eine <class>PSpell\Config</class>-Instanz.
  <info>int</info>            <strong>$min_length</strong>  Wörter mit weniger als <strong>$min_length</strong> Buchstaben werden übersprungen.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: pspell_config_mode
type: function
doc:
<comment>Description:</comment>
  Ändert den Modus für die Anzahl gelieferter Vorschläge
  
  <strong>pspell_config_mode()</strong> sollte auf die Konfiguration angewendet werden, bevor <strong>pspell_new_config()</strong>
  aufgerufen wird. Diese Funktion bestimmt, wie viele Vorschläge von <strong>pspell_suggest()</strong> zurückgegeben
  werden.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>  Eine <class>PSpell\Config</class>-Instanz.
  <info>int</info>            <strong>$mode</strong>    Der Modus, in dem die Rechtschreibprüfung arbeitet. Es stehen mehrere Modi
                          zur Verfügung: <info>PSPELL_FAST</info> - Schneller Modus (geringste Anzahl Vorschläge)
                          <info>PSPELL_NORMAL</info> - Normaler Modus (mehr Vorschläge) <info>PSPELL_BAD_SPELLERS</info> -
                          Langsamer Modus (viele Vorschläge)
                          
                          <info>PSPELL_FAST</info> - Schneller Modus (geringste Anzahl Vorschläge)
                          
                          <info>PSPELL_NORMAL</info> - Normaler Modus (mehr Vorschläge)
                          
                          <info>PSPELL_BAD_SPELLERS</info> - Langsamer Modus (viele Vorschläge)

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: pspell_config_personal
type: function
doc:
<comment>Description:</comment>
  Legt die Datei fest, die die persönliche Wortliste enthält
  
  Legt die Datei fest, die die persönliche Wortliste enthält. Die persönliche Wortliste wird geladen
  und nach dem Aufruf von <strong>pspell_new_config()</strong> zusätzlich zur standardmäßigen verwendet. Diese Datei
  ist auch der Ort, an dem <strong>pspell_save_wordlist()</strong> die persönliche Wortliste speichert.
  
  <strong>pspell_config_personal()</strong> sollte auf die Konfiguration angewendet werden, bevor <strong>pspell_new_config()</strong>
  aufgerufen wird.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>    Eine <class>PSpell\Config</class>-Instanz.
  <info>string</info>         <strong>$filename</strong>  Die persönliche Wortliste. Falls die Datei nicht existiert, wird sie
                            angelegt. Die Datei sollte für denjenigen, unter dem PHP läuft (z. B.
                            nobody), eine Schreibberechtigung haben.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: pspell_config_repl
type: function
doc:
<comment>Description:</comment>
  Legt die Datei fest, welche die Ersetzungspaare enthält
  
  Legt die Datei fest, welche die Ersetzungspaare enthält.
  
  Die Ersetzungspaare verbessern die Qualität der Rechtschreibprüfung. Wenn ein Wort falsch
  geschrieben und in der Wortliste kein passender Vorschlag gefunden wurde, kann
  <strong>pspell_store_replacement()</strong> zum Speichern eines Ersetzungspaares verwendet werden und dann
  <strong>pspell_save_wordlist()</strong> zum Speichern der Wortliste zusammen mit den Ersetzungspaaren.
  
  <strong>pspell_config_repl()</strong> sollte auf die Konfiguration angewendet werden, bevor <strong>pspell_new_config()</strong>
  aufgerufen wird.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>    Eine <class>PSpell\Config</class>-Instanz.
  <info>string</info>         <strong>$filename</strong>  Die Datei sollte für denjenigen, unter dem PHP läuft (z. B. nobody),
                            eine Schreibberechtigung haben.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: pspell_config_runtogether
type: function
doc:
<comment>Description:</comment>
  Betrachtet zusammengesetzte Wörter als gültige Verbindungen
  
  Diese Funktion bestimmt, ob zusammengesetzte Wörter als erlaubte Verbindungen betrachtet werden.
  Das heißt, "dieSpinne" wäre dann eine erlaubte Verbindung, obwohl ein Leerzeichen zwischen den
  beiden Wörtern sein müsste. Eine Änderung dieser Einstellung wirkt sich nur auf das Ergebnis aus,
  das von <strong>pspell_check()</strong> zurückgegeben wird; <strong>pspell_suggest()</strong> liefert weiterhin Änderungsvorschläge.
  
  <strong>pspell_config_runtogether()</strong> sollte auf die Konfiguration angewendet werden, bevor
  <strong>pspell_new_config()</strong> aufgerufen wird.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>  Eine <class>PSpell\Config</class>-Instanz.
  <info>bool</info>           <strong>$allow</strong>   <info>true</info>, falls zusammengesetzte Wörter als gültige Verbindungen betrachtet
                          werden sollen, andernfalls <info>false</info>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: pspell_config_save_repl
type: function
doc:
<comment>Description:</comment>
  Bestimmt, ob Ersetzungspaare zusammen mit der Wortliste gespeichert werden
  
  Die Funktion <strong>pspell_config_save_repl()</strong> bestimmt, ob <strong>pspell_save_wordlist()</strong> Ersetzungspaare
  zusammen mit der Wortliste speichert. Normalerweise wird sie nicht benötigt, denn wenn die
  Funktion <strong>pspell_config_repl()</strong> verwendet wird, werden die Ersetzungspaare sowieso durch
  <strong>pspell_save_wordlist()</strong> gespeichert, und wenn sie nicht verwendet wird, werden die Ersetzungspaare
  nicht gespeichert.
  
  <strong>pspell_config_save_repl()</strong> sollte auf die Konfiguration angewendet werden, bevor
  <strong>pspell_new_config()</strong> aufgerufen wird.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>  Eine <class>PSpell\Config</class>-Instanz.
  <info>bool</info>           <strong>$save</strong>    <info>true</info>, falls Ersetzungspaare gespeichert werden sollen, andernfalls <info>false</info>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: pspell_new
type: function
doc:
<comment>Description:</comment>
  Lädt ein neues Wörterbuch
  
  <strong>pspell_new()</strong> öffnet ein neues Wörterbuch und gibt eine <class>PSpell\Dictionary</class>-Instanz für die
  Verwendung in anderen pspell-Funktionen zurück.
  
  Weitere Informationen und Beispiele sind im Online-Handbuch der pspell-Webseite zu finden:
  http://aspell.net/.

<comment>Param:</comment>
  <info>string</info>  <strong>$language</strong>  Der Sprachencode, der aus dem zweibuchstabigen ISO-639-Sprachencode und, nach
                     einem Binde- oder Unterstrich, einem optionalen zweibuchstabigen
                     ISO-3166-Ländercode besteht.
  <info>string</info>  <strong>$spelling</strong>  Die angeforderte Schreibweise für Sprachen mit mehr als einer Schreibweise, wie
                     zum Beispiel Englisch. Bekannte Werte sind 'american', 'british' und
                     'canadian'.
  <info>string</info>  <strong>$jargon</strong>    Enthält zusätzliche Informationen, um zwischen zwei Wortlisten mit derselben
                     Sprache und denselben Parametern für die Schreibweise zu unterscheiden.
  <info>string</info>  <strong>$encoding</strong>  Die Kodierung, in der die Wörter voraussichtlich sind. Gültige Werte sind
                     'utf-8', 'iso8859-*', 'koi8-r', 'viscii', 'cp1252', 'machine unsigned 16' und
                     'machine unsigned 32'. Dieser Parameter ist weitgehend ungetestet, weshalb bei
                     dessen Verwendung Vorsicht geboten ist.
  <info>int</info>     <strong>$mode</strong>      Der Modus, in dem die Rechtschreibprüfung arbeitet. Es stehen mehrere Modi zur
                     Verfügung: <info>PSPELL_FAST</info> - Schneller Modus (geringste Anzahl Vorschläge)
                     <info>PSPELL_NORMAL</info> - Normaler Modus (mehr Vorschläge) <info>PSPELL_BAD_SPELLERS</info> -
                     Langsamer Modus (viele Vorschläge) <info>PSPELL_RUN_TOGETHER</info> - Betrachtet
                     zusammengesetzte Wörter als erlaubte Verbindungen. Das heißt, "dieSpinne" wäre
                     dann eine erlaubte Verbindung, obwohl ein Leerzeichen zwischen den beiden
                     Wörtern sein müsste. Eine Änderung dieser Einstellung wirkt sich nur auf das
                     Ergebnis aus, das von <strong>pspell_check()</strong> zurückgegeben wird; <strong>pspell_suggest()</strong>
                     liefert weiterhin Änderungsvorschläge.  <strong>$mode</strong> ist eine Bitmaske, die sich aus
                     verschiedenden der oben aufgelisteten Konstanten zusammensetzt. <info>PSPELL_FAST</info>,
                     <info>PSPELL_NORMAL</info> und <info>PSPELL_BAD_SPELLERS</info> schließen sich allerdings gegenseitig
                     aus, weshalb nur eine davon ausgewählt werden sollte.
                     
                     <info>PSPELL_FAST</info> - Schneller Modus (geringste Anzahl Vorschläge)
                     
                     <info>PSPELL_NORMAL</info> - Normaler Modus (mehr Vorschläge)
                     
                     <info>PSPELL_BAD_SPELLERS</info> - Langsamer Modus (viele Vorschläge)
                     
                     <info>PSPELL_RUN_TOGETHER</info> - Betrachtet zusammengesetzte Wörter als erlaubte
                     Verbindungen. Das heißt, "dieSpinne" wäre dann eine erlaubte Verbindung, obwohl
                     ein Leerzeichen zwischen den beiden Wörtern sein müsste. Eine Änderung dieser
                     Einstellung wirkt sich nur auf das Ergebnis aus, das von <strong>pspell_check()</strong>
                     zurückgegeben wird; <strong>pspell_suggest()</strong> liefert weiterhin Änderungsvorschläge.

<comment>Return:</comment>
  <info>PSpell\Dictionary|false</info>  Gibt bei Erfolg eine <class>PSpell\Dictionary</class>-Instanz zurück. Bei einem Fehler
                           wird <info>false</info> zurückgegeben.


id: pspell_new_config
type: function
doc:
<comment>Description:</comment>
  Lädt ein neues Wörterbuch mit den Einstellungen einer angegebenen Konfiguration
  
  <strong>pspell_new_config()</strong> öffnet ein neues Wörterbuch, das mittels <strong>pspell_config_create()</strong> erzeugt und
  mit den <strong>pspell_config_*()</strong>-Funktionen geändert wurde, mit den Einstellungen aus <strong>$config</strong>. Diese
  Methode bietet die größte Flexibilität und hat die ganze Funktionalität, die <strong>pspell_new()</strong> und
  <strong>pspell_new_personal()</strong> bieten.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>  <strong>$config</strong> ist der Parameter, der von <strong>pspell_config_create()</strong> beim Erzeugen
                          der Konfiguration zurückgegeben wird.

<comment>Return:</comment>
  <info>PSpell\Dictionary|false</info>  Gibt bei Erfolg eine <class>PSpell\Dictionary</class>-Instanz zurück. Bei einem Fehler
                           wird <info>false</info> zurückgegeben.


id: pspell_new_personal
type: function
doc:
<comment>Description:</comment>
  Lädt ein neues Wörterbuch mit persönlicher Wortliste
  
  <strong>pspell_new_personal()</strong> öffnet ein neues Wörterbuch mit einer persönlichen Wortliste. Die Wortliste
  kann bei Bedarf mit <strong>pspell_save_wordlist()</strong> geändert und gespeichert werden. Die Ersetzungspaare
  werden jedoch nicht gespeichert. Um diese zu speichern, müssen Sie mittels <strong>pspell_config_create()</strong>
  eine Konfiguration erzeugen, die persönliche Wortliste mit <strong>pspell_config_personal()</strong> setzen, die
  Datei für die Ersetzen-Paare mit <strong>pspell_config_repl()</strong> setzen und mit <strong>pspell_new_config()</strong> ein neues
  Wörterbuch öffnen.
  
  Weitere Informationen und Beispiele sind im Online-Handbuch der pspell-Webseite zu finden:
  http://aspell.net/.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Die Datei, in der Wörter, die zur persönlichen Wortliste hinzugefügt wurden,
                     gespeichert werden. Dieser Parameter sollte als absoluter Dateiname mit '/'
                     beginnend angegeben werden, weil er andernfalls relativ zu $HOME wäre, was auf
                     den meisten Systemen '/root' ist und es vermutlich nicht das ist, was Sie
                     wollen.
  <info>string</info>  <strong>$language</strong>  Der Sprachencode, der aus dem zweibuchstabigen ISO-639-Sprachencode und, nach
                     einem Binde- oder Unterstrich, einem optionalen zweibuchstabigen
                     ISO-3166-Ländercode besteht.
  <info>string</info>  <strong>$spelling</strong>  Die angeforderte Schreibweise für Sprachen mit mehr als einer Schreibweise, wie
                     zum Beispiel Englisch. Bekannte Werte sind 'american', 'british' und
                     'canadian'.
  <info>string</info>  <strong>$jargon</strong>    Enthält zusätzliche Informationen, um zwischen zwei Wortlisten mit derselben
                     Sprache und denselben Parametern für die Schreibweise zu unterscheiden.
  <info>string</info>  <strong>$encoding</strong>  Die Kodierung, in der die Wörter voraussichtlich sind. Gültige Werte sind
                     <return>utf-8</return>, <return>iso8859-*</return>, <return>koi8-r</return>, <return>viscii</return>, <return>cp1252</return>, <return>machine unsigned 16</return> und <return>machine
                     unsigned 32</return>.
  <info>int</info>     <strong>$mode</strong>      Der Modus, in dem die Rechtschreibprüfung arbeitet. Es stehen mehrere Modi zur
                     Verfügung: <info>PSPELL_FAST</info> - Schneller Modus (geringste Anzahl Vorschläge)
                     <info>PSPELL_NORMAL</info> - Normaler Modus (mehr Vorschläge) <info>PSPELL_BAD_SPELLERS</info> -
                     Langsamer Modus (viele Vorschläge) <info>PSPELL_RUN_TOGETHER</info> - Betrachtet
                     zusammengesetzte Wörter als erlaubte Verbindungen. Das heißt, "dieSpinne" wäre
                     dann eine erlaubte Verbindung, obwohl ein Leerzeichen zwischen den beiden
                     Wörtern sein müsste. Eine Änderung dieser Einstellung wirkt sich nur auf das
                     Ergebnis aus, das von <strong>pspell_check()</strong> zurückgegeben wird; <strong>pspell_suggest()</strong>
                     liefert weiterhin Änderungsvorschläge.  <strong>$mode</strong> ist eine Bitmaske, die sich aus
                     verschiedenden der oben aufgelisteten Konstanten zusammensetzt. <info>PSPELL_FAST</info>,
                     <info>PSPELL_NORMAL</info> und <info>PSPELL_BAD_SPELLERS</info> schließen sich allerdings gegenseitig
                     aus, weshalb nur eine davon ausgewählt werden sollte.
                     
                     <info>PSPELL_FAST</info> - Schneller Modus (geringste Anzahl Vorschläge)
                     
                     <info>PSPELL_NORMAL</info> - Normaler Modus (mehr Vorschläge)
                     
                     <info>PSPELL_BAD_SPELLERS</info> - Langsamer Modus (viele Vorschläge)
                     
                     <info>PSPELL_RUN_TOGETHER</info> - Betrachtet zusammengesetzte Wörter als erlaubte
                     Verbindungen. Das heißt, "dieSpinne" wäre dann eine erlaubte Verbindung, obwohl
                     ein Leerzeichen zwischen den beiden Wörtern sein müsste. Eine Änderung dieser
                     Einstellung wirkt sich nur auf das Ergebnis aus, das von <strong>pspell_check()</strong>
                     zurückgegeben wird; <strong>pspell_suggest()</strong> liefert weiterhin Änderungsvorschläge.

<comment>Return:</comment>
  <info>PSpell\Dictionary|false</info>  Gibt bei Erfolg eine <class>PSpell\Dictionary</class>-Instanz zurück. Bei einem Fehler
                           wird <info>false</info> zurückgegeben.


id: pspell_save_wordlist
type: function
doc:
<comment>Description:</comment>
  Speichert die persönliche Wortliste in einer Datei
  
  <strong>pspell_save_wordlist()</strong> speichert die persönliche Wortliste der aktuellen Sitzung. Die Stelle der
  zu speichernden Dateien muss mit <strong>pspell_config_personal()</strong> und (optional) <strong>pspell_config_repl()</strong>
  bestimmt werden.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Eine <class>PSpell\Dictionary</class>-Instanz.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: pspell_store_replacement
type: function
doc:
<comment>Description:</comment>
  Speichert das Ersetzungspaar für ein Wort
  
  <strong>pspell_store_replacement()</strong> speichert das Ersetzungspaar für ein Wort, damit dieses Ersetzungspaar
  später von <strong>pspell_suggest()</strong> zurückgegeben werden kann. Um von dieser Funktion profitieren zu
  können, muss <strong>pspell_new_personal()</strong> zum Öffnen des Wörterbuchs verwendet werden. Um das
  Ersetzungspaar dauerhaft zu speichern, müssen <strong>pspell_config_personal()</strong> und <strong>pspell_config_repl()</strong>
  verwendet werden, um den Pfad zu setzen, unter dem die selbst erstellten Wortlisten gespeichert
  werden sollen und dann <strong>pspell_save_wordlist()</strong>, damit die Änderungen auf die Festplatte geschrieben
  werden.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Eine <class>PSpell\Dictionary</class>-Instanz.
  <info>string</info>             <strong>$misspelled</strong>  Das falsch geschriebene Wort
  <info>string</info>             <strong>$correct</strong>     Die richtige Schreibweise für <strong>$misspelled</strong>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: pspell_suggest
type: function
doc:
<comment>Description:</comment>
  Macht Vorschläge für die Schreibweise eines Wortes
  
  <strong>pspell_suggest()</strong> gibt ein Array möglicher Schreibweisen für das angegebene Wort zurück.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Eine <class>PSpell\Dictionary</class>-Instanz.
  <info>string</info>             <strong>$word</strong>        Das zu überprüfende Wort.

<comment>Return:</comment>
  <info>array|false</info>  Gibt ein Array möglicher Schreibweisen zurück.


id: putenv
type: function
doc:
<comment>Description:</comment>
  Setzt den Wert einer Umgebungsvariablen
  
  Fügt <strong>$assignment</strong> zur Server-Umgebung hinzu. Die Umgebungsvariable existiert nur für die Dauer der
  aktuellen Anfrage. Am Ende der Anfrage wird der Originalzustand der Umgebung wiederhergestellt.

<comment>Param:</comment>
  <info>string</info>  <strong>$assignment</strong>  Die Einstellung, beispielsweise <return>"FOO=BAR"</return>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>getenv()</strong>
   * <strong>apache_setenv()</strong>


id: quoted_printable_decode
type: function
doc:
<comment>Description:</comment>
  Konvertiert einen "Quoted-Printable"-String in einen 8-Bit-String
  
  Diese Funktion gibt einen 8-Bit-String zurück, der der Konvertierung aus einem
  "Quoted-Printable"-String entspricht (gemäß RFC2045, Kapitel 6.7, aber nicht RFC2821, Kapitel
  4.5.2, da zusätzliche Punkte am Zeilenanfang nicht herausgefiltert werden).
  
  Diese Funktion ist ähnlich wie <strong>imap_qprint()</strong>, mit dem Unterschied, dass sie kein IMAP-Modul
  benötigt.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Die Eingabezeichenkette.

<comment>Return:</comment>
  <info>string</info>  Gibt den 8-Bit-Binärstring zurück.

<comment>See Also:</comment>
   * <strong>quoted_printable_encode()</strong>


id: quoted_printable_encode
type: function
doc:
<comment>Description:</comment>
  Wandelt einen 8-Bit-String in sein 'Quoted Printable' Gegenstück
  
  Gibt einen 'Quoted Printable'-String zurück, der gemäß RFC2045, Abschnitt 6.7, erzeugt wurde.
  
  Die Funktion ist vergleichbar mit <strong>imap_8bit()</strong>, mit dem Unterschied, dass sie kein IMAP-Modul
  benötigt.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Der Eingabestring.

<comment>Return:</comment>
  <info>string</info>  Gibt den kodierten String zurück.

<comment>See Also:</comment>
   * <strong>quoted_printable_decode()</strong>
   * <strong>iconv_mime_encode()</strong>


id: quotemeta
type: function
doc:
<comment>Description:</comment>
  Maskiert (quotet) Meta-Zeichen
  
  Der Inhalt von <strong>$string</strong> wird mit einem Backslash (<return>\</return>) vor jedem Vorkommen von . \ + * ? [ ^ ] ( $ )
  versehen ("quoten") und zurückgegeben.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Die Eingabezeichenkette.

<comment>Return:</comment>
  <info>string</info>  Gibt die Zeichenkette mit maskierten Metazeichen zurück oder <info>false</info>, falls eine leere
          Zeichenkette als <strong>$string</strong> übergeben wurde.

<comment>See Also:</comment>
   * <strong>addslashes()</strong>
   * <strong>addcslashes()</strong>
   * <strong>htmlentities()</strong>
   * <strong>htmlspecialchars()</strong>
   * <strong>nl2br()</strong>
   * <strong>stripslashes()</strong>
   * <strong>stripcslashes()</strong>
   * <strong>preg_quote()</strong>


id: rad2deg
type: function
doc:
<comment>Description:</comment>
  Rechnet einen Winkel vom Bogenmaß in Grad um
  
  Diese Funktion rechnet einen Winkel <strong>$num</strong> vom Bogenmaß in Grad um.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  Ein Winkel im Bogenmaß.

<comment>Return:</comment>
  <info>float</info>  Der zu <strong>$num</strong> äquivalente Wert in Grad.

<comment>See Also:</comment>
   * <strong>deg2rad()</strong>


id: radius_acct_open
type: function
doc:
<comment>Description:</comment>
  Creates a Radius handle for accounting

<comment>Return:</comment>
  <info>resource</info>  Returns a handle on success, <info>false</info> on error. This function only fails if insufficient
            memory is available.


id: radius_add_server
type: function
doc:
<comment>Description:</comment>
  Adds a server
  
  <strong>radius_add_server()</strong> may be called multiple times, and it may be used together with
  <strong>radius_config()</strong>. At most 10 servers may be specified. When multiple servers are given, they are
  tried in round-robin fashion until a valid response is received, or until each server's <strong>$max_tries</strong>
  limit has been reached.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  
  <info>string</info>    <strong>$hostname</strong>       The <strong>$hostname</strong> parameter specifies the server host, either as a fully
                            qualified domain name or as a dotted-quad IP address in text form.
  <info>int</info>       <strong>$port</strong>           The <strong>$port</strong> specifies the UDP port to contact on the server. If port is
                            given as 0, the library looks up the radius/udp or radacct/udp service
                            in the network services database, and uses the port found there.  If no
                            entry is found, the library uses the standard Radius ports, 1812 for
                            authentication and 1813 for accounting.
  <info>string</info>    <strong>$secret</strong>         The shared secret for the server host is passed to the <strong>$secret</strong>
                            parameter. The Radius protocol ignores all but the leading 128 bytes of
                            the shared secret.
  <info>int</info>       <strong>$timeout</strong>        The timeout for receiving replies from the server is passed to the
                            <strong>$timeout</strong> parameter, in units of seconds.
  <info>int</info>       <strong>$max_tries</strong>      The maximum number of repeated requests to make before giving up is
                            passed into the <strong>$max_tries</strong>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>radius_config()</strong>


id: radius_auth_open
type: function
doc:
<comment>Description:</comment>
  Creates a Radius handle for authentication

<comment>Return:</comment>
  <info>resource</info>  Returns a handle on success, <info>false</info> on error. This function only fails if insufficient
            memory is available.


id: radius_close
type: function
doc:
<comment>Description:</comment>
  Frees all ressources
  
  It is not needed to call this function because php frees all resources at the end of each request.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  Die RADIUS-Ressource.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: radius_config
type: function
doc:
<comment>Description:</comment>
  Causes the library to read the given configuration file
  
  Before issuing any Radius requests, the library must be made aware of the servers it can contact.
  The easiest way to configure the library is to call <strong>radius_config()</strong>. <strong>radius_config()</strong> causes the
  library to read a configuration file whose format is described in radius.conf.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  
  <info>string</info>    <strong>$file</strong>           The pathname of the configuration file is passed as the file argument to
                            <strong>radius_config()</strong>. The library can also be configured programmatically by
                            calls to <strong>radius_add_server()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>radius_add_server()</strong>


id: radius_create_request
type: function
doc:
<comment>Description:</comment>
  Create accounting or authentication request
  
  A Radius request consists of a code specifying the kind of request, and zero or more attributes
  which provide additional information. To begin constructing a new request, call
  <strong>radius_create_request()</strong>.
  
  Attention: You must call this function, before you can put any attribute!

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  
  <info>int</info>       <strong>$type</strong>           Type is <info>RADIUS_ACCESS_REQUEST</info> or <info>RADIUS_ACCOUNTING_REQUEST</info>.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>radius_send_request()</strong>


id: radius_cvt_addr
type: function
doc:
<comment>Description:</comment>
  Converts raw data to IP-Address
  
  Converts raw data to IP-Address

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Input data

<comment>Return:</comment>
  <info>string</info>  Returns the IP-Address.

<comment>See Also:</comment>
   * <strong>radius_cvt_int()</strong>
   * <strong>radius_cvt_string()</strong>


id: radius_cvt_int
type: function
doc:
<comment>Description:</comment>
  Converts raw data to integer
  
  Converts raw data to integer

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Input data

<comment>Return:</comment>
  <info>int</info>  Returns the integer, retrieved from data.

<comment>See Also:</comment>
   * <strong>radius_cvt_addr()</strong>
   * <strong>radius_cvt_string()</strong>


id: radius_cvt_string
type: function
doc:
<comment>Description:</comment>
  Converts raw data to string
  
  Converts raw data to string

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Input data

<comment>Return:</comment>
  <info>string</info>  Returns the string, retrieved from data.

<comment>See Also:</comment>
   * <strong>radius_cvt_addr()</strong>
   * <strong>radius_cvt_int()</strong>


id: radius_demangle
type: function
doc:
<comment>Description:</comment>
  Demangles data
  
  Some data (Passwords, MS-CHAPv1 MPPE-Keys) is mangled for security reasons, and must be demangled
  before you can use them.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  Die RADIUS-Ressource.
  <info>string</info>    <strong>$mangled</strong>        The mangled data to demangle

<comment>Return:</comment>
  <info>string</info>  Returns the demangled string, or <info>false</info> on error.


id: radius_demangle_mppe_key
type: function
doc:
<comment>Description:</comment>
  Derives mppe-keys from mangled data
  
  When using MPPE with MS-CHAPv2, the send- and recv-keys are mangled (see RFC 2548), however this
  function is useless, because I don't think that there is or will be a PPTP-MPPE implementation in
  PHP.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  Die RADIUS-Ressource.
  <info>string</info>    <strong>$mangled</strong>        The mangled data to demangle

<comment>Return:</comment>
  <info>string</info>  Returns the demangled string, or <info>false</info> on error.


id: radius_get_attr
type: function
doc:
<comment>Description:</comment>
  Extracts an attribute
  
  Like Radius requests, each response may contain zero or more attributes. After a response has been
  received successfully by <strong>radius_send_request()</strong>, its attributes can be extracted one by one using
  <strong>radius_get_attr()</strong>. Each time <strong>radius_get_attr()</strong> is called, it gets the next attribute from the
  current response.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  Die RADIUS-Ressource.

<comment>Return:</comment>
  <info>mixed</info>  Returns an associative array containing the attribute-type and the data, or error number \<= 0.

<comment>See Also:</comment>
   * <strong>radius_put_attr()</strong>
   * <strong>radius_get_vendor_attr()</strong>
   * <strong>radius_put_vendor_attr()</strong>
   * <strong>radius_send_request()</strong>


id: radius_get_tagged_attr_data
type: function
doc:
<comment>Description:</comment>
  Extracts the data from a tagged attribute
  
  If a tagged attribute has been returned from <strong>radius_get_attr()</strong>, <strong>radius_get_tagged_attr_data()</strong> will
  return the data from the attribute.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The tagged attribute to be decoded.

<comment>Return:</comment>
  <info>string|false</info>  Returns the data from the tagged attribute Bei einem Fehler wird <info>false</info>
                zurückgegeben..

<comment>See Also:</comment>
   * <strong>radius_get_attr()</strong>
   * <strong>radius_get_tagged_attr_tag()</strong>


id: radius_get_tagged_attr_tag
type: function
doc:
<comment>Description:</comment>
  Extracts the tag from a tagged attribute
  
  If a tagged attribute has been returned from <strong>radius_get_attr()</strong>, <strong>radius_get_tagged_attr_data()</strong> will
  return the tag from the attribute.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The tagged attribute to be decoded.

<comment>Return:</comment>
  <info>int|false</info>  Returns the tag from the tagged attribute Bei einem Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>radius_get_attr()</strong>
   * <strong>radius_get_tagged_attr_data()</strong>


id: radius_get_vendor_attr
type: function
doc:
<comment>Description:</comment>
  Extracts a vendor specific attribute
  
  If <strong>radius_get_attr()</strong> returns <info>RADIUS_VENDOR_SPECIFIC</info>, <strong>radius_get_vendor_attr()</strong> may be called to
  determine the vendor.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Input data

<comment>Return:</comment>
  <info>array</info>  Returns an associative array containing the attribute-type, vendor and the data, or <info>false</info>
         on error.

<comment>See Also:</comment>
   * <strong>radius_get_attr()</strong>
   * <strong>radius_put_vendor_attr()</strong>


id: radius_put_addr
type: function
doc:
<comment>Description:</comment>
  Attaches an IP address attribute
  
  Attaches an IP address attribute to the current RADIUS request.
  
  Bevor diese Funktion aufgerufen werden kann, muss mittels <strong>radius_create_request()</strong> eine Anfrage
  erstellt werden.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  Die RADIUS-Ressource.
  <info>int</info>       <strong>$type</strong>           Der Typ des Attributs.
  <info>string</info>    <strong>$addr</strong>           An IPv4 address in string form, such as <return>10.0.0.1</return>.
  <info>int</info>       <strong>$options</strong>        Eine Bitmaske der Attribut-Optionen; zur Verfügung stehen die Optionen
                            <info>RADIUS_OPTION_TAGGED</info> und <info>RADIUS_OPTION_SALT</info>.
  <info>int</info>       <strong>$tag</strong>            Das Attribut-Tag. Dieser Parameter wird nur berücksichtigt, wenn die
                            Option <info>RADIUS_OPTION_TAGGED</info> gesetzt ist.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: radius_put_attr
type: function
doc:
<comment>Description:</comment>
  Attaches a binary attribute
  
  Attaches a binary attribute to the current RADIUS request.
  
  Bevor diese Funktion aufgerufen werden kann, muss mittels <strong>radius_create_request()</strong> eine Anfrage
  erstellt werden.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  Die RADIUS-Ressource.
  <info>int</info>       <strong>$type</strong>           Der Typ des Attributs.
  <info>string</info>    <strong>$value</strong>          The attribute value, which will be treated as a raw binary string.
  <info>int</info>       <strong>$options</strong>        Eine Bitmaske der Attribut-Optionen; zur Verfügung stehen die Optionen
                            <info>RADIUS_OPTION_TAGGED</info> und <info>RADIUS_OPTION_SALT</info>.
  <info>int</info>       <strong>$tag</strong>            Das Attribut-Tag. Dieser Parameter wird nur berücksichtigt, wenn die
                            Option <info>RADIUS_OPTION_TAGGED</info> gesetzt ist.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>radius_get_attr()</strong>
   * <strong>radius_get_vendor_attr()</strong>
   * <strong>radius_put_vendor_attr()</strong>


id: radius_put_int
type: function
doc:
<comment>Description:</comment>
  Attaches an integer attribute
  
  Attaches an integer attribute to the current RADIUS request.
  
  Bevor diese Funktion aufgerufen werden kann, muss mittels <strong>radius_create_request()</strong> eine Anfrage
  erstellt werden.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  Die RADIUS-Ressource.
  <info>int</info>       <strong>$type</strong>           Der Typ des Attributs.
  <info>int</info>       <strong>$value</strong>          The attribute value.
  <info>int</info>       <strong>$options</strong>        Eine Bitmaske der Attribut-Optionen; zur Verfügung stehen die Optionen
                            <info>RADIUS_OPTION_TAGGED</info> und <info>RADIUS_OPTION_SALT</info>.
  <info>int</info>       <strong>$tag</strong>            Das Attribut-Tag. Dieser Parameter wird nur berücksichtigt, wenn die
                            Option <info>RADIUS_OPTION_TAGGED</info> gesetzt ist.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>radius_put_string()</strong>
   * <strong>radius_put_vendor_int()</strong>
   * <strong>radius_put_vendor_string()</strong>


id: radius_put_string
type: function
doc:
<comment>Description:</comment>
  Attaches a string attribute
  
  Attaches a string attribute to the current RADIUS request. In general, <strong>radius_put_attr()</strong> is a more
  useful function for attaching string attributes, as it is binary safe.
  
  Bevor diese Funktion aufgerufen werden kann, muss mittels <strong>radius_create_request()</strong> eine Anfrage
  erstellt werden.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  Die RADIUS-Ressource.
  <info>int</info>       <strong>$type</strong>           Der Typ des Attributs.
  <info>string</info>    <strong>$value</strong>          The attribute value. This value is expected by the underlying library to
                            be null terminated, therefore this parameter is not binary safe.
  <info>int</info>       <strong>$options</strong>        Eine Bitmaske der Attribut-Optionen; zur Verfügung stehen die Optionen
                            <info>RADIUS_OPTION_TAGGED</info> und <info>RADIUS_OPTION_SALT</info>.
  <info>int</info>       <strong>$tag</strong>            Das Attribut-Tag. Dieser Parameter wird nur berücksichtigt, wenn die
                            Option <info>RADIUS_OPTION_TAGGED</info> gesetzt ist.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>radius_put_int()</strong>
   * <strong>radius_put_vendor_int()</strong>
   * <strong>radius_put_vendor_string()</strong>


id: radius_put_vendor_addr
type: function
doc:
<comment>Description:</comment>
  Attaches a vendor specific IP address attribute
  
  Attaches an IP address vendor specific attribute to the current RADIUS request.
  
  Bevor diese Funktion aufgerufen werden kann, muss mittels <strong>radius_create_request()</strong> eine Anfrage
  erstellt werden.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  Die RADIUS-Ressource.
  <info>int</info>       <strong>$vendor</strong>         Die Anbieter-ID.
  <info>int</info>       <strong>$type</strong>           Der Typ des Attributs.
  <info>string</info>    <strong>$addr</strong>           An IPv4 address in string form, such as <return>10.0.0.1</return>.
  <info></info>          <strong>$options</strong>        Eine Bitmaske der Attribut-Optionen; zur Verfügung stehen die Optionen
                            <info>RADIUS_OPTION_TAGGED</info> und <info>RADIUS_OPTION_SALT</info>.
  <info></info>          <strong>$tag</strong>            Das Attribut-Tag. Dieser Parameter wird nur berücksichtigt, wenn die
                            Option <info>RADIUS_OPTION_TAGGED</info> gesetzt ist.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: radius_put_vendor_attr
type: function
doc:
<comment>Description:</comment>
  Attaches a vendor specific binary attribute
  
  Attaches a vendor specific binary attribute to the current RADIUS request.
  
  Bevor diese Funktion aufgerufen werden kann, muss mittels <strong>radius_create_request()</strong> eine Anfrage
  erstellt werden.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  Die RADIUS-Ressource.
  <info>int</info>       <strong>$vendor</strong>         Die Anbieter-ID.
  <info>int</info>       <strong>$type</strong>           Der Typ des Attributs.
  <info>string</info>    <strong>$value</strong>          The attribute value, which will be treated as a raw binary string.
  <info>int</info>       <strong>$options</strong>        Eine Bitmaske der Attribut-Optionen; zur Verfügung stehen die Optionen
                            <info>RADIUS_OPTION_TAGGED</info> und <info>RADIUS_OPTION_SALT</info>.
  <info>int</info>       <strong>$tag</strong>            Das Attribut-Tag. Dieser Parameter wird nur berücksichtigt, wenn die
                            Option <info>RADIUS_OPTION_TAGGED</info> gesetzt ist.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>radius_get_vendor_attr()</strong>


id: radius_put_vendor_int
type: function
doc:
<comment>Description:</comment>
  Attaches a vendor specific integer attribute
  
  Attaches a vendor specific integer attribute to the current RADIUS request.
  
  Bevor diese Funktion aufgerufen werden kann, muss mittels <strong>radius_create_request()</strong> eine Anfrage
  erstellt werden.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  Die RADIUS-Ressource.
  <info>int</info>       <strong>$vendor</strong>         Die Anbieter-ID.
  <info>int</info>       <strong>$type</strong>           Der Typ des Attributs.
  <info>int</info>       <strong>$value</strong>          The attribute value.
  <info>int</info>       <strong>$options</strong>        Eine Bitmaske der Attribut-Optionen; zur Verfügung stehen die Optionen
                            <info>RADIUS_OPTION_TAGGED</info> und <info>RADIUS_OPTION_SALT</info>.
  <info>int</info>       <strong>$tag</strong>            Das Attribut-Tag. Dieser Parameter wird nur berücksichtigt, wenn die
                            Option <info>RADIUS_OPTION_TAGGED</info> gesetzt ist.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>radius_put_vendor_string()</strong>


id: radius_put_vendor_string
type: function
doc:
<comment>Description:</comment>
  Attaches a vendor specific string attribute
  
  Attaches a vendor specific string attribute to the current RADIUS request. In general,
  <strong>radius_put_vendor_attr()</strong> is a more useful function for attaching string attributes, as it is
  binary safe.
  
  Bevor diese Funktion aufgerufen werden kann, muss mittels <strong>radius_create_request()</strong> eine Anfrage
  erstellt werden.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  Die RADIUS-Ressource.
  <info>int</info>       <strong>$vendor</strong>         Die Anbieter-ID.
  <info>int</info>       <strong>$type</strong>           Der Typ des Attributs.
  <info>string</info>    <strong>$value</strong>          The attribute value. This value is expected by the underlying library to
                            be null terminated, therefore this parameter is not binary safe.
  <info>int</info>       <strong>$options</strong>        Eine Bitmaske der Attribut-Optionen; zur Verfügung stehen die Optionen
                            <info>RADIUS_OPTION_TAGGED</info> und <info>RADIUS_OPTION_SALT</info>.
  <info>int</info>       <strong>$tag</strong>            Das Attribut-Tag. Dieser Parameter wird nur berücksichtigt, wenn die
                            Option <info>RADIUS_OPTION_TAGGED</info> gesetzt ist.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>radius_put_vendor_int()</strong>


id: radius_request_authenticator
type: function
doc:
<comment>Description:</comment>
  Returns the request authenticator
  
  The request authenticator is needed for demangling mangled data like passwords and
  encryption-keys.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  Die RADIUS-Ressource.

<comment>Return:</comment>
  <info>string</info>  Returns the request authenticator as string, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>radius_demangle()</strong>


id: radius_salt_encrypt_attr
type: function
doc:
<comment>Description:</comment>
  Salt-encrypts a value
  
  Applies the RADIUS salt-encryption algorithm to the given value.
  
  In general, this is achieved automatically by providing the <info>RADIUS_OPTION_SALT</info> option to an
  attribute setter function, but this function can be used if low-level request construction is
  required.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The data to be salt-encrypted.

<comment>Return:</comment>
  <info>string|false</info>  Returns the salt-encrypted data Bei einem Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>radius_put_addr()</strong>
   * <strong>radius_put_attr()</strong>
   * <strong>radius_put_int()</strong>
   * <strong>radius_put_string()</strong>


id: radius_send_request
type: function
doc:
<comment>Description:</comment>
  Sends the request and waits for a reply
  
  After the Radius request has been constructed, it is sent by <strong>radius_send_request()</strong>.
  
  The <strong>radius_send_request()</strong> function sends the request and waits for a valid reply, retrying the
  defined servers in round-robin fashion as necessary.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  Die RADIUS-Ressource.

<comment>Return:</comment>
  <info>int</info>  If a valid response is received, <strong>radius_send_request()</strong> returns the Radius code which
       specifies the type of the response. This will typically be <info>RADIUS_ACCESS_ACCEPT</info>,
       <info>RADIUS_ACCESS_REJECT</info>, or <info>RADIUS_ACCESS_CHALLENGE</info>. If no valid response is received,
       <strong>radius_send_request()</strong> returns <info>false</info>.

<comment>See Also:</comment>
   * <strong>radius_create_request()</strong>


id: radius_server_secret
type: function
doc:
<comment>Description:</comment>
  Returns the shared secret
  
  The shared secret is needed as salt for demangling mangled data like passwords and
  encryption-keys.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  Die RADIUS-Ressource.

<comment>Return:</comment>
  <info>string</info>  Returns the server's shared secret as string, or <info>false</info> on error.


id: radius_strerror
type: function
doc:
<comment>Description:</comment>
  Returns an error message
  
  If Radius-functions fail then they record an error message. This error message can be retrieved
  with this function.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  Die RADIUS-Ressource.

<comment>Return:</comment>
  <info>string</info>  Returns error messages as string from failed radius functions.


id: rand
type: function
doc:
<comment>Description:</comment>
  Erzeugt eine zufällige Zahl
  
  Gibt eine Pseudozufallszahl zwischen <strong>$min</strong> und <strong>$max</strong> (inklusive) zurück oder zwischen 0 und
  <strong>getrandmax()</strong>, falls keine Parameter angegeben wurden. Wenn z. B. ein Zufallswert zwischen 5 und 15
  benötigt wird, so wäre der Aufruf dafür <return>rand(5, 15)</return>.
  
  Diese Funktion erzeugt keine kryptografisch sicheren Werte und darf nicht für kryptografische
  Zwecke verwendet werden oder für Zwecke, bei denen die zurückgegebenen Werte nicht abschätzbar
  sein dürfen.
  
  Falls kryptographisch sichere Zufallszahlen benötigt werden, kann der <class>Random\Randomizer</class> mit der
  <class>Random\Engine\Secure</class>-Engine verwendet werden. Für einfache Anwendungsfälle bieten die Funktionen
  <strong>random_int()</strong> und <strong>random_bytes()</strong> eine bequeme und sichere API, die den CSPRNG des Betriebssystems
  verwendet.
  
  Auf manchen Plattformen (z. B. Windows) ist <strong>getrandmax()</strong> nur 32767. Wenn ein größerer Wertebereich
  benötigt wird, kann entweder ein größerer <strong>$max</strong>-Wert übergeben werden oder es kann stattdessen die
  Funktion <strong>mt_rand()</strong> verwendet werden.
  
  Ab PHP 7.1.0 verwendet <strong>rand()</strong> denselben Zufallszahlengenerator wie <strong>mt_rand()</strong>. Um die
  Abwärtskompatibilität zu wahren, erlaubt <strong>rand()</strong>, dass <strong>$max</strong> kleiner als <strong>$min</strong> ist, ohne wie
  <strong>mt_rand()</strong> <info>false</info> zurückzugeben.

<comment>Param:</comment>
  <info>int</info>  <strong>$min</strong>  Der niedrigste zurückzugebende Wert (Vorgabe: 0)
  <info>int</info>  <strong>$max</strong>  Der höchste zurückzugebende Wert (Vorgabe: <strong>getrandmax()</strong>)

<comment>Return:</comment>
  <info>int</info>  Ein Pseudozufallswert zwischen <strong>$min</strong> (oder 0) und <strong>$max</strong> (oder <strong>getrandmax()</strong>, inklusive).

<comment>See Also:</comment>
   * <strong>srand()</strong>
   * <strong>getrandmax()</strong>
   * <strong>mt_rand()</strong>
   * <strong>random_int()</strong>
   * <strong>random_bytes()</strong>


id: random_bytes
type: function
doc:
<comment>Description:</comment>
  Get cryptographically secure random bytes
  
  Generates a string containing uniformly selected random bytes with the requested <strong>$length</strong>.
  
  As the returned bytes are selected completely randomly, the resulting string is likely to contain
  unprintable characters or invalid UTF-8 sequences. It may be necessary to encode it before
  transmission or display.
  
  The randomness generated by this function is suitable for all applications, including the
  generation of long-term secrets, such as encryption keys.
  
  Die Zufallsquellen in der Reihenfolge ihrer Priorität sind folgende:
  
  Linux: getrandom(), /dev/urandom
  
  FreeBSD &gt;= 12 (PHP &gt;= 7.3): getrandom(), /dev/urandom
  
  Windows (PHP &gt;= 7.2): CNG-API
  
  Windows: CryptGenRandom
  
  macOS (PHP &gt;= 8.2; &gt;= 8.1.9; &gt;= 8.0.22 wenn CCRandomGenerateBytes bei der Kompilierung
  verfügbar ist): CCRandomGenerateBytes()
  
  macOS (PHP &gt;= 8.1; &gt;= 8.0.2): arc4random_buf(), /dev/urandom
  
  NetBSD &gt;= 7 (PHP &gt;= 7.1; &gt;= 7.0.1): arc4random_buf(), /dev/urandom
  
  OpenBSD &gt;= 5.5 (PHP &gt;= 7.1; &gt;= 7.0.1): arc4random_buf(), /dev/urandom
  
  DragonflyBSD (PHP &gt;= 8.1): getrandom(), /dev/urandom
  
  Solaris (PHP &gt;= 8.1): getrandom(), /dev/urandom
  
  Jede beliebige Kombination von Betriebssystem und PHP-Version, die oben nicht erwähnt wurde:
  /dev/urandom
  
  Wenn keine der Quellen verfügbar ist oder keine davon Zufälligkeit erzeugen kann, wird eine
  <class>Random\RandomException</class> ausgelöst.
  
  Obwohl diese Funktion erst mit PHP 7.0.0 in PHP hinzugefügt wurde, gibt es
  Userland-Implementierungen für PHP 5.2 bis einschließlich 5.6.

<comment>Param:</comment>
  <info>int</info>  <strong>$length</strong>  The length of the random string that should be returned in bytes; must be <return>1</return> or
                greater.

<comment>Return:</comment>
  <info>string</info>  A string containing the requested number of cryptographically secure random bytes.

<comment>See Also:</comment>
   * <strong>Random\Randomizer::getBytes()</strong>
   * <strong>random_int()</strong>
   * <strong>bin2hex()</strong>
   * <strong>base64_encode()</strong>


id: random_int
type: function
doc:
<comment>Description:</comment>
  Get a cryptographically secure, uniformly selected integer
  
  Generates a uniformly selected integer between the given minimum and maximum.
  
  The randomness generated by this function is suitable for all applications, including the
  generation of long-term secrets, such as encryption keys.
  
  Die Zufallsquellen in der Reihenfolge ihrer Priorität sind folgende:
  
  Linux: getrandom(), /dev/urandom
  
  FreeBSD &gt;= 12 (PHP &gt;= 7.3): getrandom(), /dev/urandom
  
  Windows (PHP &gt;= 7.2): CNG-API
  
  Windows: CryptGenRandom
  
  macOS (PHP &gt;= 8.2; &gt;= 8.1.9; &gt;= 8.0.22 wenn CCRandomGenerateBytes bei der Kompilierung
  verfügbar ist): CCRandomGenerateBytes()
  
  macOS (PHP &gt;= 8.1; &gt;= 8.0.2): arc4random_buf(), /dev/urandom
  
  NetBSD &gt;= 7 (PHP &gt;= 7.1; &gt;= 7.0.1): arc4random_buf(), /dev/urandom
  
  OpenBSD &gt;= 5.5 (PHP &gt;= 7.1; &gt;= 7.0.1): arc4random_buf(), /dev/urandom
  
  DragonflyBSD (PHP &gt;= 8.1): getrandom(), /dev/urandom
  
  Solaris (PHP &gt;= 8.1): getrandom(), /dev/urandom
  
  Jede beliebige Kombination von Betriebssystem und PHP-Version, die oben nicht erwähnt wurde:
  /dev/urandom
  
  Wenn keine der Quellen verfügbar ist oder keine davon Zufälligkeit erzeugen kann, wird eine
  <class>Random\RandomException</class> ausgelöst.
  
  Obwohl diese Funktion erst mit PHP 7.0.0 in PHP hinzugefügt wurde, gibt es
  Userland-Implementierungen für PHP 5.2 bis einschließlich 5.6.

<comment>Param:</comment>
  <info>int</info>  <strong>$min</strong>  The lowest value to be returned.
  <info>int</info>  <strong>$max</strong>  The highest value to be returned.

<comment>Return:</comment>
  <info>int</info>  A cryptographically secure, uniformly selected integer from the closed interval [<strong>$min</strong>, <strong>$max</strong>].
       Both <strong>$min</strong> and <strong>$max</strong> are possible return values.

<comment>See Also:</comment>
   * Random\Randomizer::getInt
   * <strong>random_bytes()</strong>


id: range
type: function
doc:
<comment>Description:</comment>
  Erstellt ein Array mit einem Bereich von Elementen
  
  Erstellt ein Array mit einem Bereich von Elementen.
  
  Wenn sowohl <strong>$start</strong> als auch <strong>$end</strong> vom Typ <info>string</info> sind und <strong>$step</strong> vom Typ <info>int</info> ist, ist das erzeugte
  Array eine Folge von Bytes. Andernfalls ist das erzeugte Array eine Folge von Zahlen.
  
  Wenn der <strong>$start</strong> kleiner ist als <strong>$end</strong>, ist die Folge aufsteigend, andernfalls ist sie absteigend.

<comment>Param:</comment>
  <info>string|int|float</info>  <strong>$start</strong>  Der erste Wert der Folge.
  <info>string|int|float</info>  <strong>$end</strong>    Der letzte mögliche Wert der Folge.
  <info>int|float</info>         <strong>$step</strong>   <strong>$step</strong> gibt an, wie weit die einzelnen Werte der erzeugten Folge
                            auseinander liegen.
                            
                            <strong>$step</strong> kann für absteigende Folgen negativ sein.
                            
                            Wenn <strong>$step</strong> ein <info>float</info> ohne Nachkommastelle ist, wird er als <info>int</info>
                            interpretiert.

<comment>Return:</comment>
  <info>array</info>  Gibt eine Folge von Elementen als <info>Array</info> zurück, beginnend mit <strong>$start</strong> und endend mit <strong>$end</strong>,
         wobei die einzelnen Werte der Folge einen Abstand von <strong>$step</strong> voneinander haben.
         
         Das letzte Element des zurückgegebenen Arrays ist in Abhängigkeit vom Wert von <strong>$step</strong>
         entweder <strong>$end</strong> oder das vorherige Element der Folge.
         
         Wenn sowohl <strong>$start</strong> als auch <strong>$end</strong> vom Typ <info>string</info> sind und <strong>$step</strong> vom Typ <info>int</info> ist, besteht das
         erzeugte Array aus einer Folge von Bytes, in der Regel lateinische ASCII-Zeichen.
         
         Wenn mindestens einer der Parameter <strong>$start</strong>, <strong>$end</strong> oder <strong>$step</strong> vom Typ <info>float</info> ist, ist das
         erzeugte Array eine Folge vom Typ <info>float</info>.
         
         Andernfalls ist das erzeugte Array eine Folge vom Typ <info>int</info>.

<comment>See Also:</comment>
   * <strong>shuffle()</strong>
   * <strong>array_fill()</strong>
   * foreach


id: rar_wrapper_cache_stats
type: function
doc:
<comment>Description:</comment>
  Cache hits and misses for the URL wrapper
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>string</info>  


id: rawurldecode
type: function
doc:
<comment>Description:</comment>
  Dekodiert URL-kodierte Strings
  
  Gibt einen String zurück, in dem die Abfolgen beginnend mit einem Prozentzeichen (<return>%</return>) gefolgt von
  zwei Hex-Werten durch ihr originäres Zeichen ersetzt wurden.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Der zu dekodierende URL.

<comment>Return:</comment>
  <info>string</info>  Gibt die dekodierte URL im Stringformat zurück.

<comment>See Also:</comment>
   * <strong>rawurlencode()</strong>
   * <strong>urldecode()</strong>
   * <strong>urlencode()</strong>
   * RFC 3986


id: rawurlencode
type: function
doc:
<comment>Description:</comment>
  URL-Kodierung nach RFC 3986
  
  Kodiert einen übergebenen String entsprechend RFC 3986.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Die zu kodierende URL.

<comment>Return:</comment>
  <info>string</info>  Gibt einen String zurück, in dem alle nicht-alphanumerischen Zeichen außer <return>-_.~</return> durch ein
          Prozentzeichen (<return>%</return>) gefolgt von zwei Hex-Werten ersetzt wurden. Diese Kodierung,
          beschrieben im RFC 3986, wurde entworfen, um Sonderzeichen davor zu bewahren, fälschlich
          als spezielle URL-Trennzeichen interpretiert zu werden, sowie um URLs vor dem Verstümmeln
          durch Übertragungsmedien mit Zeichenumwandlung (wie bei einigen E-Mail-Systemen) zu
          schützen.

<comment>See Also:</comment>
   * <strong>rawurldecode()</strong>
   * <strong>urldecode()</strong>
   * <strong>urlencode()</strong>
   * RFC 3986


id: read_exif_data
type: function
doc:
<comment>Description:</comment>
  Alias von exif_read_data
  
  Diese Funktion ist ein Alias für:  <strong>exif_read_data()</strong>.


id: readdir
type: function
doc:
<comment>Description:</comment>
  Liest einen Eintrag aus einem Verzeichnis-Handle
  
  Gibt den Namen des nächsten Eintrags des Verzeichnisses zurück. Die Einträge werden in der
  Reihenfolge zurückgegeben, in der sie innerhalb des Dateisystems angelegt wurden.

<comment>Param:</comment>
  <info>resource|null</info>  <strong>$dir_handle</strong>  Die Verzeichnis-Handle-<info>Ressource</info>, die zuvor mit <strong>opendir()</strong> geöffnet
                              wurde. Wenn das Verzeichnis-Handle nicht angegeben ist, wird dasjenige
                              verwendet, das auf das zuletzt mittels <strong>opendir()</strong> geöffnete Verzeichnis
                              zeigt.

<comment>Return:</comment>
  <info>string|false</info>  Gibt bei Erfolg den Namen des Eintrags zurück. Bei einem Fehler wird <info>false</info>
                zurückgegeben.
                
                Diese Funktion kann sowohl das
                boolsche <info>false</info> zurückliefern, als auch einen nicht-boolschen Wert, welcher zu <info>false</info>
                ausgewertet wird.
                Weitere Informationen entnehmen Sie bitte dem Abschnitt über die
                 boolschen Typen. Benutzen Sie deshalb
                den === Operator,
                um den Rückgabewert dieser Funktion zu überprüfen.

<comment>See Also:</comment>
   * <strong>is_dir()</strong>
   * <strong>glob()</strong>
   * <strong>opendir()</strong>
   * <strong>scandir()</strong>


id: readfile
type: function
doc:
<comment>Description:</comment>
  Gibt eine Datei aus
  
  Liest den Inhalt einer Datei und schreibt ihn in den Ausgabepuffer.

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>          Der Name der Datei, die gelesen werden soll.
  <info>bool</info>           <strong>$use_include_path</strong>  Sie können optional den zweiten Parameter benutzen und diesen
                                    auf <info>true</info> setzen, wenn Sie auch im include_path nach der Datei
                                    suchen möchten.
  <info>resource|null</info>  <strong>$context</strong>           Eine Stream-Kontext-<info>Ressource</info>.

<comment>Return:</comment>
  <info>int|false</info>  Gibt bei Erfolg die Anzahl der gelesenen Bytes einer Datei zurück. Bei einem Fehler
             wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>fpassthru()</strong>
   * <strong>file()</strong>
   * <strong>fopen()</strong>
   * <strong>include()</strong>
   * <strong>require()</strong>
   * <strong>virtual()</strong>
   * <strong>file_get_contents()</strong>
   * 


id: readgzfile
type: function
doc:
<comment>Description:</comment>
  Gibt eine gz-komprimierte Datei aus
  
  Liest eine Datei, dekomprimiert sie und gibt das Ergebnis auf die Standardausgabe aus.
  
  <strong>readgzfile()</strong> kann auch Dateien lesen, die nicht im gzip-Format vorliegen; in diesem Fall wird der
  Inhalt der Datei direkt ohne Dekomprimierung ausgegeben.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>          Der Dateiname. Die Datei wird geöffnet und ihr Inhalt auf die
                             Standardausgabe ausgegeben.
  <info>int</info>     <strong>$use_include_path</strong>  Dieser Parameter kann auf <return>1</return> gesetzt werden, wenn die Datei auch im
                             include_path gesucht werden soll.

<comment>Return:</comment>
  <info>int|false</info>  Gibt im Erfolgsfall die Anzahl der ausgegebenen Zeichen zurück. Bei einem Fehler wird
             <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>gzpassthru()</strong>
   * <strong>gzfile()</strong>
   * <strong>gzopen()</strong>


