# php_manual

id: imap_headers
type: function
doc:
<comment>Description:</comment>
  Liefert die Kopfzeilen aller Nachrichten eines Postfachs
  
  Diese Funktion gibt die Kopfzeilen aller Nachrichten eines Postfachs zurück.

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

<comment>Return:</comment>
  <info>array|false</info>  Gibt ein Array aus Strings mit formatierten Headerinformationen zurück. Das Array
               enthält ein Element für jede Nachricht im Postfach. Bei einem Fehler wird <info>false</info>
               zurückgegeben.


id: imap_is_open
type: function
doc:
<comment>Description:</comment>
  Check if the IMAP stream is still valid
  
  Check if the IMAP stream is still valid.

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

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the stream is still valid, <info>false</info> otherwise.


id: imap_last_error
type: function
doc:
<comment>Description:</comment>
  Liefert den zuletzt aufgetretenen IMAP-Fehler
  
  Gibt den vollständigen Text der letzten IMAP-Fehlermeldung zurück, die für die aktuelle Seite
  erzeugt wurde. Der Fehlerstack bleibt erhalten, wiederholte <strong>imap_last_error()</strong>-Aufrufe liefern
  daher die gleiche Fehlermeldung, falls nicht inzwschen ein weiterer Fehler aufgetreten ist.

<comment>Return:</comment>
  <info>string|false</info>  Gibt den vollständigen Text der letzten IMAP-Fehlermeldung zurück, die auf der
                aktuellen Seite aufgetreten ist, und <info>false</info>, wenn es keine gibt.

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


id: imap_list
type: function
doc:
<comment>Description:</comment>
  Liefert die Liste der Postfächer
  
  Gibt die Liste aller Pöstfächer zurück.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>       Eine <class>IMAP\Connection</class>-Instanz.
  <info>string</info>           <strong>$reference</strong>  Die Angabe des Servers in der in <strong>imap_open()</strong> beschriebenen Form.
                               
                               Die Übergabe von nicht vertrauenswürdigen Daten an diesen Parameter
                               ist unsicher,falls
                               imap.enable_insecure_rsh nicht deaktiviert ist.
  <info>string</info>           <strong>$pattern</strong>    Gibt an, wo in der Postfach-Hierarchie
                               mit der Suche begonnen werden soll.
                               
                               Es gibt zwei Sonderzeichen, die
                               man als Teil von <strong>$pattern</strong> verwenden kann:
                               '<return>*</return>' und '<return>%</return>'.
                               '<return>*</return>' heißt, dass alle Postfächer zurückgegeben
                               werden sollen. Wenn man <strong>$pattern</strong> als
                               '<return>*</return>' übergibt, so erhält man eine Liste der
                               vollständigen Postfach-Hierarchie. '<return>%</return>' heißt,
                               dass nur die aktuelle Stufe zurückgegeben wird.
                               '<return>%</return>' als Wert des Parameters <strong>$pattern</strong> gibt nur die Postfächer der
                               obersten Ebene zurück.
                               '<return>~/mail/%</return>' unter <return>UW_IMAPD</return> gibt alle Postfächer des
                               Verzeichnisses ~/mail zurück, aber keine aus dessen
                               Unterverzeichnissen.

<comment>Return:</comment>
  <info>array|false</info>  Gibt ein Array mit den Namen der gefundenen Postfächer zurück oder <info>false</info> im
               Fehlerfall.

<comment>See Also:</comment>
   * <strong>imap_getmailboxes()</strong>
   * <strong>imap_lsub()</strong>


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


id: imap_listscan
type: function
doc:
<comment>Description:</comment>
  Liefert eine Liste von Postfächern nach Suchkriterien
  
  Gibt ein Array mit den Namen der Postfächer zurück, in deren Inhalt der Suchtext <strong>$content</strong>
  vorkommt.
  
  Diese Funktion verhält sich ähnlich wie <strong>imap_listmailbox()</strong>, sucht aber zusätzlich nach dem
  Suchtext <strong>$content</strong> innerhalb der Daten des Postfachs.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>       Eine <class>IMAP\Connection</class>-Instanz.
  <info>string</info>           <strong>$reference</strong>  Die Angabe des Servers in der in <strong>imap_open()</strong> beschriebenen Form.
                               
                               Die Übergabe von nicht vertrauenswürdigen Daten an diesen Parameter
                               ist unsicher,falls
                               imap.enable_insecure_rsh nicht deaktiviert ist.
  <info>string</info>           <strong>$pattern</strong>    Gibt an, wo in der Postfach-Hierarchie
                               mit der Suche begonnen werden soll.
                               
                               Es gibt zwei Sonderzeichen, die
                               man als Teil von <strong>$pattern</strong> verwenden kann:
                               '<return>*</return>' und '<return>%</return>'.
                               '<return>*</return>' heißt, dass alle Postfächer zurückgegeben
                               werden sollen. Wenn man <strong>$pattern</strong> als
                               '<return>*</return>' übergibt, so erhält man eine Liste der
                               vollständigen Postfach-Hierarchie. '<return>%</return>' heißt,
                               dass nur die aktuelle Stufe zurückgegeben wird.
                               '<return>%</return>' als Wert des Parameters <strong>$pattern</strong> gibt nur die Postfächer der
                               obersten Ebene zurück.
                               '<return>~/mail/%</return>' unter <return>UW_IMAPD</return> gibt alle Postfächer des
                               Verzeichnisses ~/mail zurück, aber keine aus dessen
                               Unterverzeichnissen.
  <info>string</info>           <strong>$content</strong>    Der zu suchende Text

<comment>Return:</comment>
  <info>array|false</info>  Gibt ein Array mit den Namen der Postfächer zurück, in deren Inhalt der Suchtext
               <strong>$content</strong> vorkommt. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>imap_listmailbox()</strong>
   * <strong>imap_search()</strong>


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


id: imap_lsub
type: function
doc:
<comment>Description:</comment>
  Liefert eine Liste aller abonnierten Postfächer
  
  Gibt ein Array aller vom Benutzer abonnierten Postfächer zurück.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>       Eine <class>IMAP\Connection</class>-Instanz.
  <info>string</info>           <strong>$reference</strong>  Die Angabe des Servers in der in <strong>imap_open()</strong> beschriebenen Form.
                               
                               Die Übergabe von nicht vertrauenswürdigen Daten an diesen Parameter
                               ist unsicher,falls
                               imap.enable_insecure_rsh nicht deaktiviert ist.
  <info>string</info>           <strong>$pattern</strong>    Gibt an, wo in der Postfach-Hierarchie
                               mit der Suche begonnen werden soll.
                               
                               Es gibt zwei Sonderzeichen, die
                               man als Teil von <strong>$pattern</strong> verwenden kann:
                               '<return>*</return>' und '<return>%</return>'.
                               '<return>*</return>' heißt, dass alle Postfächer zurückgegeben
                               werden sollen. Wenn man <strong>$pattern</strong> als
                               '<return>*</return>' übergibt, so erhält man eine Liste der
                               vollständigen Postfach-Hierarchie. '<return>%</return>' heißt,
                               dass nur die aktuelle Stufe zurückgegeben wird.
                               '<return>%</return>' als Wert des Parameters <strong>$pattern</strong> gibt nur die Postfächer der
                               obersten Ebene zurück.
                               '<return>~/mail/%</return>' unter <return>UW_IMAPD</return> gibt alle Postfächer des
                               Verzeichnisses ~/mail zurück, aber keine aus dessen
                               Unterverzeichnissen.

<comment>Return:</comment>
  <info>array|false</info>  Gibt ein Array mit allen abonnierten Postfächern zurück. Bei einem Fehler wird <info>false</info>
               zurückgegeben.

<comment>See Also:</comment>
   * <strong>imap_list()</strong>
   * <strong>imap_getmailboxes()</strong>


id: imap_mail
type: function
doc:
<comment>Description:</comment>
  Sendet eine E-Mail-Nachricht
  
  Diese Funktion ermöglicht das Senden einer E-Mail mit korrekter Behandlung von Cc- und
  Bcc-Kopffeldern.
  
  Die Parameter <strong>$to</strong>, <strong>$cc</strong> und <strong>$bcc</strong> sind Strings, die als Adresslisten gemäß RFC822 interpretiert
  werden.

<comment>Param:</comment>
  <info>string</info>       <strong>$to</strong>                  Der Empfänger der Nachricht
  <info>string</info>       <strong>$subject</strong>             Die Betreffzeile der Nachricht
  <info>string</info>       <strong>$message</strong>             Der Inhalt der Nachricht, siehe <strong>imap_mail_compose()</strong>
  <info>string|null</info>  <strong>$additional_headers</strong>  Ein String mit zusätzlichen Kopfzeilen
  <info>string|null</info>  <strong>$cc</strong>                  
  <info>string|null</info>  <strong>$bcc</strong>                 Die in <strong>$bcc</strong> angegebenen weiteren Empfänger erhalten die
                                    Nachricht, werden aber nicht im Nachrichtenkopf aufgeführt.
  <info>string|null</info>  <strong>$return_path</strong>         Die Rückgabeadresse für den Fall, dass die Zustellung der
                                    Nachricht fehlschlägt. Diese ist nützlich, wenn PHP als
                                    Mail-Client für mehrere Benutzer verwendet wird.

<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>mail()</strong>
   * <strong>imap_mail_compose()</strong>


id: imap_mail_compose
type: function
doc:
<comment>Description:</comment>
  Erzeugt eine MIME-Nachricht aus Kopf- und Nachrichtenelementen
  
  Erzeugt eine MIME-konforme Nachricht aus den in <strong>$envelope</strong> gegebenen Kopfelementen und den
  Nachrichtenteilen aus <strong>$bodies</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$envelope</strong>  Ein assoziatives Array von Kopfzeilenfeldern. Gültige Schlüssel sind: <return>"remail"</return>,
                    <return>"return_path"</return>, <return>"date"</return>, <return>"from"</return>, <return>"reply_to"</return>, <return>"in_reply_to"</return>, <return>"subject"</return>, <return>"to"</return>, <return>"cc"</return>,
                    <return>"bcc"</return> und <return>"message_id"</return>, die die jeweiligen Kopfzeilen zum angegebenen String
                    definieren. Um zusätzliche Kopfzeilen zu definieren, kann der Schlüssel
                    <return>"custom_headers"</return> verwendet werden, der ein Array von anderen Kopfzeilen
                    erwartet, z. B. ["User-Agent: Mein Mail-Client"]).
  <info>array</info>  <strong>$bodies</strong>    Ein Array mit dem Textkörper. Das erste Element des Arrays ist der zentrale Teil
                    der Nachricht. Nur wenn er vom Typ <info>TYPEMULTIPART</info> ist, werden die weiteren
                    Elemente verarbeitet. Die verarbeiteten Elemente bilden die Teile des Körpers.
                    
                    Der Aufbau des Körper-ArraysSchlüsselTypBeschreibung<return>type</return><info>int</info> Der MIME-Typ.
                    Entweder <info>TYPETEXT</info> (Standard), <info>TYPEMULTIPART</info>, <info>TYPEMESSAGE</info>, <info>TYPEAPPLICATION</info>,
                    <info>TYPEAUDIO</info>, <info>TYPEIMAGE</info>, <info>TYPEMODEL</info> oder <info>TYPEOTHER</info>. <return>encoding</return><info>int</info> Das
                    <return>Content-Transfer-Encoding</return>. Entweder <info>ENC7BIT</info> (Standard), <info>ENC8BIT</info>, <info>ENCBINARY</info>,
                    <info>ENCBASE64</info>, <info>ENCQUOTEDPRINTABLE</info> oder <info>ENCOTHER</info>. <return>charset</return><info>string</info>Der
                    Zeichensatz-Parameter des MIME-Typs.<return>type.parameters</return><info>array</info> Ein assoziatives Array
                    von <return>Content-Type</return>-Parameternamen und deren Werten. <return>subtype</return><info>string</info> Der MIME-Subtyp,
                    z. B. <return>'jpeg'</return> für <info>TYPEIMAGE</info>. <return>id</return><info>string</info>Die <return>Content-ID</return>.<return>description</return><info>string</info>Die
                    <return>Content-Description</return>.<return>disposition.type</return><info>string</info> Die <return>Content-Disposition</return>, z. B.
                    <return>'attachment'</return>. <return>disposition</return><info>array</info> Ein assoziatives Array von
                    <return>Content-Disposition</return>-Parameternamen und deren Werten. <return>contents.data</return><info>string</info>Der
                    Inhalt.<return>lines</return><info>int</info>Die Größe des Inhalts in Zeilen.<return>bytes</return><info>int</info>Die Größe des Inhalts in
                    Bytes.<return>md5</return><info>string</info>Die MD5-Prüfsumme des Inhalts.

<comment>Return:</comment>
  <info>string|false</info>  Gibt eine MIME-konforme Nachricht als String zurück. Bei einem Fehler wird <info>false</info>
                zurückgegeben.


id: imap_mail_copy
type: function
doc:
<comment>Description:</comment>
  Kopiert Nachrichten in ein Postfach
  
  <strong>imap_mail_copy()</strong> kopiert die mit <strong>$message_nums</strong> angegebenen Nachrichten in das Postfach <strong>$mailbox</strong>.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>          Eine <class>IMAP\Connection</class>-Instanz.
  <info>string</info>           <strong>$message_nums</strong>  <strong>$message_nums</strong> ist keine Liste von Nachrichtennummern, sondern ein
                                  Nachrichtenbereich (wie in RFC2060 beschrieben).
  <info>string</info>           <strong>$mailbox</strong>       Das Zielpostfach, für weitere Informationen siehe <strong>imap_open()</strong>
                                  
                                  Die Übergabe von nicht vertrauenswürdigen Daten an diesen
                                  Parameter ist unsicher,falls
                                  imap.enable_insecure_rsh nicht deaktiviert ist.
  <info>int</info>              <strong>$flags</strong>         <strong>$flags</strong> ist eine Bitmaske, die sich aus einem oder mehreren der
                                  folgenden Flags zusammensetzt: <info>CP_UID</info> - die Nummern der
                                  Nachrichten sind UIDs <info>CP_MOVE</info> - Nachrichten nach dem Kopieren aus
                                  dem aktuellen Postfach entfernen. Wenn dieses Flag gesetzt ist,
                                  verhält sich die Funktion genauso wie <strong>imap_mail_move()</strong>.
                                  
                                  <info>CP_UID</info> - die Nummern der Nachrichten sind UIDs
                                  
                                  <info>CP_MOVE</info> - Nachrichten nach dem Kopieren aus dem aktuellen Postfach
                                  entfernen. Wenn dieses Flag gesetzt ist, verhält sich die Funktion
                                  genauso wie <strong>imap_mail_move()</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>imap_mail_move()</strong>


id: imap_mail_move
type: function
doc:
<comment>Description:</comment>
  Verschiebt Nachrichten in ein anderes Postfach
  
  <strong>imap_mail_move()</strong> verschiebt die mit <strong>$message_nums</strong> angegebenen Nachrichten in das Postfach
  <strong>$mailbox</strong>. Es ist zu beachten, dass die Nachrichten in Wirklichkeit in das Postfach <strong>$mailbox</strong>
  kopiert werden und die ursprünglichen Nachrichten zum Löschen markiert werden. Das bedeutet, dass
  die Nachrichten in <strong>$mailbox</strong> neue UIDs zugewiesen bekommen.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>          Eine <class>IMAP\Connection</class>-Instanz.
  <info>string</info>           <strong>$message_nums</strong>  <strong>$message_nums</strong> ist keine Liste von Nachrichtennummern, sondern ein
                                  Nachrichtenbereich (wie in RFC2060 beschrieben).
  <info>string</info>           <strong>$mailbox</strong>       Das Zielpostfach, für weitere Informationen siehe <strong>imap_open()</strong>
                                  
                                  Die Übergabe von nicht vertrauenswürdigen Daten an diesen
                                  Parameter ist unsicher,falls
                                  imap.enable_insecure_rsh nicht deaktiviert ist.
  <info>int</info>              <strong>$flags</strong>         <strong>$flags</strong> ist eine Bitmaske und kann zur Zeit nur eine Option
                                  enthalten: <info>CP_UID</info> - die Nummern der Nachrichten sind UIDs
                                  
                                  <info>CP_UID</info> - die Nummern der Nachrichten sind UIDs

<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>imap_mail_copy()</strong>


id: imap_mailboxmsginfo
type: function
doc:
<comment>Description:</comment>
  Liefert Informationen zum aktuellen Postfach
  
  Prüft den aktuelle Status des Postfachs auf dem Server. Die Funktion ist vergleichbar mit
  <strong>imap_status()</strong>, gibt aber zusätzlich auch die Gesamtgröße aller Nachrichten in Bytes zurück. Das
  Aufsummieren der einzelnen Nachrichtengrößen benötigt dabei zusätzliche Zeit zur Ausführung.

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

<comment>Return:</comment>
  <info>stdClass</info>  Die Ergebnisse werden in einem Objekt mit folgenden Eigenschaften zurückgegeben:
            Postfach-EigenschaftenDateZeitpunkt der letzten Änderung (aktuelle
            Zeit)DriverTreiberMailboxName des PostfachsNmsgsAnzahl der NachrichtenRecentAnzahl der
            kürzlich eingetroffenen NachrichtenUnreadAnzal der ungelesenen NachrichtenDeletedAnzahl
            der gelöschten NachrichtenSizeGesamtgröße des Postfachs in Bytes


id: imap_mime_header_decode
type: function
doc:
<comment>Description:</comment>
  Dekodiert MIME-kodierte Kopfzeilen
  
  Dekodiert MIME-kodierte Kopfzeilen, die nicht-ASCII-Zeichen enthalten (siehe RFC2047).

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Der MIME-kodierte Text

<comment>Return:</comment>
  <info>array|false</info>  Die dekodierten Textteile werden als ein Array von Objekten zurückgegeben, die
               jeweils eine <return>charset</return>- und eine <return>text</return>-Eigenschaft enthalten.
               
               Für nicht kodierte ASCII-Teile wird die <return>charset</return>-Eigenschaft auf den Wert <return>default</return>
               gesetzt.
               
               Die Funktion gibt bei einem Fehler <info>false</info> zurück.

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


id: imap_msgno
type: function
doc:
<comment>Description:</comment>
  Liefert die Nummer einer Nachricht für eine gegebene UID
  
  Gibt die Nummer der Nachricht für <strong>$message_uid</strong> zurück.
  
  Diese Funktion ist das Gegenstück zu <strong>imap_uid()</strong>.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>         Eine <class>IMAP\Connection</class>-Instanz.
  <info>int</info>              <strong>$message_uid</strong>  Die UID der Nachricht

<comment>Return:</comment>
  <info>int</info>  Gibt die Nummer der Nachricht mit der gegebenen <strong>$message_uid</strong> zurück.

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


id: imap_mutf7_to_utf8
type: function
doc:
<comment>Description:</comment>
  Decode a modified UTF-7 string to UTF-8
  
  Decode a modified UTF-7 (as specified in RFC 2060, section 5.1.3) string to UTF-8.
  
  This function is only available, if libcclient exports utf8_to_mutf7().

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A string encoded in modified UTF-7.

<comment>Return:</comment>
  <info>string|false</info>  Returns <strong>$string</strong> converted to UTF-8, Bei einem Fehler wird <info>false</info> zurückgegeben..

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


id: imap_num_msg
type: function
doc:
<comment>Description:</comment>
  Liefert die Anzahl der Nachrichten im aktuellen Postfach
  
  Gibt die Anzahl der Nachrichten im aktuellen Postfach zurück.

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

<comment>Return:</comment>
  <info>int|false</info>  Gibt die Anzahl der Nachrichten im aktuellen Postfach als Integer zurück oder <info>false</info> im
             Fehlerfall.

<comment>See Also:</comment>
   * <strong>imap_num_recent()</strong>
   * <strong>imap_status()</strong>


id: imap_num_recent
type: function
doc:
<comment>Description:</comment>
  Liefert die Anzahl der kürzlich eingetroffenen Nachrichten
  
  Gibt die Anzahl der kürzlich im aktuellen Postfach eingetroffenen Nachrichten zurück.

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

<comment>Return:</comment>
  <info>int</info>  Gibt die Anzahl der kürzlich im aktuellen Postfach eingetroffenen Nachrichten als Integer
       zurück.

<comment>See Also:</comment>
   * <strong>imap_num_msg()</strong>
   * <strong>imap_status()</strong>


id: imap_open
type: function
doc:
<comment>Description:</comment>
  Öffnet einen IMAP-Stream zu einem Postfach
  
  Öffnet einen IMAP-Stream zum Postfach <strong>$mailbox</strong>.
  
  Diese Funktion kann auch verwendet werden, um Streams zu POP3- und NNTP-Servern zu öffnen, einige
  Funktionen und Eigenschaften sind aber nur bei IMAP-Verbindungen verfügbar.

<comment>Param:</comment>
  <info>string</info>  <strong>$mailbox</strong>   Ein Postfachname besteht aus einer Serveradresse und dem Pfad zum Postfach auf
                     diesem Server. Der reservierte Name <return>INBOX</return> steht für das persönliche Postfach
                     des aktuellen Benutzers. Enthält der Name des Postfachs internationale Zeichen
                     außerhalb des druckbaren ASCII-Bereichs, so müssen diese mit <strong>imap_utf7_encode()</strong>
                     kodiert werden.
                     
                     Die Übergabe von nicht vertrauenswürdigen Daten an diesen Parameter ist
                     unsicher,falls
                     imap.enable_insecure_rsh nicht deaktiviert ist.
                     
                     Der Serverteil wird in '{' und '}' eingebettet und besteht aus der Domain oder
                     der IP-Adresse des Servers, einer optionalen Portnummer (eingeleitet mit ':')
                     und einer optionalen Protokollangabe (eingeleitet mit '/').
                     
                     Die Angabe des Serverteils ist immer zwingend bei allen Postfach-Parametern.
                     
                     Alle Namen, die mit <return>{</return> beginnen, bezeichnen Serverdienste und werden in der Form
                     <return>"{" remote_system_name [":" port] [flags] "}"[mailbox_name]</return> angegeben:
                     <return>remote_system_name</return> - der Internet-Domain-Name oder die in Klammern gesetzte
                     IP-Adresse des Servers <return>port</return> - die optionale Portnummer, Standard ist der
                     jeweilige Standardport des gewählten Protokolls <return>flags</return> - optionale Flags, siehe
                     folgende Tabelle <return>mailbox_name</return> - der Name des gewünschten Serverpostfachs,
                     Standard ist "INBOX"
                     
                     <return>remote_system_name</return> - der Internet-Domain-Name oder die in Klammern gesetzte
                     IP-Adresse des Servers
                     
                     <return>port</return> - die optionale Portnummer, Standard ist der jeweilige Standardport des
                     gewählten Protokolls
                     
                     <return>flags</return> - optionale Flags, siehe folgende Tabelle
                     
                     <return>mailbox_name</return> - der Name des gewünschten Serverpostfachs, Standard ist "INBOX"
                     
                     Optionale FlagsFlagBeschreibung<return>/service=</return>servicePostfach-Zugriffsprotokoll,
                     Standard ist "imap"<return>/user=</return>userBenutzername für die Anmeldung am
                     Mailserver<return>/authuser=</return>user Benutzername für die Remote-Authentifizierung; falls
                     angegeben, ist dies der Benutzername dessen Passwort verwendet wird (z. B.
                     administrator) <return>/anonymous</return>Zugriff als anonymer Benutzer<return>/debug</return> Protokollausgaben
                     im Debug-Log der Anwendung aufzeichnen <return>/secure</return>Übertragung von
                     Klartext-Passwörtern wird verhindert<return>/imap</return>, <return>/imap2</return>, <return>/imap2bis</return>, <return>/imap4</return>,
                     <return>/imap4rev1</return>Kurzform für <return>/service=imap</return><return>/pop3</return>Kurzform für
                     <return>/service=pop3</return><return>/nntp</return>Kurzform für <return>/service=nntp</return><return>/norsh</return> Für eine vorauthentifizierte
                     IMAP-Verbindung soll weder RSH noch SSH verwendet werden <return>/ssl</return><return>Secure Socket
                     Layer</return> (SSL) zur Verschlüsselung der Verbindung verwenden
                     <return>/validate-cert</return>TLS/SSL-Zertifikate verifizieren
                     (Standardverhalten)<return>/novalidate-cert</return> TLS/SSL-Zertifikate nicht verifizieren;
                     wird für selbstsignierte Zertifikate benötigt <return>/tls</return><return>start-TLS</return>-Verschlüsselung
                     erzwingen und Verbindungen zu Servern, die dies nicht unterstützen, ablehnen
                     <return>/notls</return><return>start-TLS</return> nicht zum Verschlüsseln der Verbindung verwenden, auch wenn es
                     der Server unterstützt <return>/readonly</return> Öffnen des Postfachs im Nur-Lese-Modus
                     anfordern (nur für IMAP, NNTP ignoriert dies, POP3 und SMTP verweigern
                     readonly-Verbindungen)
  <info>string</info>  <strong>$user</strong>      Der Benutzername
  <info>string</info>  <strong>$password</strong>  Das Passwort von <strong>$user</strong>
  <info>int</info>     <strong>$flags</strong>     Der Parameter <strong>$flags</strong> kann sich als Bitmaske aus folgenden Werten
                     zusammensetzen: <info>OP_READONLY</info> - nur lesende Zugriffe <info>OP_ANONYMOUS</info> - ein
                     existierendes .newsrc weder lesen noch aktualisieren (nur NNTP) <info>OP_HALFOPEN</info> -
                     Verbindung zum Server öffnen, aber noch kein Postfach auswählen (nur IMAP und
                     NNTP) <info>CL_EXPUNGE</info> - zum Löschen markierte Nachrichten beim Schließen des
                     Postfachs automatisch entfernen (siehe auch <strong>imap_delete()</strong> und <strong>imap_expunge()</strong>)
                     <info>OP_DEBUG</info> - Protokollverhandlungen debuggen <info>OP_SHORTCACHE</info> - kurzes Caching (nur
                     <return>elt</return>) <info>OP_SILENT</info> - Ereignisse nicht weitergeben (interne Einstellung)
                     <info>OP_PROTOTYPE</info> - Treiber-Prototyp zurückgeben <info>OP_SECURE</info> - keine unsichere
                     Verbindung zum Server öffnen
                     
                     <info>OP_READONLY</info> - nur lesende Zugriffe
                     
                     <info>OP_ANONYMOUS</info> - ein existierendes .newsrc weder lesen noch aktualisieren (nur
                     NNTP)
                     
                     <info>OP_HALFOPEN</info> - Verbindung zum Server öffnen, aber noch kein Postfach auswählen
                     (nur IMAP und NNTP)
                     
                     <info>CL_EXPUNGE</info> - zum Löschen markierte Nachrichten beim Schließen des Postfachs
                     automatisch entfernen (siehe auch <strong>imap_delete()</strong> und <strong>imap_expunge()</strong>)
                     
                     <info>OP_DEBUG</info> - Protokollverhandlungen debuggen
                     
                     <info>OP_SHORTCACHE</info> - kurzes Caching (nur <return>elt</return>)
                     
                     <info>OP_SILENT</info> - Ereignisse nicht weitergeben (interne Einstellung)
                     
                     <info>OP_PROTOTYPE</info> - Treiber-Prototyp zurückgeben
                     
                     <info>OP_SECURE</info> - keine unsichere Verbindung zum Server öffnen
  <info>int</info>     <strong>$retries</strong>   Maximale Anzahl der Verbindungsversuche
  <info>array</info>   <strong>$options</strong>   Verbindungsparameter; die folgenden (String-)Schlüssel können verwendet werden,
                     um einen oder mehrere Verbindungsparameter anzugeben: <return>DISABLE_AUTHENTICATOR</return> -
                     Deaktiviere Authentifizierungs-Eigenschaften
                     
                     <return>DISABLE_AUTHENTICATOR</return> - Deaktiviere Authentifizierungs-Eigenschaften

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

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


id: imap_ping
type: function
doc:
<comment>Description:</comment>
  Prüft einen IMAP-Stream auf Funktionalität
  
  <strong>imap_ping()</strong> 'pingt' einen IMAP-Stream an, um zu sehen, ob dieser noch aktiv ist. Diese Funktion
  kann auch neu eingetroffene Nachrichten erkennen. Daher ist dies die bevorzugte Methode zur
  regelmäßigen Überprüfung auf neue Nachrichten und um die Verbindung bei Servern offen zu halten,
  die sie sonst nach einer gewissen Zeit der Inaktivität beenden.

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

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn der Stream noch funktioniert, sonst <info>false</info>.


id: imap_qprint
type: function
doc:
<comment>Description:</comment>
  Konvertiert einen quoted-printable-kodierten String in einen 8-Bit-String
    
  
  Konvertiert einen quoted-printable String in einen 8-Bit-String gemäß RFC2045, Abschnitt 6.7.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Ein quoted-printable-kodierter String

<comment>Return:</comment>
  <info>string|false</info>  Gibt einen 8-Bit-String zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

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


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


id: imap_renamemailbox
type: function
doc:
<comment>Description:</comment>
  Ändert den Namen eines Postfachs
  
  Diese Funktion ändert den Namen des Postfachs von <strong>$from</strong> in <strong>$to</strong> (siehe <strong>imap_open()</strong> für das Format
  von <strong>$mbox</strong>-Namen).

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>  Eine <class>IMAP\Connection</class>-Instanz.
  <info>string</info>           <strong>$from</strong>  Der bisherige Name des Postfachs, siehe  <strong>imap_open()</strong> für weitere
                          Informationen.
                          
                          Die Übergabe von nicht vertrauenswürdigen Daten an diesen Parameter ist
                          unsicher,falls
                          imap.enable_insecure_rsh nicht deaktiviert ist.
  <info>string</info>           <strong>$to</strong>    Der neue Name des Postfachs, siehe  <strong>imap_open()</strong> für weitere Informationen.
                          
                          Die Übergabe von nicht vertrauenswürdigen Daten an diesen Parameter ist
                          unsicher,falls
                          imap.enable_insecure_rsh nicht deaktiviert 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>imap_createmailbox()</strong>
   * <strong>imap_deletemailbox()</strong>


id: imap_reopen
type: function
doc:
<comment>Description:</comment>
  Öffnet einen IMAP-Stream für ein anderes Postfach neu
    
  
  <strong>imap_reopen()</strong> öffnet die angegebene Verbindung zu einem IMAP- oder NNTP-Server erneut für ein
  anderes Postfach.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     Eine <class>IMAP\Connection</class>-Instanz.
  <info>string</info>           <strong>$mailbox</strong>  Der Name des Postfachs, siehe <strong>imap_open()</strong> für weitere Informationen.
                             
                             Die Übergabe von nicht vertrauenswürdigen Daten an diesen Parameter ist
                             unsicher,falls
                             imap.enable_insecure_rsh nicht deaktiviert ist.
  <info>int</info>              <strong>$flags</strong>    Der Parameter <strong>$flags</strong> kann als Bitmaske einen oder mehrere der folgenden
                             Werte enthalten: <info>OP_READONLY</info> - öffnet das Postfach nur für Lesezugriffe
                             <info>OP_ANONYMOUS</info> - die .newsrc-Datei weder lesen noch aktualisieren (nur
                             NNTP) <info>OP_HALFOPEN</info> - die Verbindung aufbauen, ohne ein Postfach zu
                             öffnen (nur IMAP und NNTP) <info>OP_EXPUNGE</info> - zum Löschen vorgemerkte
                             Nachrichten stillschweigend sofort löschen <info>CL_EXPUNGE</info> - zum Löschen
                             vorgemerkte Nachrichten werden beim Schließen der Verbindung
                             automatisch gelöscht (siehe auch <strong>imap_delete()</strong> und <strong>imap_expunge()</strong>)
                             
                             <info>OP_READONLY</info> - öffnet das Postfach nur für Lesezugriffe
                             
                             <info>OP_ANONYMOUS</info> - die .newsrc-Datei weder lesen noch aktualisieren (nur
                             NNTP)
                             
                             <info>OP_HALFOPEN</info> - die Verbindung aufbauen, ohne ein Postfach zu öffnen (nur
                             IMAP und NNTP)
                             
                             <info>OP_EXPUNGE</info> - zum Löschen vorgemerkte Nachrichten stillschweigend sofort
                             löschen
                             
                             <info>CL_EXPUNGE</info> - zum Löschen vorgemerkte Nachrichten werden beim Schließen
                             der Verbindung automatisch gelöscht (siehe auch <strong>imap_delete()</strong> und
                             <strong>imap_expunge()</strong>)
  <info>int</info>              <strong>$retries</strong>  Die maximale Anzahl von Verbindungsversuchen

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn der Stream wieder geöffnet wird, ansonsten <info>false</info>.


id: imap_rfc822_parse_adrlist
type: function
doc:
<comment>Description:</comment>
  Zerlegt einen String mit Mailadressen
  
  Zerlegt den übergebenen String mit Mailadressen in einzelne Mailadressen gemäß RFC2822.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>            Ein String aus Mailadressen
  <info>string</info>  <strong>$default_hostname</strong>  Der Standard-Hostname

<comment>Return:</comment>
  <info>array</info>  Gibt ein Array aus Objekten mit folgenden Eigenschaften zurück:
         
          mailbox - der Name des Postfachs bzw. der Benutzername  host - der Hostname  personal -
         der tatsächliche Name des Benutzers  adl - "at-domain-list"; wird nicht mehr verwendet
         
         mailbox - der Name des Postfachs bzw. der Benutzername
         
         host - der Hostname
         
         personal - der tatsächliche Name des Benutzers
         
         adl - "at-domain-list"; wird nicht mehr verwendet

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


id: imap_rfc822_parse_headers
type: function
doc:
<comment>Description:</comment>
  Liest E-Mail-Kopfzeilen aus einem String aus
  
  Gibt ein Objekt mit diversen Kopfelementen zurück, ähnlich <strong>imap_header()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$headers</strong>           Die auszulesenden Kopfdaten
  <info>string</info>  <strong>$default_hostname</strong>  Der Standard-Hostname

<comment>Return:</comment>
  <info>stdClass</info>  Gibt ein ähnliches Objekt zurück wie <strong>imap_header()</strong>, mit Ausnahme der Flags und anderen
            vom IMAP-Server zurückgegebenen Daten.

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


id: imap_rfc822_write_address
type: function
doc:
<comment>Description:</comment>
  Liefert eine korrekt formatierte E-Mail-Adresse aus übergebenen Informationen
    
  
  <strong>imap_rfc822_write_address()</strong> bildet eine gemäß RFC2822 formatierte E-Mail-Adresse aus den
  übergebenen Informationen.

<comment>Param:</comment>
  <info>string</info>  <strong>$mailbox</strong>   Der Name des Postfachs, siehe <strong>imap_open()</strong> für weitere Informationen.
                     
                     Die Übergabe von nicht vertrauenswürdigen Daten an diesen Parameter ist
                     unsicher,falls
                     imap.enable_insecure_rsh nicht deaktiviert ist.
  <info>string</info>  <strong>$hostname</strong>  Der Domain-Teil der Mailadresse
  <info>string</info>  <strong>$personal</strong>  Der tatsächliche Name des Besitzers des Postfachs

<comment>Return:</comment>
  <info>string|false</info>  Gibt eine gemäß RFC2822 formatierte Mailadresse als String zurück. Bei einem Fehler
                wird <info>false</info> zurückgegeben.


id: imap_savebody
type: function
doc:
<comment>Description:</comment>
  Speichert einen Teil des Nachrichtentextes in einer Datei
  
  Speichert einen Teil des Nachrichtenkörpers oder den gesamten Textkörper der angegebenen
  Nachricht.

<comment>Param:</comment>
  <info>IMAP\Connection</info>      <strong>$imap</strong>         Eine <class>IMAP\Connection</class>-Instanz.
  <info>resource|string|int</info>  <strong>$file</strong>         Der Name der Zieldatei oder ein gültiger von <strong>fopen()</strong>
                                     zurückgegebener Dateideskriptor.
  <info>int</info>                  <strong>$message_num</strong>  Die Nummer der Nachricht
  <info>string</info>               <strong>$section</strong>      Die Nummer des Nachrichtenabschnitts. Ein String aus ganzen
                                     Zahlen, getrennt durch Punkte, der einen Teil des
                                     Nachrichtentextes gemäß der IMAP4-Spezifikation definiert.
  <info>int</info>                  <strong>$flags</strong>        Eine Bitmaske aus einem oder mehrereren der folgenden Werte:
                                     <info>FT_UID</info> - <strong>$message_num</strong> ist eine UID <info>FT_PEEK</info> - Das \Seen-Flag
                                     nicht setzen, falls es nicht bereits gesetzt ist <info>FT_INTERNAL</info> -
                                     Rückgabe im internen Format ohne Umwandlung der Zeilenenden in
                                     CRLF.
                                     
                                     <info>FT_UID</info> - <strong>$message_num</strong> ist eine UID
                                     
                                     <info>FT_PEEK</info> - Das \Seen-Flag nicht setzen, falls es nicht bereits
                                     gesetzt ist
                                     
                                     <info>FT_INTERNAL</info> - Rückgabe im internen Format ohne Umwandlung der
                                     Zeilenenden in CRLF.

<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>imap_fetchbody()</strong>


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


id: imap_search
type: function
doc:
<comment>Description:</comment>
  Liefert ein Array von Nachrichten, die den gegebenen Suchkriterien entsprechen
    
  
  Diese Funktion durchsucht die Nachrichten des aktuellen Postfachs auf dem angegebenen IMAP-Stream.
  
  Der Suchstring, um z. B. nach allen unbeantworteten Nachrichten von Mutter zu suchen, wäre
  "UNANSWERED FROM Mutter". Die Suche unterscheidet nicht nach Groß- und Kleinschreibung. Die
  folgende Liste von Suchkriterien wurde aus dem Sourcecode des UW-c-client erstellt und ist daher
  nicht unbedingt vollständig oder in allen Einzelheiten korrekt (siehe auch RFC1176, Abschnitt "tag
  SEARCH search_criteria").

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>      Eine <class>IMAP\Connection</class>-Instanz.
  <info>string</info>           <strong>$criteria</strong>  Ein String, in dem die folgenden durch Leerzeichen getrennten
                              Schlüsselwörter erlaubt sind. Argumente, die selbt Leerzeichen
                              enthalten, müssen in doppelte Anführungszeichen gefasst werden (z. B.
                              <return>FROM "Hans Müller"</return>). Die Ergebnisse müssen mit allen Einträgen in
                              <strong>$criteria</strong> übereinstimmen.  ALL - gebe alle Nachrichten zurück, die den
                              übrigen Kriterien entsprechen  ANSWERED - sucht Nachrichten mit dem
                              Flag \\ANSWERED  BCC "text" - sucht Nachrichten mit "text" im
                              Bcc:-Feld  BEFORE "datum" - sucht Nachrichten, die vor "datum"
                              gesendet wurden  BODY "text" - sucht Nachrichten mit "text" im
                              Nachrichtenkörper  CC "text" - sucht Nachrichten mit "text" im
                              Cc:-Feld  DELETED - sucht Nachrichten, die zur Löschung vorgemerkt
                              sind  FLAGGED - sucht Nachrichten mit dem Flag \\FLAGGED (manchmal
                              auch als wichtig oder dringend bezeichnet)  FROM "text" - sucht
                              Nachrichten mit "text" im From:-Feld  KEYWORD "text" - sucht
                              Nachrichten mit dem Schlüsselwort "text"  NEW - sucht neue Nachrichten
                              OLD - sucht alte Nachrichten  ON "datum" - sucht Nachrichten, die am
                              angegebenen "datum" gesendet wurden  RECENT - sucht Nachrichten mit
                              dem Flag \\RECENT  SEEN - sucht bereits gelesene Nachrichten (das Flag
                              \\SEEN ist gesetzt)  SINCE "datum" - sucht nach "datum" gesendete
                              Nachrichten  SUBJECT "text" - sucht Nachrichten mit "text" in der
                              Betreffzeile  TEXT "text" - sucht Nachrichten, deren Text "text"
                              enthält  TO "text" - sucht Nachrichten mit "text" im To:-Feld
                              UNANSWERED - sucht noch nicht beantwortete Nachrichten  UNDELETED -
                              sucht Nachrichten, die nicht zum Löschen vorgemerkt sind  UNFLAGGED -
                              sucht Nachrichten, die nicht als wichtig markiert sind  UNKEYWORD
                              "text" - sucht Nachrichten, in deren Schlüsselwörtern "text" nicht
                              enthalten ist  UNSEEN - sucht ungelesene Nachrichten
                              
                              ALL - gebe alle Nachrichten zurück, die den übrigen Kriterien
                              entsprechen
                              
                              ANSWERED - sucht Nachrichten mit dem Flag \\ANSWERED
                              
                              BCC "text" - sucht Nachrichten mit "text" im Bcc:-Feld
                              
                              BEFORE "datum" - sucht Nachrichten, die vor "datum" gesendet wurden
                              
                              BODY "text" - sucht Nachrichten mit "text" im Nachrichtenkörper
                              
                              CC "text" - sucht Nachrichten mit "text" im Cc:-Feld
                              
                              DELETED - sucht Nachrichten, die zur Löschung vorgemerkt sind
                              
                              FLAGGED - sucht Nachrichten mit dem Flag \\FLAGGED (manchmal auch als
                              wichtig oder dringend bezeichnet)
                              
                              FROM "text" - sucht Nachrichten mit "text" im From:-Feld
                              
                              KEYWORD "text" - sucht Nachrichten mit dem Schlüsselwort "text"
                              
                              NEW - sucht neue Nachrichten
                              
                              OLD - sucht alte Nachrichten
                              
                              ON "datum" - sucht Nachrichten, die am angegebenen "datum" gesendet
                              wurden
                              
                              RECENT - sucht Nachrichten mit dem Flag \\RECENT
                              
                              SEEN - sucht bereits gelesene Nachrichten (das Flag \\SEEN ist
                              gesetzt)
                              
                              SINCE "datum" - sucht nach "datum" gesendete Nachrichten
                              
                              SUBJECT "text" - sucht Nachrichten mit "text" in der Betreffzeile
                              
                              TEXT "text" - sucht Nachrichten, deren Text "text" enthält
                              
                              TO "text" - sucht Nachrichten mit "text" im To:-Feld
                              
                              UNANSWERED - sucht noch nicht beantwortete Nachrichten
                              
                              UNDELETED - sucht Nachrichten, die nicht zum Löschen vorgemerkt sind
                              
                              UNFLAGGED - sucht Nachrichten, die nicht als wichtig markiert sind
                              
                              UNKEYWORD "text" - sucht Nachrichten, in deren Schlüsselwörtern "text"
                              nicht enthalten ist
                              
                              UNSEEN - sucht ungelesene Nachrichten
  <info>int</info>              <strong>$flags</strong>     Der einzige gültige Werte für <strong>$flags</strong> ist <info>SE_UID</info>, was bewirkt, dass das
                              zurückgegebene Array UIDs anstelle von Nachrichtennummern enthält.
  <info>string</info>           <strong>$charset</strong>   Der bei der Stringsuche zu verwendende MIME-Zeichensatz.

<comment>Return:</comment>
  <info>array|false</info>  Gibt ein Array mit Nachrichtennummern oder UIDs zurück.
               
               Wenn die Suchkriterien <strong>$criteria</strong> nicht verstanden wurden oder keine Nachrichten
               gefunden wurden, wird <info>false</info> zurückgegeben.

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


id: imap_set_quota
type: function
doc:
<comment>Description:</comment>
  Legt die Größenbeschränkung für ein Postfach fest
  
  Legt die Größenbeschränkung für das angegebene Postfach fest.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>          Eine <class>IMAP\Connection</class>-Instanz.
  <info>string</info>           <strong>$quota_root</strong>    Das Postfach, für das eine Größenbeschränkung festgelegt werden
                                  soll. Dieses sollte dem IMAP-Standard für Postfächer folgen:
                                  <return>user.name</return>.
  <info>int</info>              <strong>$mailbox_size</strong>  Die maximale Größe des Postfachs <strong>$quota_root</strong> in KB

<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>imap_open()</strong>
   * <strong>imap_get_quota()</strong>


id: imap_setacl
type: function
doc:
<comment>Description:</comment>
  Legt die ACL (Zugriffsrechte) für ein Postfach fest
  
  Legt die ACL (Zugriffsrechte) für das angegebene Postfach fest.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     Eine <class>IMAP\Connection</class>-Instanz.
  <info>string</info>           <strong>$mailbox</strong>  Der Name des Postfachs, siehe <strong>imap_open()</strong> für nähere Informationen.
                             
                             Die Übergabe von nicht vertrauenswürdigen Daten an diesen Parameter ist
                             unsicher,falls
                             imap.enable_insecure_rsh nicht deaktiviert ist.
  <info>string</info>           <strong>$user_id</strong>  Der Benutzer, dessen Berechtigungen geändert werden sollen.
  <info>string</info>           <strong>$rights</strong>   Die Berechtigungen, die dem Benutzer gewährt werden sollen. Durch die
                             Übergabe eines leeren Strings wird die ACL entfernt, d. h. alle
                             Berechtigungen werden entzogen.

<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>imap_getacl()</strong>


id: imap_setflag_full
type: function
doc:
<comment>Description:</comment>
  Setzt Nachrichtenflags
  
  Setzt die mit <strong>$flag</strong> angegebenen Flags bei allen Nachrichten aus der Liste <strong>$sequence</strong>.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>      Eine <class>IMAP\Connection</class>-Instanz.
  <info>string</info>           <strong>$sequence</strong>  Eine Liste von Nachrichtennummern. Sie können die gewünschten
                              Nachrichten mit Komma getrennt aufzählen (<return>X,Y</return>) oder alle Nachrichten
                              in einem bestimmten Intervall mit <return>X:Y</return> auswählen.
  <info>string</info>           <strong>$flag</strong>      Die möglichen Flags, die gesetzt werden können, sind <return>\Seen</return>, <return>\Answered</return>,
                              <return>\Flagged</return>, <return>\Deleted</return> und <return>\Draft</return>, wie in RFC2060 definiert.
  <info>int</info>              <strong>$options</strong>   Eine Bitmaske mit Optionen, die zurzeit wird nur eine Option
                              unterstützt: <info>ST_UID</info> - Die Nachrichtenliste <strong>$sequence</strong> enthält UIDs
                              anstelle von Nachrichtennummern.
                              
                              <info>ST_UID</info> - Die Nachrichtenliste <strong>$sequence</strong> enthält UIDs anstelle von
                              Nachrichtennummern.

<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>imap_clearflag_full()</strong>


id: imap_sort
type: function
doc:
<comment>Description:</comment>
  Liefert und sortiert Nachrichten eines Postfachs
  
  Gibt eine gemäß den angegebenen Sortierkriterien sortierte Liste von Nachrichtennummern zurück.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>             Eine <class>IMAP\Connection</class>-Instanz.
  <info>int</info>              <strong>$criteria</strong>         Nur eines der folgenden Sortierkriterien: <info>SORTDATE</info> - das
                                     Sendedatum <info>SORTARRIVAL</info> - das Eingangsdatum <info>SORTFROM</info> - die erste
                                     Absenderadresse <info>SORTSUBJECT</info> - der Betreff <info>SORTTO</info> - die erste
                                     Empfängeradresse <info>SORTCC</info> - die erste CC-Empfängeradresse
                                     <info>SORTSIZE</info> - die Größe der Nachricht in Bytes
                                     
                                     <info>SORTDATE</info> - das Sendedatum
                                     
                                     <info>SORTARRIVAL</info> - das Eingangsdatum
                                     
                                     <info>SORTFROM</info> - die erste Absenderadresse
                                     
                                     <info>SORTSUBJECT</info> - der Betreff
                                     
                                     <info>SORTTO</info> - die erste Empfängeradresse
                                     
                                     <info>SORTCC</info> - die erste CC-Empfängeradresse
                                     
                                     <info>SORTSIZE</info> - die Größe der Nachricht in Bytes
  <info>bool</info>             <strong>$reverse</strong>          Sortierung in umgekehrter Reihenfolge, wenn <info>true</info>
  <info>int</info>              <strong>$flags</strong>            Der Parameter <strong>$flags</strong> enthält eine Bitmaske mit einem oder
                                     mehreren der folgenden Werte: <info>SE_UID</info> - es werden UIDs anstelle
                                     von Nachrichtennummern zurückgegeben <info>SE_NOPREFETCH</info> -
                                     Nachrichten werden nicht auf Vorrat abgerufen
                                     
                                     <info>SE_UID</info> - es werden UIDs anstelle von Nachrichtennummern
                                     zurückgegeben
                                     
                                     <info>SE_NOPREFETCH</info> - Nachrichten werden nicht auf Vorrat abgerufen
  <info>string|null</info>      <strong>$search_criteria</strong>  Ein String mit Suchkriterien im IMAP2-Format. Details können
                                     <strong>imap_search()</strong> entnommen werden.
  <info>string|null</info>      <strong>$charset</strong>          Der zum Sortieren von Strings zu verwendende MIME-Zeichensatz.

<comment>Return:</comment>
  <info>array|false</info>  Gibt ein Array mit Nachrichtennummern zurück, die nach den angegebenen
               Sortierkriterien sortiert sind. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: imap_status
type: function
doc:
<comment>Description:</comment>
  Liefert Statusinformationen zum angegebenen Postfach
  
  Gibt Statusinformationen zum Postfach <strong>$mailbox</strong> zurück.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     Eine <class>IMAP\Connection</class>-Instanz.
  <info>string</info>           <strong>$mailbox</strong>  Der Name des Postfachs, siehe <strong>imap_open()</strong> für weitere Informationen.
                             
                             Die Übergabe von nicht vertrauenswürdigen Daten an diesen Parameter ist
                             unsicher,falls
                             imap.enable_insecure_rsh nicht deaktiviert ist.
  <info>int</info>              <strong>$flags</strong>    Eine Bitmaske mit folgenden möglichen Werten: <info>SA_MESSAGES</info> - setzt
                             $status-&gt;messages auf die Anzahl der Nachrichten im Postfach
                             <info>SA_RECENT</info> - setzt $status-&gt;recent auf die Anzahl kürzlich
                             eingetroffener Nachrichten im Postfach <info>SA_UNSEEN</info> - setzt
                             $status-&gt;unseen auf die Anzahl ungelesener (neuer) Nachrichten im
                             Postfach <info>SA_UIDNEXT</info> - setzt $status-&gt;uidnext auf die nächste diesem
                             Postfach zugeteilte UID <info>SA_UIDVALIDITY</info> - setzt $status-&gt;uidvalidity
                             auf eine Konstante, die sich ändert, falls die UIDs im Postfach ihre
                             Gültigkeit verloren haben könnten <info>SA_ALL</info> - setzt alle Flags
                             
                             <info>SA_MESSAGES</info> - setzt $status-&gt;messages auf die Anzahl der Nachrichten
                             im Postfach
                             
                             <info>SA_RECENT</info> - setzt $status-&gt;recent auf die Anzahl kürzlich
                             eingetroffener Nachrichten im Postfach
                             
                             <info>SA_UNSEEN</info> - setzt $status-&gt;unseen auf die Anzahl ungelesener (neuer)
                             Nachrichten im Postfach
                             
                             <info>SA_UIDNEXT</info> - setzt $status-&gt;uidnext auf die nächste diesem Postfach
                             zugeteilte UID
                             
                             <info>SA_UIDVALIDITY</info> - setzt $status-&gt;uidvalidity auf eine Konstante, die
                             sich ändert, falls die UIDs im Postfach ihre Gültigkeit verloren haben
                             könnten
                             
                             <info>SA_ALL</info> - setzt alle Flags

<comment>Return:</comment>
  <info>stdClass|false</info>  Diese Funktion gibt ein Objekt mit Statusinformationen zurück. Bei einem Fehler
                  wird <info>false</info> zurückgegeben. Das Objekt hat die folgenden Eigenschaften: <return>messages</return>,
                  <return>recent</return>, <return>unseen</return>, <return>uidnext</return> und <return>uidvalidity</return>.
                  
                  <return>flags</return> wird ebenfalls gesetzt und enthält eine Bitmaske, mit der die tatsächlich
                  zurückgegebenen Informationen mit Hilfe der oben beschriebenen Konstanten geprüft
                  werden können.


id: imap_subscribe
type: function
doc:
<comment>Description:</comment>
  Abonniert ein Postfach
  
  Abonniert ein neues Postfach.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     Eine <class>IMAP\Connection</class>-Instanz.
  <info>string</info>           <strong>$mailbox</strong>  Der Name des Postfachs, siehe <strong>imap_open()</strong> für weitere Informationen.
                             
                             Die Übergabe von nicht vertrauenswürdigen Daten an diesen Parameter ist
                             unsicher,falls
                             imap.enable_insecure_rsh nicht deaktiviert 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>imap_unsubscribe()</strong>


id: imap_thread
type: function
doc:
<comment>Description:</comment>
  Liefert Nachrichten als Baum zusammenhängender Themenstränge
  
  Gibt Nachrichten als Baum zusammenhängender Themenstränge zurück.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>   Eine <class>IMAP\Connection</class>-Instanz.
  <info>int</info>              <strong>$flags</strong>  

<comment>Return:</comment>
  <info>array|false</info>  <strong>imap_thread()</strong> gibt ein assoziatives Array von Nachrichten zurück, die über <return>REFERENCES</return>
               verknüpft sind, oder <info>false</info> bei Fehlern.
               
               Jede Nachricht im aktuellen Postfach wird im zurückgegebenen Array durch drei
               Einträge repräsentiert: $thread["XX.num"] - die Nummer der aktuellen Nachricht
               $thread["XX.next"]$thread["XX.branch"]
               
               $thread["XX.num"] - die Nummer der aktuellen Nachricht
               
               $thread["XX.next"]
               
               $thread["XX.branch"]


id: imap_timeout
type: function
doc:
<comment>Description:</comment>
  Setzt oder liefert den Imap-Timeout
  
  Setzt den Timeoutwert für das IMAP-Protokoll oder gibt ihn zurück.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout_type</strong>  Eine der folgenden Konstanten: <info>IMAP_OPENTIMEOUT</info>, <info>IMAP_READTIMEOUT</info>,
                      <info>IMAP_WRITETIMEOUT</info> oder <info>IMAP_CLOSETIMEOUT</info>.
  <info>int</info>  <strong>$timeout</strong>       Der Timeout in Sekunden

<comment>Return:</comment>
  <info>int|bool</info>  Wenn der Parameter <strong>$timeout</strong> gesetzt ist, gibt diese Funktion bei Erfolg <info>true</info> zurück,
            sonst <info>false</info>.
            
            Wird kein <strong>$timeout</strong> übergeben oder entspricht dessen Wert -1, so wird der aktuelle
            Timeoutwert für <strong>$timeout_type</strong> als Integer zurückgegeben.


id: imap_uid
type: function
doc:
<comment>Description:</comment>
  Liefert die UID für die gegebene Nachrichtennummer
  
  Diese Funktion gibt die UID für die angegebene Nachrichtennummer zurück. Eine UID ist ein
  eindeutiger Bezeichner für eine Nachricht, der sich nicht mit der Zeit ändert, während eine
  Nachrichtennummer sich bei jeder Veränderung des Postfachinhalts ändern kann.
  
  Diese Funktion ist das Gegenstück zu <strong>imap_msgno()</strong>.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>         Eine <class>IMAP\Connection</class>-Instanz.
  <info>int</info>              <strong>$message_num</strong>  Die Nummer der Nachricht

<comment>Return:</comment>
  <info>int|false</info>  Gibt die UID der gewünschten Nachricht zurück.

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


id: imap_undelete
type: function
doc:
<comment>Description:</comment>
  Nimmt eine bereits gesetzte Löschmarkierung einer Nachricht zurück
    
  
  Entfernt das "gelöscht"-Flag der angegebenen Nachricht. Das Flag wird von den Funktionen
  <strong>imap_delete()</strong> oder <strong>imap_mail_move()</strong> gesetzt.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>          Eine <class>IMAP\Connection</class>-Instanz.
  <info>string</info>           <strong>$message_nums</strong>  Ein String, der eine oder mehrere Nachrichten im IMAP4-üblichen
                                  Sequenzformat darstellt (<return>"n"</return>, <return>"n:m"</return> oder eine Kombination daraus,
                                  durch Kommas getrennt).
  <info>int</info>              <strong>$flags</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>imap_delete()</strong>
   * <strong>imap_mail_move()</strong>


id: imap_unsubscribe
type: function
doc:
<comment>Description:</comment>
  Beendet das Abonnement eines Postfachs
  
  Beendet das Abonnement des Postfachs <strong>$mailbox</strong>.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     Eine <class>IMAP\Connection</class>-Instanz.
  <info>string</info>           <strong>$mailbox</strong>  Der Name des Postfachs, siehe <strong>imap_open()</strong> für weitere Informationen.
                             
                             Die Übergabe von nicht vertrauenswürdigen Daten an diesen Parameter ist
                             unsicher,falls
                             imap.enable_insecure_rsh nicht deaktiviert 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>imap_subscribe()</strong>


id: imap_utf7_decode
type: function
doc:
<comment>Description:</comment>
  Dekodiert einen String im modifizierten UTF-7-Format
  
  Dekodiert den String <strong>$string</strong> aus dem modifizierten UTF-7-Format in ISO-8859-1-kodierten Text.
  
  Diese Funktion wird benötigt, um Mailboxnamen zu dekodieren, die Zeichen außerhalb des druckbaren
  ASCII-Bereichs enthalten.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Ein String im modifizerten UTF-7-Format gemäß RFC 2060, Abschnitt 5.1.3..

<comment>Return:</comment>
  <info>string|false</info>  Gibt einen ISO-8859-1-kodierten String zurück oder <info>false</info>, wenn <strong>$string</strong> ungültige
                modifizierte UTF-7-Sequenzen enthält oder Zeichen, die nicht Teil des
                ISO-8859-1-Zeichensatzes sind.

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


id: imap_utf7_encode
type: function
doc:
<comment>Description:</comment>
  Kodiert ISO-8859-1 Text im modifizieren UTF-7-Format
  
  Konvertiert den in <strong>$string</strong> übergebenen Text in das modifizierte UTF-7-Format.
  
  Diese Funktion wird benötigt, um Mailboxnamen zu kodieren, die außerhalb des druckbaren
  ASCII-Bereichs liegen.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Ein ISO-8859-1-String

<comment>Return:</comment>
  <info>string</info>  Gibt <strong>$string</strong> kodiert im modifizierten UTF-7-Format wie in RFC 2060, Abschnitt 5.1.3
          definiert zurück.

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


id: imap_utf8
type: function
doc:
<comment>Description:</comment>
  Konvertiert Text nach UTF-8
  
  Konvertiert den übergebenen String <strong>$mime_encoded_text</strong> ins UTF-8-Format, wenn der deklarierte
  Zeichensatz dem libc-Client bekannt ist. Andernfalls wird der übergebene Text dekodiert, aber
  nicht nach UTF-8 konvertiert.

<comment>Param:</comment>
  <info>string</info>  <strong>$mime_encoded_text</strong>  Ein MIME-kodierter String. Die Methode der MIME-Kodierung und die
                              UTF-8-Spezifikation finden sich unter RFC2047 und RFC2044.

<comment>Return:</comment>
  <info>string</info>  Gibt den dekodierten String zurück, wenn möglich nach UTF-8 konvertiert.

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


id: imap_utf8_to_mutf7
type: function
doc:
<comment>Description:</comment>
  Encode a UTF-8 string to modified UTF-7
  
  Encode a UTF-8 string to modified UTF-7 (as specified in RFC 2060, section 5.1.3).
  
  This function is only available, if libcclient exports utf8_to_mutf7().

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A UTF-8 encoded string.

<comment>Return:</comment>
  <info>string|false</info>  Returns <strong>$string</strong> converted to modified UTF-7, Bei einem Fehler wird <info>false</info>
                zurückgegeben..

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


id: implode
type: function
doc:
<comment>Description:</comment>
  Verbindet Array-Elemente zu einem String
  
  Alternative Signatur (benannte Parameter werden nicht unterstützt):
  
  Alte Signatur (veraltet ab PHP 7.4.0, entfernt ab PHP 8.0.0):
  
  Verbindet die Elemente eines Array mittels <strong>$separator</strong> zu einer Zeichenkette.

<comment>Param:</comment>
  <info>string</info>  <strong>$separator</strong>  Optional, standardmäßig eine leere Zeichenkette.
  <info>array</info>   <strong>$array</strong>      Das Array mit den zusammenzufügenden Zeichenketten.

<comment>Return:</comment>
  <info>string</info>  Gibt einen String mit einer String-Repräsentation aller Array-Elemente in der gleichen
          Reihenfolge wie im Array zurück, bei dem die einzelnen Array-Elemente mit dem im Parameter
          separator angegebenen String verbunden werden.

<comment>See Also:</comment>
   * <strong>explode()</strong>
   * <strong>preg_split()</strong>
   * <strong>http_build_query()</strong>


id: in_array
type: function
doc:
<comment>Description:</comment>
  Prüft, ob ein Wert in einem Array existiert
  
  Diese Funktion sucht in <strong>$haystack</strong> nach <strong>$needle</strong>. Wenn <strong>$strict</strong> gesetzt ist, wird dabei auch der Typ
  des Elements beachtet.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$needle</strong>    Der gesuchte Wert.
                    
                    Ist <strong>$needle</strong> ein String, so wird bei der Suche die Groß- und Kleinschreibung
                    beachtet.
  <info>array</info>  <strong>$haystack</strong>  Das zu durchsuchende Array.
  <info>bool</info>   <strong>$strict</strong>    Wenn der dritte Parameter auf <info>true</info> gesetzt wird, vergleicht <strong>in_array()</strong> nicht nur
                    den Wert, sondern auch den Typ des gesuchten Wertes <strong>$needle</strong> mit den Elementen
                    des Arrays.
                    
                    Vor PHP 8.0.0 passt ein <strong>$needle</strong>-Wert vom Typ <return>string</return> im nicht-strikten Modus auf
                    einen Array-Wert von <return>0</return> und umgekehrt. Das kann zu unerwünschten Ergebnissen
                    führen. Ähnliche Grenzfälle gibt es auch für andere Typen. Wenn nicht absolut
                    sicher ist, um welche Art von Werten es sich handelt, sollte immer das Flag
                    <strong>$strict</strong> verwendet werden, um ein unerwartetes Verhalten zu vermeiden.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück wenn <strong>$needle</strong> im Array gefunden wird, sonst <info>false</info>.

<comment>See Also:</comment>
   * <strong>array_search()</strong>
   * <strong>isset()</strong>
   * <strong>array_key_exists()</strong>


id: inet_ntop
type: function
doc:
<comment>Description:</comment>
  Konvertiert eine komprimierte IP-Adresse in ein menschenlesbares Format
    
  
  Die Funktion konvertiert eine 32-bittige IPv4- oder eine 128-bittige IPv6-Adresse (sofern PHP mit
  IPv6-Unterstützung kompiliert wurde) in ein für die Adressfamilie geeignetes Format.

<comment>Param:</comment>
  <info>string</info>  <strong>$ip</strong>  Eine 32-bittige IPv4- or 128-bittige IPv6-Adresse.

<comment>Return:</comment>
  <info>string|false</info>  Gibt eine Stringdarstellung der Adresse zurück. Bei einem Fehler wird <info>false</info>
                zurückgegeben.

<comment>See Also:</comment>
   * <strong>long2ip()</strong>
   * <strong>ip2long()</strong>
   * <strong>inet_pton()</strong>


id: inet_pton
type: function
doc:
<comment>Description:</comment>
  Konvertiert eine IP-Adresse im menschenlesbaren Format in eine komprimierte
     in_addr-Darstellung
    
  
  Die Funktion konvertiert eine menschenlesbare IPv4- oder IPv6-Adresse (sofern PHP mit IPv6-Support
  kompiliert wurde) in eine für die Adressfamilie geeignete 32-bittige oder 128-bittige
  Binärstruktur.

<comment>Param:</comment>
  <info>string</info>  <strong>$ip</strong>  Eine menschenlesbare IPv4- oder IPv6-Adresse.

<comment>Return:</comment>
  <info>string|false</info>  Gibt die <return>in_addr</return>-Darstellung der übergebenen <strong>$ip</strong> zurück oder <info>false</info>, wenn eine
                syntaktisch ungültige <strong>$ip</strong> angegeben wurde, z. B. eine IPv4-Adresse ohne Punkte oder
                eine IPv6-Adresse ohne Doppelpunkte.

<comment>See Also:</comment>
   * <strong>ip2long()</strong>
   * <strong>long2ip()</strong>
   * <strong>inet_ntop()</strong>


id: inflate_add
type: function
doc:
<comment>Description:</comment>
  Incrementally inflate encoded data
  
  Incrementally inflates encoded data in the specified <strong>$context</strong>.
  
  Limitation: header information from GZIP compressed data are not made available.

<comment>Param:</comment>
  <info>InflateContext</info>  <strong>$context</strong>     A context created with <strong>inflate_init()</strong>.
  <info>string</info>          <strong>$data</strong>        A chunk of compressed data.
  <info>int</info>             <strong>$flush_mode</strong>  One of <info>ZLIB_BLOCK</info>, <info>ZLIB_NO_FLUSH</info>, <info>ZLIB_PARTIAL_FLUSH</info>, <info>ZLIB_SYNC_FLUSH</info>
                               (default), <info>ZLIB_FULL_FLUSH</info>, <info>ZLIB_FINISH</info>. Normally you will want to
                               set <info>ZLIB_NO_FLUSH</info> to maximize compression, and <info>ZLIB_FINISH</info> to
                               terminate with the last chunk of data. See the zlib manual for a
                               detailed description of these constants.

<comment>Return:</comment>
  <info>string|false</info>  Returns a chunk of uncompressed data, Bei einem Fehler wird <info>false</info> zurückgegeben..

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


id: inflate_get_read_len
type: function
doc:
<comment>Description:</comment>
  Get number of bytes read so far
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

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

<comment>Return:</comment>
  <info>int</info>  Returns number of bytes read so farBei einem Fehler wird <info>false</info> zurückgegeben..


id: inflate_get_status
type: function
doc:
<comment>Description:</comment>
  Get decompression status
  
  Usually returns either <info>ZLIB_OK</info> or <info>ZLIB_STREAM_END</info>.

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

<comment>Return:</comment>
  <info>int</info>  Returns decompression status.


id: inflate_init
type: function
doc:
<comment>Description:</comment>
  Initialize an incremental inflate context
  
  Initialize an incremental inflate context with the specified <strong>$encoding</strong>.

<comment>Param:</comment>
  <info>int</info>    <strong>$encoding</strong>  One of the <info>ZLIB_ENCODING_*</info> constants.
  <info>array</info>  <strong>$options</strong>   An associative array which may contain the following elements: level The
                    compression level in range -1..9; defaults to -1. memory The compression memory
                    level in range 1..9; defaults to 8. window The zlib window size (logarithmic) in
                    range 8..15; defaults to 15. strategy One of <info>ZLIB_FILTERED</info>, <info>ZLIB_HUFFMAN_ONLY</info>,
                    <info>ZLIB_RLE</info>, <info>ZLIB_FIXED</info> or <info>ZLIB_DEFAULT_STRATEGY</info> (the default). dictionary A <info>string</info>
                    or an <info>array</info> of <info>strings</info> of the preset dictionary (default: no preset dictionary).
                    
                    The compression level in range -1..9; defaults to -1.
                    
                    The compression memory level in range 1..9; defaults to 8.
                    
                    The zlib window size (logarithmic) in range 8..15; defaults to 15.
                    
                    One of <info>ZLIB_FILTERED</info>, <info>ZLIB_HUFFMAN_ONLY</info>, <info>ZLIB_RLE</info>, <info>ZLIB_FIXED</info> or
                    <info>ZLIB_DEFAULT_STRATEGY</info> (the default).
                    
                    A <info>string</info> or an <info>array</info> of <info>strings</info> of the preset dictionary (default: no preset
                    dictionary).

<comment>Return:</comment>
  <info>InflateContext|false</info>  Returns an inflate context resource (<return>zlib.inflate</return>) on success, Bei einem
                        Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>inflate_add()</strong>
   * <strong>deflate_init()</strong>


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


id: ini_get
type: function
doc:
<comment>Description:</comment>
  Gets the value of a configuration option
  
  Returns the value of the configuration option on success.

<comment>Param:</comment>
  <info>string</info>  <strong>$option</strong>  The configuration option name.

<comment>Return:</comment>
  <info>string|false</info>  Returns the value of the configuration option as a string on success, or an empty
                string for <return>null</return> values. Returns <info>false</info> if the configuration option doesn't exist.

<comment>See Also:</comment>
   * <strong>get_cfg_var()</strong>
   * <strong>ini_get_all()</strong>
   * <strong>ini_restore()</strong>
   * <strong>ini_set()</strong>


id: ini_get_all
type: function
doc:
<comment>Description:</comment>
  Gets all configuration options
  
  Returns all the registered configuration options.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$extension</strong>  An optional extension name. If not <info>null</info> or the String <return>core</return>, the function
                           returns only options specific for that extension.
  <info>bool</info>         <strong>$details</strong>    Retrieve details settings or only the current value for each setting.
                           Default is <info>true</info> (retrieve details).

<comment>Return:</comment>
  <info>array|false</info>  Returns an associative array with directive name as the array key. Returns <info>false</info> and
               raises an <info>E_WARNING</info> level error if the <strong>$extension</strong> doesn't exist.
               
               When <strong>$details</strong> is <info>true</info> (default) the array will contain <return>global_value</return> (set in php.ini),
               <return>local_value</return> (perhaps set with <strong>ini_set()</strong> or .htaccess), and <return>access</return> (the access level).
               
               When <strong>$details</strong> is <info>false</info> the value will be the current value of the option.
               
               See the manual section for information on what access levels mean.
               
               It's possible for a directive to have multiple access levels, which is why <return>access</return>
               shows the appropriate bitmask values.

<comment>See Also:</comment>
   * 
   * <strong>ini_get()</strong>
   * <strong>ini_restore()</strong>
   * <strong>ini_set()</strong>
   * <strong>get_loaded_extensions()</strong>
   * <strong>phpinfo()</strong>
   * ReflectionExtension::getINIEntries


id: ini_parse_quantity
type: function
doc:
<comment>Description:</comment>
  Get interpreted size from ini shorthand syntax
  
  Returns the interpreted size in bytes on success from an ini shorthand.

<comment>Param:</comment>
  <info>string</info>  <strong>$shorthand</strong>  Ini shorthand to parse, must be a number followed by an optional multiplier.
                       The following multipliers are supported: <return>k</return>/<return>K</return> (<return>1024</return>), <return>m</return>/<return>M</return> (<return>1048576</return>), <return>g</return>/<return>G</return>
                      (<return>1073741824</return>).
                       The number can be a decimal, hex (prefixed with <return>0x</return> or <return>0X</return>), octal (prefixed
                      with <return>0o</return>, <return>0O</return> or <return>0</return>) or binary (prefixed with <return>0b</return> or <return>0B</return>)

<comment>Return:</comment>
  <info>int</info>  Returns the interpreted size in bytes as an Integer.

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


id: ini_restore
type: function
doc:
<comment>Description:</comment>
  Restores the value of a configuration option
  
  Restores a given configuration option to its original value.

<comment>Param:</comment>
  <info>string</info>  <strong>$option</strong>  The configuration option name.

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

<comment>See Also:</comment>
   * <strong>ini_get()</strong>
   * <strong>ini_get_all()</strong>
   * <strong>ini_set()</strong>


id: ini_set
type: function
doc:
<comment>Description:</comment>
  Sets the value of a configuration option
  
  Sets the value of the given configuration option.  The configuration option will keep this new
  value during the script's execution, and will be restored at the script's ending.

<comment>Param:</comment>
  <info>string</info>                      <strong>$option</strong>  Not all the available options can be changed using <strong>ini_set()</strong>.
                                       There is a list of all available options in the appendix.
  <info>string|int|float|bool|null</info>  <strong>$value</strong>   The new value for the option.

<comment>Return:</comment>
  <info>string|false</info>  Returns the old value on success, <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>get_cfg_var()</strong>
   * <strong>ini_get()</strong>
   * <strong>ini_get_all()</strong>
   * <strong>ini_restore()</strong>
   * How to change configuration settings


id: inotify_add_watch
type: function
doc:
<comment>Description:</comment>
  Add a watch to an initialized inotify instance
  
  <strong>inotify_add_watch()</strong> adds a new watch or modify an existing watch for the file or directory
  specified in <strong>$pathname</strong>.
  
  Using <strong>inotify_add_watch()</strong> on a watched object replaces the existing watch. Using the <info>IN_MASK_ADD</info>
  constant adds (OR) events to the existing watch.

<comment>Param:</comment>
  <info>resource</info>  <strong>$inotify_instance</strong>  Von <strong>inotify_init()</strong> zurückgegebene Ressource
  <info>string</info>    <strong>$pathname</strong>          File or directory to watch
  <info>int</info>       <strong>$mask</strong>              Events to watch for. See Vordefinierte Konstanten.

<comment>Return:</comment>
  <info>int</info>  The return value is a unique (inotify instance wide) watch descriptor.

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


id: inotify_init
type: function
doc:
<comment>Description:</comment>
  Initialize an inotify instance
  
  Initialize an inotify instance for use with <strong>inotify_add_watch()</strong>

<comment>Return:</comment>
  <info>resource</info>  A stream resource or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>inotify_add_watch()</strong>
   * <strong>inotify_rm_watch()</strong>
   * <strong>inotify_queue_len()</strong>
   * <strong>inotify_read()</strong>
   * <strong>fclose()</strong>


id: inotify_queue_len
type: function
doc:
<comment>Description:</comment>
  Return a number upper than zero if there are pending events
  
  This function allows to know if <strong>inotify_read()</strong> will block or not. If a number upper than zero is
  returned, there are pending events and  <strong>inotify_read()</strong> will not block.

<comment>Param:</comment>
  <info>resource</info>  <strong>$inotify_instance</strong>  Von <strong>inotify_init()</strong> zurückgegebene Ressource

<comment>Return:</comment>
  <info>int</info>  Returns a number upper than zero if there are pending events.

<comment>See Also:</comment>
   * <strong>inotify_init()</strong>
   * <strong>stream_select()</strong>
   * <strong>stream_set_blocking()</strong>


id: inotify_read
type: function
doc:
<comment>Description:</comment>
  Read events from an inotify instance
  
  Read inotify events from an inotify instance.

<comment>Param:</comment>
  <info>resource</info>  <strong>$inotify_instance</strong>  Von <strong>inotify_init()</strong> zurückgegebene Ressource

<comment>Return:</comment>
  <info>array</info>  An array of inotify events or <info>false</info> if no events was pending and <strong>$inotify_instance</strong> is
         non-blocking. Each event is an array with the following keys: wd is a watch descriptor
         returned by <strong>inotify_add_watch()</strong>mask is a bit mask of eventscookie is a unique id to connect
         related events (e.g. <info>IN_MOVE_FROM</info> and <info>IN_MOVE_TO</info>)name is the name of a file (e.g. if a file
         was modified in a watched directory)

<comment>See Also:</comment>
   * <strong>inotify_init()</strong>
   * <strong>stream_select()</strong>
   * <strong>stream_set_blocking()</strong>
   * <strong>inotify_queue_len()</strong>


id: inotify_rm_watch
type: function
doc:
<comment>Description:</comment>
  Remove an existing watch from an inotify instance
  
  <strong>inotify_rm_watch()</strong> removes the watch <strong>$watch_descriptor</strong> from the inotify instance
  <strong>$inotify_instance</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$inotify_instance</strong>  Von <strong>inotify_init()</strong> zurückgegebene Ressource
  <info>int</info>       <strong>$watch_descriptor</strong>  Watch to remove from the instance

<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>inotify_init()</strong>


id: intdiv
type: function
doc:
<comment>Description:</comment>
  Integer-Division
  
  Gibt den Integer-Quotienten der Division von <strong>$num1</strong> durch <strong>$num2</strong> zurück.

<comment>Param:</comment>
  <info>int</info>  <strong>$num1</strong>  Die Ausgangszahl, die geteilt werden soll.
  <info>int</info>  <strong>$num2</strong>  Die Zahl, durch die <strong>$num1</strong> geteilt werden soll.

<comment>Return:</comment>
  <info>int</info>  Der Integer-Quotient der Division <strong>$num1</strong> durch <strong>$num2</strong>.

<comment>See Also:</comment>
   * <return>/</return> - Gleitkomma-Division
   * <return>%</return> - Integer-Modulus
   * <strong>fmod()</strong> - Gleitkomma-Modulus


id: interface_exists
type: function
doc:
<comment>Description:</comment>
  Prüft, ob ein bestimmtes Interface definiert wurde
  
  Prüft, ob das übergebene Interface definiert wurde.

<comment>Param:</comment>
  <info>string</info>  <strong>$interface</strong>  Der Name des Interfaces.
  <info>bool</info>    <strong>$autoload</strong>   Gibt an, ob automatisch geladen werden soll, falls nicht bereits geladen.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn das durch <strong>$interface</strong> bezeichnete Interface definiert ist, sonst
        <info>false</info>.

<comment>See Also:</comment>
   * <strong>get_declared_interfaces()</strong>
   * <strong>class_implements()</strong>
   * <strong>class_exists()</strong>
   * <strong>enum_exists()</strong>


id: intl_error_name
type: function
doc:
<comment>Description:</comment>
  Get symbolic name for a given error code
  
  Return ICU error code name.

<comment>Param:</comment>
  <info>int</info>  <strong>$errorCode</strong>  ICU error code.

<comment>Return:</comment>
  <info>string</info>  The returned string will be the same as the name of the error code constant.

<comment>See Also:</comment>
   * <strong>intl_is_failure()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_get_error_message()</strong>


id: intl_get_error_code
type: function
doc:
<comment>Description:</comment>
  Get the last error code
  
  Useful to handle errors occurred in static methods when there's no object to get error code from.

<comment>Return:</comment>
  <info>int</info>  Error code returned by the last API function call.

<comment>See Also:</comment>
   * <strong>intl_is_failure()</strong>
   * <strong>intl_error_name()</strong>
   * <strong>intl_get_error_message()</strong>
   * <strong>collator_get_error_code()</strong>
   * <strong>numfmt_get_error_code()</strong>


id: intl_get_error_message
type: function
doc:
<comment>Description:</comment>
  Get description of the last error
  
  Get error message from last internationalization function called.

<comment>Return:</comment>
  <info>string</info>  Description of an error occurred in the last API function call.

<comment>See Also:</comment>
   * <strong>intl_error_name()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_is_failure()</strong>
   * <strong>collator_get_error_message()</strong>
   * <strong>numfmt_get_error_message()</strong>


id: intl_is_failure
type: function
doc:
<comment>Description:</comment>
  Check whether the given error code indicates failure
  
  

<comment>Param:</comment>
  <info>int</info>  <strong>$errorCode</strong>  is a value that returned by functions: <strong>intl_get_error_code()</strong>,
                   <strong>collator_get_error_code()</strong> .

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if it the code indicates some failure, and <info>false</info> in case of success or a warning.

<comment>See Also:</comment>
   * <strong>intl_get_error_code()</strong>
   * <strong>collator_get_error_code()</strong>
   * <strong>Collator-getErrorCode()</strong>


id: intval
type: function
doc:
<comment>Description:</comment>
  Konvertiert einen Wert nach integer
  
  Gibt den <info>integer</info>-Wert von <strong>$value</strong> unter Verwendung der angegebenen Basis (Standardwert ist
  <strong>$base</strong>=10). <strong>intval()</strong> sollte nicht auf Objekte angewandt werden, da dies eine Meldung vom Typ
  <info>E_WARNING</info> erzeugt und den Wert 1 zurückgibt.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Der skalare Wert (das kann ein Ausdruck oder eine einfache Variable sein, nicht
                 jedoch ein Array oder Objekt.), der nach <info>integer</info> konvertiert werden soll.
  <info>int</info>    <strong>$base</strong>   Die Basis der Konvertierung
                 
                 Wenn <strong>$base</strong> 0 ist, wird die verwendete Basis durch das Format von <strong>$value</strong> bestimmt:
                 wenn die Zeichenkette ein Präfix "0x" (oder "0X") enthält, ist die Basis 16
                 (hexadezimal); andernfalls,  wenn die Zeichenkette mit "0b" (oder "0B") beginnt,
                 ist die Basis 2 (binär); andernfalls,  wenn die Zeichenkette mit "0" beginnt, ist
                 die Basis 8 (oktal); andernfalls,  ist die Basis 10 (dezimal).
                 
                 wenn die Zeichenkette ein Präfix "0x" (oder "0X") enthält, ist die Basis 16
                 (hexadezimal); andernfalls,
                 
                 wenn die Zeichenkette mit "0b" (oder "0B") beginnt, ist die Basis 2 (binär);
                 andernfalls,
                 
                 wenn die Zeichenkette mit "0" beginnt, ist die Basis 8 (oktal); andernfalls,
                 
                 ist die Basis 10 (dezimal).

<comment>Return:</comment>
  <info>int</info>  Der integer-Wert von <strong>$value</strong> bei Erfolg, sonst 0. Leere Arrays geben den Wert 0 zurück,
       nichtleere Arrays den Wert 1.
       
       Der Maximalwert hängt vom System ab. 32-Bit-Systeme haben einen maximalen Wertebereich für
       signed integer von -2147483648 bis 2147483647. Also wird beispielsweise auf solch einem
       System <return>intval('1000000000000')</return> 2147483647 zurückgeben. Der maximale signed integer-Wert auf
       64-Bit-Systemen ist 9223372036854775807.
       
       Zeichenketten werden meistens 0 zurückgeben, auch wenn das erste Zeichen hier entscheidend
       ist. Es gelten die normalen Regeln zur Umwandlung nach integer.

<comment>See Also:</comment>
   * <strong>boolval()</strong>
   * <strong>floatval()</strong>
   * <strong>strval()</strong>
   * <strong>settype()</strong>
   * <strong>is_numeric()</strong>
   * Typen-Tricks
   * BCMath - Mathematische Funktionen mit beliebiger Genauigkeit


id: ip2long
type: function
doc:
<comment>Description:</comment>
  Konvertiert eine gemäß IPv4-Protokoll angegebene IP-Adresse vom
     Punkt-Format in ein Long Integer
    
  
  Die Funktion <strong>ip2long()</strong> erzeugt aus einer im Punkt-Format angegebenen IPv4-Adresse ein Long
  Integer.
  
  <strong>ip2long()</strong> funktioniert auch mit unvollständigen IP-Adressen. Lesen Sie
  http://ps-2.kev009.com/wisclibrary/aix52/usr/share/man/info/en_US/a_doc_lib/libs/commtrf2/inet_addr.htm,
  um weitere Informationen zu erhalten.

<comment>Param:</comment>
  <info>string</info>  <strong>$ip</strong>  Eine Adresse im Standardformat.

<comment>Return:</comment>
  <info>int|false</info>  Gibt ein Long Integer zurück. Ist <strong>$ip</strong> ungültig, wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>long2ip()</strong>
   * <strong>sprintf()</strong>


id: iptcembed
type: function
doc:
<comment>Description:</comment>
  Embeds binary IPTC data into a JPEG image
  
  Embeds binary IPTC data into a JPEG image.

<comment>Param:</comment>
  <info>string</info>  <strong>$iptc_data</strong>  The data to be written.
  <info>string</info>  <strong>$filename</strong>   Path to the JPEG image.
  <info>int</info>     <strong>$spool</strong>      Spool flag. If the spool flag is less than 2 then the JPEG will be  returned
                      as a string. Otherwise the JPEG will be printed to STDOUT.

<comment>Return:</comment>
  <info>string|bool</info>  If <strong>$spool</strong> is less than 2, the JPEG will be returned, Bei einem Fehler wird <info>false</info>
               zurückgegeben.. Otherwise returns <info>true</info> on success Bei einem Fehler wird <info>false</info>
               zurückgegeben..


id: iptcparse
type: function
doc:
<comment>Description:</comment>
  Parse a binary IPTC block into single tags
  
  Parses an IPTC block into its single tags.

<comment>Param:</comment>
  <info>string</info>  <strong>$iptc_block</strong>  A binary IPTC block.

<comment>Return:</comment>
  <info>array|false</info>  Returns an array using the tagmarker as an index and the value as the value. It
               returns <info>false</info> on error or if no IPTC data was found.


id: is_a
type: function
doc:
<comment>Description:</comment>
  Prüft, ob ein Objekt vom angegebenen Typ oder untergeordneten Typ ist
  
  Prüft, ob das angegebene <strong>$object_or_class</strong> vom angegebenen Objekttyp ist oder diesen Objekttyp als
  einen seiner Eltern hat.

<comment>Param:</comment>
  <info>mixed</info>   <strong>$object_or_class</strong>  Der Name einer Klasse oder ein Objekt
  <info>string</info>  <strong>$class</strong>            Der Name einer Klasse oder Schnittstelle
  <info>bool</info>    <strong>$allow_string</strong>     Wenn dieser Parameter auf <info>false</info> gesetzt ist, ist beim Parameter
                            <strong>$object_or_class</strong> kein Klassenname erlaubt. Dadurch wird auch verhindert,
                            dass der Autoloader aufgerufen wird, wenn die Klasse nicht existiert.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn das Objekt vom angegebenen Objekttyp ist oder diesen Objekttyp als
        einen seiner Eltern hat, andernfalls wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>get_class()</strong>
   * <strong>get_parent_class()</strong>
   * <strong>is_subclass_of()</strong>


id: is_array
type: function
doc:
<comment>Description:</comment>
  Prüft, ob die Variable ein Array ist
  
  Ermittelt, ob die gegebene Variable ein Array ist.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Die zu untersuchende Variable.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn <strong>$value</strong> vom Typ <info>array</info> ist, andernfalls <info>false</info>.

<comment>See Also:</comment>
   * <strong>array_is_list()</strong>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_string()</strong>
   * <strong>is_object()</strong>


id: is_bool
type: function
doc:
<comment>Description:</comment>
  Prüft, ob eine Variable vom Typ boolean ist
    
  
  Prüft, ob die gegebene Variable ein Boolean ist.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Die zu untersuchende Variable.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn <strong>$value</strong> vom Typ <info>boolean</info> ist, ansonsten <info>false</info>.

<comment>See Also:</comment>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_string()</strong>
   * <strong>is_object()</strong>
   * <strong>is_array()</strong>


id: is_callable
type: function
doc:
<comment>Description:</comment>
  Prüft, ob ein Wert als Funktion aus dem aktuellen Bereich aufgerufen werden kann.
    
  
  Prüft, ob ein Wert ein <info>callable</info> ist.

<comment>Param:</comment>
  <info>mixed</info>   <strong>$value</strong>          Der zu prüfende Wert.
  <info>bool</info>    <strong>$syntax_only</strong>    Wenn dieser Parameter auf <info>true</info> gesetzt wird, prüft die Funktion nur, ob
                          <strong>$value</strong> eine Funktion oder Methode enthalten könnte. Nur einfache
                          Variablen, die keinen String enthalten, werden zurückgewiesen, oder
                          Arrays, die nicht die richtige Struktur haben, um als Callback verwendet
                          werden zu können. Gültige Arrays müssen zwei Elemente haben, von denen der
                          erste ein Objekt oder String und der zweite ein String ist.
  <info>string</info>  <strong>$callable_name</strong>  Hier wird der "aufrufbare Name" abgelegt. Für das Beispiel weiter unten
                          ist dies "someClass::someMethod". Es ist zu beachten, dass dies keine
                          statische Methode ist, auch wenn die Syntax das nahelegt.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn <strong>$value</strong> aufrufbar ist, sonst <info>false</info>.

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


id: is_countable
type: function
doc:
<comment>Description:</comment>
  Verify that the contents of a variable is a countable value
    
  
  Verify that the contents of a variable is an <info>array</info> or an object implementing <class>Countable</class>

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The value to check

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$value</strong> is countable, <info>false</info>  otherwise.

<comment>See Also:</comment>
   * <strong>is_array()</strong>
   * <strong>is_object()</strong>
   * <strong>is_iterable()</strong>
   * <strong>is_bool()</strong>


id: is_dir
type: function
doc:
<comment>Description:</comment>
  Prüft, ob der angegebene Dateiname ein Verzeichnis ist
  
  Prüft, ob der angegebene Dateiname ein Verzeichnis ist.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Pfad zur Datei. Wenn <strong>$filename</strong> ein relativer Dateiname ist, so wird er auch
                     relativ zu dem aktuellen Verzeichnis geprüft. Wenn <strong>$filename</strong> ein symbolischer
                     oder harter Link ist, so wird der Link aufgelöst und geprüft. Falls
                     open_basedir aktiviert ist, können weitere Einschränkungen berücksichtigt
                     werden.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn der Dateiname existiert und ein Verzeichnis ist, sonst <info>false</info>.

<comment>See Also:</comment>
   * <strong>chdir()</strong>
   * <strong>dir()</strong>
   * <strong>opendir()</strong>
   * <strong>is_file()</strong>
   * <strong>is_link()</strong>


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


id: is_executable
type: function
doc:
<comment>Description:</comment>
  Prüft, ob der Dateiname ausführbar ist
  
  Prüft, ob der Dateiname ausführbar ist.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Der Pfad zur Datei.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn der Dateiname existiert und ausführbar ist, oder <info>false</info> im Fehlerfall.
        Auf POSIX-Systemen ist eine Datei ausführbar, wenn in den Dateiberechtigungen das
        Ausführungsbit gesetzt ist. Für Windows siehe den Hinweis unten.

<comment>See Also:</comment>
   * <strong>is_file()</strong>
   * <strong>is_link()</strong>


id: is_file
type: function
doc:
<comment>Description:</comment>
  Prüft, ob der Dateiname eine reguläre Datei ist
  
  Prüft, ob der Dateiname eine reguläre Datei ist.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Pfad zur Datei.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn der Dateiname existiert und eine reguläre Datei ist, sonst <info>false</info>.
        
        Weil PHPs Integer Typ vorzeichenbehaftet ist und viele Platformen 32bit Integer
        verwenden, können einige Dateisystem-Funktionen für Dateien größer als 2GB unerwartete
        Ergebnisse liefern.

<comment>See Also:</comment>
   * <strong>is_dir()</strong>
   * <strong>is_link()</strong>
   * <class>SplFileInfo</class>


id: is_finite
type: function
doc:
<comment>Description:</comment>
  Prüft, ob eine Gleitkommazahl endlich ist
  
  Gibt zurück, ob der übergebene Parameter <strong>$num</strong> eine endliche Gleitkommazahl ist.
  
  Eine endliche Gleitkommazahl ist weder <return>NAN</return> (<strong>is_nan()</strong>) noch unendlich (<strong>is_infinite()</strong>).

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  Die zu überprüfende Gleitkommazahl

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn <strong>$num</strong> nicht <return>NAN</return>, <return>INF</return> oder <return>-INF</return> ist, andernfalls <info>false</info>.

<comment>See Also:</comment>
   * <strong>is_infinite()</strong>
   * <strong>is_nan()</strong>


id: is_float
type: function
doc:
<comment>Description:</comment>
  Prüft, ob eine Variable vom Typ float ist
  
  Prüft, ob eine Variable vom Typ float ist
  
  Um zu testen, ob eine Variable eine Zahl oder eine numerische Zeichenkette ist (wie zum Beispiel
  Formularangaben, die immer Zeichenketten sind), müssen Sie <strong>is_numeric()</strong> verwenden.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Die auszuwertende Variable.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn <strong>$value</strong> vom Typ <info>float</info> ist, sonst <info>false</info>.

<comment>See Also:</comment>
   * <strong>is_bool()</strong>
   * <strong>is_int()</strong>
   * <strong>is_numeric()</strong>
   * <strong>is_string()</strong>
   * <strong>is_array()</strong>
   * <strong>is_object()</strong>


id: is_infinite
type: function
doc:
<comment>Description:</comment>
  Prüft, ob eine Gleitkommazahl unendlich ist
  
  Gibt zurück, ob der übergebene Parameter <strong>$num</strong> entweder <return>INF</return> oder <return>-INF</return> ist.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  Die zu überprüfende Gleitkommazahl

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn <strong>$num</strong> entweder <return>INF</return> oder <return>-INF</return> ist, andernfalls <info>false</info>.

<comment>See Also:</comment>
   * <strong>is_finite()</strong>
   * <strong>is_nan()</strong>


id: is_int
type: function
doc:
<comment>Description:</comment>
  Prüft, ob eine Variable vom Typ int ist
  
  Prüft, ob eine Variable vom Typ integer ist.
  
  Um zu testen, ob eine Variable eine Zahl oder eine numerische Zeichenkette ist (wie zum Beispiel
  Formularangaben, die immer Zeichenketten sind), müssen Sie <strong>is_numeric()</strong> verwenden.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Die auszuwertende Variable.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn <strong>$value</strong> vom Typ <info>int</info> ist, sonst <info>false</info>.

<comment>See Also:</comment>
   * <strong>is_bool()</strong>
   * <strong>is_float()</strong>
   * <strong>is_numeric()</strong>
   * <strong>is_string()</strong>
   * <strong>is_array()</strong>
   * <strong>is_object()</strong>


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


id: is_iterable
type: function
doc:
<comment>Description:</comment>
  Verify that the contents of a variable is an iterable value
    
  
  Verify that the contents of a variable is accepted by the <info>iterable</info> pseudo-type, i.e. that it is
  either an <info>array</info> or an object implementing <class>Traversable</class>

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The value to check

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$value</strong> is iterable, <info>false</info>  otherwise.

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


id: is_link
type: function
doc:
<comment>Description:</comment>
  Prüft, ob der Dateiname ein symbolischer Link ist
  
  Prüft, ob der angegebene Dateiname ein symbolischer Link ist.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Pfad zur Datei.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn der Dateiname existiert und es sich um einen symbolischen Link
        handelt, sonst <info>false</info>.

<comment>See Also:</comment>
   * <strong>is_dir()</strong>
   * <strong>is_file()</strong>
   * <strong>readlink()</strong>


id: is_nan
type: function
doc:
<comment>Description:</comment>
  Prüft, ob eine Gleitkommazahl NAN ist
  
  Gibt zurück, ob die angegebene <strong>$Zahl</strong> <return>NAN</return> (Not A Number) ist.
  
  <return>NAN</return> wird von mathematischen Operationen zurückgegeben, die undefiniert sind, z. B. bei der
  Übergabe von Parametern außerhalb des Eingabebereichs einer Funktion. Die Quadratwurzel (<strong>sqrt()</strong>)
  ist nur für positive Zahlen definiert, die Übergabe einer negativen Zahl führt zu <return>NAN</return>. Andere
  Beispiele für Operationen, die <return>NAN</return> zurückgeben, sind die Division von <return>INF</return> durch <return>INF</return> und jede
  Operation, die sich auf einen bestehenden <return>NAN</return>-Wert bezieht.
  
  Trotz seines Namens Not A Number ist <return>NAN</return> (keine Zahl) ein gültiger Wert vom Typ Float.
  
  <return>NAN</return> kann nicht mit <return>NAN</return> verglichen werden. Um zu prüfen, ob ein float <return>NAN</return> ist, muss <strong>is_nan()</strong>
  verwendet werden. Zu prüfen, ob $float === NAN ist, funktioniert nicht.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  Die zu überprüfende Gleitkommazahl

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn <strong>$num</strong> <return>NAN</return> ist, andernfalls <info>false</info>.

<comment>See Also:</comment>
   * <strong>is_finite()</strong>
   * <strong>is_infinite()</strong>


id: is_null
type: function
doc:
<comment>Description:</comment>
  Prüft, ob eine Variable null enthält
    
  
  Prüft, ob die gegebene Variable <info>null</info> enthält

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Die zu prüfende Variable.

<comment>Return:</comment>
  <info>bool</info>  Liefert <info>true</info> wenn <strong>$value</strong> <info>null</info> enthält, sonst <info>false</info>.

<comment>See Also:</comment>
   * Der <info>null</info>-Typ
   * <strong>isset()</strong>
   * <strong>is_bool()</strong>
   * <strong>is_numeric()</strong>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_string()</strong>
   * <strong>is_object()</strong>
   * <strong>is_array()</strong>


id: is_numeric
type: function
doc:
<comment>Description:</comment>
  Prüft, ob eine Variable eine Zahl oder ein numerischer String ist
    
  
  Prüft, ob die gegebene Variable eine Zahl oder ein numerischer String ist.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Die zu untersuchende Variable

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn <strong>$value</strong> eine Zahl oder ein numerischer String ist, ansonsten <info>false</info>.

<comment>See Also:</comment>
   * Numerische Strings
   * <strong>ctype_digit()</strong>
   * <strong>is_bool()</strong>
   * <strong>is_null()</strong>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_string()</strong>
   * <strong>is_object()</strong>
   * <strong>is_array()</strong>
   * <strong>filter_var()</strong>


id: is_object
type: function
doc:
<comment>Description:</comment>
  Prüft, ob eine Variable vom Typ object ist
  
  Prüft, ob die gegebene Variable ein Objekt ist.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Die zu untersuchende Variable.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn <strong>$value</strong> vom Typ <info>object</info> ist, ansonsten <info>false</info>.

<comment>See Also:</comment>
   * <strong>is_bool()</strong>
   * <strong>is_int()</strong>
   * <strong>is_float()</strong>
   * <strong>is_string()</strong>
   * <strong>is_array()</strong>


id: is_readable
type: function
doc:
<comment>Description:</comment>
  Prüft, ob eine Datei existiert und lesbar ist
  
  Gibt <info>true</info> zurück, wenn die Datei existiert und lesbar ist.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Pfad zur Datei.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn die Datei oder das Verzeichnis (angegeben durch <strong>$filename</strong>) existiert
        und lesbar ist, sonst <info>false</info>.

<comment>See Also:</comment>
   * <strong>is_writable()</strong>
   * <strong>file_exists()</strong>
   * <strong>fgets()</strong>


id: is_real
type: function
doc:
<comment>Description:</comment>
  Alias von is_float
  
  Diese Funktion ist ein Alias für:  <strong>is_float()</strong>.
  
  Dieser Alias ist seit PHP 7.4.0
  als DEPRECATED (veraltet) markiert und wurde in PHP 8.0.0
  ENTFERNT.


id: is_resource
type: function
doc:
<comment>Description:</comment>
  Prüft, ob eine Variable vom Typ resource ist
    
  
  Prüft, ob die gegebene Variable eine <info>resource</info> ist.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Die zu untersuchende Variable.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn <strong>$value</strong> vom Typ <info>resource</info> ist, andernfalls <info>false</info>.

<comment>See Also:</comment>
   * Die Ressource-Typen
     Dokumentation
   * <strong>get_resource_type()</strong>


id: is_scalar
type: function
doc:
<comment>Description:</comment>
  Prüft, ob eine Variable skalar ist
  
  Prüft, ob die gegebene Variable skalar ist.
  
  Unter skalaren Variablen versteht man solche, die einen <info>int</info>-, <info>float</info>-, <info>string</info>- oder <info>bool</info>-Wert
  enthalten. Variablen vom Typ <info>array</info>, <info>object</info>, <info>resource</info> und <info>null</info> sind nicht skalar.
  
  <strong>is_scalar()</strong> betrachtet Variablen vom Typ <info>resource</info> nicht als skalar, da Resourcen abstrakte
  Datentypen darstellen, auch wenn sie zur Zeit als Integer repräsentiert sind. Sie sollten sich
  nicht auf dieses Implementationsdetail verlassen, da es sich ändern kann.
  
  <strong>is_scalar()</strong> erachtet NULL nicht als skalar.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Die zu prüfende Variable.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn <strong>$value</strong> skalar ist, sonst <info>false</info>.

<comment>See Also:</comment>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_numeric()</strong>
   * <strong>is_real()</strong>
   * <strong>is_string()</strong>
   * <strong>is_bool()</strong>
   * <strong>is_object()</strong>
   * <strong>is_array()</strong>


id: is_soap_fault
type: function
doc:
<comment>Description:</comment>
  Prüft, ob ein SOAP-Aufruf fehlgeschlagen ist
  
  Diese Funktion ist nützlich, um festzustellen, ob ein SOAP-Aufruf fehlgeschlagen ist, aber keine
  Exceptions verwendet wurden. Um die Funktion zu verwenden, muss ein <class>SoapClient</class>-Objekt erzeugt und
  <return>exceptions</return> auf 0 oder <info>false</info> gesetzt werden. In diesem Fall gibt die SOAP-Methode ein spezielles
  <class>SoapFault</class>-Objekt zurück, das die Fehlerinformationen enthält (Fehlercode, Fehlerbeschreibung,
  Verursacher und Details).
  
  Wenn <return>exceptions</return> nicht gesetzt ist, wirft der SOAP-Aufruf im Fehlerfall eine Exception.
  <strong>is_soap_fault()</strong> prüft, ob der gegebene Parameter ein <class>SoapFault</class>-Objekt ist.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$object</strong>  Das zu testende Objekt.

<comment>Return:</comment>
  <info>bool</info>  Die Funktion gibt im Fehlerfall <info>true</info>, ansonsten <info>false</info> zurück.

<comment>See Also:</comment>
   * SoapClient::__construct
   * SoapFault::__construct


id: is_string
type: function
doc:
<comment>Description:</comment>
  Prüft, ob Variable vom Typ string ist
  
  Prüft, ob die gegebene Variable vom Typ String ist.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Die zu untersuchende Variable.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn <strong>$value</strong> vom Typ <info>string</info> ist, andernfalls <info>false</info>.

<comment>See Also:</comment>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_bool()</strong>
   * <strong>is_object()</strong>
   * <strong>is_array()</strong>


id: is_subclass_of
type: function
doc:
<comment>Description:</comment>
  Prüft ob ein Objekt von der angegebenen Klasse abstammt oder sie implementiert
  
  Diese Funktion prüft ob das Objekt <strong>$object_or_class</strong> von der Klasse <strong>$class</strong> abstammt oder sie
  implementiert.

<comment>Param:</comment>
  <info>mixed</info>   <strong>$object_or_class</strong>  Ein Klassenname oder eine Objektinstanz. Es wird kein Fehler generiert,
                            wenn die Klasse nicht existiert.
  <info>string</info>  <strong>$class</strong>            Ein Klassenname
  <info>bool</info>    <strong>$allow_string</strong>     Wenn dieser Parameter false ist, ist ein Zeichenketten-Klassenname als
                            <strong>$object_or_class</strong> nicht erlaubt. Dies verhindert ebenso den Aufruf vom
                            Autoloader, wenn die Klasse nicht existiert.

<comment>Return:</comment>
  <info>bool</info>  Die Funktion liefert <info>true</info> wenn die Klasse des Objekts <strong>$object_or_class</strong> eine Unterklasse von
        <strong>$class</strong> ist, sonst <info>false</info>.

<comment>See Also:</comment>
   * <strong>get_class()</strong>
   * <strong>get_parent_class()</strong>
   * <strong>is_a()</strong>
   * <strong>class_parents()</strong>


id: is_tainted
type: function
doc:
<comment>Description:</comment>
  Checks whether a string is tainted
  
  Checks whether a string is tainted

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

<comment>Return:</comment>
  <info>bool</info>  Return TRUE if the string is tainted, FALSE otherwise.


id: is_uploaded_file
type: function
doc:
<comment>Description:</comment>
  Prüft, ob die Datei mittels HTTP-POST upgeloadet wurde
  
  Gibt <info>true</info> zurück, wenn die Datei <strong>$filename</strong> mittels HTTP-POST hochgeladen wurde. Dies ist
  hilfreich, um sicherzustellen, dass kein böswilliger Nutzer versucht hat, das Skript zu
  überlisten, indem  er es Dateien bearbeiten lässt, die es gar nicht bearbeiten sollte, zum
  Beispiel /etc/passwd.
  
  Diese Prüfung ist insbesondere dort interessant, wo irgendeine Aktion mit  upgeloadeten Dateien
  deren Inhalt dem Nutzer (oder sogar anderen Nutzern auf dem gleichen System) zugänglich machen
  könnte.
  
  Um korrekt arbeiten zu können, benötigt die Funktion <strong>is_uploaded_file()</strong> einen Parameter wie
  $_FILES['userfile']['tmp_name']. Der Name der upgeloadeten Datei auf dem Anwenderrechner
  $_FILES['userfile']['name'] funktioniert nicht.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Der zu prüfende Dateiname.

<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>move_uploaded_file()</strong>
   * $_FILES
   * Siehe Steuerung von Dateiuploads
    für ein einfaches Anwendungsbeispiel.


id: is_writable
type: function
doc:
<comment>Description:</comment>
  Prüft, ob in eine Datei geschrieben werden kann
  
  Gibt <info>true</info> zurück, wenn <strong>$filename</strong> existiert und schreibbar ist. Der Dateinamens-Parameter kann auch
  ein Verzeichnisname sein, um prüfen zu können, ob ein Verzeichnis schreibbar ist.
  
  Bedenken Sie, dass PHP mit der Benutzer-ID auf die Datei zugreift, unter der der Webserver läuft
  (oftmals ist dies 'nobody').

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Der zu prüfende Dateiname.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn <strong>$filename</strong> existiert und schreibbar ist.

<comment>See Also:</comment>
   * <strong>is_readable()</strong>
   * <strong>file_exists()</strong>
   * <strong>fwrite()</strong>


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


id: isset
type: function
doc:
<comment>Description:</comment>
  Prüft, ob eine Variable deklariert ist und sich von null unterscheidet
  
  Prüft, ob eine Variable als belegt gilt, d.h., ob eine Variable deklariert ist und sich von <info>null</info>
  unterscheidet.
  
  Wenn eine Variable mittels <strong>unset()</strong> zurückgesetzt wurde, gilt sie nicht länger als belegt.
  
  <strong>isset()</strong> gibt <info>false</info> zurück, wenn damit eine Variable geprüft wird, der <info>null</info> zugewiesen wurde. Zu
  beachten ist auch, dass ein Nullzeichen (<return>"\0"</return>) nicht der PHP-Konstante <info>null</info> entspricht.
  
  Wenn mehrere Parameter übergeben werden, gibt <strong>isset()</strong> nur dann <info>true</info> zurück, wenn alle Parameter
  als belegt gelten. Die Auswertung geht von links nach rechts und wird abgebrochen, sobald eine
  Variable nicht belegt ist.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>   Die zu überprüfende Variable.
  <info>mixed</info>  <strong>$vars</strong>  Eine weitere Variable ...

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn <strong>$var</strong> existiert und einen von <info>null</info> verschiedenen Wert hat, andernfalls
        <info>false</info>.

<comment>See Also:</comment>
   * <strong>empty()</strong>
   * __isset
   * <strong>unset()</strong>
   * <strong>defined()</strong>
   * die Tabelle zum Typenvergleich
   * <strong>array_key_exists()</strong>
   * <strong>is_null()</strong>
   * Fehler-Kontroll-Operator @


id: iterator_apply
type: function
doc:
<comment>Description:</comment>
  Call a function for every element in an iterator
  
  Calls a function for every element in an iterator.

<comment>Param:</comment>
  <info>Traversable</info>  <strong>$iterator</strong>  The iterator object to iterate over.
  <info>callable</info>     <strong>$callback</strong>  The callback function to call on every element. This function only
                          receives the given <strong>$args</strong>, so it is nullary by default. If <return>count($args) ===
                          3</return>, for instance, the callback function is ternary.  The function must
                          return <info>true</info> in order to continue iterating over the <strong>$iterator</strong>.
                          
                          The function must return <info>true</info> in order to continue iterating over the
                          <strong>$iterator</strong>.
  <info>array|null</info>   <strong>$args</strong>      An <info>array</info> of arguments; each element of <strong>$args</strong> is passed to the callback
                          <strong>$callback</strong> as separate argument.

<comment>Return:</comment>
  <info>int</info>  Returns the iteration count.

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


id: iterator_count
type: function
doc:
<comment>Description:</comment>
  Count the elements in an iterator
  
  Count the elements in an iterator. <strong>iterator_count()</strong> is not guaranteed to retain the current
  position of the <strong>$iterator</strong>.

<comment>Param:</comment>
  <info>Traversable|array</info>  <strong>$iterator</strong>  The iterator being counted.

<comment>Return:</comment>
  <info>int</info>  The number of elements in <strong>$iterator</strong>.


id: iterator_to_array
type: function
doc:
<comment>Description:</comment>
  Copy the iterator into an array
  
  Copy the elements of an iterator into an array.

<comment>Param:</comment>
  <info>Traversable|array</info>  <strong>$iterator</strong>       The iterator being copied.
  <info>bool</info>               <strong>$preserve_keys</strong>  Whether to use the iterator element keys as index.
                                     
                                     If a key is an <info>array</info> or <info>object</info>, a warning will be generated.
                                     <info>null</info> keys will be converted to an empty string, <info>float</info> keys will
                                     be truncated to their <info>int</info> counterpart, <info>resource</info> keys will
                                     generate a warning and be converted to their resource ID, and
                                     <info>bool</info> keys will be converted to integers.
                                     
                                     If this parameter is not set or set to <info>true</info>, duplicate keys
                                     will be overwritten. The last value with a given key will be in
                                     the returned <info>array</info>. Set this parameter to <info>false</info> to get all the
                                     values in any case.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> containing the elements of the <strong>$iterator</strong>.


id: jddayofweek
type: function
doc:
<comment>Description:</comment>
  Bestimmt den Wochentag aus einem Julianischen Datum
      
  
  Diese Funktion bestimmt den Wochentag für den in <strong>$julianday</strong> übergebenen Tag im Julianischen Datum.
  Die Ausgabe erfolgt in Abhängigkeit von <strong>$mode</strong> als integer oder string.

<comment>Param:</comment>
  <info>int</info>  <strong>$julian_day</strong>  Ein Julianischer Tag als Integer
  <info>int</info>  <strong>$mode</strong>        

<comment>Return:</comment>
  <info>int|string</info>  Der Gregorianische Wochentag als Integer oder String.


id: jdmonthname
type: function
doc:
<comment>Description:</comment>
  Liefert den Monatsnamen
  
  Gibt eine Zeichenkette zurück, die einen Monatsnamen enthält. <strong>$mode</strong> teilt dieser Funktion mit, in
  welchen Kalender die julianische Tageszahl umgewandelt werden soll, und welche Art von Monatsnamen
  zurückgegeben werden sollen. Mögliche
  <strong>$mode</strong>-WerteModusBedeutungWerte<info>CAL_MONTH_GREGORIAN_SHORT</info>Gregorianisch (Abk.)Jan, Feb, Mar, Apr,
  May, Jun, Jul, Aug, Sep, Oct, Nov, Dec<info>CAL_MONTH_GREGORIAN_LONG</info>GregorianischJanuary, February,
  March, April, May, June, July, August, September, October, November,
  December<info>CAL_MONTH_JULIAN_SHORT</info>Julianisch - (Abk.)Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct,
  Nov, Dec<info>CAL_MONTH_JULIAN_LONG</info>JulianischJanuary, February, March, April, May, June, July, August,
  September, October, November, December<info>CAL_MONTH_JEWISH</info>JüdischTishri, Heshvan, Kislev, Tevet,
  Shevat, Adar, AdarI, AdarII, Nisan, Iyyar, Sivan, Tammuz, Av, Elul<info>CAL_MONTH_FRENCH</info>Französisch
  revolutionärVendemiaire, Brumaire, Frimaire, Nivose, Pluviose, Ventose, Germinal, Floreal,
  Prairial, Messidor, Thermidor, Fructidor, Extra

<comment>Param:</comment>
  <info></info>     <strong>$jday</strong>  Ein Julianischer Tag als Integer.
  <info>int</info>  <strong>$mode</strong>  Der Kalender-Modus (siehe Tabelle weiter oben).

<comment>Return:</comment>
  <info>string</info>  Der Monatsname für den gegebene julianischen Tag im gewünschten <strong>$mode</strong>.


id: jdtofrench
type: function
doc:
<comment>Description:</comment>
  Konvertiert ein Julianisches Datum zum Kalender der Französischen
     Revolution
    
  
  Konvertiert ein Julianisches Datum zum Kalender der Französischen Revolution

<comment>Param:</comment>
  <info>int</info>  <strong>$julian_day</strong>  Ein Julianischer Tag als Integer

<comment>Return:</comment>
  <info>string</info>  Ein Französisches Revolutionsdatum als String in der Form "Monat/Tag/Yahr"

<comment>See Also:</comment>
   * <strong>frenchtojd()</strong>
   * <strong>cal_from_jd()</strong>


id: jdtogregorian
type: function
doc:
<comment>Description:</comment>
  Wandelt eine julianische Tageszahl in ein gregorianischen Datum um
  
  Wandelt eine julianische Tageszahl in eine Zeichenkette um, die das gregorianische Datum im Format
  "Monat/Tag/Jahr" enthält.

<comment>Param:</comment>
  <info>int</info>  <strong>$julian_day</strong>  Eine julianischer Tageszahl als Integer.

<comment>Return:</comment>
  <info>string</info>  Das gregorianische Datum als Zeichenkette der Form "Monat/Tag/Jahr".

<comment>See Also:</comment>
   * <strong>gregoriantojd()</strong>
   * <strong>cal_from_jd()</strong>


id: jdtojewish
type: function
doc:
<comment>Description:</comment>
  Konvertierung vom Julianischen Datum zum Jüdischen Kalender
    
  
  Diese Funktion konvertiert den in <strong>$julianday</strong> angegebenen Tag im Julianischen Datum in den
  Jüdischen Kalender.

<comment>Param:</comment>
  <info>int</info>   <strong>$julian_day</strong>  Ein Julianischer Tag als Integer
  <info>bool</info>  <strong>$hebrew</strong>      Wird dieser Parameter auf <info>true</info> gesetzt, so wird das Jüdische Datum als
                     hebräischer ISO-8859-8 kodierter String gemäß dem im Parameter <strong>$flags</strong>
                     festgelegten Format zurückgegeben.
  <info>int</info>   <strong>$flags</strong>       Eine Bitmaske bestehend aus <info>CAL_JEWISH_ADD_ALAFIM_GERESH</info>, <info>CAL_JEWISH_ADD_ALAFIM</info>
                     und <info>CAL_JEWISH_ADD_GERESHAYIM</info>.

<comment>Return:</comment>
  <info>string</info>  Das jüdische Datum als String in der Form "Monat/Tag/Jahr", oder eine ISO-8859-8 kodierte
          hebräische Datumszeichenkette gemäß dem <strong>$hebrew</strong> Parameter.

<comment>See Also:</comment>
   * <strong>jewishtojd()</strong>
   * <strong>cal_from_jd()</strong>


id: jdtojulian
type: function
doc:
<comment>Description:</comment>
  Wandelt eine julianische Tageszahl in ein julianisches Kalenderdatum um
  
  Wandelt eine julianische Tageszahl in eine Zeichenkette um, die das julianische Kalenderdatum im
  Form "Monat/Tag/Year" enthält.

<comment>Param:</comment>
  <info>int</info>  <strong>$julian_day</strong>  Eine julianische Tageszahl als Integer.

<comment>Return:</comment>
  <info>string</info>  Ein julianisches Kalenderdatum als Zeichenkette in der Form "Monat/Tag/Jahr".

<comment>See Also:</comment>
   * <strong>juliantojd()</strong>
   * <strong>cal_from_jd()</strong>


id: jdtounix
type: function
doc:
<comment>Description:</comment>
  Konvertiert ein julianisches Datum in einen Unix-Timestamp
  
  Diese Funktion gibt einen Unix-Timestamp (in Sekunden seit dem 1.1.1970) zurück, der dem in
  <strong>$julian_day</strong> übergebenen julianischen Datum entspricht. Die zurückgegebene Zeit ist UTC.

<comment>Param:</comment>
  <info>int</info>  <strong>$julian_day</strong>  Die Zahl eines julianischen Tages zwischen <return>2440588</return> und <return>106751993607888</return> auf
                    64-Bit-Systemen oder zwischen <return>2440588</return> und <return>2465443</return> auf 32-Bit-Systemen.

<comment>Return:</comment>
  <info>int</info>  Der Unix-Timestamp für den Anfang (Mitternacht, nicht Mittag) des angegebenen julianischen
       Tages.

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


id: jewishtojd
type: function
doc:
<comment>Description:</comment>
  Konvertiert vom Jüdischen Kalender zum Julianischen Datum
    
  
  Obwohl diese Funktion mit Werten bis zurück zum Jahr 1 (3761 v.Chr.) arbeiten kann, wird eine
  solche Nutzen nicht empfohlen. Der Jüdische Kalender wurde mehrere tausend Jahre lang benutzt,
  aber in den frühen Tagen existierte keine Formel, um den Monatsanfang zu bestimmen. Ein neuer
  Monat begann, wenn der Neumond beobachtet wurde.

<comment>Param:</comment>
  <info>int</info>  <strong>$month</strong>  Der Monat als Zahl zwischen <return>1</return> und <return>13</return>, wobei <return>1</return> für <return>Tishri</return>, <return>13</return> für <return>Elul</return>, und <return>6</return> und <return>7</return>
               für <return>Adar</return> in regulären Jahren steht, aber für <return>Adar I</return> bzw. <return>Adar II</return> in Schaltjahren.
  <info>int</info>  <strong>$day</strong>    Der Tag als Zahl zwischen <return>1</return> und <return>30</return>. Hat der Monat nur 29 Tage, wird der erste Tag des
               folgenden Monats angenommen.
  <info>int</info>  <strong>$year</strong>   Das Jahr als Zahl zwischen 1 und 9999

<comment>Return:</comment>
  <info>int</info>  Der Julianische Tag für das gegebene Jüdische Datum als Integer.

<comment>See Also:</comment>
   * <strong>jdtojewish()</strong>
   * <strong>cal_to_jd()</strong>


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


id: jpeg2wbmp
type: function
doc:
<comment>Description:</comment>
  Konvertiert eine JPEG-Bilddatei in eine WBMP-Bilddatei
  
  Konvertiert eine JPEG-Datei in eine WBMP-Datei.

<comment>Param:</comment>
  <info>string</info>  <strong>$jpegname</strong>     Pfad zur JPEG-Datei.
  <info>string</info>  <strong>$wbmpname</strong>     Pfad zur WBMP-Datei.
  <info>int</info>     <strong>$dest_height</strong>  Höhe des Zielbildes.
  <info>int</info>     <strong>$dest_width</strong>   Breite des Zielbildes.
  <info>int</info>     <strong>$threshold</strong>    Schwellenwert, zwischen 0 und 8 (inklusive).

<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>png2wbmp()</strong>


id: json_decode
type: function
doc:
<comment>Description:</comment>
  Dekodiert eine JSON-Zeichenkette
  
  Konvertiert eine JSON-kodierte Zeichenkette in einen PHP-Wert.

<comment>Param:</comment>
  <info>string</info>     <strong>$json</strong>         Der zu dekodierende <strong>$json</strong>-String.
                           
                           Diese Funktion funktioniert nur mit Zeichenketten, die UTF-8-kodiert
                           sind.
                           
                           PHP implementiert eine Obermenge von JSON wie im Original RFC 7159
                           beschrieben.
  <info>bool|null</info>  <strong>$associative</strong>  Wenn <info>true</info>, werden JSON-Objekte als assoziative Arrays zurückgegeben. Wenn
                           <info>false</info>, werden JSON-Objekte als Objekte zurückgegeben. Wenn <info>null</info>, werden
                           JSON-Objekte als assoziative Arrays oder Objekte zurückgegeben, abhängig
                           davon, ob <info>JSON_OBJECT_AS_ARRAY</info> in den <strong>$flags</strong> gesetzt ist.
  <info>int</info>        <strong>$depth</strong>        Die maximale Verschachtelungstiefe der zu dekodierenden Struktur. Der
                           Wert muss größer als <return>0</return> sein und kleiner als oder gleich <return>2147483647</return>.
  <info>int</info>        <strong>$flags</strong>        Eine Bitmaske von <info>JSON_BIGINT_AS_STRING</info>, <info>JSON_INVALID_UTF8_IGNORE</info>,
                           <info>JSON_INVALID_UTF8_SUBSTITUTE</info>, <info>JSON_OBJECT_AS_ARRAY</info>, <info>JSON_THROW_ON_ERROR</info>.
                           Das Verhalten dieser Konstanten ist auf der Seite über die
                           JSON-Konstanten beschrieben.

<comment>Return:</comment>
  <info>mixed</info>  Gibt den in <strong>$json</strong> kodierten Wert als entsprechenden PHP-Typ zurück. Ohne Anführungszeichen
         werden die Werte <return>true</return>, <return>false</return> und <return>null</return> als <info>true</info>, <info>false</info> bzw. <info>null</info> zurückgegeben. Wenn <strong>$json</strong>
         nicht dekodiert werden kann oder wenn die kodierten Daten tiefer verschachtelt sind, als es
         der Parameter für Verschachtelungstiefe erlaubt, wird <info>null</info> zurückgegeben.

<comment>See Also:</comment>
   * <strong>json_encode()</strong>
   * <strong>json_last_error()</strong>


id: json_encode
type: function
doc:
<comment>Description:</comment>
  Liefert die JSON-Darstellung eines Wertes
  
  Gibt eine Zeichenkette zurück, die die JSON-Darstellung des übergebenen <strong>$value</strong> beinhaltet. Wenn
  der Parameter ein Array oder Objekt ist, wird er rekursiv serialisiert.
  
  Wenn ein Wert, der serialisiert werden soll, ein Objekt ist, dann werden standardmäßig nur die
  öffentlich sichtbaren Eigenschaften einbezogen. Alternativ dazu kann eine Klasse JsonSerializable
  implementieren, um zu steuern, wie ihre Werte zu JSON serialisiert werden.
  
  Die Kodierung wird von den übergebenen <strong>$flags</strong> beeinflusst und zusätzlich hängt die Kodierung von
  Float-Werten vom Wert von serialize_precision ab.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Der zu kodierende <strong>$value</strong>. Kann von jedem Typ außer Ressource sein.
                 
                 Alle Zeichenketten müssen in UTF-8 kodiert sein.
                 
                 PHP implementiert eine Obermenge von JSON wie im Original RFC 7159 beschrieben.
  <info>int</info>    <strong>$flags</strong>  Eine Bitmaske bestehend aus <info>JSON_FORCE_OBJECT</info>, <info>JSON_HEX_QUOT</info>, <info>JSON_HEX_TAG</info>,
                 <info>JSON_HEX_AMP</info>, <info>JSON_HEX_APOS</info>, <info>JSON_INVALID_UTF8_IGNORE</info>,
                 <info>JSON_INVALID_UTF8_SUBSTITUTE</info>, <info>JSON_NUMERIC_CHECK</info>, <info>JSON_PARTIAL_OUTPUT_ON_ERROR</info>,
                 <info>JSON_PRESERVE_ZERO_FRACTION</info>, <info>JSON_PRETTY_PRINT</info>, <info>JSON_UNESCAPED_LINE_TERMINATORS</info>,
                 <info>JSON_UNESCAPED_SLASHES</info>, <info>JSON_UNESCAPED_UNICODE</info>, <info>JSON_THROW_ON_ERROR</info>. Das Verhalten
                 dieser Konstanten ist auf der Seite über die JSON-Konstanten beschrieben.
  <info>int</info>    <strong>$depth</strong>  Setzt die maximale Verschachtelungstiefe. Muss größer als Null sein.

<comment>Return:</comment>
  <info>string|false</info>  Gibt einen JSON-kodierten String zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

<comment>See Also:</comment>
   * JsonSerializable
   * <strong>json_decode()</strong>
   * <strong>json_last_error()</strong>
   * <strong>serialize()</strong>


id: json_last_error
type: function
doc:
<comment>Description:</comment>
  Gibt den letzten aufgetretenen Fehler zurück
  
  Gibt (sofern vorhanden) den letzten Fehler zurück, der beim letzten Kodieren/Dekodieren von JSON,
  das <info>JSON_THROW_ON_ERROR</info> nicht angab, aufgetreten ist.

<comment>Return:</comment>
  <info>int</info>  Gibt einen Integer zurück, der Wert kann eine der folgenden Konstanten sein:

<comment>See Also:</comment>
   * <strong>json_last_error_msg()</strong>
   * <strong>json_decode()</strong>
   * <strong>json_encode()</strong>


id: json_last_error_msg
type: function
doc:
<comment>Description:</comment>
  Liefert die Fehlermeldung des letzten Aufrufs von json_encode() oder
     json_decode()
    
  
  Gibt die Fehlerzeichenkette des letzten Aufrufs von <strong>json_encode()</strong> oder <strong>json_decode()</strong> zurück, der
  nicht <info>JSON_THROW_ON_ERROR</info> angab.

<comment>Return:</comment>
  <info>string</info>  Gibt bei Erfolg die Fehlermeldung zurück oder <return>"No error"</return>, wenn kein Fehler aufgetreten
          ist.

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


id: json_validate
type: function
doc:
<comment>Description:</comment>
  Checks if a string contains valid JSON
  
  Returns whether the given String is syntactically valid JSON. If <strong>json_validate()</strong> returns <info>true</info>,
  <strong>json_decode()</strong> will successfully decode the given string when using the same <strong>$depth</strong> and <strong>$flags</strong>.
  
  If <strong>json_validate()</strong> returns <info>false</info>, the cause can be retrieved using <strong>json_last_error()</strong> and
  <strong>json_last_error_msg()</strong>.
  
  <strong>json_validate()</strong> uses less memory than <strong>json_decode()</strong> if the decoded JSON payload is not used,
  because it does not need to build the array or object structure containing the payload.
  
  Calling <strong>json_validate()</strong> immediately before <strong>json_decode()</strong> will unnecessarily parse the string
  twice, as <strong>json_decode()</strong> implicitly performs validation during decoding.
  
  <strong>json_validate()</strong> should therefore only be used if the decode JSON payload is not immediately used
  and knowing whether the string contains valid JSON is needed.

<comment>Param:</comment>
  <info>string</info>  <strong>$json</strong>   The string to validate.
                  
                  This function only works with UTF-8 encoded strings.
                  
                  PHP implementiert eine Obermenge von JSON wie im Original RFC 7159 beschrieben.
  <info>int</info>     <strong>$depth</strong>  Maximum nesting depth of the structure being decoded. The value must be greater
                  than <return>0</return>, and less than or equal to <return>2147483647</return>.
  <info>int</info>     <strong>$flags</strong>  Currently only <info>JSON_INVALID_UTF8_IGNORE</info> is accepted.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the given string is syntactically valid JSON, otherwise returns <info>false</info>.

<comment>See Also:</comment>
   * <strong>json_decode()</strong>
   * <strong>json_last_error()</strong>
   * <strong>json_last_error_msg()</strong>


id: juliantojd
type: function
doc:
<comment>Description:</comment>
  Konvertierung vom Julianischen Kalender zum Julianischen Datum
    
  
  Diese Funktion konvertiert das in <strong>$month</strong>, <strong>$day</strong> und <strong>$year</strong> übergebene Datum im Gregorianischen
  Kalender in einen Tag im Julianischen Datum.
  
  Gültige Daten liegen im Bereich von 4714 v.Chr. bis 9999 n.Chr. Der Julianische Kalender wurde
  allerdings erst 46 v.Chr. eingeführt, und die Details der Anwendung stabilisierten sich frühestens
  im Jahre 8 n. Chr., z. T. vielleicht sogar erst im vierten Jahrhundert nach Christus.  Weiterhin
  betrachteten nicht alle Kulturen, die sich nach diesem Kalender richteten, den Januar als den
  ersten Monat des Jahres.
  
  Bitte beachten Sie, dass der weltweit genutzte Kalender der Gregorianische und nicht der
  Julianische Kalender ist.  Für diesen Kalender kann die Funktion <strong>gregoriantojd()</strong> genutzt werden.

<comment>Param:</comment>
  <info>int</info>  <strong>$month</strong>  Der Monat als Zahl von 1 (für Januar) bis 12 (für Dezember)
  <info>int</info>  <strong>$day</strong>    Der Tag als Zahl von 1 bis 31
  <info>int</info>  <strong>$year</strong>   Das Jahr als Zahl zwischen -4713 und 9999

<comment>Return:</comment>
  <info>int</info>  Der Julianische Tag für das angegebene Julianische Datum als Integer.

<comment>See Also:</comment>
   * <strong>jdtojulian()</strong>
   * <strong>cal_to_jd()</strong>


id: key
type: function
doc:
<comment>Description:</comment>
  Liefert einen Schlüssel eines Arrays
  
  <strong>key()</strong> gibt das Index-Element der aktuellen Position im Array zurück.

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

<comment>Return:</comment>
  <info>int|string|null</info>  Die Funktion <strong>key()</strong> gibt lediglich den Schlüssel des Arrayelements zurück, auf das
                   der interne Zeiger gerade zeigt. Der Zeiger wird dabei nicht bewegt. Zeigt der
                   interne Zeiger über das Ende der Elementliste hinaus oder ist das Array leer,
                   gibt <strong>key()</strong> <info>null</info> zurück.

<comment>See Also:</comment>
   * <strong>current()</strong>
   * <strong>next()</strong>
   * <strong>array_key_first()</strong>
   * foreach


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


id: krsort
type: function
doc:
<comment>Description:</comment>
  Sortiert ein Array nach Schlüsseln in absteigender Reihenfolge
  
  Sortiert <strong>$array</strong> nach Schlüsseln in absteigender Reihenfolge.
  
  Wenn zwei Mitglieder als identisch verglichen werden, behalten sie ihre ursprüngliche Reihenfolge
  bei. Vor PHP 8.0.0 war die relative Sortierung im sortierten Array nicht definiert.
  
  Setzt den internen Zeiger des Arrays auf das erste Element zurück.

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  Das Eingabe-Array.
  <info>int</info>    <strong>$flags</strong>  Der optionale zweite Parameter <strong>$flags</strong> kann mit folgenden Werten genutzt werden, um
                 das Sortierverhalten zu ändern:
                 
                 Flags für den Sortiertyp: <info>SORT_REGULAR</info> - vergleicht Elemente normal; die Details
                 werden im Abschnitt Vergleichsoperatoren beschrieben. <info>SORT_NUMERIC</info> - vergleicht
                 Elemente numerisch. <info>SORT_STRING</info> - vergleicht Elemente als Zeichenketten.
                 <info>SORT_LOCALE_STRING</info> - vergleicht Elemente als Zeichenketten, basierend auf dem
                 aktuellen Gebietsschema. Es wird das Gebietsschema verwendet, das mit <strong>setlocale()</strong>
                 geändert werden kann. <info>SORT_NATURAL</info> - vergleicht Elemente als Zeichenketten wie
                 <strong>natsort()</strong> mit "natürlicher Ordnung". <info>SORT_FLAG_CASE</info> - kann kombiniert werden
                 (bitweise ODER) mit <info>SORT_STRING</info> oder <info>SORT_NATURAL</info>, um Zeichenketten unter
                 Berücksichtigung der Groß- und Kleinschreibung zu sortieren.
                 
                 <info>SORT_REGULAR</info> - vergleicht Elemente normal; die Details werden im Abschnitt
                 Vergleichsoperatoren beschrieben.
                 
                 <info>SORT_NUMERIC</info> - vergleicht Elemente numerisch.
                 
                 <info>SORT_STRING</info> - vergleicht Elemente als Zeichenketten.
                 
                 <info>SORT_LOCALE_STRING</info> - vergleicht Elemente als Zeichenketten, basierend auf dem
                 aktuellen Gebietsschema. Es wird das Gebietsschema verwendet, das mit <strong>setlocale()</strong>
                 geändert werden kann.
                 
                 <info>SORT_NATURAL</info> - vergleicht Elemente als Zeichenketten wie <strong>natsort()</strong> mit "natürlicher
                 Ordnung".
                 
                 <info>SORT_FLAG_CASE</info> - kann kombiniert werden (bitweise ODER) mit <info>SORT_STRING</info> oder
                 <info>SORT_NATURAL</info>, um Zeichenketten unter Berücksichtigung der Groß- und Kleinschreibung
                 zu sortieren.

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

<comment>See Also:</comment>
   * <strong>sort()</strong>
   * <strong>ksort()</strong>
   * Den Vergleich von Arraysortierungsfunktionen


id: ksort
type: function
doc:
<comment>Description:</comment>
  Sortiert ein Array nach Schlüsseln in aufsteigender Reihenfolge
  
  Sortiert <strong>$array</strong> nach Schlüsseln in aufsteigender Reihenfolge.
  
  Wenn zwei Mitglieder als identisch verglichen werden, behalten sie ihre ursprüngliche Reihenfolge
  bei. Vor PHP 8.0.0 war die relative Sortierung im sortierten Array nicht definiert.
  
  Setzt den internen Zeiger des Arrays auf das erste Element zurück.

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  Das Eingabe-Array.
  <info>int</info>    <strong>$flags</strong>  Der optionale zweite Parameter <strong>$flags</strong> kann mit folgenden Werten genutzt werden, um
                 das Sortierverhalten zu ändern:
                 
                 Flags für den Sortiertyp: <info>SORT_REGULAR</info> - vergleicht Elemente normal; die Details
                 werden im Abschnitt Vergleichsoperatoren beschrieben. <info>SORT_NUMERIC</info> - vergleicht
                 Elemente numerisch. <info>SORT_STRING</info> - vergleicht Elemente als Zeichenketten.
                 <info>SORT_LOCALE_STRING</info> - vergleicht Elemente als Zeichenketten, basierend auf dem
                 aktuellen Gebietsschema. Es wird das Gebietsschema verwendet, das mit <strong>setlocale()</strong>
                 geändert werden kann. <info>SORT_NATURAL</info> - vergleicht Elemente als Zeichenketten wie
                 <strong>natsort()</strong> mit "natürlicher Ordnung". <info>SORT_FLAG_CASE</info> - kann kombiniert werden
                 (bitweise ODER) mit <info>SORT_STRING</info> oder <info>SORT_NATURAL</info>, um Zeichenketten unter
                 Berücksichtigung der Groß- und Kleinschreibung zu sortieren.
                 
                 <info>SORT_REGULAR</info> - vergleicht Elemente normal; die Details werden im Abschnitt
                 Vergleichsoperatoren beschrieben.
                 
                 <info>SORT_NUMERIC</info> - vergleicht Elemente numerisch.
                 
                 <info>SORT_STRING</info> - vergleicht Elemente als Zeichenketten.
                 
                 <info>SORT_LOCALE_STRING</info> - vergleicht Elemente als Zeichenketten, basierend auf dem
                 aktuellen Gebietsschema. Es wird das Gebietsschema verwendet, das mit <strong>setlocale()</strong>
                 geändert werden kann.
                 
                 <info>SORT_NATURAL</info> - vergleicht Elemente als Zeichenketten wie <strong>natsort()</strong> mit "natürlicher
                 Ordnung".
                 
                 <info>SORT_FLAG_CASE</info> - kann kombiniert werden (bitweise ODER) mit <info>SORT_STRING</info> oder
                 <info>SORT_NATURAL</info>, um Zeichenketten unter Berücksichtigung der Groß- und Kleinschreibung
                 zu sortieren.

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

<comment>See Also:</comment>
   * <strong>sort()</strong>
   * <strong>krsort()</strong>
   * Den Vergleich von Arraysortierungsfunktionen


id: lcfirst
type: function
doc:
<comment>Description:</comment>
  Wandelt den ersten Buchstaben eines Strings in einen Kleinbuchstaben um
  
  Wandelt das erste Zeichen von <strong>$string</strong> in einen Kleinbuchstaben um, sofern es ein ASCII-Zeichen im
  Bereich von <return>"A"</return> (0x41) bis <return>"Z"</return> (0x5a) ist, und gibt die veränderte Zeichenkette zurück.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Der Eingabestring.

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

<comment>See Also:</comment>
   * <strong>ucfirst()</strong>
   * <strong>strtolower()</strong>
   * <strong>strtoupper()</strong>
   * <strong>ucwords()</strong>


id: lcg_value
type: function
doc:
<comment>Description:</comment>
  Kongruenzgenerator für Pseudozufallszahlen
  
  <strong>lcg_value()</strong> gibt eine Pseudozufallszahl zwischen Null und Eins (inklusive) zurück. Die Funktion
  kombiniert zwei gemischte kongruente Kongruenzgeneratoren mit den Perioden 2^31 - 85 und 2^31 -
  249. Die Periode der von dieser Funktion generierten Pseudozufallsfolge entspricht dem Produkt
  dieser beiden Primzahlen.
  
  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.
  
  Wenn der Rückgabewert durch Multiplikation oder Addition auf ein anderes Intervall skaliert wird
  (eine sogenannte affine Transformation), kann dies zu einer Verzerrung des resultierenden Wertes
  führen, weil Gleitkommazahlen auf der Zahlengeraden nicht gleichmäßig dicht sind. Da nicht alle
  Werte exakt durch eine Gleitkommazahl dargestellt werden können, kann das Ergebnis der affinen
  Transformation auch zu Werten außerhalb des gewünschten Intervalls führen.
  
  Um einen zufälligen Gleitkommawert innerhalb eines beliebigen Intervalls zu erzeugen, kann
  Random\Randomizer::getFloat verwendet werden. Mit Random\Randomizer::getInt kann eine zufällige
  ganze Zahl innerhalb eines beliebigen Intervalls erzeugt werden.

<comment>Return:</comment>
  <info>float</info>  Eine Pseudozufallszahl zwischen 0.0 und 1.0 (inklusive) als <info>float</info>.

<comment>See Also:</comment>
   * Random\Randomizer::getFloat
   * Random\Randomizer::getInt
   * <strong>random_int()</strong>


id: lchgrp
type: function
doc:
<comment>Description:</comment>
  Changes group ownership of symlink
  
  Attempts to change the group of the symlink <strong>$filename</strong> to <strong>$group</strong>.
  
  Only the superuser may change the group of a symlink arbitrarily; other users may change the group
  of a symlink to any group of which that user is a member.

<comment>Param:</comment>
  <info>string</info>      <strong>$filename</strong>  Path to the symlink.
  <info>string|int</info>  <strong>$group</strong>     The group specified by name or number.

<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>chgrp()</strong>
   * <strong>lchown()</strong>
   * <strong>chown()</strong>
   * <strong>chmod()</strong>


id: lchown
type: function
doc:
<comment>Description:</comment>
  Changes user ownership of symlink
  
  Attempts to change the owner of the symlink <strong>$filename</strong> to user <strong>$user</strong>.
  
  Only the superuser may change the owner of a symlink.

<comment>Param:</comment>
  <info>string</info>      <strong>$filename</strong>  Path to the file.
  <info>string|int</info>  <strong>$user</strong>      User name or number.

<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>chown()</strong>
   * <strong>lchgrp()</strong>
   * <strong>chgrp()</strong>
   * <strong>chmod()</strong>


id: ldap_8859_to_t61
type: function
doc:
<comment>Description:</comment>
  Übersetzt 8859-Zeichen in t61-Zeichen
  
  Übersetzt <return>ISO-8859</return> Zeichen in <return>t61</return>-Zeichen.
  
  Diese Funktion ist nützlich, wenn es erforderlich ist, mit einem alten <return>LDAPv2</return>-Server zu sprechen.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  Der zu übersetzende Text.

<comment>Return:</comment>
  <info>string|false</info>  Gibt die <return>t61</return>-Übersetzung von <strong>$value</strong> zurück. Bei einem Fehler wird <info>false</info>
                zurückgegeben.

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


id: ldap_add
type: function
doc:
<comment>Description:</comment>
  Fügt einem LDAP-Verzeichnis Einträge hinzu
  
  Fügt Einträge in ein LDAP-Verzeichnis ein.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>      Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben
                              wurde.
  <info>string</info>           <strong>$dn</strong>        Der Distinguished Name eines LDAP-Datenobjekts.
  <info>array</info>            <strong>$entry</strong>     Ein Array, das die Informationen des Eintrags bestimmt. Die Werte in
                              den Einträgen werden durch individuelle Merkmale indiziert. Im Fall
                              von mehreren Werten für ein Merkmal werden diese durch die Verwendung
                              von Zahlen indiziert, die bei 0 beginnen.  ]]>
  <info>array|null</info>       <strong>$controls</strong>  Ein Array von LDAP-Steuerbefehlen, die mit der Anfrage versendet
                              werden sollen.

<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>ldap_add_ext()</strong>
   * <strong>ldap_delete()</strong>


id: ldap_add_ext
type: function
doc:
<comment>Description:</comment>
  Add entries to LDAP directory
  
  Does the same thing as <strong>ldap_add()</strong> but returns an <class>LDAP\Result</class> instance to be parsed with
  <strong>ldap_parse_result()</strong>.

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

<comment>See Also:</comment>
   * <strong>ldap_add()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_bind
type: function
doc:
<comment>Description:</comment>
  Anmeldung an einem LDAP-Verzeichnis
  
  Anmeldung an einem LDAP-Verzeichnis mit angegebenem RDN und Kennwort.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>      Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben
                              wurde.
  <info>string|null</info>      <strong>$dn</strong>        
  <info>string|null</info>      <strong>$password</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>ldap_bind_ext()</strong>
   * <strong>ldap_unbind()</strong>


id: ldap_bind_ext
type: function
doc:
<comment>Description:</comment>
  Bind to LDAP directory
  
  Does the same thing as <strong>ldap_bind()</strong> but returns an <class>LDAP\Result</class> instance to be parsed with
  <strong>ldap_parse_result()</strong>.

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

<comment>See Also:</comment>
   * <strong>ldap_bind()</strong>
   * <strong>ldap_parse_result()</strong>


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


id: ldap_compare
type: function
doc:
<comment>Description:</comment>
  Vergleicht den Wert eines Merkmals mit dem eines Eintrags
  
  Vergleicht den Wert (<strong>$value</strong> des Merkmals <strong>$attribute</strong> mit dem Wert desselben Merkmals in einem
  LDAP-Verzeichniseintrag.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>       Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben
                               wurde.
  <info>string</info>           <strong>$dn</strong>         Der Distinguished Name eines LDAP-Datenobjekts.
  <info>string</info>           <strong>$attribute</strong>  Der Name des Merkmals.
  <info>string</info>           <strong>$value</strong>      Der zu vergleichende Wert.
  <info>array|null</info>       <strong>$controls</strong>   Ein Array von LDAP-Steuerbefehlen, die mit der Anfrage versendet
                               werden sollen.

<comment>Return:</comment>
  <info>bool|int</info>  Gibt <info>true</info> zurück, wenn <strong>$value</strong> übereinstimmt, falls nicht, wird <info>false</info> zurückgegeben. Im
            Fehlerfall wird -1 zurückgegeben.


id: ldap_connect
type: function
doc:
<comment>Description:</comment>
  Verbindet mit einem LDAP-Server
  
  Seit PHP 8.3.0 ist die folgende Signatur veraltet.
  
  Erzeugt eine <class>LDAP\Connection</class>-Verbindung und prüft, ob der angegebene <strong>$uri</strong> plausibel ist.
  
  Es ist zu beachten, dass diese Funktion keine Verbindung öffnet. Sie prüft, ob die übergebenen
  Parameter plausibel sind, und kann verwendet werden, um eine Verbindung zu öffnen, sobald eine
  benötigt wird.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$uri</strong>   Ein vollständiger LDAP-URI der Form <return>ldap://hostname:port</return> oder
                      <return>ldaps://hostname:port</return> für SSL-Verschlüsselung.
                      
                      Es können auch mehrere LDAP-URIs, getrennt durch ein Leerzeichen, als eine
                      Zeichenkette angegeben werden.
                      
                      Es muss beachtet werden, dass <return>hostname:port</return> kein unterstützter LDAP-URI ist,
                      da das Schema fehlt.
  <info>string|null</info>  <strong>$host</strong>  Der Hostname, zu dem eine Verbindung aufgebaut werden soll.
  <info>int</info>          <strong>$port</strong>  Der Port, zu dem eine Verbindung aufgebaut werden soll.

<comment>Return:</comment>
  <info>LDAP\Connection|false</info>  Gibt eine <class>LDAP\Connection</class>-Instanz zurück, wenn der angegebene LDAP-URI
                         plausibel scheint. Es handelt sich um eine Syntaxprüfung der übergebenen
                         Parameter, aber Server werden nicht kontaktiert! Schlägt die Syntaxprüfung
                         fehl, wird <info>false</info> zurückgegeben. Andernfalls gibt <strong>ldap_connect()</strong> immer eine
                         gültige <class>LDAP\Connection</class>-Instanz mit positiver Verbindungskennung zurück.
                         Die Verbindung zum LDAP-Server wird noch nicht hergestellt, sie wird
                         lediglich initialisiert. Der Verbindungsaufbau erfolgt bei der nächsten
                         Nutzung einer ldap_*-Funktion; normalerweise ist dies <strong>ldap_bind()</strong>.
                         
                         Wird kein Argumente angegeben, wird die <class>LDAP\Connection</class>-Instanz einer
                         bereits geöffneten Verbindung zurückgegeben.

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


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

<comment>Param:</comment>
  <info>string|null</info>  <strong>$uri</strong>        
  <info>string</info>       <strong>$wallet</strong>     
  <info>string</info>       <strong>$password</strong>   
  <info>int</info>          <strong>$auth_mode</strong>  

<comment>Return:</comment>
  <info>LDAP\Connection|false</info>  

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


id: ldap_control_paged_result
type: function
doc:
<comment>Description:</comment>
  Send LDAP pagination control
  
  Enable LDAP pagination by sending the pagination control (page size, cookie...).

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>        An LDAP resource, returned by <strong>ldap_connect()</strong>.
  <info>int</info>       <strong>$pagesize</strong>    The number of entries by page.
  <info>bool</info>      <strong>$iscritical</strong>  Indicates whether the pagination is critical or not.  If true and if the
                         server doesn't support pagination, the search will return no result.
  <info>string</info>    <strong>$cookie</strong>      An opaque structure sent by the server
                         (<strong>ldap_control_paged_result_response()</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>ldap_control_paged_result_response()</strong>
   * RFC2696 : LDAP Control Extension for Simple
    Paged Results Manipulation


id: ldap_control_paged_result_response
type: function
doc:
<comment>Description:</comment>
  Retrieve the LDAP pagination cookie
  
  Retrieve the pagination information send by the server.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>       An LDAP resource, returned by <strong>ldap_connect()</strong>.
  <info>resource</info>  <strong>$result</strong>     
  <info>string</info>    <strong>$cookie</strong>     An opaque structure sent by the server.
  <info>int</info>       <strong>$estimated</strong>  The estimated number of entries to retrieve.

<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>ldap_control_paged_result()</strong>
   * RFC2696 : LDAP Control Extension for Simple
    Paged Results Manipulation


id: ldap_count_entries
type: function
doc:
<comment>Description:</comment>
  Liefert bei einer Suche die Anzahl der Einträge
  
  Gibt die Anzahl der Einträge zurück, die im Ergebnis der vorherigen Suchoperation gespeichert
  sind.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>    Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben
                            wurde.
  <info>LDAP\Result</info>      <strong>$result</strong>  Eine <class>LDAP\Connection</class>Instanz, die von <strong>ldap_list()</strong> oder <strong>ldap_search()</strong>
                            zurückgegeben wurde.

<comment>Return:</comment>
  <info>int</info>  Gibt die Anzahl der Einträge im Ergebnis zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: ldap_count_references
type: function
doc:
<comment>Description:</comment>
  Counts the number of references in a search result
  
  Counts the number of references in a search result.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>    Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben
                            wurde.
  <info>LDAP\Result</info>      <strong>$result</strong>  Eine <class>LDAP\Connection</class>Instanz, die von <strong>ldap_list()</strong> oder <strong>ldap_search()</strong>
                            zurückgegeben wurde.

<comment>Return:</comment>
  <info>int</info>  Returns the number of references in a search result.

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


id: ldap_delete
type: function
doc:
<comment>Description:</comment>
  Löscht einen Eintrag aus einem Verzeichnis
  
  Löscht einen bestimmten Eintrag aus einem LDAP-Verzeichnis.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>      Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben
                              wurde.
  <info>string</info>           <strong>$dn</strong>        Der Distinguished Name eines LDAP-Datenobjekts.
  <info>array|null</info>       <strong>$controls</strong>  Ein Array von LDAP-Steuerbefehlen, die mit der Anfrage versendet
                              werden sollen.

<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>ldap_delete_ext()</strong>
   * <strong>ldap_add()</strong>


id: ldap_delete_ext
type: function
doc:
<comment>Description:</comment>
  Delete an entry from a directory
  
  Does the same thing as <strong>ldap_delete()</strong> but returns an <class>LDAP\Result</class> instance to be parsed with
  <strong>ldap_parse_result()</strong>.

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

<comment>See Also:</comment>
   * <strong>ldap_delete()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_dn2ufn
type: function
doc:
<comment>Description:</comment>
  Konvertiert einen DN in ein benutzerfreundliches Namensformat
  
  Wandelt den angegebenen <strong>$dn</strong> in ein benutzerfreundlicheres Format, in dem die Typnamen entfernt
  wurden.

<comment>Param:</comment>
  <info>string</info>  <strong>$dn</strong>  Der Distinguished Name eines LDAP-Datenobjekts.

<comment>Return:</comment>
  <info>string|false</info>  Gibt den benutzerfreundlichen Namen zurück. Bei einem Fehler wird <info>false</info>
                zurückgegeben.


id: ldap_err2str
type: function
doc:
<comment>Description:</comment>
  Konvertiert eine LDAP-Fehlernummer in einen Fehlertext
  
  Gibt den Fehlertext zurück, der die Fehlernummer <strong>$errno</strong> erklärt. Während LDAP-Fehlernummern
  standardisiert sind, liefern unterschiedliche Bibliotheken unterschiedliche oder sogar
  lokalisierte Fehlermeldungen. Deshalb sollte nie auf eine spezielle Fehlermeldung geprüft, sondern
  immer eine Fehlernummer verwendet werden.

<comment>Param:</comment>
  <info>int</info>  <strong>$errno</strong>  Die Fehlernummer.

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

<comment>See Also:</comment>
   * <strong>ldap_errno()</strong>
   * <strong>ldap_error()</strong>


id: ldap_errno
type: function
doc:
<comment>Description:</comment>
  Liefert die LDAP-Fehlernummer des letzten LDAP-Kommandos
  
  Gibt die standardisierte Fehlernummer des zuletzt ausgeführten LDAP-Kommandos zurück. Diese Nummer
  kann mit der Funktion <strong>ldap_err2str()</strong> in einen Fehlertext konvertiert werden.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>  Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben wurde.

<comment>Return:</comment>
  <info>int</info>  Gibt die LDAP-Fehlernummer des letzten LDAP-Kommandos für diese Verbindung zurück.

<comment>See Also:</comment>
   * <strong>ldap_err2str()</strong>
   * <strong>ldap_error()</strong>


id: ldap_error
type: function
doc:
<comment>Description:</comment>
  Liefert die LDAP-Fehlermeldung des letzten LDAP-Kommandos
  
  Gibt den erklärenden Fehlertext für den Fehler zurück, der vom zuletzt ausgeführten LDAP-Kommando
  mit der angegebenen Verbindungskennung <strong>$ldap</strong> erzeugt wurde. Während LDAP-Fehlernummern
  standardisiert sind, liefern unterschiedliche Bibliotheken unterschiedliche oder sogar
  lokalisierte Fehlermeldungen. Deshalb sollte nie auf eine spezielle Fehlermeldung geprüft, sondern
  immer eine Fehlernummer verwendet werden.
  
  Solange Sie die Stufe der Fehlerwarnungen in Ihrer php.ini nicht herabsetzen oder vor Ihre
  LDAP-Kommandos ein <return>@</return> (at) setzen, um die Ausgabe von Fehlermeldungen zu unterdrücken, werden die
  aufgetretenen Fehler auch in Ihrer HTML-Ausgabe zu sehen sein.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>  Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben wurde.

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

<comment>See Also:</comment>
   * <strong>ldap_err2str()</strong>
   * <strong>ldap_errno()</strong>


id: ldap_escape
type: function
doc:
<comment>Description:</comment>
  Escape a string for use in an LDAP filter or DN
  
  Escapes <strong>$value</strong> for use in the context implied by <strong>$flags</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>   The value to escape.
  <info>string</info>  <strong>$ignore</strong>  Characters to ignore when escaping.
  <info>int</info>     <strong>$flags</strong>   The context the escaped string will be used in: <info>LDAP_ESCAPE_FILTER</info> for filters to
                   be used with <strong>ldap_search()</strong>, or <info>LDAP_ESCAPE_DN</info> for DNs. If neither flag is passed,
                   all chars are escaped.

<comment>Return:</comment>
  <info>string</info>  Returns the escaped string.


id: ldap_exop
type: function
doc:
<comment>Description:</comment>
  Performs an extended operation
  
  Performs an extended operation on the specified <strong>$ldap</strong> with <strong>$request_oid</strong> the OID of the operation
  and <strong>$request_data</strong> the data.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>           Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong>
                                   zurückgegeben wurde.
  <info>string</info>           <strong>$request_oid</strong>    The extended operation request OID. You may use one of
                                   <info>LDAP_EXOP_START_TLS</info>, <info>LDAP_EXOP_MODIFY_PASSWD</info>, <info>LDAP_EXOP_REFRESH</info>,
                                   <info>LDAP_EXOP_WHO_AM_I</info>, <info>LDAP_EXOP_TURN</info>, or a string with the OID of
                                   the operation you want to send.
  <info>string</info>           <strong>$request_data</strong>   The extended operation request data. May be NULL for some
                                   operations like <info>LDAP_EXOP_WHO_AM_I</info>, may also need to be BER
                                   encoded.
  <info>array</info>            <strong>$controls</strong>       Array of LDAP Controls to send with the request.
  <info>string</info>           <strong>$response_data</strong>  Will be filled with the extended operation response data if
                                   provided. If not provided you may use ldap_parse_exop on the
                                   result object later to get this data.
  <info>string</info>           <strong>$response_oid</strong>   Will be filled with the response OID if provided, usually equal
                                   to the request OID.

<comment>Return:</comment>
  <info>mixed</info>  When used with <strong>$response_data</strong>, returns <info>true</info> on success or <info>false</info> on error. When used without
         <strong>$response_data</strong>, returns a result identifier or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>ldap_parse_result()</strong>
   * <strong>ldap_parse_exop()</strong>
   * <strong>ldap_exop_whoami()</strong>
   * <strong>ldap_exop_refresh()</strong>
   * <strong>ldap_exop_passwd()</strong>


id: ldap_exop_passwd
type: function
doc:
<comment>Description:</comment>
  PASSWD extended operation helper
  
  Performs a PASSWD extended operation.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>          Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben
                                  wurde.
  <info>string</info>           <strong>$user</strong>          dn of the user to change the password of.
  <info>string</info>           <strong>$old_password</strong>  The old password of this user. May be ommited depending of server
                                  configuration.
  <info>string</info>           <strong>$new_password</strong>  The new password for this user. May be omitted or empty to have a
                                  generated password.
  <info>array</info>            <strong>$controls</strong>      If provided, a password policy request control is send with the
                                  request and this is filled with an array of LDAP Controls returned
                                  with the request.

<comment>Return:</comment>
  <info>string|bool</info>  Returns the generated password if <strong>$new_password</strong> is empty or omitted. Otherwise
               returns <info>true</info> on success and <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>ldap_exop()</strong>
   * <strong>ldap_parse_exop()</strong>


id: ldap_exop_refresh
type: function
doc:
<comment>Description:</comment>
  Refresh extended operation helper
  
  Performs a Refresh extended operation and returns the data.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>  Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben wurde.
  <info>string</info>           <strong>$dn</strong>    dn of the entry to refresh.
  <info>int</info>              <strong>$ttl</strong>   Time in seconds (between 1 and 31557600) that the client requests that the
                          entry exists in the directory before being automatically removed.

<comment>Return:</comment>
  <info>int|false</info>  From RFC: The responseTtl field is the time in seconds which the server chooses to have
             as the time-to-live field for that entry.  It must not be any smaller than that which
             the client requested, and it may be larger. However, to allow servers to maintain a
             relatively accurate directory, and to prevent clients from abusing the dynamic
             extensions, servers are permitted to shorten a client-requested time-to-live value,
             down to a minimum of 86400 seconds (one day).
              <info>false</info> will be returned on error.

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


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

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>           Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong>
                                   zurückgegeben wurde.
  <info>string</info>           <strong>$request_oid</strong>    
  <info>string</info>           <strong>$request_data</strong>   
  <info>array</info>            <strong>$controls</strong>       
  <info>string</info>           <strong>$response_data</strong>  
  <info>string</info>           <strong>$response_oid</strong>   

<comment>Return:</comment>
  <info>LDAP\Result|bool</info>  

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


id: ldap_exop_whoami
type: function
doc:
<comment>Description:</comment>
  WHOAMI extended operation helper
  
  Performs a WHOAMI extended operation and returns the data.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>  Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben wurde.

<comment>Return:</comment>
  <info>string|false</info>  The data returned by the server, or <info>false</info> on error.

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


id: ldap_explode_dn
type: function
doc:
<comment>Description:</comment>
  Trennt einen DN in seine Bestandteile
  
  Teilt einen von <strong>ldap_get_dn()</strong> gelieferten DN auf und zerlegt ihn in seine Bestandteile. Jeder Teil
  wird als Relative Distinguished Name, RDN, bezeichnet.

<comment>Param:</comment>
  <info>string</info>  <strong>$dn</strong>           Der Distinguished Name eines LDAP-Datenobjekts.
  <info>int</info>     <strong>$with_attrib</strong>  Wird verwendet, um zu bestimmen, ob die RDNs nur mit Werten oder zusätzlich
                        mit ihren Merkmalen angefragt werden. Um RDNs mit Merkmalen (d.h. im Format
                        Merkmal=Wert) zu erhalten, ist <strong>$with_attrib</strong> auf 0 zu setzen, um nur Werte zu
                        erhalten, auf 1.

<comment>Return:</comment>
  <info>array|false</info>  Gibt ein Array aller DN-Bestandteile zurück, Bei einem Fehler wird <info>false</info>
               zurückgegeben. Das erste Element im Array hat einen <return>count</return>-Schlüssel, und stellt die
               Anzahl der zurückgegebenen Werte dar; die folgenden Elemente sind numerisch
               indexierte DN-Bestandteile.


id: ldap_first_attribute
type: function
doc:
<comment>Description:</comment>
  Liefert das erste Merkmal
  
  Liefert das erste Merkmal im angegebenen Eintrag. Verbleibende Merkmale werden durch wiederholte
  Aufrufe von <strong>ldap_next_attribute()</strong> abgerufen.
  
  Analog zum Lesen von Einträgen werden Merkmale ebenfalls eines nach dem anderen aus einem
  bestimmten Eintrag gelesen.

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>   Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben
                            wurde.
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>  Eine <class>LDAP\ResultEntry</class>-Instanz

<comment>Return:</comment>
  <info>string|false</info>  Gibt im Erfolgsfall das erste Merkmal im Eintrag zurück und <info>false</info> im Fehlerfall.

<comment>See Also:</comment>
   * <strong>ldap_next_attribute()</strong>
   * <strong>ldap_get_attributes()</strong>


id: ldap_first_entry
type: function
doc:
<comment>Description:</comment>
  Liefert die Kennung des ersten Ergebnisses
  
  Gibt die Eintragskennung des ersten Eintrags im Ergbnis zurück. Diese Eintragskennung wird dann an
  die Funktion <strong>ldap_next_entry()</strong> übergeben, um die folgenden Einträge des Ergebnisses zu erhalten.
  
  Einträge eines LDAP-Ergebnisses werden unter Verwendung der Funktionen <strong>ldap_first_entry()</strong> und
  <strong>ldap_next_entry()</strong> sequentiell gelesen.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>    Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben
                            wurde.
  <info>LDAP\Result</info>      <strong>$result</strong>  Eine <class>LDAP\Connection</class>Instanz, die von <strong>ldap_list()</strong> oder <strong>ldap_search()</strong>
                            zurückgegeben wurde.

<comment>Return:</comment>
  <info>LDAP\ResultEntry|false</info>  Gibt im Erfolgsfall eine <class>LDAP\ResultEntry</class>-Instanz zurück. Bei einem Fehler
                          wird <info>false</info> zurückgegeben.

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


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

<comment>Return:</comment>
  <info>LDAP\ResultEntry|false</info>  


id: ldap_free_result
type: function
doc:
<comment>Description:</comment>
  Gibt den Ergebnisspeicher frei
  
  Gibt den intern für die Speicherung des Ergebnisses zugewiesenen Speicher frei. Der gesamte
  Ergebnisspeicher wird automatisch bei Beendigung des Skripts freigegeben.
  
  Typischerweise wird nach Beendigung des Skripts der gesamte Ergebnisspeicher automatisch
  freigegeben. Falls das Skript sukzessive Suchoperationen durchführt, die große Ergebnismengen
  liefern, kann <strong>ldap_free_result()</strong> aufgerufen werden, um den Speicherverbrauch zur Laufzeit niedrig
  zu halten.

<comment>Param:</comment>
  <info>LDAP\Result</info>  <strong>$result</strong>  Eine <class>LDAP\Connection</class>Instanz, die von <strong>ldap_list()</strong> oder <strong>ldap_search()</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.


id: ldap_get_attributes
type: function
doc:
<comment>Description:</comment>
  Liefert die Merkmale eines Eintrags aus einem Suchergebnis
  
  Liest Merkmale und Werte eines Eintrags im Suchergebnis.
  
  Nachdem ein bestimmter Eintrag in dem Verzeichnis lokalisiert wurde, kann mit dieser Funktion
  herausgefunden werden, welche Informationen für diesen Eintrag verfügbar sind. Diese Funktion
  würde in einer Anwendung verwendet werden, die Verzeichniseinträge "durchstöbert" und/oder wo die
  Struktur der Verzeichniseinträge nicht bekannt ist. In vielen Anwendungen wird nach einem
  bestimmten Merkmal gesucht, z. B. einer E-Mail-Adresse oder einem Nachnamen, und welche anderen
  Daten verfügbar sind, interessiert nicht.

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>   Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben
                            wurde.
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>  Eine <class>LDAP\ResultEntry</class>-Instanz

<comment>Return:</comment>
  <info>array</info>  Gibt im Erfolgfall die vollständige Eintragsinformation in einem mehrdimensionalen Array
         zurück.

<comment>See Also:</comment>
   * <strong>ldap_first_attribute()</strong>
   * <strong>ldap_next_attribute()</strong>


id: ldap_get_dn
type: function
doc:
<comment>Description:</comment>
  Liefert den DN eines Eintrags aus einem Suchergebnis
  
  Ermittelt den DN eines Eintrags aus einem Suchergebnis.

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>   Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben
                            wurde.
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>  Eine <class>LDAP\ResultEntry</class>-Instanz

<comment>Return:</comment>
  <info>string|false</info>  Gibt den DN eines Ergebniseintrags zurück und <info>false</info> im Fehlerfall.


id: ldap_get_entries
type: function
doc:
<comment>Description:</comment>
  Liefert alle Einträge aus einem Ergebnis
  
  Liest mehrere Einträge aus dem angegebenen Ergebnis und dann die Merkmale und mehreren Werte.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>    Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben
                            wurde.
  <info>LDAP\Result</info>      <strong>$result</strong>  Eine <class>LDAP\Connection</class>Instanz, die von <strong>ldap_list()</strong> oder <strong>ldap_search()</strong>
                            zurückgegeben wurde.

<comment>Return:</comment>
  <info>array|false</info>  Gibt im Erfolgsfall die gesamten Informationen aus einem Ergebnis in einem
               mehrdimensionalen Array zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.
               
               Die Struktur dieses Arrays sieht wie folgt aus: Der Merkmal-Index wird in
               Kleinbuchstaben umgewandelt (Verzeichnis-Server unterscheiden nicht zwischen Groß-
               und Kleinschreibung hinsichtlich der Merkmake, aber der Unterschied ist wichtig, wenn
               diese Merkmale als Array-Indizes verwendet werden).

<comment>See Also:</comment>
   * <strong>ldap_first_entry()</strong>
   * <strong>ldap_next_entry()</strong>


id: ldap_get_option
type: function
doc:
<comment>Description:</comment>
  Liefert den aktuellen Wert einer gegebenen Option
  
  Setzt <strong>$value</strong> auf den Wert der angegebenen Option.

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>    Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben
                             wurde.
  <info>int</info>               <strong>$option</strong>  Der Parameter <strong>$option</strong> ist einer der folgenden:
                             OptionTypseit<info>LDAP_OPT_DEREF</info><info>int</info><info>LDAP_OPT_SIZELIMIT</info><info>int</info><info>LDAP_OPT_TIMELIMIT</info><info>int</info><info>LDAP_OPT_NETWORK_TIMEOUT</info><info>int</info><info>LDAP_OPT_PROTOCOL_VERSION</info><info>int</info><info>LDAP_OPT_ERROR_NUMBER</info><info>int</info><info>LDAP_OPT_DIAGNOSTIC_MESSAGE</info><info>string</info><info>LDAP_OPT_REFERRALS</info><info>int</info><info>LDAP_OPT_RESTART</info><info>int</info><info>LDAP_OPT_HOST_NAME</info><info>string</info><info>LDAP_OPT_ERROR_STRING</info><info>string</info><info>LDAP_OPT_MATCHED_DN</info><info>string</info><info>LDAP_OPT_SERVER_CONTROLS</info><info>array</info><info>LDAP_OPT_CLIENT_CONTROLS</info><info>array</info><info>LDAP_OPT_X_KEEPALIVE_IDLE</info><info>int</info>7.1<info>LDAP_OPT_X_KEEPALIVE_PROBES</info><info>int</info>7.1<info>LDAP_OPT_X_KEEPALIVE_INTERVAL</info><info>int</info>7.1<info>LDAP_OPT_X_TLS_CACERTDIR</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_CACERTFILE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_CERTFILE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_CIPHER_SUITE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_CRLCHECK</info><info>int</info>7.1<info>LDAP_OPT_X_TLS_CRL_NONE</info><info>int</info>7.1<info>LDAP_OPT_X_TLS_CRL_PEER</info><info>int</info>7.1<info>LDAP_OPT_X_TLS_CRL_ALL</info><info>int</info>7.1<info>LDAP_OPT_X_TLS_CRLFILE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_DHFILE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_KEYFILE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_PACKAGE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_PROTOCOL_MIN</info><info>int</info>7.1<info>LDAP_OPT_X_TLS_RANDOM_FILE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_REQUIRE_CERT</info><info>int</info>
  <info>array|string|int</info>  <strong>$value</strong>   Dies wird auf den Wert der Option gesetzt.

<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>ldap_set_option()</strong>


id: ldap_get_values
type: function
doc:
<comment>Description:</comment>
  Liefert alle Werte eines Eintrags aus einem Ergebnis
  
  Liest alle Werte eines Merkmals im Ergebniseintrag.
  
  Da diese Funktion eine Ergebniseintragskennung (<strong>$entry</strong>) benötigt, muss ein Aufruf einer der
  LDAP-Suchfunktionen und einer der Funktionen, die einen einzelnen Eintrag liefern, vorausgehen.
  
  Die Anwendung ist entweder hart kodiert, um bestimmte Merkmale (z. B. "Nachname" oder "E-Mail") zu
  suchen, oder die Funktion <strong>ldap_get_attributes()</strong> muss verwendet werden, um herauszufinden, welche
  Merkmale für einen gegebenen Eintrag vorhanden sind.

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>       Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben
                                wurde.
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>      Eine <class>LDAP\ResultEntry</class>-Instanz
  <info>string</info>            <strong>$attribute</strong>  

<comment>Return:</comment>
  <info>array|false</info>  Gibt im Erfolgsfall ein Array mit den Werten des Merkmals zurück und <info>false</info> im
               Fehlerfall. Die Anzahl der zurückgegebenen Werte steht im Index "count" des
               zurückgegebenen Arrays zur Verfügung. Der Zugriff auf einzelne Werte erfolgt durch
               einen numerischen Index im Array. Der erste Indexwert ist 0.
               
               LDAP erlaubt mehr als einen Eintrag für ein Merkmal, so dass es z. B. sein kann, dass
               der Verzeichnis-Eintrag einer Person mehrere E-Mail-Adressen enthält, die alle mit
               dem Merkmal "mail" bezeichnet sind.  return_value["count"] = Anzahl der Werte eines
               Merkmals return_value[0]       = der erste Wert des Merkmals return_value[i]       =
               der i-te Wert des Merkmals

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


id: ldap_get_values_len
type: function
doc:
<comment>Description:</comment>
  Liefert alle binären Werte eines Eintrags aus einem Ergebnis
  
  Liest alle Werte eines Merkmals im Ergebniseintrag.
  
  Diese Funktion wird exakt gleich verwendet wie die Funktion <strong>ldap_get_values()</strong>, mit der Ausnahme,
  dass hier binäre Daten statt Textdaten behandelt werden.

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>       Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben
                                wurde.
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>      Eine <class>LDAP\ResultEntry</class>-Instanz
  <info>string</info>            <strong>$attribute</strong>  

<comment>Return:</comment>
  <info>array|false</info>  Gibt im Erfolgsfall ein Array mit den Werten des Merkmals zurück und <info>false</info> im
               Fehlerfall. Auf einzelne Werte kann über die numerischen Indizes des Arrays
               zugegriffen werden. Der erste Indexwert ist 0. Die Anzahl der zurückgegebenen Werte
               steht im Index "count" des zurückgegebenen Arrays zur Verfügung.

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


id: ldap_list
type: function
doc:
<comment>Description:</comment>
  Suche in einer Ebene
  
  Führt eine Suche für einen angegeben <strong>$filter</strong> im Verzeichnis mit dem Geltungsbereich
  <info>LDAP_SCOPE_ONELEVEL</info> durch.
  
  <info>LDAP_SCOPE_ONELEVEL</info> bedeutet, dass die Suche nur Informationen liefert, die direkt innerhalb der
  Ebene liegen, die durch die Angabe des Parameters <strong>$base</strong> im Aufruf bestimmt wird. Das entspricht
  der Eingabe von "ls", die eine Liste von Dateien und Verzeichnissen des aktuellen
  Arbeitsverzeichnisses anzeigt.
  
  Es ist auch möglich, parallele Suchen durchzuführen. In diesem Fall muss der erste Parameter ein
  Array von
  <class>LDAP\Connection</class>-Instanzen sein, anstatt einer einzelnen.
  Wenn die Suchen nicht alle den gleichen Basis-DN und Filter verwenden sollen, kann stattdessen ein
  Array von Basis-DNs und/oder ein Array von Filtern als Parameter übergeben werden.
  Diese Arrays müssen die gleiche Größe haben wie das Array von <class>LDAP\Connection</class>-Instanzen,
  da die ersten Einträge der Arrays für eine Suche verwendet werden, die zweiten Einträge für eine
  andere und so weiter.
  Bei parallelen Suchen wird ein Array von <class>LDAP\Result</class>-Instanzen zurückgegeben, außer im Fall eines
  Fehlers, dann ist der Rückgabewert <info>false</info>.

<comment>Param:</comment>
  <info>LDAP\Connection|array</info>  <strong>$ldap</strong>             Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong>
                                           zurückgegeben wurde.
  <info>array|string</info>           <strong>$base</strong>             Der Basis-DN für das Verzeichnis.
  <info>array|string</info>           <strong>$filter</strong>           
  <info>array</info>                  <strong>$attributes</strong>       Ein Array von erforderlichen Merkmalen, z. B.
                                           array("mail", "sn", "cn"). Es ist zu beachten, dass der
                                           "dn" immer zurückgegeben wird, unabhängig davon, welche
                                           Merkmalstypen angefordert wurden.
                                           
                                           Die Verwendung dieses Parameters ist effizienter als die
                                           Standardaktion (die alle Merkmale und deren assoziierte
                                           Werte zurückgibt). Die Verwendung dieses Parameters
                                           sollte daher als gute Praxis eingestuft werden.
  <info>int</info>                    <strong>$attributes_only</strong>  Sollte auf 1 gesetzt werden, wenn nur Merkmalstypen
                                           erwünscht sind. Wird 0 übergeben, werden sowohl
                                           Merkmalstypen als auch Merkmalswerte abgerufen, was das
                                           Standardverhalten ist.
  <info>int</info>                    <strong>$sizelimit</strong>        Ermöglicht die Begrenzung der Anzahl der abgerufenen
                                           Einträge. Wird hier 0 übergeben, besteht keine
                                           Begrenzung.
                                           
                                           Dieser Parameter kann ein serverseitig voreingestelltes
                                           sizelimit NICHT überschreiben. Es kann allerdings kleiner
                                           gewählt werden.
                                           
                                           Verzeichnis-Server können so konfiguriert werden, dass
                                           sie nicht mehr als eine voreingestellte Anzahl von
                                           Einträgen zurückgeben. Wenn dies der Fall ist, dann zeigt
                                           der Server an, dass nur eine teilweise Ergebnismenge
                                           zurückgegeben wurde. Das geschieht ebenfalls, wenn dieser
                                           Parameter verwendet wird, um die Zahl der abgerufenen
                                           Einträge zu begrenzen.
  <info>int</info>                    <strong>$timelimit</strong>        Setzt die Anzahl von Sekunden, die auf die Suche
                                           verwendet wird. Die Übergabe von 0 bedeutet keine
                                           Begrenzung.
                                           
                                           Dieser Parameter kann ein serverseitig voreingestelltes
                                           timelimit NICHT überschreiben. Es kann allerdings kleiner
                                           gewählt werden.
  <info>int</info>                    <strong>$deref</strong>            Gibt an, wie Aliase während der Suche behandelt werden
                                           sollen. Es kann einen der folgenden Werte annehmen:
                                           <info>LDAP_DEREF_NEVER</info> - (standard) Aliase werden nie
                                           dereferenziert. <info>LDAP_DEREF_SEARCHING</info> - Aliase sollen
                                           während der Suche dereferenziert werden, aber nicht wenn
                                           das Basis-Objekt der Suche lokalisiert wird.
                                           <info>LDAP_DEREF_FINDING</info> - Aliase sollen für die Lokalisierung
                                           des Basis-Objekts dereferenziert werden, aber nicht
                                           während der Suche. <info>LDAP_DEREF_ALWAYS</info> - Aliase sollen
                                           immer dereferenziert werden.
                                           
                                           <info>LDAP_DEREF_NEVER</info> - (standard) Aliase werden nie
                                           dereferenziert.
                                           
                                           <info>LDAP_DEREF_SEARCHING</info> - Aliase sollen während der Suche
                                           dereferenziert werden, aber nicht wenn das Basis-Objekt
                                           der Suche lokalisiert wird.
                                           
                                           <info>LDAP_DEREF_FINDING</info> - Aliase sollen für die Lokalisierung
                                           des Basis-Objekts dereferenziert werden, aber nicht
                                           während der Suche.
                                           
                                           <info>LDAP_DEREF_ALWAYS</info> - Aliase sollen immer dereferenziert
                                           werden.
  <info>array|null</info>             <strong>$controls</strong>         Ein Array von LDAP-Steuerbefehlen, die mit der Anfrage
                                           versendet werden sollen.

<comment>Return:</comment>
  <info>LDAP\Result|array|false</info>  Gibt eine <class>LDAP\Result</class>-Instanz oder ein Array von <class>LDAP\Result</class>-Instanzen
                           zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

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


id: ldap_mod_add
type: function
doc:
<comment>Description:</comment>
  Fügt Merkmalswerte zum aktuellen Eintrag hinzu
  
  Fügt ein oder mehrere Merkmalswerte zum angegebenen <strong>$dn</strong> hinzu. Um ein ganz neues Objekt
  hinzuzufügen, ist <strong>ldap_add()</strong> zu verwenden.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>      Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben
                              wurde.
  <info>string</info>           <strong>$dn</strong>        Der Distinguished Name eines LDAP-Datenobjekts.
  <info>array</info>            <strong>$entry</strong>     Ein assoziatives Array, das die Merkmalswerte aufführt, die
                              hinzugefügt werden sollen. Existiert ein Merkmal noch nicht, wird es
                              hinzugefügt. Existiert ein Merkmal bereits, können nur dann Werte
                              hinzugefügt werden, wenn es mehrere Werte unterstützt.
  <info>array|null</info>       <strong>$controls</strong>  Ein Array von LDAP-Steuerbefehlen, die mit der Anfrage versendet
                              werden sollen.

<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>ldap_mod_add_ext()</strong>
   * <strong>ldap_mod_del()</strong>
   * <strong>ldap_mod_replace()</strong>
   * <strong>ldap_modify_batch()</strong>


id: ldap_mod_add_ext
type: function
doc:
<comment>Description:</comment>
  Add attribute values to current attributes
  
  Does the same thing as <strong>ldap_mod_add()</strong> but returns an <class>LDAP\Result</class> instance to be parsed with
  <strong>ldap_parse_result()</strong>.

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

<comment>See Also:</comment>
   * <strong>ldap_mod_add()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_mod_del
type: function
doc:
<comment>Description:</comment>
  Löscht Merkmalswerte des aktuellen Eintrags
  
  Entfernt ein oder mehrere Merkmalswerte vom angegebenen <strong>$dn</strong>. Das Löschen von Objekten erfolgt mit
  der Funktion <strong>ldap_delete()</strong>.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>      Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben
                              wurde.
  <info>string</info>           <strong>$dn</strong>        Der Distinguished Name eines LDAP-Datenobjekts.
  <info>array</info>            <strong>$entry</strong>     
  <info>array|null</info>       <strong>$controls</strong>  Ein Array von LDAP-Steuerbefehlen, die mit der Anfrage versendet
                              werden sollen.

<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>ldap_mod_del_ext()</strong>
   * <strong>ldap_mod_add()</strong>
   * <strong>ldap_mod_replace()</strong>
   * <strong>ldap_modify_batch()</strong>


id: ldap_mod_del_ext
type: function
doc:
<comment>Description:</comment>
  Delete attribute values from current attributes
  
  Does the same thing as <strong>ldap_mod_del()</strong> but returns an <class>LDAP\Result</class> instance to be parsed with
  <strong>ldap_parse_result()</strong>.

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

<comment>See Also:</comment>
   * <strong>ldap_mod_del()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_mod_replace
type: function
doc:
<comment>Description:</comment>
  Ersetzt Merkmalswerte durch neue Merkmalswerte
  
  Ersetzt ein oder mehrere Merkmale des angegeben <strong>$dn</strong>. Es können auch Merkmale hinzugefügt oder
  gelöscht werden.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>      Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben
                              wurde.
  <info>string</info>           <strong>$dn</strong>        Der Distinguished Name eines LDAP-Datenobjekts.
  <info>array</info>            <strong>$entry</strong>     Ein assoziatives Array, das die zu ersetzenden Merkmale aufführt. Die
                              Übergabe eines leeren Arrays als Wert entfernt das Merkmal, während
                              das Übergeben eines noch nicht existierenden Merkmals dieses
                              hinzufügt.
  <info>array|null</info>       <strong>$controls</strong>  Ein Array von LDAP-Steuerbefehlen, die mit der Anfrage versendet
                              werden sollen.

<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>ldap_mod_replace_ext()</strong>
   * <strong>ldap_mod_del()</strong>
   * <strong>ldap_mod_add()</strong>
   * <strong>ldap_modify_batch()</strong>


id: ldap_mod_replace_ext
type: function
doc:
<comment>Description:</comment>
  Replace attribute values with new ones
  
  Does the same thing as <strong>ldap_mod_replace()</strong> but returns an <class>LDAP\Result</class> instance to be parsed with
  <strong>ldap_parse_result()</strong>.

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

<comment>See Also:</comment>
   * <strong>ldap_mod_replace()</strong>
   * <strong>ldap_parse_result()</strong>


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

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


id: ldap_modify_batch
type: function
doc:
<comment>Description:</comment>
  Batch and execute modifications on an LDAP entry
  
  Modifies an existing entry in the LDAP directory. Allows detailed specification of the
  modifications to perform.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>                An LDAP resource, returned by <strong>ldap_connect()</strong>.
  <info>string</info>           <strong>$dn</strong>                  The distinguished name of an LDAP entity.
  <info>array</info>            <strong>$modifications_info</strong>  An array that specifies the modifications to make. Each
                                        entry in this array is an associative array with two or
                                        three keys: <return>attrib</return> maps to the name of the attribute to
                                        modify, <return>modtype</return> maps to the type of modification to perform,
                                        and (depending on the type of modification) <return>values</return> maps to
                                        an array of attribute values relevant to the modification.
                                        
                                        Possible values for <return>modtype</return> include: <info>LDAP_MODIFY_BATCH_ADD</info>
                                        Each value specified through <return>values</return> is added (as an
                                        additional value) to the attribute named by <return>attrib</return>.
                                        <info>LDAP_MODIFY_BATCH_REMOVE</info> Each value specified through <return>values</return>
                                        is removed from the attribute named by <return>attrib</return>. Any value of
                                        the attribute not contained in the <return>values</return> array will remain
                                        untouched. <info>LDAP_MODIFY_BATCH_REMOVE_ALL</info> All values are
                                        removed from the attribute named by <return>attrib</return>. A <return>values</return> entry
                                        must not be provided. <info>LDAP_MODIFY_BATCH_REPLACE</info> All current
                                        values of the attribute named by <return>attrib</return> are replaced with
                                        the values specified through <return>values</return>.
                                        
                                        Each value specified through <return>values</return> is added (as an
                                        additional value) to the attribute named by <return>attrib</return>.
                                        
                                        Each value specified through <return>values</return> is removed from the
                                        attribute named by <return>attrib</return>. Any value of the attribute not
                                        contained in the <return>values</return> array will remain untouched.
                                        
                                        All values are removed from the attribute named by <return>attrib</return>. A
                                        <return>values</return> entry must not be provided.
                                        
                                        All current values of the attribute named by <return>attrib</return> are
                                        replaced with the values specified through <return>values</return>.
                                        
                                        Note that any value for <return>attrib</return> must be a string, any value
                                        for <return>values</return> must be an array of strings, and any value for
                                        <return>modtype</return> must be one of the LDAP_MODIFY_BATCH_* constants
                                        listed above.
  <info>array|null</info>       <strong>$controls</strong>            Array of LDAP Controls to send with the request.

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


id: ldap_next_attribute
type: function
doc:
<comment>Description:</comment>
  Liefert das nächste Merkmal im Ergebnis
  
  Ermittelt die Merkmale eines Eintrags. Der erste Aufruf von <strong>ldap_next_attribute()</strong> wird mit dem
  Eintrag <strong>$entry</strong> durchgeführt, der von <strong>ldap_first_attribute()</strong> zurückgegeben wurde.

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>   Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben
                            wurde.
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>  Eine <class>LDAP\ResultEntry</class>-Instanz

<comment>Return:</comment>
  <info>string|false</info>  Gibt im Erfolgsfall das nächste Merkmal eines Eintrags zurück und <info>false</info> im
                Fehlerfall.

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


id: ldap_next_entry
type: function
doc:
<comment>Description:</comment>
  Liefert den nächsten Eintrag eines Ergebnisses
  
  Ermittle die Einträge, die im Ergebnis gespeichert sind. Wiederholtes Aufrufen von
  <strong>ldap_next_entry()</strong> liefert einen Eintrag nach dem anderen, solange bis kein Eintrag mehr vorliegt.
  Der erste Aufruf von <strong>ldap_next_entry()</strong> erfolgt nach dem Aufruf von <strong>ldap_first_entry()</strong> mit <strong>$entry</strong>,
  das von <strong>ldap_first_entry()</strong> zurückgegeben wurde.

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>   Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong> zurückgegeben
                            wurde.
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>  Eine <class>LDAP\ResultEntry</class>-Instanz

<comment>Return:</comment>
  <info>LDAP\ResultEntry|false</info>  Gibt eine <class>LDAP\ResultEntry</class>-Instanz für den nächsten Eintrag des
                          Ergebnisses zurück, dessen Einträge beginnend mit <strong>ldap_first_entry()</strong>
                          gelesen werden. Wenn keine weiteren Einträge im Ergebnis vorhanden sind,
                          wird <info>false</info> zurückgegeben.

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


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

<comment>Return:</comment>
  <info>LDAP\ResultEntry|false</info>  


id: ldap_parse_exop
type: function
doc:
<comment>Description:</comment>
  Parse result object from an LDAP extended operation
  
  Parse LDAP extended operation data from result object <strong>$result</strong>

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>           Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong>
                                   zurückgegeben wurde.
  <info>LDAP\Result</info>      <strong>$result</strong>         Eine <class>LDAP\Connection</class>Instanz, die von <strong>ldap_list()</strong> oder
                                   <strong>ldap_search()</strong> zurückgegeben wurde.
  <info>string</info>           <strong>$response_data</strong>  Will be filled by the response data.
  <info>string</info>           <strong>$response_oid</strong>   Will be filled by the response OID.

<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>ldap_exop()</strong>


id: ldap_parse_reference
type: function
doc:
<comment>Description:</comment>
  Extrahiert Informationen aus einem Referenz-Eintrag
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>bool</info>  


id: ldap_parse_result
type: function
doc:
<comment>Description:</comment>
  Extrahiert Informationen aus einem Ergebnis
  
  Parst ein LDAP-Suchergebnis.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>           Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong>
                                   zurückgegeben wurde.
  <info>LDAP\Result</info>      <strong>$result</strong>         Eine <class>LDAP\Connection</class>Instanz, die von <strong>ldap_list()</strong> oder
                                   <strong>ldap_search()</strong> zurückgegeben wurde.
  <info>int</info>              <strong>$error_code</strong>     Eine Referenz auf eine Variable, die auf den LDAP-Fehlercode des
                                   Ergebnisses gesetzt wird, oder <return>0</return>, wenn kein Fehler auftrat.
  <info>string</info>           <strong>$matched_dn</strong>     Eine Referenz auf eine Variable, die auf den übereinstimmenden DN
                                   gesetzt wird, wenn einer in der Anfrage erkannt wurde;
                                   andernfalls wird sie auf <info>null</info> gesetzt.
  <info>string</info>           <strong>$error_message</strong>  Eine Referenz auf eine Variable, die auf die LDAP-Fehlermeldung
                                   des Ergebnisses gesetzt wird, oder eine leere Zeichenkette, wenn
                                   kein Fehler auftrat.
  <info>array</info>            <strong>$referrals</strong>      Eine Referenz auf eine Variable, die auf ein Array gesetzt wird,
                                   das alle Verweiszeichenketten im Ergebnis enthält, oder ein
                                   leeres Array, wenn keine Verweise zurückgegeben wurden.
  <info>array</info>            <strong>$controls</strong>       Ein Array von LDAP-Steuerbefehlen, die mit der Antwort versendet
                                   wurden.

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


id: ldap_read
type: function
doc:
<comment>Description:</comment>
  Liest einen Eintrag
  
  Führt eine Suche nach dem angegeben <strong>$filter</strong> im Verzeichnis mit dem Geltungsbereich <info>LDAP_SCOPE_BASE</info>
  durch. Somit ist es gleichwertig zum Lesen eines Eintrags aus dem Verzeichnis.
  
  Es ist auch möglich, parallele Suchen durchzuführen. In diesem Fall muss der erste Parameter ein
  Array von
  <class>LDAP\Connection</class>-Instanzen sein, anstatt einer einzelnen.
  Wenn die Suchen nicht alle den gleichen Basis-DN und Filter verwenden sollen, kann stattdessen ein
  Array von Basis-DNs und/oder ein Array von Filtern als Parameter übergeben werden.
  Diese Arrays müssen die gleiche Größe haben wie das Array von <class>LDAP\Connection</class>-Instanzen,
  da die ersten Einträge der Arrays für eine Suche verwendet werden, die zweiten Einträge für eine
  andere und so weiter.
  Bei parallelen Suchen wird ein Array von <class>LDAP\Result</class>-Instanzen zurückgegeben, außer im Fall eines
  Fehlers, dann ist der Rückgabewert <info>false</info>.

<comment>Param:</comment>
  <info>LDAP\Connection|array</info>  <strong>$ldap</strong>             Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong>
                                           zurückgegeben wurde.
  <info>array|string</info>           <strong>$base</strong>             Der Basis-DN für das Verzeichnis.
  <info>array|string</info>           <strong>$filter</strong>           Ein leerer Filter ist nicht erlaubt. Sollen alle
                                           Information zu einem Eintrag ermittelt werden, ist ein
                                           <return>objectClass=*</return>-Filter zu verwenden. Wenn bekannt ist,
                                           welche Eintragstypen auf dem Verzeichnis-Server verwendet
                                           werden, könnte ein entsprechender Filter, wie
                                           <return>objectClass=inetOrgPerson</return> verwendet werden.
  <info>array</info>                  <strong>$attributes</strong>       Ein Array von erforderlichen Merkmalen, z. B.
                                           array("mail", "sn", "cn"). Es ist zu beachten, dass der
                                           "dn" immer zurückgegeben wird, unabhängig davon, welche
                                           Merkmalstypen angefordert wurden.
                                           
                                           Die Verwendung dieses Parameters ist effizienter als die
                                           Standardaktion (die alle Merkmale und deren assoziierte
                                           Werte zurückgibt). Die Verwendung dieses Parameters
                                           sollte daher als gute Praxis eingestuft werden.
  <info>int</info>                    <strong>$attributes_only</strong>  Sollte auf 1 gesetzt werden, wenn nur Merkmalstypen
                                           erwünscht sind. Wird 0 übergeben, werden sowohl
                                           Merkmalstypen als auch Merkmalswerte abgerufen, was das
                                           Standardverhalten ist.
  <info>int</info>                    <strong>$sizelimit</strong>        Ermöglicht die Begrenzung der Anzahl der abgerufenen
                                           Einträge. Wird hier 0 übergeben, besteht keine
                                           Begrenzung.
                                           
                                           Dieser Parameter kann ein serverseitig voreingestelltes
                                           sizelimit NICHT überschreiben. Es kann allerdings kleiner
                                           gewählt werden.
                                           
                                           Verzeichnis-Server können so konfiguriert werden, dass
                                           sie nicht mehr als eine voreingestellte Anzahl von
                                           Einträgen zurückgeben. Wenn dies der Fall ist, dann zeigt
                                           der Server an, dass nur eine teilweise Ergebnismenge
                                           zurückgegeben wurde. Das geschieht ebenfalls, wenn dieser
                                           Parameter verwendet wird, um die Zahl der abgerufenen
                                           Einträge zu begrenzen.
  <info>int</info>                    <strong>$timelimit</strong>        Setzt die Anzahl von Sekunden, die auf die Suche
                                           verwendet wird. Die Übergabe von 0 bedeutet keine
                                           Begrenzung.
                                           
                                           Dieser Parameter kann ein serverseitig voreingestelltes
                                           timelimit NICHT überschreiben. Es kann allerdings kleiner
                                           gewählt werden.
  <info>int</info>                    <strong>$deref</strong>            Gibt an, wie Aliase während der Suche behandelt werden
                                           sollen. Es kann einen der folgenden Werte annehmen:
                                           <info>LDAP_DEREF_NEVER</info> - (standard) Aliase werden nie
                                           dereferenziert. <info>LDAP_DEREF_SEARCHING</info> - Aliase sollen
                                           während der Suche dereferenziert werden, aber nicht wenn
                                           das Basis-Objekt der Suche lokalisiert wird.
                                           <info>LDAP_DEREF_FINDING</info> - Aliase sollen für die Lokalisierung
                                           des Basis-Objekts dereferenziert werden, aber nicht
                                           während der Suche. <info>LDAP_DEREF_ALWAYS</info> - Aliase sollen
                                           immer dereferenziert werden.
                                           
                                           <info>LDAP_DEREF_NEVER</info> - (standard) Aliase werden nie
                                           dereferenziert.
                                           
                                           <info>LDAP_DEREF_SEARCHING</info> - Aliase sollen während der Suche
                                           dereferenziert werden, aber nicht wenn das Basis-Objekt
                                           der Suche lokalisiert wird.
                                           
                                           <info>LDAP_DEREF_FINDING</info> - Aliase sollen für die Lokalisierung
                                           des Basis-Objekts dereferenziert werden, aber nicht
                                           während der Suche.
                                           
                                           <info>LDAP_DEREF_ALWAYS</info> - Aliase sollen immer dereferenziert
                                           werden.
  <info>array|null</info>             <strong>$controls</strong>         Ein Array von LDAP-Steuerbefehlen, die mit der Anfrage
                                           versendet werden sollen.

<comment>Return:</comment>
  <info>LDAP\Result|array|false</info>  Gibt eine <class>LDAP\Result</class>-Instanz oder ein Array von <class>LDAP\Result</class>-Instanzen
                           zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: ldap_rename
type: function
doc:
<comment>Description:</comment>
  Ändert den Namen eines Eintrags
  
  Der Eintrag, der durch <strong>$dn</strong> gegeben ist, wird umbenannt/verschoben.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>            Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong>
                                    zurückgegeben wurde.
  <info>string</info>           <strong>$dn</strong>              Der Distinguished Name eines LDAP-Datenobjekts.
  <info>string</info>           <strong>$new_rdn</strong>         Der neue RDN.
  <info>string</info>           <strong>$new_parent</strong>      Der neue übergeordnete Eintrag.
  <info>bool</info>             <strong>$delete_old_rdn</strong>  Wenn <info>true</info>, dann wird der alte RDN-Wert entfernt; ansonsten
                                    bleibt der alte RDN-Wert als nicht-unterscheidbarer Wert des
                                    Eintrags erhalten.
  <info>array|null</info>       <strong>$controls</strong>        Ein Array von LDAP-Steuerbefehlen, die mit der Anfrage versendet
                                    werden sollen.

<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>ldap_rename_ext()</strong>
   * <strong>ldap_modify()</strong>


id: ldap_rename_ext
type: function
doc:
<comment>Description:</comment>
  Modify the name of an entry
  
  Does the same thing as <strong>ldap_rename()</strong> but returns an <class>LDAP\Result</class> instance to be parsed with
  <strong>ldap_parse_result()</strong>.

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

<comment>See Also:</comment>
   * <strong>ldap_rename()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_sasl_bind
type: function
doc:
<comment>Description:</comment>
  Bind to LDAP directory using SASL
  
  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: ldap_search
type: function
doc:
<comment>Description:</comment>
  Sucht im LDAP-Baum
  
  Führt eine Suche für einen gegebenen Filter im Verzeichnis mit dem Geltungsbereichmit von
  <info>LDAP_SCOPE_SUBTREE</info> durch. Das ist äquivalent zu einer Suche im ganzen Verzeichnis.
  
  Es ist auch möglich, parallele Suchen durchzuführen. In diesem Fall muss der erste Parameter ein
  Array von
  <class>LDAP\Connection</class>-Instanzen sein, anstatt einer einzelnen.
  Wenn die Suchen nicht alle den gleichen Basis-DN und Filter verwenden sollen, kann stattdessen ein
  Array von Basis-DNs und/oder ein Array von Filtern als Parameter übergeben werden.
  Diese Arrays müssen die gleiche Größe haben wie das Array von <class>LDAP\Connection</class>-Instanzen,
  da die ersten Einträge der Arrays für eine Suche verwendet werden, die zweiten Einträge für eine
  andere und so weiter.
  Bei parallelen Suchen wird ein Array von <class>LDAP\Result</class>-Instanzen zurückgegeben, außer im Fall eines
  Fehlers, dann ist der Rückgabewert <info>false</info>.

<comment>Param:</comment>
  <info>LDAP\Connection|array</info>  <strong>$ldap</strong>             Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</strong>
                                           zurückgegeben wurde.
  <info>array|string</info>           <strong>$base</strong>             Der Basis-DN für das Verzeichnis.
  <info>array|string</info>           <strong>$filter</strong>           Der Suchfilter kann einfach oder erweitert sein und
                                           boolesche Operatoren in dem Format verwenden, das in der
                                           LDAP-Dokumentation beschrieben wird (siehe das Netscape
                                           Directory SDK oder RFC4515 für vollständige Informationen
                                           zu Filtern).
  <info>array</info>                  <strong>$attributes</strong>       Ein Array von erforderlichen Merkmalen, z. B.
                                           <return>array("mail", "sn", "cn")</return>. Es ist zu beachten, dass der
                                           "dn" immer zurückgegeben wird, unabhängig davon, welche
                                           Merkmalstypen angefragt wurden.
                                           
                                           Die Verwendung dieses Parameters ist effizienter als die
                                           Standardaktion (die alle Merkmale und deren assoziierte
                                           Werte zurückgibt). Die Verwendung dieses Parameters
                                           sollte daher als gute Praxis eingestuft werden.
  <info>int</info>                    <strong>$attributes_only</strong>  Sollte auf 1 gesetzt werden, wenn nur Merkmalstypen
                                           erwünscht sind. Wird 0 übergeben, werden sowohl
                                           Merkmalstypen als auch Merkmalswerte abgerufen, was das
                                           Standardverhalten ist.
  <info>int</info>                    <strong>$sizelimit</strong>        Ermöglicht die Begrenzung der Anzahl der abgerufenen
                                           Einträge. Wird hier 0 übergeben, besteht keine
                                           Begrenzung.
                                           
                                           Dieser Parameter kann ein serverseitig voreingestelltes
                                           sizelimit NICHT überschreiben. Es kann allerdings kleiner
                                           gewählt werden.
                                           
                                           Verzeichnis-Server können so konfiguriert werden, dass
                                           sie nicht mehr als eine voreingestellte Anzahl von
                                           Einträgen zurückgeben. Wenn dies der Fall ist, dann zeigt
                                           der Server an, dass nur eine teilweise Ergebnismenge
                                           zurückgegeben wurde. Das geschieht ebenfalls, wenn dieser
                                           Parameter verwendet wird, um die Zahl der abgerufenen
                                           Einträge zu begrenzen.
  <info>int</info>                    <strong>$timelimit</strong>        Setzt die Anzahl von Sekunden, die auf die Suche
                                           verwendet wird. Die Übergabe von 0 bedeutet keine
                                           Begrenzung.
                                           
                                           Dieser Parameter kann ein serverseitig voreingestelltes
                                           timelimit NICHT überschreiben. Es kann allerdings kleiner
                                           gewählt werden.
  <info>int</info>                    <strong>$deref</strong>            Gibt an, wie Aliase während der Suche behandelt werden
                                           sollen. Es kann einen der folgenden Werte annehmen:
                                           <info>LDAP_DEREF_NEVER</info> - (standard) Aliase werden nie
                                           dereferenziert. <info>LDAP_DEREF_SEARCHING</info> - Aliase sollen
                                           während der Suche dereferenziert werden, aber nicht wenn
                                           das Basis-Objekt der Suche lokalisiert wird.
                                           <info>LDAP_DEREF_FINDING</info> - Aliase sollen für die Lokalisierung
                                           des Basis-Objekts dereferenziert werden, aber nicht
                                           während der Suche. <info>LDAP_DEREF_ALWAYS</info> - Aliase sollen
                                           immer dereferenziert werden.
                                           
                                           <info>LDAP_DEREF_NEVER</info> - (standard) Aliase werden nie
                                           dereferenziert.
                                           
                                           <info>LDAP_DEREF_SEARCHING</info> - Aliase sollen während der Suche
                                           dereferenziert werden, aber nicht wenn das Basis-Objekt
                                           der Suche lokalisiert wird.
                                           
                                           <info>LDAP_DEREF_FINDING</info> - Aliase sollen für die Lokalisierung
                                           des Basis-Objekts dereferenziert werden, aber nicht
                                           während der Suche.
                                           
                                           <info>LDAP_DEREF_ALWAYS</info> - Aliase sollen immer dereferenziert
                                           werden.
  <info>array|null</info>             <strong>$controls</strong>         Ein Array von LDAP-Steuerbefehlen, die mit der Anfrage
                                           versendet werden sollen.

<comment>Return:</comment>
  <info>LDAP\Result|array|false</info>  Gibt eine <class>LDAP\Result</class>-Instanz oder ein Array von <class>LDAP\Result</class>-Instanzen
                           zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.


id: ldap_set_option
type: function
doc:
<comment>Description:</comment>
  Setzt den Wert der gegebenen Option
  
  Setzt den Wert der angegebenen Option auf <strong>$value</strong>.

<comment>Param:</comment>
  <info>LDAP\Connection|null</info>   <strong>$ldap</strong>    Entweder eine von <strong>ldap_connect()</strong> zurückgegebene
                                  <class>LDAP\Connection</class>-Instanz, um die Option für diese Verbindung zu
                                  setzen, oder <info>null</info>, um die Option global zu setzen.
  <info>int</info>                    <strong>$option</strong>  Der Parameter <strong>$option</strong> kann einer der folgenden Werte sein:
                                  OptionTypVerfügbar
                                  seit<info>LDAP_OPT_DEREF</info><info>int</info><info>LDAP_OPT_SIZELIMIT</info><info>int</info><info>LDAP_OPT_TIMELIMIT</info><info>int</info><info>LDAP_OPT_NETWORK_TIMEOUT</info><info>int</info><info>LDAP_OPT_PROTOCOL_VERSION</info><info>int</info><info>LDAP_OPT_ERROR_NUMBER</info><info>int</info><info>LDAP_OPT_REFERRALS</info><info>bool</info><info>LDAP_OPT_RESTART</info><info>bool</info><info>LDAP_OPT_HOST_NAME</info><info>string</info><info>LDAP_OPT_ERROR_STRING</info><info>string</info><info>LDAP_OPT_DIAGNOSTIC_MESSAGE</info><info>string</info><info>LDAP_OPT_MATCHED_DN</info><info>string</info><info>LDAP_OPT_SERVER_CONTROLS</info><info>array</info><info>LDAP_OPT_CLIENT_CONTROLS</info><info>array</info><info>LDAP_OPT_X_KEEPALIVE_IDLE</info><info>int</info>PHP
                                  7.1.0<info>LDAP_OPT_X_KEEPALIVE_PROBES</info><info>int</info>PHP
                                  7.1.0<info>LDAP_OPT_X_KEEPALIVE_INTERVAL</info><info>int</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_CACERTDIR</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_CACERTFILE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_CERTFILE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_CIPHER_SUITE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_CRLCHECK</info><info>int</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_CRLFILE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_DHFILE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_KEYFILE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_PROTOCOL_MIN</info><info>int</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_RANDOM_FILE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_REQUIRE_CERT</info><info>int</info>PHP 7.0.5
                                  
                                  Die Optionen <info>LDAP_OPT_SERVER_CONTROLS</info> und <info>LDAP_OPT_CLIENT_CONTROLS</info>
                                  benötigen eine Liste von Steuerelementen, d. h. der Wert muss ein
                                  Array aus Steuerelementen sein. Ein Steuerelement besteht aus
                                  einer OID, die das Steuerelement identifiziert, einem optionalen
                                  Wert, und einem optionalen Kennzeichen für die Kritikalität. Bei
                                  PHP wird ein Steuerelement durch ein Array angegeben. Dieses Array
                                  enthält ein Element mit dem Schlüssel oid und einer Zeichenkette
                                  als Wert und zwei optionale Elemente. Die optionalen Elemente sind
                                  die Schlüssel value mit einer Zeichenkette als Wert und iscritical
                                  mit einem booleschen Wert. Der vorgegebene Wert von iscritical ist
                                  <info>false</info>, falls nicht angegeben. Siehe
                                  draft-ietf-ldapext-ldap-c-api-xx.txt für Details. Ebenso ist das
                                  zweite Beispiel weiter unten zu konsultieren.
  <info>array|string|int|bool</info>  <strong>$value</strong>   Der neue Wert für die angegebene <strong>$option</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>ldap_get_option()</strong>


id: ldap_set_rebind_proc
type: function
doc:
<comment>Description:</comment>
  Setzt einen Callback für erneute Bindungen bei der Verweisverfolgung
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>bool</info>  


id: ldap_sort
type: function
doc:
<comment>Description:</comment>
  Sortiert LDAP-Ergebniseinträge clientseitig
  
  Sortiert das Ergebnis einer LDAP-Suche, das von <strong>ldap_search()</strong> zurückgegeben wurde.
  
  Da diese Funktion die zurückgegebenen Werte clientseitig sortiert, ist es möglich, dass
  unerwartete Ergebnisse geliefert werden, falls entweder das serverseitige <strong>$sizelimit</strong> oder
  dasjenige, das mit <strong>ldap_search()</strong> festgelegt wurde, erreicht wurde.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>        Eine LDAP-Ressource, die von <strong>ldap_connect()</strong> zurückgegeben wurde.
  <info>resource</info>  <strong>$result</strong>      Eine Suchergebniskennung, die von <strong>ldap_search()</strong> zurückgegeben wurde.
  <info>string</info>    <strong>$sortfilter</strong>  Das als Sortierschlüssel zu verwendende Merkmal.

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


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

<comment>Return:</comment>
  <info>bool</info>  


id: ldap_t61_to_8859
type: function
doc:
<comment>Description:</comment>
  Übersetzt t61-Zeichen in 8859-Zeichen
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

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


id: ldap_unbind
type: function
doc:
<comment>Description:</comment>
  Löst die Bindung zu einem LDAP-Verzeichnis
  
  Löst die Bindung zu einem LDAP-Verzeichnis.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>  Eine <class>LDAP\Connection</class>Instanz, die von  <strong>ldap_connect()</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>ldap_bind()</strong>


id: levenshtein
type: function
doc:
<comment>Description:</comment>
  Berechnet die Levenshtein-Distanz zwischen zwei Strings
  
  Die Levenshtein-Distanz bezeichnet die minimale Anzahl von Zeichen, die Sie ersetzen, einfügen
  oder löschen müssen, um <strong>$string1</strong> in <strong>$string2</strong> umzuwandeln. Die Komplexität des Algorithmus ist
  <return>O(m*n)</return>, wobei <return>n</return> und <return>m</return> die Länge von <strong>$string1</strong> und <strong>$string2</strong> darstellen (recht gut, im Vergleich zu
  <strong>similar_text()</strong>, das <return>O(max(n,m)**3)</return> ist, aber trotzdem immer noch aufwendig).
  
  Wenn <strong>$insertion_cost</strong>, <strong>$replacement_cost</strong> und/oder <strong>$deletion_cost</strong> ungleich <return>1</return> sind, passt sich der
  Algorithmus an, um die günstigsten Transformationen zu wählen. Wenn z. B. $insertion_cost +
  $deletion_cost
  \< $replacement_cost, werden keine Ersetzungen durchgeführt, sondern stattdessen Einfügungen und Löschungen.

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>           Eine der Zeichenketten, für die die Levenshtein-Distanz zu berechnen
                             ist.
  <info>string</info>  <strong>$string2</strong>           Eine der Zeichenketten, für die die Levenshtein-Distanz zu berechnen
                             ist.
  <info>int</info>     <strong>$insertion_cost</strong>    Definiert die Kosten des Einfügens.
  <info>int</info>     <strong>$replacement_cost</strong>  Definiert die Kosten des Ersetzens.
  <info>int</info>     <strong>$deletion_cost</strong>     Definiert die Kosten des Löschens.

<comment>Return:</comment>
  <info>int</info>  Die Funktion gibt die Levenshtein-Distanz zwischen den beiden Argument-Strings zurück.

<comment>See Also:</comment>
   * <strong>soundex()</strong>
   * <strong>similar_text()</strong>
   * <strong>metaphone()</strong>


id: libXMLError
type: class
doc:
<comment>Description:</comment>
  Contains various information about errors thrown by libxml. The error codes are described within
  the official  xmlError API documentation.


id: libxml_clear_errors
type: function
doc:
<comment>Description:</comment>
  Clear libxml error buffer
    
  
  <strong>libxml_clear_errors()</strong> clears the libxml error buffer.

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

<comment>See Also:</comment>
   * <strong>libxml_get_errors()</strong>
   * <strong>libxml_get_last_error()</strong>


id: libxml_disable_entity_loader
type: function
doc:
<comment>Description:</comment>
  Disable the ability to load external entities
  
  Disable/enable the ability to load external entities. Note that disabling the loading of external
  entities may cause general issues with loading XML documents. However, as of libxml 2.9.0 entity
  substitution is disabled by default, so there is no need to disable the loading of external
  entities, unless there is the need to resolve internal entity references with <info>LIBXML_NOENT</info>.
  Generally, it is preferable to use <strong>libxml_set_external_entity_loader()</strong> to suppress loading of
  external entities.

<comment>Param:</comment>
  <info>bool</info>  <strong>$disable</strong>  Disable (<info>true</info>) or enable (<info>false</info>) libxml extensions (such as ,  and ) to load
                  external entities.

<comment>Return:</comment>
  <info>bool</info>  Returns the previous value.

<comment>See Also:</comment>
   * <strong>libxml_use_internal_errors()</strong>
   * <strong>libxml_set_external_entity_loader()</strong>
   * The <info>LIBXML_NOENT</info> constant


id: libxml_get_errors
type: function
doc:
<comment>Description:</comment>
  Retrieve array of errors
    
  
  Retrieve array of errors.

<comment>Return:</comment>
  <info>array</info>  Returns an array with <info>LibXMLError</info> objects if there are any errors in the buffer, or an
         empty array otherwise.

<comment>See Also:</comment>
   * <strong>libxml_get_last_error()</strong>
   * <strong>libxml_clear_errors()</strong>


id: libxml_get_external_entity_loader
type: function
doc:
<comment>Description:</comment>
  Get the current external entity loader
  
  Get external entity loader previously installed by <strong>libxml_set_external_entity_loader()</strong>.

<comment>Return:</comment>
  <info>callable|null</info>  The external entity loader previously installed by
                 <strong>libxml_set_external_entity_loader()</strong>. If that function was never called, or if it
                 was called with <info>null</info>, <info>null</info> will be returned.

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


id: libxml_get_last_error
type: function
doc:
<comment>Description:</comment>
  Retrieve last error from libxml
    
  
  Retrieve last error from libxml.

<comment>Return:</comment>
  <info>LibXMLError|false</info>  Returns a <info>LibXMLError</info> object if there is any error in the buffer, <info>false</info>
                     otherwise.

<comment>See Also:</comment>
   * <strong>libxml_get_errors()</strong>
   * <strong>libxml_clear_errors()</strong>


id: libxml_set_external_entity_loader
type: function
doc:
<comment>Description:</comment>
  Changes the default external entity loader
  
  Changes the default external entity loader. This can be used to suppress the expansion of
  arbitrary external entities to avoid XXE attacks, even when <info>LIBXML_NOENT</info> has been set for the
  respective operation, and is usually preferable over calling <strong>libxml_disable_entity_loader()</strong>.

<comment>Param:</comment>
  <info>callable|null</info>  <strong>$resolver_function</strong>  A <info>callable</info> with the following signature:
                                     <info>resource</info><info>string</info><info>null</info></info>resolver<info>string</info><info>null</info></info><strong>$public_id</strong><info>string</info><strong>$system_id</strong><info>array</info><strong>$context</strong>
                                     <strong>$public_id</strong> The public ID. <strong>$system_id</strong> The system ID. <strong>$context</strong> An
                                     array with the four elements <return>"directory"</return>, <return>"intSubName"</return>,
                                     <return>"extSubURI"</return> and <return>"extSubSystem"</return>.  This callable should return a
                                     Ressource, a String from which a resource can be opened. If
                                     <info>null</info> is returned, the entity reference resolution will fail.
                                     
                                     The public ID.
                                     
                                     The system ID.
                                     
                                     An array with the four elements <return>"directory"</return>, <return>"intSubName"</return>,
                                     <return>"extSubURI"</return> and <return>"extSubSystem"</return>.
  <info>string|null</info>    <strong>$public_id</strong>          The public ID.
  <info>string</info>         <strong>$system_id</strong>          The system ID.
  <info>array</info>          <strong>$context</strong>            An array with the four elements <return>"directory"</return>, <return>"intSubName"</return>,
                                     <return>"extSubURI"</return> and <return>"extSubSystem"</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>libxml_disable_entity_loader()</strong>
   * <strong>libxml_get_external_entity_loader()</strong>


id: libxml_set_streams_context
type: function
doc:
<comment>Description:</comment>
  Set the streams context for the next libxml document load or write
    
  
  Sets the streams context for the next libxml document load or write.

<comment>Param:</comment>
  <info>resource</info>  <strong>$context</strong>  The stream context resource (created with <strong>stream_context_create()</strong>)

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

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


id: libxml_use_internal_errors
type: function
doc:
<comment>Description:</comment>
  Disable libxml errors and allow user to fetch error information as needed
    
  
  <strong>libxml_use_internal_errors()</strong> allows you to disable standard libxml errors and enable user error
  handling.

<comment>Param:</comment>
  <info>bool|null</info>  <strong>$use_errors</strong>  Enable (<info>true</info>) user error handling or disable (<info>false</info>) user error handling.
                          Disabling will also clear any existing libxml errors.

<comment>Return:</comment>
  <info>bool</info>  This function returns the previous value of <strong>$use_errors</strong>.

<comment>See Also:</comment>
   * <strong>libxml_clear_errors()</strong>
   * <strong>libxml_get_errors()</strong>


id: link
type: function
doc:
<comment>Description:</comment>
  Erzeugt einen harten Link
  
  <strong>link()</strong> erzeugt einen harten Link.

<comment>Param:</comment>
  <info>string</info>  <strong>$target</strong>  Das Ziel des Links.
  <info>string</info>  <strong>$link</strong>    Der Name des Links.

<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>symlink()</strong>
   * <strong>readlink()</strong>
   * <strong>linkinfo()</strong>
   * <strong>unlink()</strong>


id: linkinfo
type: function
doc:
<comment>Description:</comment>
  Liefert Informationen über einen Link
  
  Liefert Informationen über einen Link.
  
  Diese Funktion wird benutzt, um zu verifizieren, ob ein Link (auf den mit <strong>$path</strong> gezeigt wird)
  wirklich existiert. Dabei wird die gleiche Methode benutzt, die in dem S_ISLNK-Makro in  stat.h
  definiert ist).

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  Pfad zum Link.

<comment>Return:</comment>
  <info>int|false</info>  <strong>linkinfo()</strong> gibt das <return>st_dev</return>-Feld der Unix-C-Stat-Struktur, die vom <return>lstat</return>-Systemaufruf
             zurückgegeben wird, zurück. Gibt im Erfolgsfall eine nicht-negative Ganzzahl zurück; -1
             im Fall, dass der Link nicht gefunden wurde, oder <info>false</info> falls ein open_base_dir Verstoß
             erfolgt.

<comment>See Also:</comment>
   * <strong>symlink()</strong>
   * <strong>link()</strong>
   * <strong>readlink()</strong>


id: list
type: function
doc:
<comment>Description:</comment>
  Weist Variablen zu, als wären sie ein Array
  
  Wie <strong>array()</strong> ist auch dies keine Funktion, sondern ein Sprachkonstrukt. <strong>list()</strong> wird verwendet, um
  eine Liste von Variablen in einer Operation zuzuweisen. Zeichenketten können nicht verarbeitet
  werden und der <strong>list()</strong>-Ausdruck darf nicht vollständig leer sein.
  
  Vor PHP 7.1.0 funktionierte <strong>list()</strong> nur bei numerischen Arrays und basierte auf der Annahme, dass
  die numerischen Indizes bei 0 beginnen.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>   Eine Variable.
  <info>mixed</info>  <strong>$vars</strong>  Weitere Variablen.

<comment>Return:</comment>
  <info>array</info>  Gibt das zugewiesene Array zurück.

<comment>See Also:</comment>
   * <strong>each()</strong>
   * <strong>array()</strong>
   * <strong>extract()</strong>


id: localeconv
type: function
doc:
<comment>Description:</comment>
  Ermittelt die Formatierungsinformationen für Zahlen
  
  Gibt ein assoziatives Array zurück, das die lokalisierten Informationen zur Formatierung von
  Zahlen und Geldbeträgen enthält.

<comment>Return:</comment>
  <info>array</info>  <strong>localeconv()</strong> gibt Daten basierend auf den aktuellen Locale-Einstellungen, wie sie mittels
         <strong>setlocale()</strong> festgelegt werden können, zurück. Das assoziative Array, das zurückgegeben
         wird, enthält folgende Felder:
         Array-ElementBeschreibungdecimal_pointDezimaltrennzeichenthousands_sepTausendertrennzeichengroupingArray
         mit numerischen Gruppierungenint_curr_symbolInternationales Währungssymbol (i. e.
         USD)currency_symbolLokales Währungssymbol (i. e. $)mon_decimal_pointDezimaltrennzeichen bei
         Geldbeträgenmon_thousands_sepTausendertrennzeichen bei Geldbeträgenmon_groupingArray mit
         Geldbetragsgruppierungenpositive_signVorzeichen für positive Wertenegative_signVorzeichen
         für negative Werteint_frac_digitsInternationale Dezimalbrüchefrac_digitsLokale
         Dezimalbrüchep_cs_precedes Ist <info>true</info>, wenn das Währungssymbol einem positiver Wert
         voransteht, oder <info>false</info>, wenn es einem positiven Wert folgt. p_sep_by_space Ist <info>true</info>, wenn
         ein Leerzeichen das Währungssymbol von einem positiven Wert trennt, ansonsten <info>false</info>.
         n_cs_precedes Ist <info>true</info>, wenn das Währungssymbol einem negativer Wert voransteht, oder
         <info>false</info>, wenn es einem negativen Wert folgt. n_sep_by_space Ist <info>true</info>, wenn ein Leerzeichen
         das Währungssymbol von einem negativen Wert trennt, ansonsten <info>false</info>. p_sign_posn0 -
         Klammern um Menge und Währungssymbol1 - Das Vorzeichen steht vor Menge und Währungssymbol2
         - Das Vorzeichen steht hinter Menge und Währungssymbol3 - Das Vorzeichen steht direkt vor
         Menge und Währungssymbol4 - Das Vorzeichen steht direkt hinter Menge und
         Währungssymboln_sign_posn0 - Klammern um Menge und Währungssymbol1 - Das Vorzeichen steht
         vor Menge und Währungssymbol2 - Das Vorzeichen steht hinter Menge und Währungssymbol3 - Das
         Vorzeichen steht direkt vor Menge und Währungssymbol4 - Das Vorzeichen steht direkt hinter
         Menge und Währungssymbol
         
         <return>p_sign_posn</return> und <return>n_sign_posn</return> enthalten einen String mit Formatierungsinformationen. Jeder
         Wert repräsentiert eine der oben aufgeführten Bedingungen.
         
         Die Gruppierungsfelder enthalten Arrays, die die Art und Weise definieren, in der Zahlen
         gruppiert werden sollten. Beispielsweise würde das Gruppierungsfeld für Geldbeträge unter
         einer nl_NL-Locale (im UTF-8-Modus mit dem Euro-Zeichen) ein Array mit zwei Einträgen mit
         den Werten 3 und 3 enthalten. Je höher der Index im Array, desto weiter links wird
         gruppiert. Wenn ein Arrayelement <info>CHAR_MAX</info> entspricht, wird keine weitere Gruppierung
         angewendet. Ist ein Arrayelement gleich 0, sollte das vorangegangene Element verwendet
         werden.

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


id: localtime
type: function
doc:
<comment>Description:</comment>
  Ermittelt die lokale Zeit
  
  Die Funktion <strong>localtime()</strong> gibt ein Array zurück, welches hinsichtlich seiner Struktur identisch ist
  mit der des Funktionsaufrufs in C.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$timestamp</strong>    Der optionale Parameter <strong>$timestamp</strong> ist ein Unix-Zeitstempel
                          vom Typ <info>int</info>. Falls <strong>$timestamp</strong> nicht übergeben
                          wird oder <info>null</info> ist, wird die aktuelle lokale Zeit als Standardwert
                          verwendet.
                          Er entspricht dann also dem Ergebnis der Funktion <strong>time()</strong>.
  <info>bool</info>      <strong>$associative</strong>  Bestimmt, ob die Funktion ein gewöhnliches numerisch indiziertes Array
                          zurückgeben soll, oder ein assoziatives.

<comment>Return:</comment>
  <info>array</info>  Ist <strong>$associative</strong> nicht angegeben oder <info>false</info>, ist das zurückgegebene Array ein gewöhnliches
         numerisch indiziertes Array. Hat <strong>$associative</strong> den Wert <info>true</info>, gibt <strong>localtime()</strong> ein
         assoziatives Array zurück, das die Strukturelemente enthält, die beim Aufruf der C-Funktion
         an localtime zurückgegeben werden. Die Namen der Schlüssel des assoziativen Arrays lauten:
         
          "tm_sec" - Sekunden, <return>0</return> bis <return>59</return>  "tm_min" - Minuten, <return>0</return> bis <return>59</return>  "tm_hour" - Stunden, <return>0</return> bis <return>23</return>
         "tm_mday" - Tag des Monats, <return>1</return> bis <return>31</return>  "tm_mon" - Monat des Jahres, <return>0</return> (Jan) bis <return>11</return> (Dez)
         "tm_year" - Jahre seit 1900  "tm_wday" - Tag der Woche, <return>0</return> (Son) bis <return>6</return> (Sam)  "tm_yday" -
         Tag des Jahres, <return>0</return> bis <return>365</return>  "tm_isdst" - ist für das Datum die Sommerzeit zu
         berücksichtigen?  Positiv wenn ja, <return>0</return> wenn nein, negativ wenn unbekannt.
         
         "tm_sec" - Sekunden, <return>0</return> bis <return>59</return>
         
         "tm_min" - Minuten, <return>0</return> bis <return>59</return>
         
         "tm_hour" - Stunden, <return>0</return> bis <return>23</return>
         
         "tm_mday" - Tag des Monats, <return>1</return> bis <return>31</return>
         
         "tm_mon" - Monat des Jahres, <return>0</return> (Jan) bis <return>11</return> (Dez)
         
         "tm_year" - Jahre seit 1900
         
         "tm_wday" - Tag der Woche, <return>0</return> (Son) bis <return>6</return> (Sam)
         
         "tm_yday" - Tag des Jahres, <return>0</return> bis <return>365</return>
         
         "tm_isdst" - ist für das Datum die Sommerzeit zu berücksichtigen?
         
         Positiv wenn ja, <return>0</return> wenn nein, negativ wenn unbekannt.

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


id: log
type: function
doc:
<comment>Description:</comment>
  Natürlicher Logarithmus
  
  Berechnet den natürlichen Logarithmus von <strong>$num</strong> beziehungsweise, falls der optionale zweite
  Parameter <strong>$base</strong> gegeben ist, den Logarithmus von <strong>$num</strong> zur Basis <strong>$base</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>   Der Wert, für den der Logarithmus berechnet werden soll.
  <info>float</info>  <strong>$base</strong>  Die optionale Basis für die Berechnung des Logarithmus (der Vorgabewert ist 'e' für
                den natürlichen Logarithmus).

<comment>Return:</comment>
  <info>float</info>  Der Logarithmus von <strong>$num</strong> zur Basis <strong>$base</strong> bzw. der natürliche Logarithmus.

<comment>See Also:</comment>
   * <strong>log10()</strong>
   * <strong>exp()</strong>
   * <strong>pow()</strong>
   * <strong>error_log()</strong>


id: log10
type: function
doc:
<comment>Description:</comment>
  Dekadischer Logarithmus (Logarithmus zur Basis 10)
  
  Berechnet den dekadischen Logarithmus von <strong>$num</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  Der zu verarbeitende Wert.

<comment>Return:</comment>
  <info>float</info>  Der dekadische Logarithmus von <strong>$num</strong>.

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


id: log1p
type: function
doc:
<comment>Description:</comment>
  Berechnet log(1 + Zahl) mit guter Genauigkeit, auch wenn Zahl nahe bei Null liegt
    
  
  <strong>log1p()</strong> gibt log(1 + <strong>$num</strong>) zurück, das so berechnet wird, dass es auch dann genau ist, wenn der
  Wert von <strong>$num</strong> sehr nahe bei <return>0</return> liegt. <strong>log()</strong> liefert in solchen Fällen aufgrund von Rundungsfehlern
  oft nur den Wert von log(1).

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  Der zu verarbeitende Wert.

<comment>Return:</comment>
  <info>float</info>  log(1 + <strong>$num</strong>).

<comment>See Also:</comment>
   * <strong>expm1()</strong>
   * <strong>log()</strong>
   * <strong>log10()</strong>


id: long2ip
type: function
doc:
<comment>Description:</comment>
  Konvertiert eine Long-Integer-Adresse in einen String, der das (IPv4)
     Internet-Standard-Punktformat enthält ("Dotted-Format")
    
  
  Die Funktion <strong>long2ip()</strong> erzeugt eine IP-Adresse im Punktformat (also: www.xxx.yyy.zzz) anhand der
  Long-Integer-Adresse.

<comment>Param:</comment>
  <info>int</info>  <strong>$ip</strong>  Eine korrekte Adressdarstellung als Long Integer.

<comment>Return:</comment>
  <info>string|false</info>  Gibt die IP-Adresse als String zurück. Bei einem Fehler wird <info>false</info> zurückgegeben.

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


id: lstat
type: function
doc:
<comment>Description:</comment>
  Sammelt Informationen über eine Datei oder einen symbolischen Link
    
  
  Sammelt Statistiken über die Datei oder den symbolischen Link, die bzw. der in <strong>$filename</strong> angegeben
  ist.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Pfad zur Datei oder zum symbolischen Link.

<comment>Return:</comment>
  <info>array|false</info>  Bitte lesen Sie die Handbuchseite zu <strong>stat()</strong> für Informationen über die Struktur des
               Arrays, das <strong>lstat()</strong> zurückgibt. Diese Funktion ist identisch zur <strong>stat()</strong>-Funktion, mit
               dem Unterschied, dass, falls <strong>$filename</strong> ein symbolischer Link ist, dessen Statistik
               zurückgegeben wird und nicht der Status der Datei, auf die  der symbolische Link
               zeigt.
               
               Bei einem Fehler wird <info>false</info> zurückgegeben.

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


id: ltrim
type: function
doc:
<comment>Description:</comment>
  Entfernt Leerraum (oder andere Zeichen) vom Anfang eines Strings
  
  Entfernt Leerraum (oder andere Zeichen) vom Anfang eines Strings.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>      Die Eingabezeichenkette.
  <info>string</info>  <strong>$characters</strong>  Sie können mittels des <strong>$characters</strong>-Parameters eigene Zeichen angeben, die Sie
                       entfernen lassen möchten. Führen Sie einfach alle zu löschenden Zeichen auf.
                       Mittels <return>..</return> können Sie einen Bereich von Zeichen benennen.

<comment>Return:</comment>
  <info>string</info>  Diese Funktion gibt den String <strong>$string</strong> zurück, von dessen Anfang alle Whitespaces entfernt
          wurden. Ohne den zweiten Parameter entfernt <strong>ltrim()</strong> diese Zeichen:   " " (ASCII <return>32</return>
          (<return>0x20</return>)), ein einfaches Leerzeichen.  "\t" (ASCII <return>9</return> (<return>0x09</return>)), ein Tabulator.  "\n" (ASCII <return>10</return>
          (<return>0x0A</return>)), ein Zeilenvorschub (line feed).  "\r" (ASCII <return>13</return> (<return>0x0D</return>)), ein
          Wagenrücklauf-Zeichen (carriage return).  "\0" (ASCII <return>0</return> (<return>0x00</return>)), das <return>NUL</return>-Byte.  "\v"
          (ASCII <return>11</return> (<return>0x0B</return>)), ein vertikaler Tabulator.
          
          " " (ASCII <return>32</return> (<return>0x20</return>)), ein einfaches Leerzeichen.
          
          "\t" (ASCII <return>9</return> (<return>0x09</return>)), ein Tabulator.
          
          "\n" (ASCII <return>10</return> (<return>0x0A</return>)), ein Zeilenvorschub (line feed).
          
          "\r" (ASCII <return>13</return> (<return>0x0D</return>)), ein Wagenrücklauf-Zeichen (carriage return).
          
          "\0" (ASCII <return>0</return> (<return>0x00</return>)), das <return>NUL</return>-Byte.
          
          "\v" (ASCII <return>11</return> (<return>0x0B</return>)), ein vertikaler Tabulator.

<comment>See Also:</comment>
   * <strong>trim()</strong>
   * <strong>rtrim()</strong>


id: lzf_compress
type: function
doc:
<comment>Description:</comment>
  LZF compression
    
  
  <strong>lzf_compress()</strong> compresses the given <strong>$data</strong> string using LZF encoding.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The string to compress.

<comment>Return:</comment>
  <info>string</info>  Returns the compressed data or <info>false</info> if an error occurred.

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


id: lzf_decompress
type: function
doc:
<comment>Description:</comment>
  LZF decompression
    
  
  <strong>lzf_compress()</strong> decompresses the given <strong>$data</strong> string containing lzf encoded data.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The compressed string.

<comment>Return:</comment>
  <info>string</info>  Returns the decompressed data or <info>false</info> if an error occurred.

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


id: lzf_optimized_for
type: function
doc:
<comment>Description:</comment>
  Determines what LZF extension was optimized for
    
  
  Determines what was LZF extension optimized for during compilation.

<comment>Return:</comment>
  <info>int</info>  Returns 1 if LZF was optimized for speed, 0 for compression.


id: mail
type: function
doc:
<comment>Description:</comment>
  Sendet eine E-Mail
  
  Sendet eine E-Mail.

<comment>Param:</comment>
  <info>string</info>        <strong>$to</strong>                  Ein oder mehrere Empfänger der E-Mail.
                                     
                                     Die Formatierung dieser Zeichenkette muss nach RFC 2822
                                     erfolgen. Beispiele: benutzer@example.combenutzer@example.com,
                                     benutzer2@example.comName \<benutzer@example.com&gt;Name \<benutzer@example.com&gt;, Name2 \<benutzer2@example.com&gt;
  <info>string</info>        <strong>$subject</strong>             Der Betreff der E-Mail.
                                     
                                     Die Formatierung dieser Zeichenkette muss nach RFC 2047
                                     erfolgen.
  <info>string</info>        <strong>$message</strong>             Die zu sendende Nachricht.
                                     
                                     Jede Zeile muss durch CRLF (\r\n) getrennt werden. Außerdem
                                     sollten die Zeilen nicht mehr als 70 Zeichen enthalten.
                                     
                                     (Nur unter Windows) Falls PHP direkt mit einem SMTP-Server
                                     kommuniziert und wenn ein Punkt (.) an einem Zeilenanfang
                                     steht, wird dieser Punkt entfernt. Um das zu verhindern, können
                                     Sie diese Punkte durch zwei Punkte ersetzen.
                                     ]]>
  <info>array|string</info>  <strong>$additional_headers</strong>  <info>string</info> oder <info>array</info>, das am Ende des E-Mail-Headers eingefügt
                                     werden soll.
                                     
                                     Dies kann benutzt werden, um zusätzliche Header wie From, Cc
                                     oder Bcc anzugeben. Falls mehrere solcher zusätzlichen Header
                                     angegeben werden sollen, müssen diese durch ein CRLF-Zeichen
                                     (\r\n) getrennt werden. Wenn von außen kommende Daten verwendet
                                     werden, um diesen Header zusammenzustellen, sollten diese Daten
                                     bereinigt werden, so dass keine ungewünschten Header
                                     eingeschleust werden können.
                                     
                                     Wird ein <info>array</info> übergeben, werden dessen Schlüssel als
                                     Header-Namen, und dessen Werte als entsprechende Header-Werte
                                     interpretiert.
                                     
                                     Vor PHP 5.4.42 bzw. 5.5.27 bot <strong>$additional_headers</strong> noch keinen
                                     Schutz vor Mail-Header-Injection. Daher müssen Anwender
                                     sicherstellen, dass die angegeben Header sicher sind und
                                     wirklich nur Header enthalten. Unter anderem ist darauf zu
                                     achten, dass mehrere aufeinanderfolgende Zeilenumbrüche den
                                     E-Mail-Header beenden.
                                     
                                     Um eine E-Mail zu senden, muss die E-Mail einen <return>From</return>-Header
                                     enthalten. Dies kann entweder durch Setzen eines
                                     <strong>$additional_headers</strong>-Parameters oder durch Setzen eines
                                     Standardwertes in der php.ini geschehen.
                                     
                                     Falls dies nicht geschieht, wird eine Fehlermeldung ähnlich wie
                                     <return>Warning: mail(): "sendmail_from" not set in php.ini or custom
                                     "From:" header missing</return> ausgegeben. Der <return>From</return>-Header setzt unter
                                     Windows auch den <return>Return-Path</return>-Header.
                                     
                                     Wenn E-Mails nicht ankommen, versuchen Sie bitte, nur das
                                     LF-Zeichen (\n) zu verwenden. Einige UNIX-MTAs (Mail Transfer
                                     Agents) (ganz besonders qmail) ersetzen leider LF durch CRLF
                                     (\r\n) automatisch (wodurch das CR-Zeichen verdoppelt wird,
                                     wenn CRLF verwendet wird). Dies sollte aber nur in
                                     Ausnahmefällen geschehen, da es gegen RFC 2822 verstößt.
  <info>string</info>        <strong>$additional_params</strong>   Der Parameter <strong>$additional_params</strong> kann verwendet werden, um
                                     zusätzliche Parameter an das Programm zu senden, das für den
                                     E-Mail-Versand konfiguriert ist (wenn die
                                     <return>sendmail_path</return>-Einstellung verwendet wird). Zum Beispiel kann
                                     hiermit die Envelope Sender Address (Umschlag-Absenderadresse)
                                     gesetzt werden, wenn sendmail mit der <return>-f</return>-Option verwendet wird.
                                     
                                     Dieser Parameter wird intern durch <strong>escapeshellcmd()</strong> maskiert,
                                     um die Kommando-Injection zu verhindern. <strong>escapeshellcmd()</strong>
                                     verhindert die Kommando-Injection, erlaubt aber, zusätzliche
                                     Parameter hinzuzufügen. Aus Sicherheitsgründen wird empfohlen,
                                     dass dieser Parameter bereinigt wird, um zu verhindern, dass
                                     keine unerwünschten Parameter an das Shell-Kommando übergeben
                                     werden.
                                     
                                     Da <strong>escapeshellcmd()</strong> automatisch angewendet wird, können einige
                                     Zeichen, die gemäß Internet-RFCs in E-Mail-Adressen erlaubt
                                     sind, nicht verwendet werden. <strong>mail()</strong> kann solche Zeichen nicht
                                     erlauben, so dass für Programme, die diese Zeichen unterstützen
                                     müssen, alternative Methoden für den E-Mail-Versand (wie
                                     beispielsweise die Verwendung eines Frameworks oder einer
                                     Bibliothek) empfohlen werden.
                                     
                                     Der Benutzer, unter dem der Webserver läuft, sollte als
                                     vertrauenswürdiger Benutzer in der sendmail-Konfiguration
                                     eingetragen werden, um zu verhindern, dass ein
                                     'X-Warning'-Header zu den E-Mails hingefügt wird, wenn mit
                                     dieser Methode (-f) der Absender gesetzt wird.
                                     Sendmail-Benutzer finden diese Datei hier:
                                     /etc/mail/trusted-users.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn die E-Mail erfolgreich für den Versand akzeptiert wurde, sonst <info>false</info>.
        
        Dass eine E-Mail für den Versand akzeptiert wurde, bedeutet NICHT, dass sie auch wirklich
        den gewünschten Empfänger erreichen wird.

<comment>See Also:</comment>
   * <strong>mb_send_mail()</strong>
   * <strong>imap_mail()</strong>
   * PEAR::Mail
   * PEAR::Mail_Mime


id: mailparse_determine_best_xfer_encoding
type: function
doc:
<comment>Description:</comment>
  Gets the best way of encoding
  
  Figures out the best way of encoding the content read from the given file pointer.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fp</strong>  A valid file pointer, which must be seek-able.

<comment>Return:</comment>
  <info>string</info>  Returns one of the character encodings supported by the mbstring module.


id: mailparse_msg_create
type: function
doc:
<comment>Description:</comment>
  Create a mime mail resource
  
  Create a <return>MIME</return> mail resource.

<comment>Return:</comment>
  <info>resource</info>  Returns a handle that can be used to parse a message.

<comment>See Also:</comment>
   * <strong>mailparse_msg_free()</strong>
   * <strong>mailparse_msg_parse_file()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>      A valid <return>MIME</return> resource.
  <info>string</info>    <strong>$msgbody</strong>       
  <info>callable</info>  <strong>$callbackfunc</strong>  

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

<comment>See Also:</comment>
   * <strong>mailparse_msg_extract_part_file()</strong>
   * <strong>mailparse_msg_extract_whole_part_file()</strong>


id: mailparse_msg_extract_part_file
type: function
doc:
<comment>Description:</comment>
  Extracts/decodes a message section
  
  Extracts/decodes a message section from the supplied filename.
  
  The contents of the section will be decoded according to their transfer encoding - base64,
  quoted-printable and uuencoded text are supported.

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>      A valid <return>MIME</return> resource, created with <strong>mailparse_msg_create()</strong>.
  <info>mixed</info>     <strong>$filename</strong>      Can be a file name or a valid stream resource.
  <info>callable</info>  <strong>$callbackfunc</strong>  If set, this must be either a valid callback that will be passed the
                           extracted section, or <info>null</info> to make this function return the extracted
                           section.
                           
                           If not specified, the contents will be sent to "stdout".

<comment>Return:</comment>
  <info>string</info>  If <strong>$callbackfunc</strong> is not <info>null</info> returns <info>true</info> on success.
          
          If <strong>$callbackfunc</strong> is set to <info>null</info>, returns the extracted section as a string.
          
          Returns <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>mailparse_msg_extract_part()</strong>
   * <strong>mailparse_msg_extract_whole_part_file()</strong>


id: mailparse_msg_extract_whole_part_file
type: function
doc:
<comment>Description:</comment>
  Extracts a message section including headers without decoding the transfer encoding
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>      A valid <return>MIME</return> resource.
  <info>string</info>    <strong>$filename</strong>      
  <info>callable</info>  <strong>$callbackfunc</strong>  

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

<comment>See Also:</comment>
   * <strong>mailparse_msg_extract_part()</strong>
   * <strong>mailparse_msg_extract_part_file()</strong>


id: mailparse_msg_free
type: function
doc:
<comment>Description:</comment>
  Frees a MIME resource
  
  Frees a <return>MIME</return> resource.

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>  A valid <return>MIME</return> resource allocated by <strong>mailparse_msg_create()</strong> or
                       <strong>mailparse_msg_parse_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.

<comment>See Also:</comment>
   * <strong>mailparse_msg_create()</strong>
   * <strong>mailparse_msg_parse_file()</strong>


id: mailparse_msg_get_part
type: function
doc:
<comment>Description:</comment>
  Returns a handle on a given section in a mimemessage
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>     A valid <return>MIME</return> resource.
  <info>string</info>    <strong>$mimesection</strong>  

<comment>Return:</comment>
  <info>resource</info>  


id: mailparse_msg_get_part_data
type: function
doc:
<comment>Description:</comment>
  Returns an associative array of info about the message
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>  A valid <return>MIME</return> resource.

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


id: mailparse_msg_get_structure
type: function
doc:
<comment>Description:</comment>
  Returns an array of mime section names in the supplied message
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>  A valid <return>MIME</return> resource.

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


id: mailparse_msg_parse
type: function
doc:
<comment>Description:</comment>
  Incrementally parse data into buffer
  
  Incrementally parse data into the supplied mime mail resource.
  
  This function allow you to stream portions of a file at a time, rather than read and parse the
  whole thing.

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>  A valid <return>MIME</return> resource.
  <info>string</info>    <strong>$data</strong>      The final chunk of <strong>$data</strong> is supposed to end with a newline (<return>CRLF</return>); otherwise
                       the last line of the message will not be parsed.

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


id: mailparse_msg_parse_file
type: function
doc:
<comment>Description:</comment>
  Parses a file
  
  Parses a file. This is the optimal way of parsing a mail file that you have on disk.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Path to the file holding the message. The file is opened and streamed through
                     the parser.
                     
                     The message contained in <strong>$filename</strong> is supposed to end with a newline (<return>CRLF</return>);
                     otherwise the last line of the message will not be parsed.

<comment>Return:</comment>
  <info>resource</info>  Returns a <return>MIME</return> resource representing the structure, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>mailparse_msg_free()</strong>
   * <strong>mailparse_msg_create()</strong>


id: mailparse_rfc822_parse_addresses
type: function
doc:
<comment>Description:</comment>
  Parse RFC 822 compliant addresses
  
  Parses a RFC 822 compliant recipient list, such as that found in the <return>To:</return> header.

<comment>Param:</comment>
  <info>string</info>  <strong>$addresses</strong>  A string containing addresses, like in: <return>Wez Furlong \<wez@example.com&gt;, doe@example.com</return>
                      
                      This string must not include the header name.

<comment>Return:</comment>
  <info>array</info>  Returns an array of associative arrays with the following keys for each recipient: <return>display</return>
         The recipient name, for display purpose. If this part is not set for a recipient, this key
         will hold the same value as  <return>address</return>. <return>address</return>The email address<return>is_group</return><info>true</info> if the recipient
         is a newsgroup, <info>false</info> otherwise.


id: mailparse_stream_encode
type: function
doc:
<comment>Description:</comment>
  Streams data from source file pointer, apply encoding and write to destfp 
    
  
  Streams data from the source file pointer, apply  <strong>$encoding</strong> and write to the destination file
  pointer.

<comment>Param:</comment>
  <info>resource</info>  <strong>$sourcefp</strong>  A valid file handle. The file is streamed through the parser.
  <info>resource</info>  <strong>$destfp</strong>    The destination file handle in which the encoded data will be written.
  <info>string</info>    <strong>$encoding</strong>  One of the character encodings supported by the mbstring module.

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


id: mailparse_uudecode_all
type: function
doc:
<comment>Description:</comment>
  Scans the data from fp and extract each embedded uuencoded file
    
  
  Scans the data from the given file pointer and extract each embedded uuencoded file into a
  temporary file.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fp</strong>  A valid file pointer.

<comment>Return:</comment>
  <info>array</info>  Returns an array of associative arrays listing filename information. <return>filename</return>Path to the
         temporary file name created<return>origfilename</return>The original filename, for uuencoded parts only The
         first filename entry is the message body. The next entries are the decoded uuencoded files.


id: max
type: function
doc:
<comment>Description:</comment>
  Bestimmt den Maximalwert
  
  Alternative Signatur (benannte Parameter werden nicht unterstützt):
  
  Ist der erste und einzige Parameter ein Array, gibt <strong>max()</strong> den größten Wert dieses Arrays zurück.
  Werden mindestens zwei Parameter übergeben, gibt <strong>max()</strong> den größeren dieser Werte zurück.
  
  Werte unterschiedlichen Typs werden unter Verwendung der Standard-Vergleichsregeln verglichen. Zum
  Beispiel wird ein nichtnumerischer <info>string</info> mit einem <info>int</info> verglichen, als ob er <return>0</return> wäre, aber mehrere
  nichtnumerische <info>string</info>-Werte werden alphanumerisch verglichen. Der tatsächlich zurückgegebene Wert
  ist vom ursprünglichen Typ ohne angewandte Umwandlung.
  
  Vorsicht ist geboten, wenn Argumente verschiedenen Typs übergeben werden, da <strong>max()</strong> in diesem Fall
  unvorhersehbare Ergebnisse liefert.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>        Ein vergleichbarer Wert.
  <info>mixed</info>  <strong>$values</strong>       Jegliche vergleichbaren Werte.
  <info>array</info>  <strong>$value_array</strong>  Ein Array, das Werte enthält.

<comment>Return:</comment>
  <info>mixed</info>  <strong>max()</strong> gibt den gemäß den Standard-Vergleichen als "größten" angesehenen Parameter-Wert
         zurück. Evaluieren mehrere Werte unterschiedlichen Typs als gleich (z. B. <return>0</return> und <return>'abc'</return>),
         wird der zuerst übergebene zurückgegeben.

<comment>See Also:</comment>
   * <strong>min()</strong>
   * <strong>count()</strong>


id: mb_check_encoding
type: function
doc:
<comment>Description:</comment>
  Check if strings are valid for the specified encoding
  
  Checks if the specified byte stream is valid for the specified encoding. If <strong>$value</strong> is of type
  Array, all keys and values are validated recursively. It is useful to prevent so-called "Invalid
  Encoding Attack".

<comment>Param:</comment>
  <info>array|string|null</info>  <strong>$value</strong>     The byte stream or Array to check. If it is omitted, this function
                                checks all the input from the beginning of the request.
                                
                                As of PHP 8.1.0, omitting this parameter or passing <info>null</info> is
                                deprecated.
  <info>string|null</info>        <strong>$encoding</strong>  The expected encoding.

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


id: mb_chr
type: function
doc:
<comment>Description:</comment>
  Return character by Unicode code point value
  
  Returns a string containing the character specified by the Unicode code point value, encoded in
  the specified encoding.
  
  This function complements <strong>mb_ord()</strong>.

<comment>Param:</comment>
  <info>int</info>          <strong>$codepoint</strong>  A Unicode codepoint value, e.g. <return>128024</return> for U+1F418 ELEPHANT
  <info>string|null</info>  <strong>$encoding</strong>   Der Parameter <strong>$encoding</strong>
                           legt die Zeichenkodierung fest. Wird er nicht übergeben, so wird die
                           interne
                           Zeichenkodierung genutzt.

<comment>Return:</comment>
  <info>string|false</info>  A string containing the requested character, if it can be represented in the
                specified encoding Bei einem Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_ord()</strong>
   * <strong>IntlChar::ord()</strong>
   * <strong>chr()</strong>


id: mb_convert_case
type: function
doc:
<comment>Description:</comment>
  Perform case folding on a string
  
  Performs case folding on a <info>string</info>, converted in the way specified by <strong>$mode</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> being converted.
  <info>int</info>          <strong>$mode</strong>      The mode of the conversion. It can be one of  <info>MB_CASE_UPPER</info>,
                          <info>MB_CASE_LOWER</info>,  <info>MB_CASE_TITLE</info>, <info>MB_CASE_FOLD</info>, <info>MB_CASE_UPPER_SIMPLE</info>,
                          <info>MB_CASE_LOWER_SIMPLE</info>, <info>MB_CASE_TITLE_SIMPLE</info>, <info>MB_CASE_FOLD_SIMPLE</info>.
  <info>string|null</info>  <strong>$encoding</strong>  Der Parameter <strong>$encoding</strong>
                          legt die Zeichenkodierung fest. Wird er nicht übergeben, so wird die
                          interne
                          Zeichenkodierung genutzt.

<comment>Return:</comment>
  <info>string</info>  A case folded version of <strong>$string</strong> converted in the way specified by <strong>$mode</strong>.

<comment>See Also:</comment>
   * <strong>mb_strtolower()</strong>
   * <strong>mb_strtoupper()</strong>
   * <strong>strtolower()</strong>
   * <strong>strtoupper()</strong>
   * <strong>ucfirst()</strong>
   * <strong>ucwords()</strong>


id: mb_convert_encoding
type: function
doc:
<comment>Description:</comment>
  Convert a string from one character encoding to another
  
  Converts <strong>$string</strong> from <strong>$from_encoding</strong>, or the current internal encoding, to <strong>$to_encoding</strong>. If
  <strong>$string</strong> is an Array, all its String values will be converted recursively.

<comment>Param:</comment>
  <info>array|string</info>       <strong>$string</strong>         The String or Array to be converted.
  <info>string</info>             <strong>$to_encoding</strong>    The desired encoding of the result.
  <info>array|string|null</info>  <strong>$from_encoding</strong>  The current encoding used to interpret <strong>$string</strong>. Multiple
                                     encodings may be specified as an Array or comma separated list,
                                     in which case the correct encoding will be guessed using the
                                     same algorithm as <strong>mb_detect_encoding()</strong>.
                                     
                                     If <strong>$from_encoding</strong> is omitted or <info>null</info>, the
                                     mbstring.internal_encoding setting will be used if set,
                                     otherwise the default_charset setting.
                                     
                                     See supported encodings for valid values of <strong>$to_encoding</strong> and
                                     <strong>$from_encoding</strong>.

<comment>Return:</comment>
  <info>array|string|false</info>  The encoded String or Array on success, Bei einem Fehler wird <info>false</info>
                      zurückgegeben..

<comment>See Also:</comment>
   * <strong>mb_detect_order()</strong>
   * UConverter::transcode
   * <strong>iconv()</strong>


id: mb_convert_kana
type: function
doc:
<comment>Description:</comment>
  Convert "kana" one from another ("zen-kaku", "han-kaku" and more)
  
  Performs a "han-kaku" - "zen-kaku" conversion for <info>string</info> <strong>$string</strong>.  This function is only useful
  for Japanese.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> being converted.
  <info>string</info>       <strong>$mode</strong>      The conversion option.
                          
                          Specify with a combination of following options. Applicable Conversion
                          OptionsOptionMeaning<return>r</return> Convert "zen-kaku" alphabets to "han-kaku" <return>R</return> Convert
                          "han-kaku" alphabets to "zen-kaku" <return>n</return> Convert "zen-kaku" numbers to
                          "han-kaku" <return>N</return> Convert "han-kaku" numbers to "zen-kaku" <return>a</return> Convert "zen-kaku"
                          alphabets and numbers to "han-kaku" <return>A</return> Convert "han-kaku" alphabets and
                          numbers to "zen-kaku" (Characters included in "a", "A" options are U+0021
                          - U+007E excluding U+0022, U+0027, U+005C, U+007E) <return>s</return> Convert "zen-kaku"
                          space to "han-kaku" (U+3000 -&gt; U+0020) <return>S</return> Convert "han-kaku" space to
                          "zen-kaku" (U+0020 -&gt; U+3000) <return>k</return> Convert "zen-kaku kata-kana" to
                          "han-kaku kata-kana" <return>K</return> Convert "han-kaku kata-kana" to "zen-kaku
                          kata-kana" <return>h</return> Convert "zen-kaku hira-gana" to "han-kaku kata-kana" <return>H</return>
                          Convert "han-kaku kata-kana" to "zen-kaku hira-gana" <return>c</return> Convert "zen-kaku
                          kata-kana" to "zen-kaku hira-gana" <return>C</return> Convert "zen-kaku hira-gana" to
                          "zen-kaku kata-kana" <return>V</return> Collapse voiced sound notation and convert them
                          into a character. Use with "K","H"
  <info>string|null</info>  <strong>$encoding</strong>  Der Parameter <strong>$encoding</strong>
                          legt die Zeichenkodierung fest. Wird er nicht übergeben, so wird die
                          interne
                          Zeichenkodierung genutzt.

<comment>Return:</comment>
  <info>string</info>  The converted <info>string</info>.


id: mb_convert_variables
type: function
doc:
<comment>Description:</comment>
  Convert character code in variable(s)
  
  Converts  character encoding of variables <strong>$var</strong> and <strong>$vars</strong> in encoding <strong>$from_encoding</strong> to encoding
  <strong>$to_encoding</strong>.
  
  <strong>mb_convert_variables()</strong> join strings in Array or Object to detect encoding, since encoding
  detection tends to fail for short strings. Therefore, it is impossible to mix encoding in single
  array or object.

<comment>Param:</comment>
  <info>string</info>        <strong>$to_encoding</strong>    The encoding that the <info>string</info> is being converted to.
  <info>array|string</info>  <strong>$from_encoding</strong>  <strong>$from_encoding</strong> is specified as an <info>array</info>  or comma separated <info>string</info>,
                                it tries to detect encoding from <strong>$from-coding</strong>. When <strong>$from_encoding</strong>
                                is omitted, <return>detect_order</return> is used.
  <info>mixed</info>         <strong>$var</strong>            <strong>$var</strong> is the reference to the variable being converted. String, Array
                                and Object are accepted. <strong>mb_convert_variables()</strong> assumes all
                                parameters have the same encoding.
  <info>mixed</info>         <strong>$vars</strong>           Additional <strong>$var</strong>s.

<comment>Return:</comment>
  <info>string|false</info>  The character encoding before conversion for success,  or <info>false</info> for failure.


id: mb_decode_mimeheader
type: function
doc:
<comment>Description:</comment>
  Decode string in MIME header field
  
  Decodes encoded-word <info>string</info> <strong>$string</strong> in MIME header.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The <info>string</info> being decoded.

<comment>Return:</comment>
  <info>string</info>  The decoded <info>string</info> in internal character encoding.

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


id: mb_decode_numericentity
type: function
doc:
<comment>Description:</comment>
  Decode HTML numeric string reference to character
  
  Convert numeric string reference of <info>string</info> <strong>$string</strong> in a specified block to character.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> being decoded.
  <info>array</info>        <strong>$map</strong>       <strong>$map</strong> is an <info>array</info> that specifies  the code area to convert.
  <info>string|null</info>  <strong>$encoding</strong>  Der Parameter <strong>$encoding</strong>
                          legt die Zeichenkodierung fest. Wird er nicht übergeben, so wird die
                          interne
                          Zeichenkodierung genutzt.
  <info></info>             <strong>$is_hex</strong>    This parameter is not used.

<comment>Return:</comment>
  <info>string</info>  The converted <info>string</info>.

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


id: mb_detect_encoding
type: function
doc:
<comment>Description:</comment>
  Detect character encoding
  
  Detects the most likely character encoding for <info>string</info> <strong>$string</strong> from an ordered list of candidates.
  
  Automatic detection of the intended character encoding can never be entirely reliable; without
  some additional information, it is similar to decoding an encrypted string without the key. It is
  always preferable to use an indication of character encoding stored or transmitted with the data,
  such as a "Content-Type" HTTP header.
  
  This function is most useful with multibyte encodings, where not all sequences of bytes form a
  valid string. If the input string contains such a sequence, that encoding will be rejected, and
  the next encoding checked.

<comment>Param:</comment>
  <info>string</info>             <strong>$string</strong>     The <info>string</info> being inspected.
  <info>array|string|null</info>  <strong>$encodings</strong>  A list of character encodings to try, in order. The list may be
                                 specified as an array of strings, or a single string separated by
                                 commas.
                                 
                                 If <strong>$encodings</strong> is omitted or <info>null</info>, the current detect_order (set
                                 with the  mbstring.detect_order configuration option, or
                                 <strong>mb_detect_order()</strong> function) will be used.
  <info>bool</info>               <strong>$strict</strong>     Controls the behaviour when <strong>$string</strong> is not valid in any of the
                                 listed <strong>$encodings</strong>. If <strong>$strict</strong> is set to <info>false</info>, the closest matching
                                 encoding will be returned; if <strong>$strict</strong> is set to <info>true</info>, <info>false</info> will be
                                 returned.
                                 
                                 The default value for <strong>$strict</strong> can be set with the
                                 mbstring.strict_detection configuration option.

<comment>Return:</comment>
  <info>string|false</info>  The detected character encoding, or <info>false</info> if the string is not valid in any of the
                listed encodings.

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


id: mb_detect_order
type: function
doc:
<comment>Description:</comment>
  Set/Get character encoding detection order
  
  Sets the automatic character encoding detection order to <strong>$encoding</strong>.

<comment>Param:</comment>
  <info>array|string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> is an <info>array</info> or  comma separated list of character
                                encoding. See supported encodings.
                                
                                If <strong>$encoding</strong> is omitted or <info>null</info>, it returns the current character
                                encoding detection order as array.
                                
                                This setting affects <strong>mb_detect_encoding()</strong> and <strong>mb_send_mail()</strong>.
                                
                                <return>mbstring</return> currently implements the following encoding detection
                                filters. If there is an invalid byte sequence for the following
                                encodings, encoding detection will fail.
                                
                                <return>UTF-8</return>, <return>UTF-7</return>, <return>ASCII</return>, <return>EUC-JP</return>,<return>SJIS</return>, <return>eucJP-win</return>, <return>SJIS-win</return>, <return>JIS</return>,
                                <return>ISO-2022-JP</return>
                                
                                For <return>ISO-8859-*</return>, <return>mbstring</return> always detects as <return>ISO-8859-*</return>.
                                
                                For <return>UTF-16</return>, <return>UTF-32</return>, <return>UCS2</return> and <return>UCS4</return>, encoding detection will fail
                                always.

<comment>Return:</comment>
  <info>array|bool</info>  When setting the encoding detection order, <info>true</info> is returned on success or <info>false</info> on
              failure.
              
              When getting the encoding detection order, an ordered array of the encodings is
              returned.

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_http_input()</strong>
   * <strong>mb_http_output()</strong>
   * <strong>mb_send_mail()</strong>


id: mb_encode_mimeheader
type: function
doc:
<comment>Description:</comment>
  Encode string for MIME header
  
  Encodes a given <info>string</info> <strong>$string</strong> by the MIME header encoding scheme.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>             The <info>string</info> being encoded. Its encoding should be same as
                                   <strong>mb_internal_encoding()</strong>.
  <info>string|null</info>  <strong>$charset</strong>            <strong>$charset</strong> specifies the name of the character set in which <strong>$string</strong>
                                   is represented in. The default value is determined by the current
                                   NLS setting (<return>mbstring.language</return>).
  <info>string|null</info>  <strong>$transfer_encoding</strong>  <strong>$transfer_encoding</strong> specifies the scheme of MIME encoding. It
                                   should be either <return>"B"</return> (Base64) or <return>"Q"</return> (Quoted-Printable). Falls
                                   back to <return>"B"</return> if not given.
  <info>string</info>       <strong>$newline</strong>            <strong>$newline</strong> specifies the EOL (end-of-line) marker with which
                                   <strong>mb_encode_mimeheader()</strong> performs line-folding (a RFC term, the act
                                   of breaking a line longer than a certain length into multiple
                                   lines. The length is currently hard-coded to 74 characters).
                                   Falls back to <return>"\r\n"</return> (CRLF) if not given.
  <info>int</info>          <strong>$indent</strong>             Indentation of the first line (number of characters in the header
                                   before <strong>$string</strong>).

<comment>Return:</comment>
  <info>string</info>  A converted version of the <info>string</info> represented in ASCII.

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


id: mb_encode_numericentity
type: function
doc:
<comment>Description:</comment>
  Encode character to HTML numeric string reference
  
  Converts specified character codes in <info>string</info> <strong>$string</strong> from character code to HTML numeric character
  reference.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> being encoded.
  <info>array</info>        <strong>$map</strong>       <strong>$map</strong> is array specifies code area to convert.
  <info>string|null</info>  <strong>$encoding</strong>  Der Parameter <strong>$encoding</strong>
                          legt die Zeichenkodierung fest. Wird er nicht übergeben, so wird die
                          interne
                          Zeichenkodierung genutzt.
  <info>bool</info>         <strong>$hex</strong>       Whether the returned entity reference should be in hexadecimal notation
                          (otherwise it is in decimal notation).

<comment>Return:</comment>
  <info>string</info>  The converted <info>string</info>.

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


id: mb_encoding_aliases
type: function
doc:
<comment>Description:</comment>
  Get aliases of a known encoding type
  
  Returns an array of aliases for a known <strong>$encoding</strong> type.

<comment>Param:</comment>
  <info>string</info>  <strong>$encoding</strong>  The encoding type being checked, for aliases.

<comment>Return:</comment>
  <info>array</info>  Returns a numerically indexed array of encoding aliases.

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


id: mb_ereg
type: function
doc:
<comment>Description:</comment>
  Regular expression match with multibyte support
  
  Executes the regular expression match with multibyte support.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  The search pattern.
  <info>string</info>  <strong>$string</strong>   The search <info>string</info>.
  <info>array</info>   <strong>$matches</strong>  If matches are found for parenthesized substrings of <strong>$pattern</strong> and the function
                    is called with the third argument <strong>$matches</strong>, the matches will be stored in the
                    elements of the array <strong>$matches</strong>. If no matches are found, <strong>$matches</strong> is set to an
                    empty array.
                    
                    $matches[1] will contain the substring which starts at the first left
                    parenthesis; $matches[2] will contain the substring starting at the second, and
                    so on. $matches[0] will contain a copy of the complete string matched.

<comment>Return:</comment>
  <info>bool</info>  Returns whether <strong>$pattern</strong> matches <strong>$string</strong>.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_eregi()</strong>


id: mb_ereg_match
type: function
doc:
<comment>Description:</comment>
  Regular expression match for multibyte string
  
  A regular expression match for a multibyte string <strong>$pattern</strong> is only matched at the beginning of
  <strong>$string</strong>.
  
  <strong>$pattern</strong> is only matched at the beginning of <strong>$string</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$pattern</strong>  The regular expression pattern.
  <info>string</info>       <strong>$string</strong>   The <info>string</info> being evaluated.
  <info>string|null</info>  <strong>$options</strong>  The search option. See <strong>mb_regex_set_options()</strong> for explanation.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$string</strong> matches the regular expression <strong>$pattern</strong>, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg()</strong>


id: mb_ereg_replace
type: function
doc:
<comment>Description:</comment>
  Replace regular expression with multibyte support
  
  Scans <strong>$string</strong> for matches to <strong>$pattern</strong>, then replaces the matched text with <strong>$replacement</strong>

<comment>Param:</comment>
  <info>string</info>       <strong>$pattern</strong>      The regular expression pattern.
                             
                             Multibyte characters may be used in <strong>$pattern</strong>.
  <info>string</info>       <strong>$replacement</strong>  The replacement text.
  <info>string</info>       <strong>$string</strong>       The <info>string</info> being checked.
  <info>string|null</info>  <strong>$options</strong>      The search option. See <strong>mb_regex_set_options()</strong> for explanation.

<comment>Return:</comment>
  <info>string|false|null</info>  The resultant <info>string</info> on success, or <info>false</info> on error. If <strong>$string</strong> is not valid for
                     the current encoding, <info>null</info> is returned.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_eregi_replace()</strong>


id: mb_ereg_replace_callback
type: function
doc:
<comment>Description:</comment>
  Perform a regular expression search and replace with multibyte support using a callback
    
  
  Scans <strong>$string</strong> for matches to <strong>$pattern</strong>, then replaces the matched text with the output of <strong>$callback</strong>
  function.
  
  The behavior of this function is almost identical to <strong>mb_ereg_replace()</strong>,  except for the fact that
  instead of <strong>$replacement</strong> parameter, one should specify a <strong>$callback</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$pattern</strong>   The regular expression pattern.
                          
                          Multibyte characters may be used in <strong>$pattern</strong>.
  <info>callable</info>     <strong>$callback</strong>  A callback that will be called and passed an array of matched elements in
                          the  <strong>$subject</strong> string. The callback should return the replacement string.
                          
                          You'll often need the <strong>$callback</strong> function for a <strong>mb_ereg_replace_callback()</strong>
                          in just one place. In this case you can use an anonymous function to
                          declare the callback within the call to <strong>mb_ereg_replace_callback()</strong>. By
                          doing it this way you have all information for the call in one place and
                          do not clutter the function namespace with a callback function's name not
                          used anywhere else.
  <info>string</info>       <strong>$string</strong>    The <info>string</info> being checked.
  <info>string|null</info>  <strong>$options</strong>   The search option. See <strong>mb_regex_set_options()</strong> for explanation.

<comment>Return:</comment>
  <info>string|false|null</info>  The resultant <info>string</info> on success, or <info>false</info> on error. If <strong>$string</strong> is not valid for
                     the current encoding, <info>null</info> is returned.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_replace()</strong>
   * Anonymous functions


id: mb_ereg_search
type: function
doc:
<comment>Description:</comment>
  Multibyte regular expression match for predefined multibyte string
  
  Performs a multibyte regular expression match for a predefined multibyte string.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$pattern</strong>  The search pattern.
  <info>string|null</info>  <strong>$options</strong>  The search option. See <strong>mb_regex_set_options()</strong> for explanation.

<comment>Return:</comment>
  <info>bool</info>  <strong>mb_ereg_search()</strong> returns <info>true</info> if the multibyte string matches with the regular expression,
        or <info>false</info> otherwise. The <info>string</info> for matching is set by  <strong>mb_ereg_search_init()</strong>. If <strong>$pattern</strong> is
        not specified, the previous one is used.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_ereg_search_getpos
type: function
doc:
<comment>Description:</comment>
  Returns start point for next regular expression match
  
  Returns the start point for the next regular expression match.

<comment>Return:</comment>
  <info>int</info>  <strong>mb_ereg_search_getpos()</strong> returns the point to start regular expression match for
       <strong>mb_ereg_search()</strong>, <strong>mb_ereg_search_pos()</strong>, <strong>mb_ereg_search_regs()</strong>. The position is represented by
       bytes from the head of string.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_setpos()</strong>


id: mb_ereg_search_getregs
type: function
doc:
<comment>Description:</comment>
  Retrieve the result from the last multibyte regular expression match
  
  Retrieve the result from the last multibyte regular expression match

<comment>Return:</comment>
  <info>array|false</info>  An <info>array</info> including the sub-string of matched part by last <strong>mb_ereg_search()</strong>,
               <strong>mb_ereg_search_pos()</strong>, <strong>mb_ereg_search_regs()</strong>. If there are some matches, the first
               element will have the matched sub-string, the second element will have the first part
               grouped with brackets,  the third element will have the second part grouped with
               brackets, and so on. It returns <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_ereg_search_init
type: function
doc:
<comment>Description:</comment>
  Setup string and regular expression for a multibyte regular expression match
  
  <strong>mb_ereg_search_init()</strong> sets <strong>$string</strong> and <strong>$pattern</strong> for a multibyte regular expression. These values
  are used for <strong>mb_ereg_search()</strong>, <strong>mb_ereg_search_pos()</strong>, and <strong>mb_ereg_search_regs()</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>   The search string.
  <info>string|null</info>  <strong>$pattern</strong>  The search pattern.
  <info>string|null</info>  <strong>$options</strong>  The search option. See <strong>mb_regex_set_options()</strong> for explanation.

<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>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_regs()</strong>


id: mb_ereg_search_pos
type: function
doc:
<comment>Description:</comment>
  Returns position and length of a matched part of the multibyte regular expression for a predefined
  multibyte string
  
  Returns position and length of a matched part of the multibyte regular expression  for a
  predefined multibyte string
  
  The string for match is specified by <strong>mb_ereg_search_init()</strong>. If it is not specified, the previous
  one will be used.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$pattern</strong>  The search pattern.
  <info>string|null</info>  <strong>$options</strong>  The search option. See <strong>mb_regex_set_options()</strong> for explanation.

<comment>Return:</comment>
  <info>array|false</info>  An <info>array</info> containing two elements. The first element is the offset, in bytes, where
               the match begins relative to the start of the search string, and the second element
               is the length in bytes of the match.
               
               If an error occurs, <info>false</info> is returned.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_ereg_search_regs
type: function
doc:
<comment>Description:</comment>
  Returns the matched part of a multibyte regular expression
  
  Returns the matched part of a multibyte regular expression.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$pattern</strong>  The search pattern.
  <info>string|null</info>  <strong>$options</strong>  The search option. See <strong>mb_regex_set_options()</strong> for explanation.

<comment>Return:</comment>
  <info>array|false</info>  <strong>mb_ereg_search_regs()</strong> executes the multibyte regular expression match, and if there
               are some matched part, it returns an <info>array</info> including substring of matched part as
               first element, the first grouped part with brackets as second element, the second
               grouped part as third element, and so on.  It returns <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_ereg_search_setpos
type: function
doc:
<comment>Description:</comment>
  Set start point of next regular expression match
  
  <strong>mb_ereg_search_setpos()</strong> sets the starting point of a match for <strong>mb_ereg_search()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  The position to set. If it is negative, it counts from the end of the string.

<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>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_eregi
type: function
doc:
<comment>Description:</comment>
  Regular expression match ignoring case with multibyte support
  
  Executes the case insensitive regular expression match with multibyte support.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  The regular expression pattern.
  <info>string</info>  <strong>$string</strong>   The <info>string</info> being searched.
  <info>array</info>   <strong>$matches</strong>  If matches are found for parenthesized substrings of <strong>$pattern</strong> and the function
                    is called with the third argument <strong>$matches</strong>, the matches will be stored in the
                    elements of the array <strong>$matches</strong>. If no matches are found, <strong>$matches</strong> is set to an
                    empty array.
                    
                    $matches[1] will contain the substring which starts at the first left
                    parenthesis; $matches[2] will contain the substring starting at the second, and
                    so on. $matches[0] will contain a copy of the complete string matched.

<comment>Return:</comment>
  <info>bool</info>  Returns whether <strong>$pattern</strong> matches <strong>$string</strong>.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg()</strong>


id: mb_eregi_replace
type: function
doc:
<comment>Description:</comment>
  Replace regular expression with multibyte support ignoring case
  
  Scans <strong>$string</strong> for matches to <strong>$pattern</strong>, then replaces the matched text with <strong>$replacement</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$pattern</strong>      The regular expression pattern.  Multibyte characters may be used. The
                             case will be ignored.
  <info>string</info>       <strong>$replacement</strong>  The replacement text.
  <info>string</info>       <strong>$string</strong>       The searched <info>string</info>.
  <info>string|null</info>  <strong>$options</strong>      The search option. See <strong>mb_regex_set_options()</strong> for explanation.

<comment>Return:</comment>
  <info>string|false|null</info>  The resultant <info>string</info> or <info>false</info> on error.  If <strong>$string</strong> is not valid for the
                     current encoding, <info>null</info> is returned.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_replace()</strong>


id: mb_get_info
type: function
doc:
<comment>Description:</comment>
  Get internal settings of mbstring
  
  <strong>mb_get_info()</strong> returns the internal setting parameters of mbstring.

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  If <strong>$type</strong> is not specified or is specified as <return>"all"</return>, <return>"internal_encoding"</return>,
                 <return>"http_input"</return>, <return>"http_output"</return>, <return>"http_output_conv_mimetypes"</return>, <return>"mail_charset"</return>,
                 <return>"mail_header_encoding"</return>, <return>"mail_body_encoding"</return>, <return>"illegal_chars"</return>,
                 <return>"encoding_translation"</return>, <return>"language"</return>, <return>"detect_order"</return>, <return>"substitute_character"</return> and
                 <return>"strict_detection"</return> will be returned.
                 
                 If <strong>$type</strong> is specified as <return>"internal_encoding"</return>, <return>"http_input"</return>, <return>"http_output"</return>,
                 <return>"http_output_conv_mimetypes"</return>, <return>"mail_charset"</return>, <return>"mail_header_encoding"</return>,
                 <return>"mail_body_encoding"</return>, <return>"illegal_chars"</return>, <return>"encoding_translation"</return>, <return>"language"</return>,
                 <return>"detect_order"</return>, <return>"substitute_character"</return> or <return>"strict_detection"</return> the specified setting
                 parameter will be returned.

<comment>Return:</comment>
  <info>array|string|int|false</info>  An <info>array</info> of type information if <strong>$type</strong>  is not specified, otherwise a
                          specific <strong>$type</strong>, Bei einem Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_http_output()</strong>


id: mb_http_input
type: function
doc:
<comment>Description:</comment>
  Detect HTTP input character encoding
  
  Detects the HTTP input character encoding.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$type</strong>  Input string specifies the input type.  <return>"G"</return> for GET, <return>"P"</return> for POST, <return>"C"</return> for
                      COOKIE, <return>"S"</return> for string, <return>"L"</return> for list, and <return>"I"</return> for the whole list (will return
                      <info>array</info>).  If type is omitted, it returns the last input type processed.

<comment>Return:</comment>
  <info>array|string|false</info>  The character encoding name, as per the <strong>$type</strong>, or an array of character
                      encoding names, if <strong>$type</strong> is <return>"I"</return>. If <strong>mb_http_input()</strong> does not process specified
                      HTTP input, it returns <info>false</info>.

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_http_output()</strong>
   * <strong>mb_detect_order()</strong>


id: mb_http_output
type: function
doc:
<comment>Description:</comment>
  Set/Get HTTP output character encoding
  
  Set/Get the HTTP output character encoding. Output after this function is called will be converted
  from the set internal encoding to <strong>$encoding</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$encoding</strong>  If <strong>$encoding</strong> is set, <strong>mb_http_output()</strong> sets the HTTP output character
                          encoding to <strong>$encoding</strong>.
                          
                          If <strong>$encoding</strong> is omitted, <strong>mb_http_output()</strong> returns the current HTTP output
                          character encoding.

<comment>Return:</comment>
  <info>string|bool</info>  If <strong>$encoding</strong> is omitted, <strong>mb_http_output()</strong> returns the current HTTP output character
               encoding. Otherwise,  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info>
               zurückgegeben.

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_http_input()</strong>
   * <strong>mb_detect_order()</strong>


id: mb_internal_encoding
type: function
doc:
<comment>Description:</comment>
  Set/Get internal character encoding
  
  Set/Get the internal character encoding

<comment>Param:</comment>
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> is the character encoding name  used for the HTTP input
                          character encoding conversion, HTTP output  character encoding conversion,
                          and the default character encoding  for string functions defined by the
                          mbstring module. You should notice that the internal encoding is totally
                          different from the one for multibyte regex.

<comment>Return:</comment>
  <info>string|bool</info>  If <strong>$encoding</strong> is set, then  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info>
               zurückgegeben. In this case, the character encoding for multibyte regex is NOT
               changed. If <strong>$encoding</strong> is omitted, then  the current character encoding name is
               returned.

<comment>See Also:</comment>
   * <strong>mb_http_input()</strong>
   * <strong>mb_http_output()</strong>
   * <strong>mb_detect_order()</strong>
   * <strong>mb_regex_encoding()</strong>


id: mb_language
type: function
doc:
<comment>Description:</comment>
  Set/Get current language
  
  Set/Get the current language.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$language</strong>  Used for encoding e-mail messages. The valid languages are listed in the
                          following table. <strong>mb_send_mail()</strong> uses this setting to encode e-mail.

<comment>Return:</comment>
  <info>string|bool</info>  If <strong>$language</strong> is set and <strong>$language</strong> is valid, it returns <info>true</info>. Otherwise, it returns
               <info>false</info>.  When <strong>$language</strong> is omitted or <info>null</info>, it returns the language name as a <info>string</info>.

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


id: mb_list_encodings
type: function
doc:
<comment>Description:</comment>
  Returns an array of all supported encodings
  
  Returns an array containing all supported encodings.

<comment>Return:</comment>
  <info>array</info>  Returns a numerically indexed array.

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


id: mb_ord
type: function
doc:
<comment>Description:</comment>
  Get Unicode code point of character
  
  Returns the Unicode code point value of the given character.
  
  This function complements <strong>mb_chr()</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    A string
  <info>string|null</info>  <strong>$encoding</strong>  Der Parameter <strong>$encoding</strong>
                          legt die Zeichenkodierung fest. Wird er nicht übergeben, so wird die
                          interne
                          Zeichenkodierung genutzt.

<comment>Return:</comment>
  <info>int|false</info>  The Unicode code point for the first character of <return>string</return> Bei einem Fehler wird <info>false</info>
             zurückgegeben..

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_chr()</strong>
   * <strong>IntlChar::ord()</strong>
   * <strong>ord()</strong>


id: mb_output_handler
type: function
doc:
<comment>Description:</comment>
  Callback function converts character encoding in output buffer
  
  <strong>mb_output_handler()</strong> is <strong>ob_start()</strong> callback function. <strong>mb_output_handler()</strong> converts characters in
  the output buffer from internal character encoding to HTTP output character encoding.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The contents of the output buffer.
  <info>int</info>     <strong>$status</strong>  The status of the output buffer.

<comment>Return:</comment>
  <info>string</info>  The converted <info>string</info>.

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


id: mb_parse_str
type: function
doc:
<comment>Description:</comment>
  Parse GET/POST/COOKIE data and set global variable
  
  Parses GET/POST/COOKIE data and sets global variables. Since PHP does not provide raw POST/COOKIE
  data, it can only be used for GET data for now. It parses URL encoded data, detects encoding,
  converts coding to internal encoding and set values to the <strong>$result</strong> <info>array</info> or global variables.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The URL encoded data.
  <info>array</info>   <strong>$result</strong>  An <info>array</info> containing decoded and character encoded converted values.

<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>mb_detect_order()</strong>
   * <strong>mb_internal_encoding()</strong>


id: mb_preferred_mime_name
type: function
doc:
<comment>Description:</comment>
  Get MIME charset string
  
  Get a MIME charset <info>string</info> for a specific encoding.

<comment>Param:</comment>
  <info>string</info>  <strong>$encoding</strong>  The encoding being checked.

<comment>Return:</comment>
  <info>string|false</info>  The MIME <return>charset</return> <info>string</info> for character encoding <strong>$encoding</strong>, or <info>false</info> if no charset is
                preferred for the given <strong>$encoding</strong>.


id: mb_regex_encoding
type: function
doc:
<comment>Description:</comment>
  Set/Get character encoding for multibyte regex
  
  Set/Get character encoding for a multibyte regex.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$encoding</strong>  Der Parameter <strong>$encoding</strong>
                          legt die Zeichenkodierung fest. Wird er nicht übergeben, so wird die
                          interne
                          Zeichenkodierung genutzt.

<comment>Return:</comment>
  <info>string|bool</info>  If <strong>$encoding</strong> is set, then  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info>
               zurückgegeben.  In this case, the internal character encoding is NOT changed. If
               <strong>$encoding</strong> is omitted, then  the current character encoding name for a multibyte regex
               is returned.

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_ereg()</strong>


id: mb_regex_set_options
type: function
doc:
<comment>Description:</comment>
  Set/Get the default options for mbregex functions
  
  Sets the default options described by <strong>$options</strong>  for multibyte regex functions.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$options</strong>  The options to set. This is a string where each  character is an option. To
                         set a mode, the mode  character must be the last one set, however there
                         can only be set one mode but multiple options.
                         
                         The <return>"e"</return> option has no effect when set through <strong>mb_regex_set_options()</strong>. Use
                         it with <strong>mb_ereg_replace()</strong> or <strong>mb_eregi_replace()</strong>.

<comment>Return:</comment>
  <info>string</info>  The previous options. If <strong>$options</strong> is omitted or <info>null</info>,  it returns the <info>string</info> that
          describes the current options.

<comment>See Also:</comment>
   * <strong>mb_split()</strong>
   * <strong>mb_ereg()</strong>
   * <strong>mb_eregi()</strong>


id: mb_scrub
type: function
doc:
<comment>Description:</comment>
  Replace ill-formed byte sequences with the substitute character
  
  Perform a character set conversion from the specified encoding, or the default encoding if no
  encoding was specified, to the same encoding. This has the effect of replacing any invalid byte
  sequences with the substitute character.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The input string.
  <info>string|null</info>  <strong>$encoding</strong>  The encoding used to interpret <strong>$string</strong>. If it is omitted or <info>null</info>, the
                          mbstring.internal_encoding setting will be used if set, otherwise the
                          default_charset setting will be used.

<comment>Return:</comment>
  <info>string</info>  The String result with invalid byte sequences replaced.


id: mb_send_mail
type: function
doc:
<comment>Description:</comment>
  Send encoded mail
  
  Sends email. Headers and messages are converted and encoded according to the <strong>mb_language()</strong>
  setting. It's a wrapper function for <strong>mail()</strong>, so see also <strong>mail()</strong> for details.

<comment>Param:</comment>
  <info>string</info>        <strong>$to</strong>                  The mail addresses being sent to. Multiple recipients may be
                                     specified by putting a comma between each address in <strong>$to</strong>.  This
                                     parameter is not automatically encoded.
  <info>string</info>        <strong>$subject</strong>             The subject of the mail.
  <info>string</info>        <strong>$message</strong>             The message of the mail.
  <info>array|string</info>  <strong>$additional_headers</strong>  <info>String</info> or <info>array</info> to be inserted at the end of the email header.
                                     
                                     This is typically used to add extra headers (From, Cc, and
                                     Bcc). Multiple extra headers should be separated with a CRLF
                                     (\r\n). Validate parameter not to be injected unwanted headers
                                     by attackers.
                                     
                                     If an <info>array</info> is passed, its keys are the header names and its
                                     values are the respective header values.
                                     
                                     When sending mail, the mail must contain a <return>From</return> header. This
                                     can be set with the  <strong>$additional_headers</strong> parameter, or a
                                     default can be set in php.ini.
                                     
                                     Failing to do this will result in an error message similar to
                                     <return>Warning: mail(): "sendmail_from" not set in php.ini or custom
                                     "From:" header missing</return>. The <return>From</return> header sets also <return>Return-Path</return>
                                     under Windows.
                                     
                                     If messages are not received, try using a LF (\n) only. Some
                                     Unix mail transfer agents (most notably qmail) replace LF by
                                     CRLF automatically (which leads to doubling CR if CRLF is
                                     used). This should be a last resort, as it does not comply with
                                     RFC 2822.
  <info>string|null</info>   <strong>$additional_params</strong>   <strong>$additional_params</strong> is a MTA command line parameter. It is
                                     useful when setting the correct Return-Path header when using
                                     sendmail.
                                     
                                     This parameter is escaped by <strong>escapeshellcmd()</strong> internally to
                                     prevent command execution. <strong>escapeshellcmd()</strong> prevents command
                                     execution, but allows to add additional parameters. For
                                     security reason, this parameter should be validated.
                                     
                                     Since <strong>escapeshellcmd()</strong> is applied automatically, some
                                     characters that are allowed as email addresses by internet RFCs
                                     cannot be used. Programs that are required to use these
                                     characters <strong>mail()</strong> cannot be used.
                                     
                                     The user that the webserver runs as should be added as a
                                     trusted user to the sendmail configuration to prevent a
                                     'X-Warning' header from being added to the message when the
                                     envelope sender (-f) is set using this method. For sendmail
                                     users, this file is /etc/mail/trusted-users.

<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>mail()</strong>
   * <strong>mb_encode_mimeheader()</strong>
   * <strong>mb_language()</strong>


id: mb_split
type: function
doc:
<comment>Description:</comment>
  Split multibyte string using regular expression
  
  Split a multibyte <strong>$string</strong> using regular expression <strong>$pattern</strong> and returns the result as an <info>array</info>.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  The regular expression pattern.
  <info>string</info>  <strong>$string</strong>   The <info>string</info> being split.
  <info>int</info>     <strong>$limit</strong>    If optional parameter <strong>$limit</strong> is specified,  it will be split in <strong>$limit</strong> elements
                    as maximum.

<comment>Return:</comment>
  <info>array|false</info>  The result as an <info>array</info>, Bei einem Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg()</strong>


id: mb_str_pad
type: function
doc:
<comment>Description:</comment>
  Pad a multibyte string to a certain length with another multibyte string
  
  This function returns the <strong>$string</strong> padded on the left, the right, or both sides to the specified
  padding length, where the length is measured in Unicode codepoints. If the optional argument
  <strong>$pad_string</strong> is not supplied, the <strong>$string</strong> is padded with spaces, otherwise it is padded with
  characters from <strong>$pad_string</strong> up to the limit.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>      The input string.
  <info>int</info>          <strong>$length</strong>      If the value of <strong>$length</strong> is negative, less than, or equal to the length
                            of the input string, no padding takes place, and <strong>$string</strong> will be
                            returned.
  <info>string</info>       <strong>$pad_string</strong>  The <strong>$pad_string</strong> may be truncated if the required number of padding
                            characters can't be evenly divided by the <strong>$pad_string</strong>'s length.
  <info>int</info>          <strong>$pad_type</strong>    Optional argument <strong>$pad_type</strong> can be <info>STR_PAD_RIGHT</info>, <info>STR_PAD_LEFT</info>, or
                            <info>STR_PAD_BOTH</info>. By default <info>STR_PAD_RIGHT</info>.
  <info>string|null</info>  <strong>$encoding</strong>    Der Parameter <strong>$encoding</strong>
                            legt die Zeichenkodierung fest. Wird er nicht übergeben, so wird die
                            interne
                            Zeichenkodierung genutzt.

<comment>Return:</comment>
  <info>string</info>  Returns the padded string.


id: mb_str_split
type: function
doc:
<comment>Description:</comment>
  Given a multibyte string, return an array of its characters
  
  This function will return an array of strings, it is a version of <strong>str_split()</strong> with support for
  encodings of variable character size as well as fixed-size encodings of 1,2 or 4 byte characters.
  If the <strong>$length</strong> parameter is specified, the string is broken down into chunks of the specified
  length in characters (not bytes). The <strong>$encoding</strong> parameter can be optionally specified and it is
  good practice to do so.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The String to split into characters or chunks.
  <info>int</info>          <strong>$length</strong>    If specified, each element of the returned array will be composed of
                          multiple characters instead of a single character.
  <info>string|null</info>  <strong>$encoding</strong>  Der Parameter <strong>$encoding</strong>
                          legt die Zeichenkodierung fest. Wird er nicht übergeben, so wird die
                          interne
                          Zeichenkodierung genutzt.
                          
                          A string specifying one of the supported encodings.

<comment>Return:</comment>
  <info>array</info>  <strong>mb_str_split()</strong> returns an array of strings.

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


id: mb_strcut
type: function
doc:
<comment>Description:</comment>
  Get part of string
  
  <strong>mb_strcut()</strong> extracts a substring from a string similarly to <strong>mb_substr()</strong>, but operates on bytes
  instead of characters. If the cut position happens to be between two bytes of a multi-byte
  character, the cut is performed starting from the first byte of that character. This is also the
  difference to the <strong>substr()</strong> function, which would simply cut the string between the bytes and thus
  result in a malformed byte sequence.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> being cut.
  <info>int</info>          <strong>$start</strong>     If <strong>$start</strong> is non-negative, the returned string will start at the <strong>$start</strong>'th
                          byte position in <strong>$string</strong>, counting from zero. For instance, in the string
                          '<return>abcdef</return>', the byte at position <return>0</return> is '<return>a</return>', the byte at position <return>2</return> is '<return>c</return>',
                          and so forth.
                          
                          If <strong>$start</strong> is negative, the returned string will start at the <strong>$start</strong>'th
                          byte counting back from the end of <strong>$string</strong>. However, if the magnitude of a
                          negative <strong>$start</strong> is greater than the length of the string, the returned
                          portion will start from the beginning of <strong>$string</strong>.
  <info>int|null</info>     <strong>$length</strong>    Length in bytes. If omitted or <return>NULL</return> is passed, extract all bytes to the
                          end of the string.
                          
                          If <strong>$length</strong> is negative, the returned string will end at the <strong>$length</strong>'th
                          byte counting back from the end of <strong>$string</strong>. However, if the magnitude of a
                          negative <strong>$length</strong> is greater than the number of characters after the <strong>$start</strong>
                          position, an empty string will be returned.
  <info>string|null</info>  <strong>$encoding</strong>  Der Parameter <strong>$encoding</strong>
                          legt die Zeichenkodierung fest. Wird er nicht übergeben, so wird die
                          interne
                          Zeichenkodierung genutzt.

<comment>Return:</comment>
  <info>string</info>  <strong>mb_strcut()</strong> returns the portion of <strong>$string</strong> specified by the <strong>$start</strong> and <strong>$length</strong> parameters.

<comment>See Also:</comment>
   * <strong>mb_substr()</strong>
   * <strong>mb_internal_encoding()</strong>


id: mb_strimwidth
type: function
doc:
<comment>Description:</comment>
  Get truncated string with specified width
  
  Truncates <info>string</info> <strong>$string</strong> to specified <strong>$width</strong>, where halfwidth characters count as <return>1</return>, and fullwidth
  characters count as <return>2</return>. See http://www.unicode.org/reports/tr11/ for details regarding East Asian
  character widths.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>       The <info>string</info> being decoded.
  <info>int</info>          <strong>$start</strong>        The start position offset. Number of characters from the beginning of
                             string (first character is 0), or if start is negative, number of
                             characters from the end of the string.
  <info>int</info>          <strong>$width</strong>        The width of the desired trim. If negative width is specified, count
                             from the end of the string.  Passing negative width is deprecated as of
                             PHP 8.3.0.
                             
                             Passing negative width is deprecated as of PHP 8.3.0.
  <info>string</info>       <strong>$trim_marker</strong>  A string that is added to the end of string  when string is truncated.
  <info>string|null</info>  <strong>$encoding</strong>     Der Parameter <strong>$encoding</strong>
                             legt die Zeichenkodierung fest. Wird er nicht übergeben, so wird die
                             interne
                             Zeichenkodierung genutzt.

<comment>Return:</comment>
  <info>string</info>  The truncated <info>string</info>. If <strong>$trim_marker</strong> is set, <strong>$trim_marker</strong> replaces the last chars to
          match the <strong>$width</strong>.

<comment>See Also:</comment>
   * <strong>mb_strwidth()</strong>
   * <strong>mb_internal_encoding()</strong>


id: mb_stripos
type: function
doc:
<comment>Description:</comment>
  Finds position of first occurrence of a string within another, case insensitive
  
  <strong>mb_stripos()</strong> returns the numeric position of the first occurrence of <strong>$needle</strong> in the <strong>$haystack</strong>
  string. Unlike <strong>mb_strpos()</strong>,  <strong>mb_stripos()</strong> is case-insensitive. If <strong>$needle</strong> is not found, it returns
  <info>false</info>.

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>  The string from which to get the position of the first occurrence of
                          <strong>$needle</strong>
  <info>string</info>       <strong>$needle</strong>    The string to find in <strong>$haystack</strong>
  <info>int</info>          <strong>$offset</strong>    The position in <strong>$haystack</strong> to start searching. A negative offset counts
                          from the end of the string.
  <info>string|null</info>  <strong>$encoding</strong>  Character encoding name to use. If it is omitted, internal character
                          encoding is used.

<comment>Return:</comment>
  <info>int|false</info>  Return the numeric position of the first occurrence of <strong>$needle</strong> in the <strong>$haystack</strong> string,
             or <info>false</info> if <strong>$needle</strong> is not found.

<comment>See Also:</comment>
   * <strong>stripos()</strong>
   * <strong>strpos()</strong>
   * <strong>mb_strpos()</strong>


id: mb_stristr
type: function
doc:
<comment>Description:</comment>
  Finds first occurrence of a string within another, case insensitive
  
  <strong>mb_stristr()</strong> finds the first occurrence of <strong>$needle</strong> in <strong>$haystack</strong> and returns the portion of
  <strong>$haystack</strong>. Unlike <strong>mb_strstr()</strong>,  <strong>mb_stristr()</strong> is case-insensitive. If <strong>$needle</strong> is not found, it
  returns <info>false</info>.

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>       The string from which to get the first occurrence of <strong>$needle</strong>
  <info>string</info>       <strong>$needle</strong>         The string to find in <strong>$haystack</strong>
  <info>bool</info>         <strong>$before_needle</strong>  Determines which portion of <strong>$haystack</strong> this function returns.  If set
                               to <info>true</info>, it returns all of  <strong>$haystack</strong> from the beginning to the first
                               occurrence of <strong>$needle</strong> (excluding needle). If set to <info>false</info>, it returns
                               all of <strong>$haystack</strong> from the first occurrence of <strong>$needle</strong> to the end
                               (including needle).
  <info>string|null</info>  <strong>$encoding</strong>       Character encoding name to use. If it is omitted, internal character
                               encoding is used.

<comment>Return:</comment>
  <info>string|false</info>  Returns the portion of <strong>$haystack</strong>, or <info>false</info> if <strong>$needle</strong> is not found.

<comment>See Also:</comment>
   * <strong>stristr()</strong>
   * <strong>strstr()</strong>
   * <strong>mb_strstr()</strong>


id: mb_strlen
type: function
doc:
<comment>Description:</comment>
  Get string length
  
  Gets the length of a <info>string</info>.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> being checked for length.
  <info>string|null</info>  <strong>$encoding</strong>  Der Parameter <strong>$encoding</strong>
                          legt die Zeichenkodierung fest. Wird er nicht übergeben, so wird die
                          interne
                          Zeichenkodierung genutzt.

<comment>Return:</comment>
  <info>int</info>  Returns the number of characters in <info>string</info> <strong>$string</strong> having character encoding <strong>$encoding</strong>. A
       multi-byte character is counted as 1.

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>grapheme_strlen()</strong>
   * <strong>iconv_strlen()</strong>
   * <strong>strlen()</strong>


id: mb_strpos
type: function
doc:
<comment>Description:</comment>
  Find position of first occurrence of string in a string
  
  Finds position of the first occurrence of a <info>string</info> in a <info>string</info>.
  
  Performs a multi-byte safe <strong>strpos()</strong> operation based on number of characters. The first character's
  position is 0, the second character position is 1, and so on.

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>  The <info>string</info> being checked.
  <info>string</info>       <strong>$needle</strong>    The string to find in <strong>$haystack</strong>. In contrast with <strong>strpos()</strong>, numeric values
                          are not applied as the ordinal value of a character.
  <info>int</info>          <strong>$offset</strong>    The search offset. If it is not specified, 0 is used. A negative offset
                          counts from the end of the string.
  <info>string|null</info>  <strong>$encoding</strong>  Der Parameter <strong>$encoding</strong>
                          legt die Zeichenkodierung fest. Wird er nicht übergeben, so wird die
                          interne
                          Zeichenkodierung genutzt.

<comment>Return:</comment>
  <info>int|false</info>  Returns the numeric position of the first occurrence of <strong>$needle</strong> in the <strong>$haystack</strong>
             <info>string</info>. If <strong>$needle</strong> is not found, it returns <info>false</info>.

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>strpos()</strong>


id: mb_strrchr
type: function
doc:
<comment>Description:</comment>
  Finds the last occurrence of a character in a string within another
  
  <strong>mb_strrchr()</strong> finds the last occurrence of <strong>$needle</strong> in <strong>$haystack</strong> and returns the portion of
  <strong>$haystack</strong>. If <strong>$needle</strong> is not found, it returns <info>false</info>.

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>       The string from which to get the last occurrence of <strong>$needle</strong>
  <info>string</info>       <strong>$needle</strong>         The string to find in <strong>$haystack</strong>
  <info>bool</info>         <strong>$before_needle</strong>  Determines which portion of <strong>$haystack</strong> this function returns.  If set
                               to <info>true</info>, it returns all of <strong>$haystack</strong> from the beginning to the last
                               occurrence of <strong>$needle</strong>. If set to <info>false</info>, it returns all of <strong>$haystack</strong>
                               from the last occurrence of <strong>$needle</strong> to the end,
  <info>string|null</info>  <strong>$encoding</strong>       Character encoding name to use. If it is omitted, internal character
                               encoding is used.

<comment>Return:</comment>
  <info>string|false</info>  Returns the portion of <strong>$haystack</strong>. or <info>false</info> if <strong>$needle</strong> is not found.

<comment>See Also:</comment>
   * <strong>strrchr()</strong>
   * <strong>mb_strstr()</strong>
   * <strong>mb_strrichr()</strong>


id: mb_strrichr
type: function
doc:
<comment>Description:</comment>
  Finds the last occurrence of a character in a string within another, case insensitive
  
  <strong>mb_strrichr()</strong> finds the last occurrence of <strong>$needle</strong> in <strong>$haystack</strong> and returns the portion of
  <strong>$haystack</strong>. Unlike <strong>mb_strrchr()</strong>, <strong>mb_strrichr()</strong> is case-insensitive. If <strong>$needle</strong> is not found, it
  returns <info>false</info>.

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>       The string from which to get the last occurrence of <strong>$needle</strong>
  <info>string</info>       <strong>$needle</strong>         The string to find in <strong>$haystack</strong>
  <info>bool</info>         <strong>$before_needle</strong>  Determines which portion of <strong>$haystack</strong> this function returns.  If set
                               to <info>true</info>, it returns all of <strong>$haystack</strong> from the beginning to the last
                               occurrence of <strong>$needle</strong>. If set to <info>false</info>, it returns all of <strong>$haystack</strong>
                               from the last occurrence of <strong>$needle</strong> to the end,
  <info>string|null</info>  <strong>$encoding</strong>       Character encoding name to use. If it is omitted, internal character
                               encoding is used.

<comment>Return:</comment>
  <info>string|false</info>  Returns the portion of <strong>$haystack</strong>. or <info>false</info> if <strong>$needle</strong> is not found.

<comment>See Also:</comment>
   * <strong>mb_stristr()</strong>
   * <strong>mb_strrchr()</strong>


id: mb_strripos
type: function
doc:
<comment>Description:</comment>
  Finds position of last occurrence of a string within another, case insensitive
  
  <strong>mb_strripos()</strong> performs multi-byte safe <strong>strripos()</strong> operation based on number of characters. <strong>$needle</strong>
  position is counted from the beginning of <strong>$haystack</strong>. First character's position is 0. Second
  character position is 1.  Unlike <strong>mb_strrpos()</strong>, <strong>mb_strripos()</strong> is case-insensitive.

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>  The string from which to get the position of the last occurrence of
                          <strong>$needle</strong>
  <info>string</info>       <strong>$needle</strong>    The string to find in <strong>$haystack</strong>
  <info>int</info>          <strong>$offset</strong>    The position in <strong>$haystack</strong> to start searching
  <info>string|null</info>  <strong>$encoding</strong>  Character encoding name to use. If it is omitted, internal character
                          encoding is used.

<comment>Return:</comment>
  <info>int|false</info>  Return the numeric position of the last occurrence of <strong>$needle</strong> in the <strong>$haystack</strong> string,
             or <info>false</info> if <strong>$needle</strong> is not found.

<comment>See Also:</comment>
   * <strong>strripos()</strong>
   * <strong>strrpos()</strong>
   * <strong>mb_strrpos()</strong>


id: mb_strrpos
type: function
doc:
<comment>Description:</comment>
  Find position of last occurrence of a string in a string
  
  Performs a multibyte safe <strong>strrpos()</strong> operation based on the  number of characters. <strong>$needle</strong> position
  is counted from the beginning of <strong>$haystack</strong>. First character's position is 0. Second character
  position is 1.

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>  The <info>string</info> being checked, for the last occurrence of <strong>$needle</strong>
  <info>string</info>       <strong>$needle</strong>    The <info>string</info> to find in <strong>$haystack</strong>.
  <info>int</info>          <strong>$offset</strong>    May be specified to begin searching an arbitrary number of characters into
                          the <info>string</info>.  Negative values will stop searching at an arbitrary point
                          prior to the end of the <info>string</info>.
  <info>string|null</info>  <strong>$encoding</strong>  Der Parameter <strong>$encoding</strong>
                          legt die Zeichenkodierung fest. Wird er nicht übergeben, so wird die
                          interne
                          Zeichenkodierung genutzt.

<comment>Return:</comment>
  <info>int|false</info>  Returns the numeric position of the last occurrence of <strong>$needle</strong> in the <strong>$haystack</strong> <info>string</info>.
             If <strong>$needle</strong> is not found, it returns <info>false</info>.

<comment>See Also:</comment>
   * <strong>mb_strpos()</strong>
   * <strong>mb_internal_encoding()</strong>
   * <strong>strrpos()</strong>


id: mb_strstr
type: function
doc:
<comment>Description:</comment>
  Finds first occurrence of a string within another
  
  <strong>mb_strstr()</strong> finds the first occurrence of <strong>$needle</strong> in <strong>$haystack</strong> and returns the portion of
  <strong>$haystack</strong>. If <strong>$needle</strong> is not found, it returns <info>false</info>.

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>       The string from which to get the first occurrence of <strong>$needle</strong>
  <info>string</info>       <strong>$needle</strong>         The string to find in <strong>$haystack</strong>
  <info>bool</info>         <strong>$before_needle</strong>  Determines which portion of <strong>$haystack</strong> this function returns.  If set
                               to <info>true</info>, it returns all of  <strong>$haystack</strong> from the beginning to the first
                               occurrence of <strong>$needle</strong> (excluding needle). If set to <info>false</info>, it returns
                               all of <strong>$haystack</strong> from the first occurrence of <strong>$needle</strong> to the end
                               (including needle).
  <info>string|null</info>  <strong>$encoding</strong>       Character encoding name to use. If it is omitted, internal character
                               encoding is used.

<comment>Return:</comment>
  <info>string|false</info>  Returns the portion of <strong>$haystack</strong>, or <info>false</info> if <strong>$needle</strong> is not found.

<comment>See Also:</comment>
   * <strong>stristr()</strong>
   * <strong>strstr()</strong>
   * <strong>mb_stristr()</strong>


id: mb_strtolower
type: function
doc:
<comment>Description:</comment>
  Make a string lowercase
  
  Returns <strong>$string</strong> with all alphabetic characters converted to lowercase.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> being lowercased.
  <info>string|null</info>  <strong>$encoding</strong>  Der Parameter <strong>$encoding</strong>
                          legt die Zeichenkodierung fest. Wird er nicht übergeben, so wird die
                          interne
                          Zeichenkodierung genutzt.

<comment>Return:</comment>
  <info>string</info>  <strong>$string</strong> with all alphabetic characters converted to lowercase.

<comment>See Also:</comment>
   * <strong>mb_strtoupper()</strong>
   * <strong>mb_convert_case()</strong>
   * <strong>strtolower()</strong>


id: mb_strtoupper
type: function
doc:
<comment>Description:</comment>
  Make a string uppercase
  
  Returns <strong>$string</strong> with all alphabetic characters converted to uppercase.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> being uppercased.
  <info>string|null</info>  <strong>$encoding</strong>  Der Parameter <strong>$encoding</strong>
                          legt die Zeichenkodierung fest. Wird er nicht übergeben, so wird die
                          interne
                          Zeichenkodierung genutzt.

<comment>Return:</comment>
  <info>string</info>  <strong>$string</strong> with all alphabetic characters converted to uppercase.

<comment>See Also:</comment>
   * <strong>mb_strtolower()</strong>
   * <strong>mb_convert_case()</strong>
   * <strong>strtoupper()</strong>


id: mb_strwidth
type: function
doc:
<comment>Description:</comment>
  Return width of string
  
  Returns the width of <info>string</info> <strong>$string</strong>, where halfwidth characters count as <return>1</return>, and fullwidth
  characters count as <return>2</return>. See http://www.unicode.org/reports/tr11/ for details regarding East Asian
  character widths.
  
  The fullwidth characters are: <return>U+1100</return>-<return>U+115F</return>, <return>U+11A3</return>-<return>U+11A7</return>, <return>U+11FA</return>-<return>U+11FF</return>, <return>U+2329</return>-<return>U+232A</return>,
  <return>U+2E80</return>-<return>U+2E99</return>, <return>U+2E9B</return>-<return>U+2EF3</return>, <return>U+2F00</return>-<return>U+2FD5</return>, <return>U+2FF0</return>-<return>U+2FFB</return>, <return>U+3000</return>-<return>U+303E</return>, <return>U+3041</return>-<return>U+3096</return>,
  <return>U+3099</return>-<return>U+30FF</return>, <return>U+3105</return>-<return>U+312D</return>, <return>U+3131</return>-<return>U+318E</return>, <return>U+3190</return>-<return>U+31BA</return>, <return>U+31C0</return>-<return>U+31E3</return>, <return>U+31F0</return>-<return>U+321E</return>,
  <return>U+3220</return>-<return>U+3247</return>, <return>U+3250</return>-<return>U+32FE</return>, <return>U+3300</return>-<return>U+4DBF</return>, <return>U+4E00</return>-<return>U+A48C</return>, <return>U+A490</return>-<return>U+A4C6</return>, <return>U+A960</return>-<return>U+A97C</return>,
  <return>U+AC00</return>-<return>U+D7A3</return>, <return>U+D7B0</return>-<return>U+D7C6</return>, <return>U+D7CB</return>-<return>U+D7FB</return>, <return>U+F900</return>-<return>U+FAFF</return>, <return>U+FE10</return>-<return>U+FE19</return>, <return>U+FE30</return>-<return>U+FE52</return>,
  <return>U+FE54</return>-<return>U+FE66</return>, <return>U+FE68</return>-<return>U+FE6B</return>, <return>U+FF01</return>-<return>U+FF60</return>, <return>U+FFE0</return>-<return>U+FFE6</return>, <return>U+1B000</return>-<return>U+1B001</return>, <return>U+1F200</return>-<return>U+1F202</return>,
  <return>U+1F210</return>-<return>U+1F23A</return>, <return>U+1F240</return>-<return>U+1F248</return>, <return>U+1F250</return>-<return>U+1F251</return>, <return>U+20000</return>-<return>U+2FFFD</return>, <return>U+30000</return>-<return>U+3FFFD</return>. All other
  characters are halfwidth characters.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> being decoded.
  <info>string|null</info>  <strong>$encoding</strong>  Der Parameter <strong>$encoding</strong>
                          legt die Zeichenkodierung fest. Wird er nicht übergeben, so wird die
                          interne
                          Zeichenkodierung genutzt.

<comment>Return:</comment>
  <info>int</info>  The width of <info>string</info> <strong>$string</strong>.

<comment>See Also:</comment>
   * <strong>mb_strimwidth()</strong>
   * <strong>mb_internal_encoding()</strong>


id: mb_substitute_character
type: function
doc:
<comment>Description:</comment>
  Set/Get substitution character
  
  Specifies a substitution character when input character encoding is invalid or character code does
  not exist in output character encoding. Invalid characters may be substituted <return>"none"</return> (no output),
  <info>string</info> or <info>int</info> value (Unicode character code value).
  
  This setting affects <strong>mb_convert_encoding()</strong>, <strong>mb_convert_variables()</strong>, <strong>mb_output_handler()</strong>, and
  <strong>mb_send_mail()</strong>.

<comment>Param:</comment>
  <info>string|int|null</info>  <strong>$substitute_character</strong>  Specify the Unicode value as an <info>int</info>,  or as one of the
                                          following <info>string</info>s: <return>"none"</return>: no output <return>"long"</return>: Output
                                          character code value (Example: <return>U+3000</return>, <return>JIS+7E7E</return>) <return>"entity"</return>:
                                          Output character entity (Example: <return>&#x200;</return>)
                                          
                                          <return>"none"</return>: no output
                                          
                                          <return>"long"</return>: Output character code value (Example: <return>U+3000</return>,
                                          <return>JIS+7E7E</return>)
                                          
                                          <return>"entity"</return>: Output character entity (Example: <return>&#x200;</return>)

<comment>Return:</comment>
  <info>string|int|bool</info>  If <strong>$substitute_character</strong> is set, it returns <info>true</info> for success, otherwise returns
                   <info>false</info>.  If <strong>$substitute_character</strong> is not set, it returns the current setting.


id: mb_substr
type: function
doc:
<comment>Description:</comment>
  Get part of string
  
  Performs a multi-byte safe <strong>substr()</strong> operation based on number of characters. Position is counted
  from the beginning of <strong>$string</strong>. First character's position is 0. Second character position is 1,
  and so on.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> to extract the substring from.
  <info>int</info>          <strong>$start</strong>     If <strong>$start</strong> is non-negative, the returned string will start at the <strong>$start</strong>'th
                          position in <strong>$string</strong>, counting from zero. For instance, in the string
                          '<return>abcdef</return>', the character at position <return>0</return> is '<return>a</return>', the character at position <return>2</return>
                          is '<return>c</return>', and so forth.
                          
                          If <strong>$start</strong> is negative, the returned string will start at the <strong>$start</strong>'th
                          character from the end of <strong>$string</strong>.
  <info>int|null</info>     <strong>$length</strong>    Maximum number of characters to use from <strong>$string</strong>. If omitted or <return>NULL</return> is
                          passed, extract all characters to the end of the string.
  <info>string|null</info>  <strong>$encoding</strong>  Der Parameter <strong>$encoding</strong>
                          legt die Zeichenkodierung fest. Wird er nicht übergeben, so wird die
                          interne
                          Zeichenkodierung genutzt.

<comment>Return:</comment>
  <info>string</info>  <strong>mb_substr()</strong> returns the portion of <strong>$string</strong> specified by the <strong>$start</strong> and <strong>$length</strong> parameters.

<comment>See Also:</comment>
   * <strong>mb_strcut()</strong>
   * <strong>mb_internal_encoding()</strong>


id: mb_substr_count
type: function
doc:
<comment>Description:</comment>
  Count the number of substring occurrences
  
  Counts the number of times the <strong>$needle</strong> substring occurs in the <strong>$haystack</strong> <info>string</info>.

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>  The <info>string</info> being checked.
  <info>string</info>       <strong>$needle</strong>    The <info>string</info> being found.
  <info>string|null</info>  <strong>$encoding</strong>  Der Parameter <strong>$encoding</strong>
                          legt die Zeichenkodierung fest. Wird er nicht übergeben, so wird die
                          interne
                          Zeichenkodierung genutzt.

<comment>Return:</comment>
  <info>int</info>  The number of times the <strong>$needle</strong> substring occurs in the <strong>$haystack</strong> <info>string</info>.

<comment>See Also:</comment>
   * <strong>mb_strpos()</strong>
   * <strong>mb_substr()</strong>
   * <strong>substr_count()</strong>


id: mcrypt_create_iv
type: function
doc:
<comment>Description:</comment>
  Creates an initialization vector (IV) from a random source
  
  Creates an initialization vector (IV) from a random source.
  
  The IV is only meant to give an alternative seed to the encryption routines. This IV does not need
  to be secret at all, though it can be desirable. You even can send it along with your ciphertext
  without losing security.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>    The size of the IV.
  <info>int</info>  <strong>$source</strong>  The source of the IV. The source can be <info>MCRYPT_RAND</info> (system random number
                generator), <info>MCRYPT_DEV_RANDOM</info> (read data from /dev/random) and <info>MCRYPT_DEV_URANDOM</info>
                (read data from /dev/urandom). Prior to 5.3.0, <info>MCRYPT_RAND</info> was the only one
                supported on Windows.
                
                Note that the default value of this parameter was <info>MCRYPT_DEV_RANDOM</info> prior to PHP
                5.6.0.
                
                Note that <info>MCRYPT_DEV_RANDOM</info> may block until more entropy is available.

<comment>Return:</comment>
  <info>string</info>  Returns the initialization vector, or <info>false</info> on error.

<comment>See Also:</comment>
   * http://www.ciphersbyritter.com/GLOSSARY.HTM#IV
   * http://www.quadibloc.com/crypto/co0409.htm
   * Chapter 9.3 of Applied Cryptography by Schneier (ISBN 0-471-11709-9)
   * <strong>random_bytes()</strong>


id: mcrypt_decrypt
type: function
doc:
<comment>Description:</comment>
  Decrypts crypttext with given parameters
  
  Decrypts the <strong>$data</strong> and returns the unencrypted data.

<comment>Param:</comment>
  <info>string</info>  <strong>$cipher</strong>  Eine der Konstanten von <info>MCRYPT_ciphername</info> oder der Name eines Algorithmus als
                   Zeichenkette.
  <info>string</info>  <strong>$key</strong>     The key with which the data was encrypted. If the provided key size is not
                   supported by the cipher, the function will emit a warning and return <info>false</info>
  <info>string</info>  <strong>$data</strong>    The data that will be decrypted with the given <strong>$cipher</strong> and <strong>$mode</strong>. If the size of
                   the data is not n * blocksize, the data will be padded with '<return>\0</return>'.
  <info>string</info>  <strong>$mode</strong>    Eine der <info>MCRYPT_MODE_modename</info>-Konstanten oder eine der folgenden Zeichenketten:
                   "ecb", "cbc", "cfb", "ofb", "nofb" oder "stream".
  <info>string</info>  <strong>$iv</strong>      Wird für die Initialisierung in den Modi CBC, CFB oder OFB und von einigen
                   Algorithmen im STREAM-Modus verwendet. Wird die Länge des angegebenen IV vom
                   Betriebsmodus nicht unterstützt, oder wurde kein IV angegeben aber der
                   Betriebsmodus benötigt einen, so wird diese Funktion eine Warnung ausgeben und
                   <info>false</info> zurückgeben.

<comment>Return:</comment>
  <info>string|false</info>  Returns the decrypted data as a string Bei einem Fehler wird <info>false</info> zurückgegeben..

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


id: mcrypt_enc_get_algorithms_name
type: function
doc:
<comment>Description:</comment>
  Returns the name of the opened algorithm
  
  This function returns the name of the algorithm.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>string</info>  Returns the name of the opened algorithm as a string.


id: mcrypt_enc_get_block_size
type: function
doc:
<comment>Description:</comment>
  Returns the blocksize of the opened algorithm
  
  Gets the blocksize of the opened algorithm.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>int</info>  Returns the block size of the specified algorithm in bytes.


id: mcrypt_enc_get_iv_size
type: function
doc:
<comment>Description:</comment>
  Returns the size of the IV of the opened algorithm
  
  This function returns the size of the IV of the algorithm specified by the encryption descriptor
  in bytes. An IV is used in cbc, cfb and ofb modes, and in some algorithms in stream mode.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>int</info>  Returns the size of the IV, or 0 if the IV is ignored by the algorithm.


id: mcrypt_enc_get_key_size
type: function
doc:
<comment>Description:</comment>
  Returns the maximum supported keysize of the opened mode
  
  Gets the maximum supported key size of the algorithm in bytes.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>int</info>  Returns the maximum supported key size of the algorithm in bytes.


id: mcrypt_enc_get_modes_name
type: function
doc:
<comment>Description:</comment>
  Returns the name of the opened mode
  
  This function returns the name of the mode.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

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


id: mcrypt_enc_get_supported_key_sizes
type: function
doc:
<comment>Description:</comment>
  Returns an array with the supported keysizes of the opened algorithm
  
  Gets the supported key sizes of the opened algorithm.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>array</info>  Returns an array with the key sizes supported by the algorithm specified by the encryption
         descriptor. If it returns an empty array then all key sizes between 1 and
         <strong>mcrypt_enc_get_key_size()</strong> are supported by the algorithm.


id: mcrypt_enc_is_block_algorithm
type: function
doc:
<comment>Description:</comment>
  Checks whether the algorithm of the opened mode is a block algorithm
  
  Tells whether the algorithm of the opened mode is a block algorithm.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the algorithm is a block algorithm or <info>false</info> if it is a stream one.


id: mcrypt_enc_is_block_algorithm_mode
type: function
doc:
<comment>Description:</comment>
  Checks whether the encryption of the opened mode works on blocks
  
  Tells whether the algorithm of the opened mode works on blocks (e.g. <info>false</info> for stream, and <info>true</info>
  for cbc, cfb, ofb)..

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the mode is for use with block algorithms, otherwise it returns <info>false</info>.


id: mcrypt_enc_is_block_mode
type: function
doc:
<comment>Description:</comment>
  Checks whether the opened mode outputs blocks
  
  Tells whether the opened mode outputs blocks (e.g. <info>true</info> for cbc and ecb, and <info>false</info> for cfb and
  stream).

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the mode outputs blocks of bytes, or <info>false</info> if it outputs just bytes.


id: mcrypt_enc_self_test
type: function
doc:
<comment>Description:</comment>
  Runs a self test on the opened module
  
  This function runs the self test on the algorithm specified by the descriptor <strong>$td</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>int</info>  Returns <return>0</return> on success and a negative Integer on failure.


id: mcrypt_encrypt
type: function
doc:
<comment>Description:</comment>
  Encrypts plaintext with given parameters
  
  Encrypts the data and returns it.

<comment>Param:</comment>
  <info>string</info>  <strong>$cipher</strong>  Eine der Konstanten von <info>MCRYPT_ciphername</info> oder der Name eines Algorithmus als
                   Zeichenkette.
  <info>string</info>  <strong>$key</strong>     The key with which the data will be encrypted. If the provided key size is not
                   supported by the cipher, the function will emit a warning and return <info>false</info>
  <info>string</info>  <strong>$data</strong>    The data that will be encrypted with the given <strong>$cipher</strong> and <strong>$mode</strong>. If the size of
                   the data is not n * blocksize, the data will be padded with '<return>\0</return>'.
                   
                   The returned crypttext can be larger than the size of the data that was given by
                   <strong>$data</strong>.
  <info>string</info>  <strong>$mode</strong>    Eine der <info>MCRYPT_MODE_modename</info>-Konstanten oder eine der folgenden Zeichenketten:
                   "ecb", "cbc", "cfb", "ofb", "nofb" oder "stream".
  <info>string</info>  <strong>$iv</strong>      Wird für die Initialisierung in den Modi CBC, CFB oder OFB und von einigen
                   Algorithmen im STREAM-Modus verwendet. Wird die Länge des angegebenen IV vom
                   Betriebsmodus nicht unterstützt, oder wurde kein IV angegeben aber der
                   Betriebsmodus benötigt einen, so wird diese Funktion eine Warnung ausgeben und
                   <info>false</info> zurückgeben.

<comment>Return:</comment>
  <info>string|false</info>  Returns the encrypted data as a string Bei einem Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>mcrypt_decrypt()</strong>
   * <strong>mcrypt_module_open()</strong>


id: mcrypt_generic
type: function
doc:
<comment>Description:</comment>
  This function encrypts data
  
  This function encrypts data. The data is padded with "<return>\0</return>" to make sure the length of the data is n
  * blocksize. This function returns the encrypted data. Note that the length of the returned string
  can in fact be longer than the input, due to the padding of the data.
  
  If you want to store the encrypted data in a database make sure to store the entire string as
  returned by mcrypt_generic, or the string will not entirely decrypt properly.  If your original
  string is 10 characters long and the block size is 8 (use <strong>mcrypt_enc_get_block_size()</strong> to determine
  the blocksize), you would need at least 16 characters in your database field. Note the string
  returned by <strong>mdecrypt_generic()</strong> will be 16 characters as well...use rtrim($str, "\0") to remove the
  padding.
  
  If you are for example storing the data in a MySQL database remember that varchar fields
  automatically have trailing spaces removed during insertion. As encrypted data can end in a space
  (ASCII 32), the data will be damaged by this removal.  Store data in a tinyblob/tinytext (or
  larger) field instead.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>    The encryption descriptor.
                   
                   The encryption handle should always be initialized with <strong>mcrypt_generic_init()</strong>
                   with a key and an IV before calling this function. Where the encryption is done,
                   you should free the encryption buffers by calling <strong>mcrypt_generic_deinit()</strong>. See
                   <strong>mcrypt_module_open()</strong> for an example.
  <info>string</info>    <strong>$data</strong>  The data to encrypt.

<comment>Return:</comment>
  <info>string</info>  Returns the encrypted data.

<comment>See Also:</comment>
   * <strong>mdecrypt_generic()</strong>
   * <strong>mcrypt_generic_init()</strong>
   * <strong>mcrypt_generic_deinit()</strong>


id: mcrypt_generic_deinit
type: function
doc:
<comment>Description:</comment>
  This function deinitializes an encryption module
  
  This function terminates encryption specified by the encryption descriptor (<strong>$td</strong>). It clears all
  buffers, but does not close the module.  You need to call <strong>mcrypt_module_close()</strong> yourself. (But PHP
  does this for you at the end of the script.)

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<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>mcrypt_module_open()</strong>
   * <strong>mcrypt_generic_init()</strong>


id: mcrypt_generic_init
type: function
doc:
<comment>Description:</comment>
  This function initializes all buffers needed for encryption
  
  You need to call this function before every call to <strong>mcrypt_generic()</strong> or <strong>mdecrypt_generic()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>   The encryption descriptor.
  <info>string</info>    <strong>$key</strong>  The maximum length of the key should be the one obtained by calling
                  <strong>mcrypt_enc_get_key_size()</strong> and every value smaller than this is legal.
  <info>string</info>    <strong>$iv</strong>   The IV should normally have the size of the algorithms block size, but you must
                  obtain the size by calling <strong>mcrypt_enc_get_iv_size()</strong>. IV is ignored in ECB. IV MUST
                  exist in CFB, CBC, STREAM, nOFB and OFB modes. It needs to be random and unique
                  (but not secret). The same IV must be used for encryption/decryption. If you do
                  not want to use it you should set it to zeros, but this is not recommended.

<comment>Return:</comment>
  <info>int</info>  The function returns a negative value on error: -3 when the key length was incorrect, -4 when
       there was a memory allocation problem and any other return value is an unknown error. If an
       error occurs a warning will be displayed accordingly. <info>false</info> is returned if incorrect
       parameters were passed.

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


id: mcrypt_get_block_size
type: function
doc:
<comment>Description:</comment>
  Gets the block size of the specified cipher
  
  The first prototype is when linked against libmcrypt 2.2.x, the second when linked against
  libmcrypt 2.4.x or 2.5.x.
  
  <strong>mcrypt_get_block_size()</strong> is used to get the size of a block of the specified <strong>$cipher</strong> (in
  combination with an encryption mode).
  
  It is more useful to use the <strong>mcrypt_enc_get_block_size()</strong> function as this uses the resource
  returned by <strong>mcrypt_module_open()</strong>.

<comment>Param:</comment>
  <info>int</info>     <strong>$cipher</strong>  Eine der Konstanten von <info>MCRYPT_ciphername</info> oder der Name eines Algorithmus als
                   Zeichenkette.
  <info>string</info>  <strong>$mode</strong>    Eine der <info>MCRYPT_MODE_modename</info>-Konstanten oder eine der folgenden Zeichenketten:
                   "ecb", "cbc", "cfb", "ofb", "nofb" oder "stream".

<comment>Return:</comment>
  <info>int|false</info>  Returns the algorithm block size in bytes Bei einem Fehler wird <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>mcrypt_get_key_size()</strong>
   * <strong>mcrypt_enc_get_block_size()</strong>
   * <strong>mcrypt_encrypt()</strong>


id: mcrypt_get_cipher_name
type: function
doc:
<comment>Description:</comment>
  Gets the name of the specified cipher
  
  <strong>mcrypt_get_cipher_name()</strong> is used to get the name of the specified cipher.
  
  <strong>mcrypt_get_cipher_name()</strong> takes the cipher number as an argument (libmcrypt 2.2.x) or takes the
  cipher name as an argument (libmcrypt 2.4.x or higher) and returns the name of the cipher or
  <info>false</info>, if the cipher does not exist.

<comment>Param:</comment>
  <info>int</info>  <strong>$cipher</strong>  Eine der Konstanten von <info>MCRYPT_ciphername</info> oder der Name eines Algorithmus als
                Zeichenkette.

<comment>Return:</comment>
  <info>string</info>  This function returns the name of the cipher or <info>false</info> if the cipher does not exist.


id: mcrypt_get_iv_size
type: function
doc:
<comment>Description:</comment>
  Returns the size of the IV belonging to a specific cipher/mode combination
  
  Gets the size of the IV belonging to a specific  <strong>$cipher</strong>/<strong>$mode</strong> combination.
  
  It is more useful to use the <strong>mcrypt_enc_get_iv_size()</strong> function as this uses the resource returned
  by <strong>mcrypt_module_open()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$cipher</strong>  Eine der Konstanten von <info>MCRYPT_ciphername</info> oder der Name eines Algorithmus als
                   Zeichenkette.
  <info>string</info>  <strong>$mode</strong>    Eine der <info>MCRYPT_MODE_modename</info>-Konstanten oder eine der folgenden Zeichenketten:
                   "ecb", "cbc", "cfb", "ofb", "nofb" oder "stream".
                   
                   The IV is ignored in ECB mode as this mode does not require it. You will need to
                   have the same IV (think: starting point) both at encryption and decryption
                   stages, otherwise your encryption will fail.

<comment>Return:</comment>
  <info>int</info>  Returns the size of the Initialization Vector (IV) in bytes. On error the function returns
       <info>false</info>. If the IV is ignored in the specified cipher/mode combination zero is returned.

<comment>See Also:</comment>
   * <strong>mcrypt_get_block_size()</strong>
   * <strong>mcrypt_enc_get_iv_size()</strong>
   * <strong>mcrypt_create_iv()</strong>


id: mcrypt_get_key_size
type: function
doc:
<comment>Description:</comment>
  Gets the key size of the specified cipher
  
  The first prototype is when linked against libmcrypt 2.2.x, the second when linked against
  libmcrypt 2.4.x or 2.5.x.
  
  <strong>mcrypt_get_key_size()</strong> is used to get the size of a key of the specified <strong>$cipher</strong> (in combination
  with an encryption mode).
  
  It is more useful to use the <strong>mcrypt_enc_get_key_size()</strong> function as this uses the resource returned
  by <strong>mcrypt_module_open()</strong>.

<comment>Param:</comment>
  <info>int</info>     <strong>$cipher</strong>  Eine der Konstanten von <info>MCRYPT_ciphername</info> oder der Name eines Algorithmus als
                   Zeichenkette.
  <info>string</info>  <strong>$mode</strong>    Eine der <info>MCRYPT_MODE_modename</info>-Konstanten oder eine der folgenden Zeichenketten:
                   "ecb", "cbc", "cfb", "ofb", "nofb" oder "stream".

<comment>Return:</comment>
  <info>int|false</info>  Returns the maximum supported key size of the algorithm in bytes Bei einem Fehler wird
             <info>false</info> zurückgegeben..

<comment>See Also:</comment>
   * <strong>mcrypt_get_block_size()</strong>
   * <strong>mcrypt_enc_get_key_size()</strong>
   * <strong>mcrypt_encrypt()</strong>


id: mcrypt_list_algorithms
type: function
doc:
<comment>Description:</comment>
  Gets an array of all supported ciphers
  
  Gets the list of all supported algorithms in the <strong>$lib_dir</strong> parameter.

<comment>Param:</comment>
  <info>string</info>  <strong>$lib_dir</strong>  Specifies the directory where all algorithms are located. If not specified, the
                    value of the <return>mcrypt.algorithms_dir</return> php.ini directive is used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with all the supported algorithms.


id: mcrypt_list_modes
type: function
doc:
<comment>Description:</comment>
  Gets an array of all supported modes
  
  Gets the list of all supported modes in the <strong>$lib_dir</strong> parameter.

<comment>Param:</comment>
  <info>string</info>  <strong>$lib_dir</strong>  Specifies the directory where all modes are located. If not specified, the value
                    of the <return>mcrypt.modes_dir</return> php.ini directive is used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with all the supported modes.


id: mcrypt_module_close
type: function
doc:
<comment>Description:</comment>
  Closes the mcrypt module
  
  Closes the specified encryption handle.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<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>mcrypt_module_open()</strong>


id: mcrypt_module_get_algo_block_size
type: function
doc:
<comment>Description:</comment>
  Returns the blocksize of the specified algorithm
  
  Gets the blocksize of the specified algorithm.

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>  The algorithm name.
  <info>string</info>  <strong>$lib_dir</strong>    This optional parameter can contain the location where the mode module is on
                      the system.

<comment>Return:</comment>
  <info>int</info>  Returns the block size of the algorithm specified in bytes.


id: mcrypt_module_get_algo_key_size
type: function
doc:
<comment>Description:</comment>
  Returns the maximum supported keysize of the opened mode
  
  Gets the maximum supported keysize of the opened mode.

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>  The algorithm name.
  <info>string</info>  <strong>$lib_dir</strong>    This optional parameter can contain the location where the mode module is on
                      the system.

<comment>Return:</comment>
  <info>int</info>  This function returns the maximum supported key size of the algorithm specified in bytes.


id: mcrypt_module_get_supported_key_sizes
type: function
doc:
<comment>Description:</comment>
  Returns an array with the supported keysizes of the opened algorithm
  
  Returns an array with the key sizes supported by the specified algorithm. If it returns an empty
  array then all key sizes between 1 and <strong>mcrypt_module_get_algo_key_size()</strong> are supported by the
  algorithm.

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>  The algorithm to be used.
  <info>string</info>  <strong>$lib_dir</strong>    The optional <strong>$lib_dir</strong> parameter can contain the location where the algorithm
                      module is on the system.

<comment>Return:</comment>
  <info>array</info>  Returns an array with the key sizes supported by the specified algorithm. If it returns an
         empty array then all key sizes between 1 and <strong>mcrypt_module_get_algo_key_size()</strong> are
         supported by the algorithm.

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


id: mcrypt_module_is_block_algorithm
type: function
doc:
<comment>Description:</comment>
  This function checks whether the specified algorithm is a block algorithm
  
  This function returns <info>true</info> if the specified algorithm is a block algorithm, or <info>false</info> if it is a
  stream one.

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>  The algorithm to check.
  <info>string</info>  <strong>$lib_dir</strong>    The optional <strong>$lib_dir</strong> parameter can contain the location where the algorithm
                      module is on the system.

<comment>Return:</comment>
  <info>bool</info>  This function returns <info>true</info> if the specified algorithm is a block algorithm, or <info>false</info> if it
        is a stream one.


id: mcrypt_module_is_block_algorithm_mode
type: function
doc:
<comment>Description:</comment>
  Returns if the specified module is a block algorithm or not
  
  This function returns <info>true</info> if the mode is for use with block algorithms, otherwise it returns
  <info>false</info>. (e.g. <info>false</info> for stream, and <info>true</info> for cbc, cfb, ofb).

<comment>Param:</comment>
  <info>string</info>  <strong>$mode</strong>     The mode to check.
  <info>string</info>  <strong>$lib_dir</strong>  The optional <strong>$lib_dir</strong> parameter can contain the location where the algorithm
                    module is on the system.

<comment>Return:</comment>
  <info>bool</info>  This function returns <info>true</info> if the mode is for use with block algorithms, otherwise it
        returns <info>false</info>. (e.g. <info>false</info> for stream, and <info>true</info> for cbc, cfb, ofb).


id: mcrypt_module_is_block_mode
type: function
doc:
<comment>Description:</comment>
  Returns if the specified mode outputs blocks or not
  
  This function returns <info>true</info> if the mode outputs blocks of bytes or <info>false</info> if it outputs just bytes.
  (e.g. <info>true</info> for cbc and ecb, and <info>false</info> for cfb and stream).

<comment>Param:</comment>
  <info>string</info>  <strong>$mode</strong>     Eine der <info>MCRYPT_MODE_modename</info>-Konstanten oder eine der folgenden Zeichenketten:
                    "ecb", "cbc", "cfb", "ofb", "nofb" oder "stream".
  <info>string</info>  <strong>$lib_dir</strong>  The optional <strong>$lib_dir</strong> parameter can contain the location where the algorithm
                    module is on the system.

<comment>Return:</comment>
  <info>bool</info>  This function returns <info>true</info> if the mode outputs blocks of bytes or <info>false</info> if it outputs just
        bytes. (e.g. <info>true</info> for cbc and ecb, and <info>false</info> for cfb and stream).


