# php_manual

id: Session::startTransaction
type: function
doc:
<comment>Description:</comment>
  Startet eine Transaktion
  
  Startet eine neue Transaktion.

<comment>Return:</comment>
  <info>void</info>  Gibt ein SqlStatementResult-Objekt zurück.


id: SessionHandler
type: class
doc:
<comment>Description:</comment>
  <class>SessionHandler</class> ist eine spezielle Klasse, die verwendet werden kann, um den aktuellen internen
  PHP-Session-Speicherverwalter (PHP Session Save Handler) durch Vererbung zugänglich zu machen. Es
  gibt sieben Methoden, die die Wrapper für die sieben internen Callbacks des
  Session-Speicherverwalters sind (<strong>$open</strong>, <strong>$close</strong>, <strong>$read</strong>, <strong>$write</strong>, <strong>$destroy</strong>, <strong>$gc</strong> und <strong>$create_sid</strong>).
  Standardmäßig ist diese Klasse der Wrapper für den internen Speicherverwalter, der durch die
  Konfigurationsdirektive session.save_handler definiert ist (normalerweise <strong>$files</strong>). Andere interne
  Session-Speicherverwalter werden von PHP-Erweiterungen wie SQLite (als <strong>$sqlite</strong>), Memcache (als
  <strong>$memcache</strong>), und Memcached (als <strong>$memcached</strong>) bereitgestellt.
  
  Wenn eine einfache Instanz von <class>SessionHandler</class> mittels <strong>session_set_save_handler()</strong> als
  Speicherverwalter festgelegt wird, wird sie zum Wrapper für den aktuellen Speicherverwalter. Eine
  Klasse, die von <class>SessionHandler</class> abgeleitet ist, erlaubt es, Methoden zu überschreiben, abzufangen
  oder zu filtern, indem die Methoden der Elternklasse aufgerufen werden, die letztendlich Wrapper
  für die internen PHP-Sessionverwalter sind.
  
  So können zum Beispiel die Methoden <strong>$read</strong> und <strong>$write</strong> abgefangen werden, um die Session-Daten zu
  verschlüsseln bzw. zu entschlüsseln und dann das Ergebnis an die übergeordnete Klasse zu
  übergeben. Alternativ könnte auch eine Methode wie der Garbage Collection Callback <strong>$gc</strong> komplett
  überschrieben werden.
  
  Da der <class>SessionHandler</class> ein Wrapper für die Methoden des aktuellen internen Speicherverwalters ist,
  kann das obige Beispiel der Verschlüsselung auf jeden internen Speicherverwalter angewendet
  werden, ohne dass die Interna des Verwalters bekannt sein müssen.
  
  Um diese Klasse zu verwenden, muss zuerst der gewünschte Speicherverwalter mit
  session.save_handler festgelegt werden und dann eine Instanz von <class>SessionHandler</class> oder eine
  Erweiterung davon an <strong>session_set_save_handler()</strong> übergeben werden.
  
  Es ist zu beachten, dass die Callback-Methoden dieser Klasse dazu gedacht sind, intern von PHP
  aufgerufen zu werden und nicht aus dem Anwenderprogramm aufgerufen werden sollen. Auch die
  Rückgabewerte werden intern von PHP verarbeitet. Weitere Informationen über den Ablauf von
  Sessions sind im Abschnitt <strong>session_set_save_handler()</strong> zu finden.


id: SessionHandler::close
type: function
doc:
<comment>Description:</comment>
  Schließt eine Session
  
  Schließt die aktuelle Session. Diese Methode wird von PHP automatisch intern ausgeführt, wenn die
  Session geschlossen wird, oder explizit über die Funktion <strong>session_write_close()</strong> (die zuerst
  <strong>SessionHandler::write()</strong> aufruft).
  
  Diese Methode ist ein Wrapper für den in der INI-Einstellung session.save_handler definierten
  internen PHP-Speicherverwalter, der gesetzt wird, bevor er mittels <strong>session_set_save_handler()</strong>
  aktiviert wird.
  
  Wenn diese Klasse durch Vererbung erweitert wird, wird durch den Aufruf der übergeordneten
  <strong>$close</strong>-Methode der Wrapper für diese Methode und damit der zugehörige interne Callback aufgerufen.
  Dadurch kann die Methode überschrieben und/oder abgefangen werden.
  
  Weitere Informationen darüber, welche Aufgaben diese Methode erfüllen soll, sind in der
  Dokumentation unter <strong>SessionHandlerInterface::close()</strong> zu finden.

<comment>Return:</comment>
  <info>bool</info>  Der Rückgabewert (normalerweise <info>true</info> bei Erfolg und <info>false</info> bei Misserfolg). Es ist zu
        beachten, dass dieser Wert intern PHP zur Verarbeitung zurückgegeben wird.


id: SessionHandler::create_sid
type: function
doc:
<comment>Description:</comment>
  Liefert eine neue Session-ID
  
  Erzeugt eine neue Session-ID und gibt sie zurück.

<comment>Return:</comment>
  <info>string</info>  Eine für den standardmäßigen Sessionverwalter gültige Session-ID.

<comment>See Also:</comment>
   * <strong>session_id()</strong>
   * <strong>session_create_id()</strong>


id: SessionHandler::destroy
type: function
doc:
<comment>Description:</comment>
  Löscht eine Session
  
  Löscht eine Session. Wird intern von PHP mit <strong>session_regenerate_id()</strong> aufgerufen (vorausgesetzt der
  Parameter <strong>$destroy</strong> ist auf <info>true</info> gesetzt), von <strong>session_destroy()</strong> oder wenn <strong>session_decode()</strong>
  fehlschlägt.
  
  Diese Methode ist ein Wrapper für den in der INI-Einstellung session.save_handler definierten
  internen PHP-Speicherverwalter, der gesetzt wird, bevor er mittels <strong>session_set_save_handler()</strong>
  gesetzt wird.
  
  Wenn diese Klasse durch Vererbung erweitert wird, wird durch den Aufruf der übergeordneten
  <strong>$destroy</strong>-Methode der Wrapper für diese Methode und damit der zugehörige interne Callback
  aufgerufen. Dadurch kann diese Methode überschrieben und/oder abgefangen und gefiltert werden.
  
  Weitere Informationen darüber, welche Aufgaben diese Methode erfüllen soll, sind in der
  Dokumentation unter <strong>SessionHandlerInterface::destroy()</strong> zu finden.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  Die ID der Session, die gelöscht werden soll.

<comment>Return:</comment>
  <info>bool</info>  Der Rückgabewert (normalerweise <info>true</info> bei Erfolg und <info>false</info> bei Misserfolg). Es ist zu
        beachten, dass dieser Wert intern PHP zur Verarbeitung zurückgegeben wird.


id: SessionHandler::gc
type: function
doc:
<comment>Description:</comment>
  Löscht alte Sessions
  
  Löscht abgelaufene Sessions. Wird zufällig von PHP intern aufgerufen, wenn eine Session beginnt
  oder wenn die Funktion <strong>session_start()</strong> aufgerufen wird. Wie oft dies aufgerufen wird, hängt von
  den Konfigurationsanweisungen session.gc_divisor und session.gc_probability ab.
  
  Diese Methode ist ein Wrapper für den in der INI-Einstellung session.save_handler definierten
  internen PHP-Speicherverwalter, der gesetzt wird, bevor er mittels <strong>session_set_save_handler()</strong>
  gesetzt wird.
  
  Wenn diese Klasse durch Vererbung erweitert wird, wird durch den Aufruf der übergeordneten
  <strong>$gc</strong>-Methode der Wrapper für diese Methode und damit der zugehörige interne Callback aufgerufen.
  Dadurch kann diese Methode überschrieben und/oder abgefangen und gefiltert werden.
  
  Weitere Informationen darüber, welche Aufgaben diese Methode erfüllen soll, sind in der
  Dokumentation unter <strong>SessionHandlerInterface::gc()</strong> zu finden.

<comment>Param:</comment>
  <info>int</info>  <strong>$max_lifetime</strong>  Sessions, die in den letzten <strong>$max_lifetime</strong> Sekunden nicht aktualisiert wurden,
                      werden entfernt.

<comment>Return:</comment>
  <info>int|false</info>  Gibt bei Erfolg die Anzahl der gelöschten Sessions zurück. Bei einem Fehler wird <info>false</info>
             zurückgegeben. Es ist zu beachten, dass dieser Wert intern an PHP zur Verarbeitung
             zurückgegeben wird.


id: SessionHandler::open
type: function
doc:
<comment>Description:</comment>
  Initialisiert eine Session
  
  Erstellt eine neue Session oder initialisiert eine bestehende Session neu. Wird intern von PHP
  aufgerufen, wenn eine Session entweder automatisch startet oder durch den Aufruf der Funktion
  <strong>session_start()</strong> gestartet wird.
  
  Diese Methode ist ein Wrapper für den in der INI-Einstellung session.save_handler definierten
  internen PHP-Speicherverwalter, der gesetzt wird, bevor er mittels <strong>session_set_save_handler()</strong>
  gesetzt wird.
  
  Wenn diese Klasse durch Vererbung erweitert wird, wird durch den Aufruf der übergeordneten
  <strong>$open</strong>-Methode der Wrapper für diese Methode und damit der zugehörige interne Callback aufgerufen.
  Dadurch kann diese Methode überschrieben und/oder abgefangen und gefiltert werden.
  
  Weitere Informationen darüber, welche Aufgaben diese Methode erfüllen soll, sind in der
  Dokumentation unter <strong>SessionHandlerInterface::open()</strong> zu finden.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  Der Pfad, unter dem die Session gespeichert/abgerufen werden soll
  <info>string</info>  <strong>$name</strong>  Der Name der Session

<comment>Return:</comment>
  <info>bool</info>  Der Rückgabewert (normalerweise <info>true</info> bei Erfolg und <info>false</info> bei Misserfolg). Es ist zu
        beachten, dass dieser Wert intern PHP zur Verarbeitung zurückgegeben wird.

<comment>See Also:</comment>
   * 
     Die Konfigurationsanweisung
     session.auto-start.
    


id: SessionHandler::read
type: function
doc:
<comment>Description:</comment>
  Ruft die Session-Daten ab
  
  Liest die Session-Daten aus dem Session-Speicher und gibt das Ergebnis zur internen Verarbeitung
  zurück an PHP. Diese Methode wird von PHP automatisch aufgerufen, wenn eine Session gestartet wird
  (entweder automatisch oder explizit mit der <strong>session_start()</strong>), und wird von einem internen Aufruf
  von <strong>SessionHandler::open()</strong> eingeleitet.
  
  Diese Methode ist ein Wrapper für den in der INI-Einstellung session.save_handler definierten
  internen PHP-Speicherverwalter, der gesetzt wird, bevor er mittels <strong>session_set_save_handler()</strong>
  gesetzt wird.
  
  Wenn diese Klasse durch Vererbung erweitert wird, wird durch den Aufruf der übergeordneten
  <strong>$read</strong>-Methode der Wrapper für diese Methode und damit der zugehörige interne Callback aufgerufen.
  Dadurch kann diese Methode überschrieben und/oder abgefangen und gefiltert werden (z. B. um den
  von der übergeordneten <strong>$read</strong>-Methode zurückgegebenen Wert des Parameters <strong>$data</strong> zu entschlüsseln).
  
  Weitere Informationen darüber, welche Aufgaben diese Methode erfüllen soll, sind in der
  Dokumentation unter <strong>SessionHandlerInterface::read()</strong> zu finden.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  Die Session-ID, für die Daten gelesen werden sollen

<comment>Return:</comment>
  <info>string|false</info>  Gibt eine kodierte Zeichenkette der gelesenen Daten zurück. Wurde nichts gelesen,
                wird <info>false</info> zurückgegeben. Zu beachten ist, dass dieser Wert intern zur Verarbeitung
                an PHP zurückgegeben wird.

<comment>See Also:</comment>
   * 
     Die Konfigurationsanweisung
     session.serialize_handler.
    


id: SessionHandler::write
type: function
doc:
<comment>Description:</comment>
  Speichert die Session-Daten
  
  Schreibt die Session-Daten in den Session-Speicher. Wird von PHP beim normalen Herunterfahren
  aufgerufen, von <strong>session_write_close()</strong> oder wenn <strong>session_register_shutdown()</strong> fehlschlägt.
  Unmittelbar nach dieser Methode ruft PHP <strong>SessionHandler::close()</strong> auf.
  
  Diese Methode ist ein Wrapper für den in der INI-Einstellung session.save_handler definierten
  internen PHP-Speicherverwalter, der gesetzt wird, bevor er mittels <strong>session_set_save_handler()</strong>
  gesetzt wird.
  
  Wenn diese Klasse durch Vererbung erweitert wird, wird durch den Aufruf der übergeordneten
  <strong>$write</strong>-Methode der Wrapper für diese Methode und damit der zugehörige interne Callback aufgerufen.
  Dadurch kann diese Methode überschrieben und/oder abgefangen und gefiltert werden (z. B. um den
  Wert des Parameters <strong>$data</strong> zu verschlüsseln, bevor er an die übergeordnete <strong>$write</strong>-Methode übergeben
  wird).
  
  Weitere Informationen darüber, welche Aufgaben diese Methode erfüllen soll, sind in der
  Dokumentation unter <strong>SessionHandlerInterface::write()</strong> zu finden.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>    Die Session-ID
  <info>string</info>  <strong>$data</strong>  Die kodierten Session-Daten. Diese Daten sind das Ergebnis der internen
                 PHP-Kodierung der Superglobale $_SESSION in eine serialisierte Zeichenkette und
                 deren Übergabe als dieser Parameter. Es ist zu beachten, dass Sessions eine andere
                 Serialisierungsmethode verwenden.

<comment>Return:</comment>
  <info>bool</info>  Der Rückgabewert (normalerweise <info>true</info> bei Erfolg und <info>false</info> bei Misserfolg). Es ist zu
        beachten, dass dieser Wert intern PHP zur Verarbeitung zurückgegeben wird.

<comment>See Also:</comment>
   * 
     Die Konfigurationsanweisung
     session.serialize_handler.
    


id: SessionHandlerInterface
type: class
doc:
<comment>Description:</comment>
  <class>SessionHandlerInterface</class> ist eine Schnittstelle, die den minimalen Prototyp für die Erstellung
  einer benutzerdefinierten Sessionverwaltung definiert. Um eine benutzerdefinierte
  Sessionverwaltung an <strong>session_set_save_handler()</strong> zu übergeben, die ihren OOP-Aufruf verwendet, kann
  die Klasse diese Schnittstelle implementieren.
  
  Es ist zu beachten, dass die Callback-Methoden dieser Klasse dazu gedacht sind, intern von PHP
  aufgerufen zu werden und nicht aus dem Anwenderprogramm aufgerufen werden sollen.


id: SessionHandlerInterface::close
type: function
doc:
<comment>Description:</comment>
  Schließt eine Session
  
  Schließt die aktuelle Session. Diese Methode wird automatisch ausgeführt, wenn die Session
  geschlossen wird, oder explizit über die Funktion <strong>session_write_close()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Der Rückgabewert (normalerweise <info>true</info> bei Erfolg und <info>false</info> bei Misserfolg). Es ist zu
        beachten, dass dieser Wert intern PHP zur Verarbeitung zurückgegeben wird.


id: SessionHandlerInterface::destroy
type: function
doc:
<comment>Description:</comment>
  Löscht eine Session
  
  Löscht eine Session. Wird von <strong>session_regenerate_id()</strong> aufgerufen (bei $destroy = <info>true</info>), von
  <strong>session_destroy()</strong> oder wenn <strong>session_decode()</strong> fehlschlägt.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  Die ID der Session, die gelöscht werden soll.

<comment>Return:</comment>
  <info>bool</info>  Der Rückgabewert (normalerweise <info>true</info> bei Erfolg und <info>false</info> bei Misserfolg). Es ist zu
        beachten, dass dieser Wert intern PHP zur Verarbeitung zurückgegeben wird.


id: SessionHandlerInterface::gc
type: function
doc:
<comment>Description:</comment>
  Löscht alte Sessions
  
  Löscht abgelaufene Sessions. Wird von <strong>session_start()</strong> aufgerufen, in Abhängigkeit von den
  Konfigurationseinstellungen session.gc_divisor, session.gc_probability und session.gc_maxlifetime.

<comment>Param:</comment>
  <info>int</info>  <strong>$max_lifetime</strong>  Sessions, die in den letzten <strong>$max_lifetime</strong> Sekunden nicht aktualisiert wurden,
                      werden entfernt.

<comment>Return:</comment>
  <info>int|false</info>  Gibt bei Erfolg die Anzahl der gelöschten Sessions zurück. Bei einem Fehler wird <info>false</info>
             zurückgegeben. Es ist zu beachten, dass dieser Wert intern an PHP zur Verarbeitung
             zurückgegeben wird.


id: SessionHandlerInterface::open
type: function
doc:
<comment>Description:</comment>
  Initialisiert eine Session
  
  Initialisiert eine bestehende Session neu oder erstellt eine neue. Wird aufgerufen, wenn eine
  Session startet oder wenn <strong>session_start()</strong> aufgerufen wird.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  Der Pfad, unter dem die Session gespeichert/abgerufen werden soll
  <info>string</info>  <strong>$name</strong>  Der Name der Session

<comment>Return:</comment>
  <info>bool</info>  Der Rückgabewert (normalerweise <info>true</info> bei Erfolg und <info>false</info> bei Misserfolg). Es ist zu
        beachten, dass dieser Wert intern PHP zur Verarbeitung zurückgegeben wird.

<comment>See Also:</comment>
   * <strong>session_name()</strong>
   * 
     Die Konfigurationsanweisung
     session.auto-start.
    


id: SessionHandlerInterface::read
type: function
doc:
<comment>Description:</comment>
  Ruft die Session-Daten ab
  
  Liest die Session-Daten aus dem Session-Speicher und gibt das Ergebnis zurück. Diese Methode wird
  direkt nach dem Start einer Session aufgerufen oder wenn <strong>session_start()</strong> aufgerufen wird. Es ist
  zu beachten, dass vor dem Aufruf dieser Methode <strong>SessionHandlerInterface::open()</strong> aufgerufen wird.
  
  Diese Methode wird von PHP selbst aufgerufen, wenn eine Session gestartet wird. Sie soll die
  Session-Daten anhand der angegebenen Session-ID aus dem Speicher abrufen. Die von dieser Methode
  zurückgegebene Zeichenkette muss dasselbe serialisierte Format haben wie die ursprünglich an die
  <strong>SessionHandlerInterface::write()</strong> übergebene Zeichenkette. Wenn der Datensatz nicht gefunden werden
  konnte, wird <info>false</info> zurückgegeben.
  
  Die von dieser Methode zurückgegebenen Daten werden von PHP intern dekodiert, indem die in
  session.serialize_handler angegebene Methode zur Deserialisierung verwendet wird. Mit den daraus
  resultierenden Daten wird die Superglobale $_SESSION gefüllt.
  
  Zu beachten ist, dass das Serialisierungsverfahren nicht dasselbe ist wie bei <strong>unserialize()</strong> und
  mittels <strong>session_decode()</strong> aufgerufen werden kann.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  Die Session-ID

<comment>Return:</comment>
  <info>string|false</info>  Gibt eine kodierte Zeichenkette der gelesenen Daten zurück. Wurde nichts gelesen,
                wird <info>false</info> zurückgegeben. Zu beachten ist, dass dieser Wert intern zur Verarbeitung
                an PHP zurückgegeben wird.

<comment>See Also:</comment>
   * 
     Die Konfigurationsanweisung
     session.serialize_handler.
    


id: SessionHandlerInterface::write
type: function
doc:
<comment>Description:</comment>
  Speichert die Session-Daten
  
  Schreibt die Session-Daten in den Session-Speicher. Wird von <strong>session_write_close()</strong> aufgerufen,
  wenn <strong>session_register_shutdown()</strong> fehlschlägt oder beim normalen Herunterfahren. Hinweis:
  Unnmittelbar nach dieser Funktion wird <strong>SessionHandlerInterface::close()</strong> aufgerufen.
  
  Diese Methode wird von PHP aufgerufen, wenn die Session bereit ist, gespeichert und geschlossen zu
  werden. Es kodiert die Session-Daten aus der Superglobalen $_SESSION in eine serialisierte
  Zeichenkette und übergibt diese zusammen mit der Session-ID zur Speicherung an diese Methode. Die
  verwendete Serialisierungsmethode wird in der Einstellung session.serialize_handler festgelegt.
  
  Zu beachten ist, dass diese Methode normalerweise von PHP aufgerufen wird, nachdem die
  Ausgabepuffer geschlossen wurden, es sei denn, sie wird explizit durch <strong>session_write_close()</strong>
  aufgerufen.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>    Die Session-ID
  <info>string</info>  <strong>$data</strong>  Die kodierten Session-Daten. Diese Daten sind das Ergebnis der internen
                 PHP-Kodierung der Superglobale $_SESSION in eine serialisierte Zeichenkette und
                 deren Übergabe als dieser Parameter. Es ist zu beachten, dass Sessions eine andere
                 Serialisierungsmethode verwenden.

<comment>Return:</comment>
  <info>bool</info>  Der Rückgabewert (normalerweise <info>true</info> bei Erfolg und <info>false</info> bei Misserfolg). Es ist zu
        beachten, dass dieser Wert intern PHP zur Verarbeitung zurückgegeben wird.

<comment>See Also:</comment>
   * 
     Die Konfigurationsanweisung
     session.serialize_handler.
    


id: SessionIdInterface
type: class
doc:
<comment>Description:</comment>
  <class>SessionIdInterface</class> ist eine Schnittstelle, die optionale Methoden zum Erstellen einer
  benutzerdefinierten Sessionverwaltung definiert. Um einen benutzerdefinierten Sessionverwalter an
  <strong>session_set_save_handler()</strong> zu übergeben, der deren OOP-Aufruf verwendet, kann die Klasse diese
  Schnittstelle implementieren.
  
  Es ist zu beachten, dass die Callback-Methoden der Klassen, die diese Schnittstelle
  implementieren, dazu gedacht sind, intern von PHP aufgerufen zu werden und nicht aus dem
  Anwenderprogramm aufgerufen werden sollen.


id: SessionIdInterface::create_sid
type: function
doc:
<comment>Description:</comment>
  Erzeugt eine Session-ID
  
  Erzeugt eine Session-ID. Diese Funktion wird automatisch ausgeführt, wenn eine neue Session-ID
  benötigt wird.

<comment>Return:</comment>
  <info>string</info>  Die neue Session-ID. Zu beachten ist, dass dieser Wert intern zur Verarbeitung an PHP
          zurückgegeben wird.

<comment>See Also:</comment>
   * SessionHandler::create_sid


id: SessionUpdateTimestampHandlerInterface
type: class
doc:
<comment>Description:</comment>
  <class>SessionUpdateTimestampHandlerInterface</class> ist eine Schnittstelle, die optionale Methoden zum
  Erstellen einer benutzerdefinierten Sessionverwaltung definiert. Um einen benutzerdefinierten
  Sessionverwalter an <strong>session_set_save_handler()</strong> zu übergeben, der deren OOP-Aufruf verwendet, kann
  die Klasse diese Schnittstelle implementieren.
  
  Es ist zu beachten, dass die Callback-Methoden der Klassen, die diese Schnittstelle
  implementieren, dazu gedacht sind, intern von PHP aufgerufen zu werden und nicht aus dem
  Anwenderprogramm aufgerufen werden sollen.


id: SessionUpdateTimestampHandlerInterface::updateTimestamp
type: function
doc:
<comment>Description:</comment>
  Aktualisiert den Zeitstempel
  
  Aktualisiert den Zeitstempel der letzten Änderung der Session. Diese Funktion wird automatisch
  ausgeführt, wenn eine Session aktualisiert wird.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>    Die Session-ID
  <info>string</info>  <strong>$data</strong>  Die Session-Daten

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn der Zeitstempel aktualisiert wurde, andernfalls <info>false</info>. Zu beachten
        ist, dass dieser Wert intern an PHP zur Verarbeitung zurückgegeben wird.


id: SessionUpdateTimestampHandlerInterface::validateId
type: function
doc:
<comment>Description:</comment>
  Validiert eine ID
  
  Überprüft eine gegebene Session-ID. Eine Session-ID ist gültig, wenn bereits eine Session mit
  dieser ID existiert. Diese Funktion wird automatisch ausgeführt, wenn eine Session gestartet
  werden soll, eine Session-ID übergeben wird und session.use_strict_mode aktiviert ist.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  Die Session-ID

<comment>Return:</comment>
  <info>bool</info>  Gibt bei einer gültigen ID <info>true</info> zurück, andernfalls <info>false</info>. Zu beachten ist, dass dieser Wert
        intern an PHP zur Verarbeitung zurückgegeben wird.


id: Shmop
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces <return>shmop</return> resources as of PHP 8.0.0.


id: SimdJsonException
type: class
doc:
<comment>Description:</comment>
  Exception thrown if <strong>simdjson_decode()</strong>, <strong>simdjson_key_count()</strong>, <strong>simdjson_key_exists()</strong>, or
  <strong>simdjson_key_value()</strong>.
   For possible values see the simdjson error codes constants.


id: SimdJsonValueError
type: class
doc:
<comment>Description:</comment>
  A <class>SimdJsonValueError</class> is thrown when the type of an argument to a function from simdjson is correct
  but the value of it is incorrect. E.g. when the JSON decoding $depth is not positive or the $depth
  is too large.


id: SimpleXMLElement::__construct
type: function
doc:
<comment>Description:</comment>
  Erstellt ein neues SimpleXMLElement-Objekt
  
  Erstellt ein neues <class>SimpleXMLElement</class>-Objekt.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>               Ein wohlgeformter XML-String, oder der Pfad oder die URL zu einem
                              XML-Dokument, wenn <strong>$dataIsURL</strong> <info>true</info> ist.
  <info>int</info>     <strong>$options</strong>            Optional zu verwenden, um weitere Libxml-Parameter anzugeben, die das
                              Lesen von XML-Dokumenten betreffen. Optionen, die die Ausgabe von
                              XML-Dokumenten betreffen (z. B. <info>LIBXML_NOEMPTYTAG</info>) werden
                              stillschweigend ignoriert.
                              
                              Es kann erforderlich sein, die Option <info>LIBXML_PARSEHUGE</info> zu übergeben,
                              um tief verschachteltes XML oder sehr große Textknoten verarbeiten zu
                              können.
  <info>bool</info>    <strong>$dataIsURL</strong>          Standardmäßig ist <strong>$dataIsURL</strong> <info>false</info>. Verwenden Sie <info>true</info>, um <strong>$data</strong> als
                              Pfad oder URL zu einem XML-Dokument an Stelle eines Daten-<info>String</info>s
                              anzugeben.
  <info>string</info>  <strong>$namespaceOrPrefix</strong>  Ein Namensraum-Präfix oder -URI.
  <info>bool</info>    <strong>$isPrefix</strong>           <info>true</info>, wenn <strong>$namespaceOrPrefix</strong> ein Präfix ist, <info>false</info>, wenn es ein URI
                              ist; der Standardwert ist <info>false</info>.

<comment>See Also:</comment>
   * 
   * <strong>simplexml_load_string()</strong>
   * <strong>simplexml_load_file()</strong>
   * 
   * <strong>libxml_use_internal_errors()</strong>
   * <strong>libxml_set_streams_context()</strong>


id: SimpleXMLElement::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the string content
  
  Returns text content that is directly in this element. Does not return text content that is inside
  this element's children.

<comment>Return:</comment>
  <info>string</info>  Returns the string content on success or an empty string on failure.

<comment>See Also:</comment>
   * SimpleXMLElement::asXML


id: SimpleXMLElement::addAttribute
type: function
doc:
<comment>Description:</comment>
  Fügt einem SimpleXML-Element ein Attribut hinzu
  
  Fügt einem SimpleXML-Element ein Attribut hinzu.

<comment>Param:</comment>
  <info>string</info>       <strong>$qualifiedName</strong>  Der Name des hinzuzufügenden Attributs.
  <info>string</info>       <strong>$value</strong>          Der Wert des Attributs.
  <info>string|null</info>  <strong>$namespace</strong>      Wenn angegeben, der Namespace, zu dem das Attribut gehört.

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

<comment>See Also:</comment>
   * SimpleXMLElement::addChild
   * 


id: SimpleXMLElement::addChild
type: function
doc:
<comment>Description:</comment>
  Fügt dem XML-Knoten ein Kind-Element hinzu
  
  Fügt ein Kind-Element an den Knoten und gibt ein SimpleXMLElement des Kindes zurück.

<comment>Param:</comment>
  <info>string</info>       <strong>$qualifiedName</strong>  Der Name des hinzuzufügenden Kind-Elements.
  <info>string|null</info>  <strong>$value</strong>          Wenn angegeben, der Wert des Kind-Elements.
  <info>string|null</info>  <strong>$namespace</strong>      Wenn angegeben, der Namespace, zu dem das Kind-Element gehört.

<comment>Return:</comment>
  <info>SimpleXMLElement|null</info>  Die <return>addChild</return>-Methode gibt bei Erfolg ein <info>SimpleXMLElement</info>-Objekt zurück,
                         das das zum XML-Knoten hinzugefügte Kind repräsentiert, oder <info>false</info>, falls
                         ein Fehler auftrat.

<comment>See Also:</comment>
   * SimpleXMLElement::addAttribute
   * 


id: SimpleXMLElement::asXML
type: function
doc:
<comment>Description:</comment>
  Liefert einen wohlgeformten XML-String, der auf einem SimpleXML-Element basiert
    
  
  Die <return>asXML</return>-Methode formatiert den Inhalt des Elternobjekts als XML Version 1.0.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  Falls ein String-Wert angegeben wird, schreibt die Funktion die Daten in
                          die Datei, anstatt sie direkt zurückzugeben.

<comment>Return:</comment>
  <info>string|bool</info>  Ist der Parameter <strong>$filename</strong> nicht angegeben, gibt die Funktion bei erfolgreicher
               Umwandlung einen <info>String</info> zurück oder <info>false</info> bei einem Fehler. Ist der Parameter
               angegeben, wird <info>true</info> zurückgegeben, wenn die Datei erfolgreich erstellt werden
               konnte; ansonsten ist der Rückgabewert <info>false</info>.

<comment>See Also:</comment>
   * SimpleXMLElement::__toString
   * 


id: SimpleXMLElement::attributes
type: function
doc:
<comment>Description:</comment>
  Liefert die Attribute eines Elements
  
  Die Funktion gibt die Attribute und Werte zurück, die innerhalb eines XML-Tags definiert wurden.
  
  SimpleXML definiert für die
  meisten Methoden Regeln für das Hinzufügen von iterativen Eigenschaften. Diese
  können weder mit <strong>var_dump()</strong> oder auf andere Weise angezeigt
  werden.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespaceOrPrefix</strong>  Ein optionaler Namespace für das abgefragte Attribut
  <info>bool</info>         <strong>$isPrefix</strong>           Standardmäßig auf <info>false</info> gesetzt

<comment>Return:</comment>
  <info>SimpleXMLElement|null</info>  Gibt ein <class>SimpleXMLElement</class>-Objekt zurück, das durchlaufen werden kann, um
                         die Attribute des Elements zu erhalten.
                         
                         Gibt <info>null</info> zurück, wenn der Aufruf auf einem <class>SimpleXMLElement</class>-Objekt
                         erfolgt, das bereits ein Attribut anstatt eines Elements darstellt.

<comment>See Also:</comment>
   * 


id: SimpleXMLElement::children
type: function
doc:
<comment>Description:</comment>
  Findet Kindelemente des gegebenen Knotens
  
  Die Methode findet Kinder eines Elements. Das Ergebnis entspricht den normalen Iterierungsregeln.
  
  SimpleXML definiert für die
  meisten Methoden Regeln für das Hinzufügen von iterativen Eigenschaften. Diese
  können weder mit <strong>var_dump()</strong> oder auf andere Weise angezeigt
  werden.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespaceOrPrefix</strong>  Ein XML-Namensraum.
  <info>bool</info>         <strong>$isPrefix</strong>           Ist <strong>$isPrefix</strong> <info>true</info>, dann wird <strong>$namespaceOrPrefix</strong> als Prefix
                                   interpretiert. Ist es <info>false</info>, dann wird <strong>$namespaceOrPrefix</strong> als
                                   Namensraum-URL interpretiert.

<comment>Return:</comment>
  <info>SimpleXMLElement|null</info>  Gibt ein <class>SimpleXMLElement</class>-Objekt zurück, unabhängig davon, ob der Knoten
                         Kindknoten hat oder nicht, außer der Knoten stellt ein Attribut dar, denn
                         in diesem Fall wird <info>null</info> zurückgegeben.

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


id: SimpleXMLElement::count
type: function
doc:
<comment>Description:</comment>
  Counts the children of an element
  
  This method counts the number of children of an element.

<comment>Return:</comment>
  <info>int</info>  Returns the number of elements of an element.

<comment>See Also:</comment>
   * SimpleXMLElement::children


id: SimpleXMLElement::current
type: function
doc:
<comment>Description:</comment>
  Returns the current element
  
  Prior to PHP 8.0, SimpleXMLElement::current was only declared on the subclass <class>SimpleXMLIterator</class>.
  
  This method returns the current element as a <class>SimpleXMLElement</class> object.

<comment>Return:</comment>
  <info>SimpleXMLElement</info>  Returns the current element as a <class>SimpleXMLElement</class> object.

<comment>See Also:</comment>
   * SimpleXMLElement::key
   * SimpleXMLElement::next
   * SimpleXMLElement::rewind
   * SimpleXMLElement::valid
   * <class>SimpleXMLElement</class>


id: SimpleXMLElement::getChildren
type: function
doc:
<comment>Description:</comment>
  Returns the sub-elements of the current element
  
  Prior to PHP 8.0, SimpleXMLElement::getChildren was only declared on the subclass
  <class>SimpleXMLIterator</class>.
  
  This method returns a <class>SimpleXMLElement</class> object containing sub-elements of the current
  <class>SimpleXMLElement</class> element.

<comment>Return:</comment>
  <info>SimpleXMLElement|null</info>  Returns a <class>SimpleXMLElement</class> object containing the sub-elements of the
                         current element.


id: SimpleXMLElement::getDocNamespaces
type: function
doc:
<comment>Description:</comment>
  Liefert die im Dokument deklarierten Namensräume
  
  Gibt die im Dokument deklarierten Namensräume zurück.

<comment>Param:</comment>
  <info>bool</info>  <strong>$recursive</strong>  Sofern angegeben, werden alle Namensräume zurückgegeben, die in Eltern- und
                    Kindknoten deklariert wurden. Andernfalls werden nur die im Wurzelknoten
                    deklarierten Namensräume zurückgegeben.
  <info>bool</info>  <strong>$fromRoot</strong>   Ermöglicht die rekursive Prüfung der Namensräume unter einem Kindknoten statt
                    von der Wurzel des XML-Dokuments.

<comment>Return:</comment>
  <info>array|false</info>  Die <return>getDocNamespaces</return>-Methode gibt ein <info>Array</info> der Namensräume mit den ihnen
               zugeordneten URIs zurück.

<comment>See Also:</comment>
   * SimpleXMLElement::getNamespaces
   * SimpleXMLElement::registerXPathNamespace


id: SimpleXMLElement::getName
type: function
doc:
<comment>Description:</comment>
  Ermittelt den Namen eines XML-Elements
  
  Ermittelt den Namen eines XML-Elements.

<comment>Return:</comment>
  <info>string</info>  Die <return>getName</return>-Methode gibt den Namen des durch das SimpleXMLElement-Objekt referenzierte
          XML-Tag als <info>String</info> zurück.


id: SimpleXMLElement::getNamespaces
type: function
doc:
<comment>Description:</comment>
  Gibt die im Dokument verwendeten Namespaces zurück
  
  Gibt die im Dokument verwendeten Namespaces zurück

<comment>Param:</comment>
  <info>bool</info>  <strong>$recursive</strong>  Sofern angegeben, werden alle Namespaces, die in Eltern- und Kindknoten
                    verwendet werden, zurückgegeben. Ansonsten werden nur die Namespaces des
                    Wurzelknoten zurückgegeben.

<comment>Return:</comment>
  <info>array</info>  Die <return>getNamespaces</return>-Methode gibt ein <info>Array</info> der Namespaces mit ihren zugehörigen URIs zurück.

<comment>See Also:</comment>
   * SimpleXMLElement::getDocNamespaces
   * SimpleXMLElement::registerXPathNamespace


id: SimpleXMLElement::hasChildren
type: function
doc:
<comment>Description:</comment>
  Checks whether the current element has sub elements
  
  Prior to PHP 8.0, SimpleXMLElement::hasChildren was only declared on the subclass
  <class>SimpleXMLIterator</class>.
  
  This method checks whether the current <class>SimpleXMLElement</class> element has sub-elements.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the current element has sub-elements, otherwise <info>false</info>


id: SimpleXMLElement::key
type: function
doc:
<comment>Description:</comment>
  Return current key
  
  Prior to PHP 8.0, SimpleXMLElement::key was only declared on the subclass <class>SimpleXMLIterator</class>.
  
  This method gets the XML tag name of the current element.

<comment>Return:</comment>
  <info>string</info>  Returns the XML tag name of the element referenced by the current <class>SimpleXMLElement</class> object.


id: SimpleXMLElement::next
type: function
doc:
<comment>Description:</comment>
  Move to next element
  
  Prior to PHP 8.0, SimpleXMLElement::next was only declared on the subclass <class>SimpleXMLIterator</class>.
  
  This method moves the <class>SimpleXMLElement</class> to the next element.

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


id: SimpleXMLElement::registerXPathNamespace
type: function
doc:
<comment>Description:</comment>
  Erzeugt einen Prefix/Namespace-Kontext für den nächsten XPath-Query
    
  
  Erzeugt einen Prefix/Namespace-Kontext für den nächsten XPath-Query. Dies ist besonders hilfreich,
  wenn der Anbieter des übergebenen XML-Dokuments die Namespace-Prefixe verändert hat.
  <return>registerXPathNamespace</return> erzeugt einen Prefix für die dazugehörigen Namespaces, die das Abfragen der
  Knoten in diesem Namespace erlauben, ohne dass der Code verändert werden muss, um die vom Anbieter
  diktierten neuen Prefixes zu erlauben.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>     Der Namespace-Prefix der im XPath-Query für den angegebenen Namespace
                      verwendet werden soll. <strong>$namespace</strong>.
  <info>string</info>  <strong>$namespace</strong>  Der Namespace, der für den XPath-Query verwendet wird. Dies muss einem
                      Namespace entsprechen, der im XML-Dokument oder im XPath-Query 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>
   * SimpleXMLElement::xpath
   * SimpleXMLElement::getDocNamespaces
   * SimpleXMLElement::getNamespaces


id: SimpleXMLElement::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind to the first element
  
  Prior to PHP 8.0, SimpleXMLElement::rewind was only declared on the subclass <class>SimpleXMLIterator</class>.
  
  This method rewinds the <class>SimpleXMLElement</class> to the first element.

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


id: SimpleXMLElement::saveXML
type: function
doc:
<comment>Description:</comment>
  Alias von SimpleXMLElement::asXML
  
  Diese Methode ist ein Alias für:  SimpleXMLElement::asXML


id: SimpleXMLElement::valid
type: function
doc:
<comment>Description:</comment>
  Check whether the current element is valid
  
  Prior to PHP 8.0, SimpleXMLElement::valid was only declared on the subclass <class>SimpleXMLIterator</class>.
  
  This method checks if the current element is valid after calls to SimpleXMLElement::rewind or
  SimpleXMLElement::next.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the current element is valid, otherwise <info>false</info>


id: SimpleXMLElement::xpath
type: function
doc:
<comment>Description:</comment>
  Führt eine XPath-Anfrage auf XML-Daten aus
  
  Die <return>xpath</return>-Methode durchsucht den SimpleXML-Knoten nach Kind-Elementen, die der XPath
  <strong>$expression</strong>-Anfrage entsprechen.

<comment>Param:</comment>
  <info>string</info>  <strong>$expression</strong>  Ein XPath-Pfad.

<comment>Return:</comment>
  <info>array|null|false</info>  Die Funktion gibt bei Erfolg ein <info>Array</info> von SimpleXMLElement-Objekten zurück und
                    <info>null</info> oder <info>false</info> im Fehlerfall.

<comment>See Also:</comment>
   * SimpleXMLElement::registerXPathNamespace
   * SimpleXMLElement::getDocNamespaces
   * SimpleXMLElement::getNamespaces
   * 


id: SimpleXMLIterator
type: class
doc:
<comment>Description:</comment>
  Der SimpleXMLIterator ermöglicht die rekursive Iteration über alle Knoten eines
  <class>SimpleXMLElement</class>-Objektes.


id: SoapClient
type: class
doc:
<comment>Description:</comment>
  Die Klasse SoapClient stellt einen Client für SOAP 1.1- und SOAP 1.2-Server zur Verfügung. Sie
  kann im WSDL oder non-WSDL-Modus verwendet werden.


id: SoapClient::__call
type: function
doc:
<comment>Description:</comment>
  Ruft eine SOAP-Funktion auf (veraltet)
  
  Der Aufruf dieser Methode wird missbilligt. Normalerweise können SOAP-Funktionen als Methoden des
  <class>SoapClient</class>-Objekts aufgerufen werden; in Situationen wo das nicht möglich ist, oder zusätzliche
  Optionen benötigt werden, ist SoapClient::__soapCall zu verwenden.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Der Name der aufzurufenden SOAP-Funktion.
  <info>array</info>   <strong>$args</strong>  Ein Array mit den Parametern, die an die Funktion übergeben werden sollen. Dies
                 kann entweder ein geordnetes oder ein assoziatives Array sein. Zu beachten ist,
                 dass die meisten SOAP-Server die Angabe von Parameternamen verlangen, weshalb es in
                 diesem Fall ein assoziatives Array sein muss.

<comment>Return:</comment>
  <info>mixed</info>  SOAP-Funktionen können einen oder mehrere Werte zurückgeben. Wenn von einer SOAP-Funktion
         nur ein Wert zurückgegeben wird, ist der Rückgabewert ein Skalar. Wenn mehrere Werte
         zurückgegeben werden, wird stattdessen ein assoziatives Array von benannten
         Ausgabeparameter zurückgegeben.
         
         Wenn das <class>SoapClient</class>-Objekt mit der auf <info>false</info> gesetzten Option <return>exceptions</return> erstellt wurde,
         wird bei einem Fehler ein <class>SoapFault</class>-Objekt zurückgegeben.


id: SoapClient::__construct
type: function
doc:
<comment>Description:</comment>
  SoapClient-Konstruktor
  
  Erstellt ein <class>SoapClient</class>-Objekt, um eine Verbindung zu einem SOAP-Dienst herzustellen.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$wsdl</strong>                Der URI einer WSDL-Datei, die den Dienst beschreibt, der
                                    verwendet wird, um den Client automatisch zu konfigurieren. Wenn
                                    er nicht angegeben wird, arbeitet der Client im non-WSDL-Modus.
                                    
                                    Standardmäßig wird die WSDL-Datei aus Performance-Gründen
                                    zwischengespeichert. Um diese Zwischenspeicherung zu
                                    deaktivieren oder zu konfigurieren, siehe die
                                    SOAP-Konfigurationsoptionen und die Option <return>cache_wsdl</return>.
  <info>array</info>        <strong>$options</strong>             Ein assoziatives Array, das zusätzliche Optionen für den
                                    SOAP-Client angibt. Wenn <strong>$wsdl</strong> angegeben wird, ist es optional,
                                    andernfalls müssen mindestens <return>location</return> und <return>url</return> angegeben werden.
                                    <strong>$location</strong><info>string</info> Die URL des SOAP-Servers, an den die Anfrage
                                    gesendet werden soll.  Wird benötigt, wenn der Parameter <strong>$wsdl</strong>
                                    nicht angegeben wird. Wenn sowohl der Parameter <strong>$wsdl</strong> als auch
                                    die Option <return>location</return> angegeben werden, überschreibt die Option
                                    <return>location</return> alle in der WSDL-Datei angegeben Orte. <strong>$uri</strong><info>string</info> Der
                                    Ziel-Namensraum des SOAP-Dienstes.  Wird benötigt, wenn der
                                    Parameter <strong>$wsdl</strong> nicht angegeben wird, andernfalls wird er
                                    ignoriert. <strong>$style</strong><info>int</info> Mit den Konstanten <info>SOAP_RPC</info> und
                                    <info>SOAP_DOCUMENT</info> kann der Bindungsstil angegeben werden, der für
                                    diesen Client verwendet werden soll. <info>SOAP_RPC</info> gibt an, dass die
                                    Bindung im RPC-Stil verwendet werden soll, bei der der Body der
                                    SOAP-Anfrage die Standardkodierung des Funktionsaufrufs enthält.
                                    <info>SOAP_DOCUMENT</info> gibt an, dass die Bindung im Dokumentenstil
                                    verwendet werden soll, wobei der Body der SOAP-Anfrage ein
                                    XML-Dokument mit einer durch den Dienst definierten Bedeutung
                                    enthält.  Wenn der Parameter <strong>$wsdl</strong> angegeben wird, wird diese
                                    Option ignoriert und der Stil wird aus der WSDL-Datei gelesen.
                                    Wenn weder diese Option noch der Parameter <strong>$wsdl</strong> angegeben wird,
                                    wird der RPC-Stil verwendet. <strong>$use</strong><info>int</info> Mit den Konstanten
                                    <info>SOAP_ENCODED</info> und <info>SOAP_LITERAL</info> kann der Kodierungsstil angegeben
                                    werden, der für diesem Client verwendet werden soll.
                                    <info>SOAP_ENCODED</info> gibt an, dass ein in der SOAP-Spezifikation
                                    definierter Kodierungstyp verwendet werden soll. <info>SOAP_LITERAL</info>
                                    gibt an, dass das vom Dienst definierte Schema für die Kodierung
                                    verwendet werden soll.  Wenn der Parameter <strong>$wsdl</strong> angegeben wird,
                                    wird diese Option ignoriert und die Kodierung wird aus der
                                    WSDL-Datei gelesen.  Wenn weder diese Option noch der Parameter
                                    <strong>$wsdl</strong> angegeben wird, wird der Stil "encoded" verwendet.
                                    <strong>$soap_version</strong><info>int</info> Gibt die Version des SOAP-Protokolls an, die
                                    verwendet werden soll: <info>SOAP_1_1</info> für SOAP 1.1 oder <info>SOAP_1_2</info> für
                                    SOAP 1.2.  Wenn diese Option weggelassen wird, wird SOAP 1.1
                                    verwendet. <strong>$authentication</strong><info>int</info> Wenn für Anfragen die
                                    HTTP-Authentifizierung verwendet wird, bestimmt diese Option die
                                    Authentifizierungsmethode. Als Wert kann
                                    <info>SOAP_AUTHENTICATION_BASIC</info> oder <info>SOAP_AUTHENTICATION_DIGEST</info>
                                    angegeben werden.  Wenn diese Option weggelassen wird und die
                                    Option <return>login</return> vorhanden ist, wird die Basic Authentication
                                    verwendet. <strong>$login</strong><info>string</info> Der Benutzername, der für die Basic oder
                                    Digest Authentication verwendet wird. <strong>$password</strong><info>string</info> Das
                                    Passwort, das für die Basic oder Digest Authentication verwendet
                                    wird.  Nicht zu verwechseln mit <return>passphrase</return>, das für die
                                    Authentifizierung mit HTTPS-Client-Zertifikat verwendet wird.
                                    <strong>$local_cert</strong><info>string</info> Der Pfad zu einem Client-Zertifikat für die
                                    Verwendung mit der HTTPS-Authentifizierung. Es muss sich um eine
                                    PEM-kodierte Datei handeln, die das Zertifikat und den privaten
                                    Schlüssel enthält.  Die Datei kann auch eine Kette von
                                    Zertifikatsausstellern enthalten, die hinter dem
                                    Client-Zertifikat angehängt sein muss.  Kann auch mittels
                                    <strong>$stream_context</strong> gesetzt werden, das auch die Angabe einer
                                    separaten privaten Schlüsseldatei unterstützt. <strong>$passphrase</strong><info>string</info>
                                    Die Passphrase für das Client-Zertifikat, das in der Option
                                    <return>local_cert</return> angegeben ist.  Nicht zu verwechseln mit <return>password</return>,
                                    das für die Basic oder Digest Authentication verwendet wird.
                                    Kann auch mittels <strong>$stream_context</strong> gesetzt werden.
                                    <strong>$proxy_host</strong><info>string</info> Der Hostname, der als Proxy-Server für
                                    HTTP-Anfragen verwendet werden soll.  Die Option <return>proxy_port</return> muss
                                    ebenfalls angegeben werden. <strong>$proxy_port</strong><info>int</info> Der TCP-Port, der bei
                                    der Verbindung mit dem in <return>proxy_host</return> angegebenen Proxy-Server
                                    verwendet werden soll. <strong>$proxy_login</strong><info>string</info> Optionaler
                                    Benutzername zur Authentifizierung bei dem in <return>proxy_host</return>
                                    angegebenen Proxyserver, unter Verwendung der HTTP Basic
                                    Authentication. <strong>$proxy_password</strong><info>string</info> Optionales Passwort zur
                                    Authentifizierung bei dem in <return>proxy_host</return> angegebenen Proxyserver,
                                    unter Verwendung der HTTP Basic Authentication. <strong>$compression</strong><info>int</info>
                                    Aktiviert die Komprimierung von HTTP-SOAP-Anfragen und
                                    -Antworten.  Der Wert ist ein bitweises OR aus drei Teilen: das
                                    optionale <info>SOAP_COMPRESSION_ACCEPT</info>, um einen
                                    "Accept-Encoding"-Header zu senden, entweder
                                    <info>SOAP_COMPRESSION_GZIP</info> oder <info>SOAP_COMPRESSION_DEFLATE</info>, um den zu
                                    verwendenden Komprimierungsalgorithmus anzugeben, und eine Zahl
                                    zwischen 1 und 9, um die Komprimierungsstufe anzugeben, die in
                                    der Anfrage verwendet werden soll. Um zum Beispiel eine
                                    bidirektionale Gzip-Kompression mit der maximalen
                                    Komprimierungsstufe zu aktivieren, wird <return>SOAP_COMPRESSION_ACCEPT
                                    | SOAP_COMPRESSION_GZIP | 9</return> verwendet. <strong>$encoding</strong><info>string</info> Gibt die
                                    interne Zeichenkodierung an. Anfragen werden immer von der hier
                                    angegebenen Kodierung in UTF-8 umgewandelt und Antworten werden
                                    in diese Kodierung umgewandelt. <strong>$trace</strong><info>bool</info> Erfasst Anfrage- und
                                    Antwortinformationen, auf die dann mit den Methoden
                                    SoapClient::__getLastRequest,
                                    SoapClient::__getLastRequestHeaders,
                                    SoapClient::__getLastResponse und
                                    SoapClient::__getLastResponseHeaders zugegriffen werden kann.
                                    Falls nicht angegeben, ist der Standardwert <info>false</info>.
                                    <strong>$classmap</strong><info>array</info> Wird verwendet, um in der WSDL definierte Typen
                                    auf PHP-Klassen abzubilden. Diese Option benötigt ein
                                    assoziatives <info>Array</info> mit den Typnamen aus der WSDL als Schlüssel
                                    und den Namen von PHP-Klassen als Werte. Es ist zu beachten,
                                    dass der Typname eines Elements nicht notwendigerweise derselbe
                                    ist wie der (Tag-)Name des Elements.  Die angegebenen
                                    Klassennamen müssen immer voll qualifiziert sein mit allen
                                    Namensräumen und dürfen nicht mit einem <return>\</return> beginnen. Die korrekte
                                    Form kann mit ::class erzeugt werden.  Zu beachten ist auch,
                                    dass beim Erstellen einer Klasse nicht der Konstruktor
                                    aufgerufen wird, sondern die Methoden __set() und __get() für
                                    die einzelnen Eigenschaften aufgerufen werden. <strong>$typemap</strong><info>array</info>
                                    Wird verwendet, um Typzuordnungen mit Hilfe benutzerdefinierter
                                    Callback-Funktionen zu definieren. Jede Typzuordnung ist ein
                                    Array mit den Schlüsseln <return>type_name</return> (eine Zeichenkette, die den
                                    Typ des XML-Elements angibt), <return>type_ns</return> (eine Zeichenkette mit dem
                                    Namesraum-URI), <return>from_xml</return> (ein <info>Callable</info>, das eine Zeichenkette
                                    als Parameter akzeptiert und ein Objekt zurückgibt) und <return>to_xml</return>
                                    (ein <info>Callable</info>, das ein Objekt als Parameter akzeptiert und eine
                                    Zeichenkette zurückgibt). <strong>$exceptions</strong><info>bool</info> Legt fest, ob Fehler
                                    Exceptions des Typs <class>SoapFault</class> auslösen.  Der Standardwert ist
                                    <info>true</info> <strong>$connection_timeout</strong><info>int</info> Legt das Zeitlimit für die
                                    Verbindung mit dem SOAP-Dienst fest (in Sekunden). Mit dieser
                                    Option wird kein Zeitlimit für Dienste mit langsamen Antworten
                                    festgelegt. Um die Zeit zu begrenzen, die auf den Abschluss von
                                    Aufrufen gewartet wird, steht die Konfigurationsoption
                                    default_socket_timeout zur Verfügung. <strong>$cache_wsdl</strong><info>int</info> Wenn der
                                    Parameter <strong>$wsdl</strong> angegeben wird, und die Konfigurationsoption
                                    soap.wsdl_cache_enabled aktiviert ist, bestimmt diese Option die
                                    Art der Zwischenspeicherung. Es kann einer der Werte
                                    <info>WSDL_CACHE_NONE</info>, <info>WSDL_CACHE_DISK</info>, <info>WSDL_CACHE_MEMORY</info> oder
                                    <info>WSDL_CACHE_BOTH</info> sein.  Es stehen zwei Arten von Caches zur
                                    Verfügung: In-Memory-Caching, bei dem die WSDL im Speicher des
                                    aktuellen Prozesses zwischenspeichert wird, und
                                    Festplatten-Caching, bei dem die WSDL auf der Festplatte in
                                    einer Datei zwischenspeichert wird, die von allen Prozessen
                                    gemeinsam genutzt werden kann. Das Verzeichnis, das für den
                                    Festplatten-Cache verwendet wird, kann durch die
                                    Konfigurationsoption soap.wsdl_cache_dir angegeben werden. Beide
                                    Caches verwenden die gleiche Lebensdauer, die durch die
                                    Konfigurationsoption soap.wsdl_cache_ttl festgelegt ist. Für den
                                    In-Memory-Cache kann die maximale Anzahl von Einträgen mit der
                                    Konfigurationsoption soap.wsdl_cache_limit festgelegt werden.
                                    Falls nicht angegeben, wird die Konfigurationsoption
                                    soap.wsdl_cache verwendet. <strong>$user_agent</strong><info>string</info> Der Wert, der im
                                    HTTP-Header <return>User-Agent</return> bei Anfragen zu verwenden ist.  Dieser
                                    Wert kann auch über <strong>$stream_context</strong> gesetzt werden.  Falls nicht
                                    angegeben, ist der User-Agent <return>"PHP-SOAP/"</return>, gefolgt vom Wert der
                                    Konstante <info>PHP_VERSION</info>. <strong>$stream_context</strong><info>resource</info> Ein
                                    Stream-Kontext, der mit der Funktion <strong>stream_context_create()</strong>
                                    erstellt werden kann und es ermöglicht, zusätzliche Optionen zu
                                    setzen.  Der Kontext kann Socket-Kontextoptionen,
                                    SSL-Kontextoptionen, sowie ausgewählte HTTP-Kontextoptionen
                                    enthalten: <return>content_type</return>, <return>header</return>, <return>max_redirects</return>, <return>protocol_version</return>
                                    und <return>user_agent</return>.  Es ist zu beachten, dass die folgenden
                                    HTTP-Header automatisch oder aus anderen Optionen generiert
                                    werden, und dass sie ignoriert werden, wenn sie in der
                                    Kontextoption <return>'header'</return> angegeben werden: <return>host</return>, <return>connection</return>,
                                    <return>user-agent</return>, <return>content-length</return>, <return>content-type</return>, <return>cookie</return>, <return>authorization</return>
                                    und <return>proxy-authorization</return>. <strong>$features</strong><info>int</info> Eine Bitmaske zur
                                    Aktivierung einer oder mehrerer der folgenden Funktionen:
                                    <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> Beim Dekodieren einer Antwort in ein
                                    Array wird standardmäßig automatisch erkannt, ob der Name eines
                                    Elements einmal oder mehrmals in einem bestimmten übergeordneten
                                    Element vorkommt. Bei Elementen, die nur einmal vorkommen, kann
                                    der Inhalt direkt über die Eigenschaften des Objekts abgerufen
                                    werden. Bei Elementen, die mehrfach vorkommen, enthält die
                                    Eigenschaft ein Array mit dem Inhalt der entsprechenden
                                    Elemente.  Wenn das Feature <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> aktiviert
                                    ist, werden die Elemente, die nur einmal vorkommen, in einem
                                    Array mit einem einzigen Element abgelegt, sodass der Zugriff
                                    für alle Elemente konsistent ist. Dies hat nur eine Auswirkung,
                                    wenn eine WSDL verwendet wird, die ein Schema für die Antwort
                                    enthält. Im Abschnitt Beispiele wird dies anschaulich
                                    dargestellt. <info>SOAP_USE_XSI_ARRAY_TYPE</info> Wenn die Option <return>use</return> oder
                                    die WSDL-Eigenschaft auf <return>encoded</return> gesetzt ist, verwenden Arrays
                                    statt eines schemaspezifischen Typs den Typ <return>SOAP-ENC:Array</return>.
                                    <info>SOAP_WAIT_ONE_WAY_CALLS</info> Auf eine Antwort warten, auch wenn die
                                    WSDL eine einseitige Anfrage angibt.  <strong>$keep_alive</strong><info>bool</info> Ein
                                    boolescher Wert, der definiert, ob der Header <return>Connection:
                                    Keep-Alive</return> oder der Header <return>Connection: close</return> gesendet wird.  Der
                                    Standardwert ist <info>true</info> <strong>$ssl_method</strong><info>string</info> Gibt die SSL- oder
                                    TLS-Protokollversion an, die für sichere HTTP-Verbindungen
                                    anstelle der Standardvereinbarung (default negotiation)
                                    verwendet werden soll. Die Angabe von <info>SOAP_SSL_METHOD_SSLv2</info> oder
                                    <info>SOAP_SSL_METHOD_SSLv3</info> erzwingt die Verwendung von SSL 2 bzw. SSL
                                    3. Die Angabe von <info>SOAP_SSL_METHOD_SSLv23</info> hat keine Auswirkung;
                                    Diese Konstante existiert nur aus Gründen der
                                    Abwärtskompatibilität. Seit PHP 7.2 hat auch die Angabe von
                                    <info>SOAP_SSL_METHOD_TLS</info> keine Auswirkung mehr; in früheren Versionen
                                    erzwang sie die Verwendung von TLS 1.0.  Es ist zu beachten,
                                    dass die SSL-Versionen 2 und 3 als unsicher gelten und von der
                                    installierten OpenSSL-Bibliothek möglicherweise nicht
                                    unterstützt werden.  Diese Option ist seit PHP 8.1.0 als
                                    VERALTET markiert und sollte nicht mehr verwendet werden. Die
                                    Option <strong>$stream_context</strong> bietet mit dem Kontextparameter
                                    'crypto_method' eine flexiblere Alternative, die es ermöglicht,
                                    einzelne Versionen von TLS anzugeben. Die Verwendung von TLS 1.3
                                    vorschreiben [ 'crypto_method' =>
                                    STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT ]
                                    ]);
                                    $client = new SoapClient("some.wsdl", ['context' => $context]);
                                    ]]> 
                                    
                                    Die URL des SOAP-Servers, an den die Anfrage gesendet werden
                                    soll.
                                    
                                    Wird benötigt, wenn der Parameter <strong>$wsdl</strong> nicht angegeben wird.
                                    Wenn sowohl der Parameter <strong>$wsdl</strong> als auch die Option <return>location</return>
                                    angegeben werden, überschreibt die Option <return>location</return> alle in der
                                    WSDL-Datei angegeben Orte.
                                    
                                    Der Ziel-Namensraum des SOAP-Dienstes.
                                    
                                    Wird benötigt, wenn der Parameter <strong>$wsdl</strong> nicht angegeben wird,
                                    andernfalls wird er ignoriert.
                                    
                                    Mit den Konstanten <info>SOAP_RPC</info> und <info>SOAP_DOCUMENT</info> kann der
                                    Bindungsstil angegeben werden, der für diesen Client verwendet
                                    werden soll. <info>SOAP_RPC</info> gibt an, dass die Bindung im RPC-Stil
                                    verwendet werden soll, bei der der Body der SOAP-Anfrage die
                                    Standardkodierung des Funktionsaufrufs enthält. <info>SOAP_DOCUMENT</info>
                                    gibt an, dass die Bindung im Dokumentenstil verwendet werden
                                    soll, wobei der Body der SOAP-Anfrage ein XML-Dokument mit einer
                                    durch den Dienst definierten Bedeutung enthält.
                                    
                                    Wenn der Parameter <strong>$wsdl</strong> angegeben wird, wird diese Option
                                    ignoriert und der Stil wird aus der WSDL-Datei gelesen.
                                    
                                    Wenn weder diese Option noch der Parameter <strong>$wsdl</strong> angegeben wird,
                                    wird der RPC-Stil verwendet.
                                    
                                    Mit den Konstanten <info>SOAP_ENCODED</info> und <info>SOAP_LITERAL</info> kann der
                                    Kodierungsstil angegeben werden, der für diesem Client verwendet
                                    werden soll. <info>SOAP_ENCODED</info> gibt an, dass ein in der
                                    SOAP-Spezifikation definierter Kodierungstyp verwendet werden
                                    soll. <info>SOAP_LITERAL</info> gibt an, dass das vom Dienst definierte
                                    Schema für die Kodierung verwendet werden soll.
                                    
                                    Wenn der Parameter <strong>$wsdl</strong> angegeben wird, wird diese Option
                                    ignoriert und die Kodierung wird aus der WSDL-Datei gelesen.
                                    
                                    Wenn weder diese Option noch der Parameter <strong>$wsdl</strong> angegeben wird,
                                    wird der Stil "encoded" verwendet.
                                    
                                    Gibt die Version des SOAP-Protokolls an, die verwendet werden
                                    soll: <info>SOAP_1_1</info> für SOAP 1.1 oder <info>SOAP_1_2</info> für SOAP 1.2.
                                    
                                    Wenn diese Option weggelassen wird, wird SOAP 1.1 verwendet.
                                    
                                    Wenn für Anfragen die HTTP-Authentifizierung verwendet wird,
                                    bestimmt diese Option die Authentifizierungsmethode. Als Wert
                                    kann <info>SOAP_AUTHENTICATION_BASIC</info> oder <info>SOAP_AUTHENTICATION_DIGEST</info>
                                    angegeben werden.
                                    
                                    Wenn diese Option weggelassen wird und die Option <return>login</return>
                                    vorhanden ist, wird die Basic Authentication verwendet.
                                    
                                    Der Benutzername, der für die Basic oder Digest Authentication
                                    verwendet wird.
                                    
                                    Das Passwort, das für die Basic oder Digest Authentication
                                    verwendet wird.
                                    
                                    Nicht zu verwechseln mit <return>passphrase</return>, das für die
                                    Authentifizierung mit HTTPS-Client-Zertifikat verwendet wird.
                                    
                                    Der Pfad zu einem Client-Zertifikat für die Verwendung mit der
                                    HTTPS-Authentifizierung. Es muss sich um eine PEM-kodierte Datei
                                    handeln, die das Zertifikat und den privaten Schlüssel enthält.
                                    
                                    Die Datei kann auch eine Kette von Zertifikatsausstellern
                                    enthalten, die hinter dem Client-Zertifikat angehängt sein muss.
                                    
                                    Kann auch mittels <strong>$stream_context</strong> gesetzt werden, das auch die
                                    Angabe einer separaten privaten Schlüsseldatei unterstützt.
                                    
                                    Die Passphrase für das Client-Zertifikat, das in der Option
                                    <return>local_cert</return> angegeben ist.
                                    
                                    Nicht zu verwechseln mit <return>password</return>, das für die Basic oder Digest
                                    Authentication verwendet wird.
                                    
                                    Kann auch mittels <strong>$stream_context</strong> gesetzt werden.
                                    
                                    Der Hostname, der als Proxy-Server für HTTP-Anfragen verwendet
                                    werden soll.
                                    
                                    Die Option <return>proxy_port</return> muss ebenfalls angegeben werden.
                                    
                                    Der TCP-Port, der bei der Verbindung mit dem in <return>proxy_host</return>
                                    angegebenen Proxy-Server verwendet werden soll.
                                    
                                    Optionaler Benutzername zur Authentifizierung bei dem in
                                    <return>proxy_host</return> angegebenen Proxyserver, unter Verwendung der HTTP
                                    Basic Authentication.
                                    
                                    Optionales Passwort zur Authentifizierung bei dem in <return>proxy_host</return>
                                    angegebenen Proxyserver, unter Verwendung der HTTP Basic
                                    Authentication.
                                    
                                    Aktiviert die Komprimierung von HTTP-SOAP-Anfragen und
                                    -Antworten.
                                    
                                    Der Wert ist ein bitweises OR aus drei Teilen: das optionale
                                    <info>SOAP_COMPRESSION_ACCEPT</info>, um einen "Accept-Encoding"-Header zu
                                    senden, entweder <info>SOAP_COMPRESSION_GZIP</info> oder
                                    <info>SOAP_COMPRESSION_DEFLATE</info>, um den zu verwendenden
                                    Komprimierungsalgorithmus anzugeben, und eine Zahl zwischen 1
                                    und 9, um die Komprimierungsstufe anzugeben, die in der Anfrage
                                    verwendet werden soll. Um zum Beispiel eine bidirektionale
                                    Gzip-Kompression mit der maximalen Komprimierungsstufe zu
                                    aktivieren, wird <return>SOAP_COMPRESSION_ACCEPT | SOAP_COMPRESSION_GZIP
                                    | 9</return> verwendet.
                                    
                                    Gibt die interne Zeichenkodierung an. Anfragen werden immer von
                                    der hier angegebenen Kodierung in UTF-8 umgewandelt und
                                    Antworten werden in diese Kodierung umgewandelt.
                                    
                                    Erfasst Anfrage- und Antwortinformationen, auf die dann mit den
                                    Methoden SoapClient::__getLastRequest,
                                    SoapClient::__getLastRequestHeaders,
                                    SoapClient::__getLastResponse und
                                    SoapClient::__getLastResponseHeaders zugegriffen werden kann.
                                    
                                    Falls nicht angegeben, ist der Standardwert <info>false</info>.
                                    
                                    Wird verwendet, um in der WSDL definierte Typen auf PHP-Klassen
                                    abzubilden. Diese Option benötigt ein assoziatives <info>Array</info> mit den
                                    Typnamen aus der WSDL als Schlüssel und den Namen von
                                    PHP-Klassen als Werte. Es ist zu beachten, dass der Typname
                                    eines Elements nicht notwendigerweise derselbe ist wie der
                                    (Tag-)Name des Elements.
                                    
                                    Die angegebenen Klassennamen müssen immer voll qualifiziert sein
                                    mit allen Namensräumen und dürfen nicht mit einem <return>\</return> beginnen.
                                    Die korrekte Form kann mit ::class erzeugt werden.
                                    
                                    Zu beachten ist auch, dass beim Erstellen einer Klasse nicht der
                                    Konstruktor aufgerufen wird, sondern die Methoden __set() und
                                    __get() für die einzelnen Eigenschaften aufgerufen werden.
                                    
                                    Wird verwendet, um Typzuordnungen mit Hilfe benutzerdefinierter
                                    Callback-Funktionen zu definieren. Jede Typzuordnung ist ein
                                    Array mit den Schlüsseln <return>type_name</return> (eine Zeichenkette, die den
                                    Typ des XML-Elements angibt), <return>type_ns</return> (eine Zeichenkette mit dem
                                    Namesraum-URI), <return>from_xml</return> (ein <info>Callable</info>, das eine Zeichenkette
                                    als Parameter akzeptiert und ein Objekt zurückgibt) und <return>to_xml</return>
                                    (ein <info>Callable</info>, das ein Objekt als Parameter akzeptiert und eine
                                    Zeichenkette zurückgibt).
                                    
                                    Legt fest, ob Fehler Exceptions des Typs <class>SoapFault</class> auslösen.
                                    
                                    Der Standardwert ist <info>true</info>
                                    
                                    Legt das Zeitlimit für die Verbindung mit dem SOAP-Dienst fest
                                    (in Sekunden). Mit dieser Option wird kein Zeitlimit für Dienste
                                    mit langsamen Antworten festgelegt. Um die Zeit zu begrenzen,
                                    die auf den Abschluss von Aufrufen gewartet wird, steht die
                                    Konfigurationsoption default_socket_timeout zur Verfügung.
                                    
                                    Wenn der Parameter <strong>$wsdl</strong> angegeben wird, und die
                                    Konfigurationsoption soap.wsdl_cache_enabled aktiviert ist,
                                    bestimmt diese Option die Art der Zwischenspeicherung. Es kann
                                    einer der Werte <info>WSDL_CACHE_NONE</info>, <info>WSDL_CACHE_DISK</info>,
                                    <info>WSDL_CACHE_MEMORY</info> oder <info>WSDL_CACHE_BOTH</info> sein.
                                    
                                    Es stehen zwei Arten von Caches zur Verfügung:
                                    In-Memory-Caching, bei dem die WSDL im Speicher des aktuellen
                                    Prozesses zwischenspeichert wird, und Festplatten-Caching, bei
                                    dem die WSDL auf der Festplatte in einer Datei zwischenspeichert
                                    wird, die von allen Prozessen gemeinsam genutzt werden kann. Das
                                    Verzeichnis, das für den Festplatten-Cache verwendet wird, kann
                                    durch die Konfigurationsoption soap.wsdl_cache_dir angegeben
                                    werden. Beide Caches verwenden die gleiche Lebensdauer, die
                                    durch die Konfigurationsoption soap.wsdl_cache_ttl festgelegt
                                    ist. Für den In-Memory-Cache kann die maximale Anzahl von
                                    Einträgen mit der Konfigurationsoption soap.wsdl_cache_limit
                                    festgelegt werden.
                                    
                                    Falls nicht angegeben, wird die Konfigurationsoption
                                    soap.wsdl_cache verwendet.
                                    
                                    Der Wert, der im HTTP-Header <return>User-Agent</return> bei Anfragen zu
                                    verwenden ist.
                                    
                                    Dieser Wert kann auch über <strong>$stream_context</strong> gesetzt werden.
                                    
                                    Falls nicht angegeben, ist der User-Agent <return>"PHP-SOAP/"</return>, gefolgt
                                    vom Wert der Konstante <info>PHP_VERSION</info>.
                                    
                                    Ein Stream-Kontext, der mit der Funktion <strong>stream_context_create()</strong>
                                    erstellt werden kann und es ermöglicht, zusätzliche Optionen zu
                                    setzen.
                                    
                                    Der Kontext kann Socket-Kontextoptionen, SSL-Kontextoptionen,
                                    sowie ausgewählte HTTP-Kontextoptionen enthalten: <return>content_type</return>,
                                    <return>header</return>, <return>max_redirects</return>, <return>protocol_version</return> und <return>user_agent</return>.
                                    
                                    Es ist zu beachten, dass die folgenden HTTP-Header automatisch
                                    oder aus anderen Optionen generiert werden, und dass sie
                                    ignoriert werden, wenn sie in der Kontextoption <return>'header'</return>
                                    angegeben werden: <return>host</return>, <return>connection</return>, <return>user-agent</return>, <return>content-length</return>,
                                    <return>content-type</return>, <return>cookie</return>, <return>authorization</return> und <return>proxy-authorization</return>.
                                    
                                    Eine Bitmaske zur Aktivierung einer oder mehrerer der folgenden
                                    Funktionen: <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> Beim Dekodieren einer
                                    Antwort in ein Array wird standardmäßig automatisch erkannt, ob
                                    der Name eines Elements einmal oder mehrmals in einem bestimmten
                                    übergeordneten Element vorkommt. Bei Elementen, die nur einmal
                                    vorkommen, kann der Inhalt direkt über die Eigenschaften des
                                    Objekts abgerufen werden. Bei Elementen, die mehrfach vorkommen,
                                    enthält die Eigenschaft ein Array mit dem Inhalt der
                                    entsprechenden Elemente.  Wenn das Feature
                                    <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> aktiviert ist, werden die Elemente,
                                    die nur einmal vorkommen, in einem Array mit einem einzigen
                                    Element abgelegt, sodass der Zugriff für alle Elemente
                                    konsistent ist. Dies hat nur eine Auswirkung, wenn eine WSDL
                                    verwendet wird, die ein Schema für die Antwort enthält. Im
                                    Abschnitt Beispiele wird dies anschaulich dargestellt.
                                    <info>SOAP_USE_XSI_ARRAY_TYPE</info> Wenn die Option <return>use</return> oder die
                                    WSDL-Eigenschaft auf <return>encoded</return> gesetzt ist, verwenden Arrays statt
                                    eines schemaspezifischen Typs den Typ <return>SOAP-ENC:Array</return>.
                                    <info>SOAP_WAIT_ONE_WAY_CALLS</info> Auf eine Antwort warten, auch wenn die
                                    WSDL eine einseitige Anfrage angibt.
                                    
                                    Beim Dekodieren einer Antwort in ein Array wird standardmäßig
                                    automatisch erkannt, ob der Name eines Elements einmal oder
                                    mehrmals in einem bestimmten übergeordneten Element vorkommt.
                                    Bei Elementen, die nur einmal vorkommen, kann der Inhalt direkt
                                    über die Eigenschaften des Objekts abgerufen werden. Bei
                                    Elementen, die mehrfach vorkommen, enthält die Eigenschaft ein
                                    Array mit dem Inhalt der entsprechenden Elemente.
                                    
                                    Wenn das Feature <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> aktiviert ist,
                                    werden die Elemente, die nur einmal vorkommen, in einem Array
                                    mit einem einzigen Element abgelegt, sodass der Zugriff für alle
                                    Elemente konsistent ist. Dies hat nur eine Auswirkung, wenn eine
                                    WSDL verwendet wird, die ein Schema für die Antwort enthält. Im
                                    Abschnitt Beispiele wird dies anschaulich dargestellt.
                                    
                                    Wenn die Option <return>use</return> oder die WSDL-Eigenschaft auf <return>encoded</return>
                                    gesetzt ist, verwenden Arrays statt eines schemaspezifischen
                                    Typs den Typ <return>SOAP-ENC:Array</return>.
                                    
                                    Auf eine Antwort warten, auch wenn die WSDL eine einseitige
                                    Anfrage angibt.
                                    
                                    Ein boolescher Wert, der definiert, ob der Header <return>Connection:
                                    Keep-Alive</return> oder der Header <return>Connection: close</return> gesendet wird.
                                    
                                    Der Standardwert ist <info>true</info>
                                    
                                    Gibt die SSL- oder TLS-Protokollversion an, die für sichere
                                    HTTP-Verbindungen anstelle der Standardvereinbarung (default
                                    negotiation) verwendet werden soll. Die Angabe von
                                    <info>SOAP_SSL_METHOD_SSLv2</info> oder <info>SOAP_SSL_METHOD_SSLv3</info> erzwingt die
                                    Verwendung von SSL 2 bzw. SSL 3. Die Angabe von
                                    <info>SOAP_SSL_METHOD_SSLv23</info> hat keine Auswirkung; Diese Konstante
                                    existiert nur aus Gründen der Abwärtskompatibilität. Seit PHP
                                    7.2 hat auch die Angabe von <info>SOAP_SSL_METHOD_TLS</info> keine Auswirkung
                                    mehr; in früheren Versionen erzwang sie die Verwendung von TLS
                                    1.0.
                                    
                                    Es ist zu beachten, dass die SSL-Versionen 2 und 3 als unsicher
                                    gelten und von der installierten OpenSSL-Bibliothek
                                    möglicherweise nicht unterstützt werden.
                                    
                                    Diese Option ist seit PHP 8.1.0 als VERALTET markiert und sollte
                                    nicht mehr verwendet werden. Die Option <strong>$stream_context</strong> bietet
                                    mit dem Kontextparameter 'crypto_method' eine flexiblere
                                    Alternative, die es ermöglicht, einzelne Versionen von TLS
                                    anzugeben. Die Verwendung von TLS 1.3 vorschreiben [
                                    'crypto_method' => STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT ]
                                    ]);
                                    $client = new SoapClient("some.wsdl", ['context' => $context]);
                                    ]]>
  <info></info>             <strong>$location</strong>            Die URL des SOAP-Servers, an den die Anfrage gesendet werden
                                    soll.
                                    
                                    Wird benötigt, wenn der Parameter <strong>$wsdl</strong> nicht angegeben wird.
                                    Wenn sowohl der Parameter <strong>$wsdl</strong> als auch die Option <return>location</return>
                                    angegeben werden, überschreibt die Option <return>location</return> alle in der
                                    WSDL-Datei angegeben Orte.
  <info></info>             <strong>$uri</strong>                 Der Ziel-Namensraum des SOAP-Dienstes.
                                    
                                    Wird benötigt, wenn der Parameter <strong>$wsdl</strong> nicht angegeben wird,
                                    andernfalls wird er ignoriert.
  <info></info>             <strong>$style</strong>               Mit den Konstanten <info>SOAP_RPC</info> und <info>SOAP_DOCUMENT</info> kann der
                                    Bindungsstil angegeben werden, der für diesen Client verwendet
                                    werden soll. <info>SOAP_RPC</info> gibt an, dass die Bindung im RPC-Stil
                                    verwendet werden soll, bei der der Body der SOAP-Anfrage die
                                    Standardkodierung des Funktionsaufrufs enthält. <info>SOAP_DOCUMENT</info>
                                    gibt an, dass die Bindung im Dokumentenstil verwendet werden
                                    soll, wobei der Body der SOAP-Anfrage ein XML-Dokument mit einer
                                    durch den Dienst definierten Bedeutung enthält.
                                    
                                    Wenn der Parameter <strong>$wsdl</strong> angegeben wird, wird diese Option
                                    ignoriert und der Stil wird aus der WSDL-Datei gelesen.
                                    
                                    Wenn weder diese Option noch der Parameter <strong>$wsdl</strong> angegeben wird,
                                    wird der RPC-Stil verwendet.
  <info></info>             <strong>$use</strong>                 Mit den Konstanten <info>SOAP_ENCODED</info> und <info>SOAP_LITERAL</info> kann der
                                    Kodierungsstil angegeben werden, der für diesem Client verwendet
                                    werden soll. <info>SOAP_ENCODED</info> gibt an, dass ein in der
                                    SOAP-Spezifikation definierter Kodierungstyp verwendet werden
                                    soll. <info>SOAP_LITERAL</info> gibt an, dass das vom Dienst definierte
                                    Schema für die Kodierung verwendet werden soll.
                                    
                                    Wenn der Parameter <strong>$wsdl</strong> angegeben wird, wird diese Option
                                    ignoriert und die Kodierung wird aus der WSDL-Datei gelesen.
                                    
                                    Wenn weder diese Option noch der Parameter <strong>$wsdl</strong> angegeben wird,
                                    wird der Stil "encoded" verwendet.
  <info></info>             <strong>$soap_version</strong>        Gibt die Version des SOAP-Protokolls an, die verwendet werden
                                    soll: <info>SOAP_1_1</info> für SOAP 1.1 oder <info>SOAP_1_2</info> für SOAP 1.2.
                                    
                                    Wenn diese Option weggelassen wird, wird SOAP 1.1 verwendet.
  <info></info>             <strong>$authentication</strong>      Wenn für Anfragen die HTTP-Authentifizierung verwendet wird,
                                    bestimmt diese Option die Authentifizierungsmethode. Als Wert
                                    kann <info>SOAP_AUTHENTICATION_BASIC</info> oder <info>SOAP_AUTHENTICATION_DIGEST</info>
                                    angegeben werden.
                                    
                                    Wenn diese Option weggelassen wird und die Option <return>login</return>
                                    vorhanden ist, wird die Basic Authentication verwendet.
  <info></info>             <strong>$login</strong>               Der Benutzername, der für die Basic oder Digest Authentication
                                    verwendet wird.
  <info></info>             <strong>$password</strong>            Das Passwort, das für die Basic oder Digest Authentication
                                    verwendet wird.
                                    
                                    Nicht zu verwechseln mit <return>passphrase</return>, das für die
                                    Authentifizierung mit HTTPS-Client-Zertifikat verwendet wird.
  <info></info>             <strong>$local_cert</strong>          Der Pfad zu einem Client-Zertifikat für die Verwendung mit der
                                    HTTPS-Authentifizierung. Es muss sich um eine PEM-kodierte Datei
                                    handeln, die das Zertifikat und den privaten Schlüssel enthält.
                                    
                                    Die Datei kann auch eine Kette von Zertifikatsausstellern
                                    enthalten, die hinter dem Client-Zertifikat angehängt sein muss.
                                    
                                    Kann auch mittels <strong>$stream_context</strong> gesetzt werden, das auch die
                                    Angabe einer separaten privaten Schlüsseldatei unterstützt.
  <info></info>             <strong>$passphrase</strong>          Die Passphrase für das Client-Zertifikat, das in der Option
                                    <return>local_cert</return> angegeben ist.
                                    
                                    Nicht zu verwechseln mit <return>password</return>, das für die Basic oder Digest
                                    Authentication verwendet wird.
                                    
                                    Kann auch mittels <strong>$stream_context</strong> gesetzt werden.
  <info></info>             <strong>$proxy_host</strong>          Der Hostname, der als Proxy-Server für HTTP-Anfragen verwendet
                                    werden soll.
                                    
                                    Die Option <return>proxy_port</return> muss ebenfalls angegeben werden.
  <info></info>             <strong>$proxy_port</strong>          Der TCP-Port, der bei der Verbindung mit dem in <return>proxy_host</return>
                                    angegebenen Proxy-Server verwendet werden soll.
  <info></info>             <strong>$proxy_login</strong>         Optionaler Benutzername zur Authentifizierung bei dem in
                                    <return>proxy_host</return> angegebenen Proxyserver, unter Verwendung der HTTP
                                    Basic Authentication.
  <info></info>             <strong>$proxy_password</strong>      Optionales Passwort zur Authentifizierung bei dem in <return>proxy_host</return>
                                    angegebenen Proxyserver, unter Verwendung der HTTP Basic
                                    Authentication.
  <info></info>             <strong>$compression</strong>         Aktiviert die Komprimierung von HTTP-SOAP-Anfragen und
                                    -Antworten.
                                    
                                    Der Wert ist ein bitweises OR aus drei Teilen: das optionale
                                    <info>SOAP_COMPRESSION_ACCEPT</info>, um einen "Accept-Encoding"-Header zu
                                    senden, entweder <info>SOAP_COMPRESSION_GZIP</info> oder
                                    <info>SOAP_COMPRESSION_DEFLATE</info>, um den zu verwendenden
                                    Komprimierungsalgorithmus anzugeben, und eine Zahl zwischen 1
                                    und 9, um die Komprimierungsstufe anzugeben, die in der Anfrage
                                    verwendet werden soll. Um zum Beispiel eine bidirektionale
                                    Gzip-Kompression mit der maximalen Komprimierungsstufe zu
                                    aktivieren, wird <return>SOAP_COMPRESSION_ACCEPT | SOAP_COMPRESSION_GZIP
                                    | 9</return> verwendet.
  <info></info>             <strong>$encoding</strong>            Gibt die interne Zeichenkodierung an. Anfragen werden immer von
                                    der hier angegebenen Kodierung in UTF-8 umgewandelt und
                                    Antworten werden in diese Kodierung umgewandelt.
  <info></info>             <strong>$trace</strong>               Erfasst Anfrage- und Antwortinformationen, auf die dann mit den
                                    Methoden SoapClient::__getLastRequest,
                                    SoapClient::__getLastRequestHeaders,
                                    SoapClient::__getLastResponse und
                                    SoapClient::__getLastResponseHeaders zugegriffen werden kann.
                                    
                                    Falls nicht angegeben, ist der Standardwert <info>false</info>.
  <info></info>             <strong>$classmap</strong>            Wird verwendet, um in der WSDL definierte Typen auf PHP-Klassen
                                    abzubilden. Diese Option benötigt ein assoziatives <info>Array</info> mit den
                                    Typnamen aus der WSDL als Schlüssel und den Namen von
                                    PHP-Klassen als Werte. Es ist zu beachten, dass der Typname
                                    eines Elements nicht notwendigerweise derselbe ist wie der
                                    (Tag-)Name des Elements.
                                    
                                    Die angegebenen Klassennamen müssen immer voll qualifiziert sein
                                    mit allen Namensräumen und dürfen nicht mit einem <return>\</return> beginnen.
                                    Die korrekte Form kann mit ::class erzeugt werden.
                                    
                                    Zu beachten ist auch, dass beim Erstellen einer Klasse nicht der
                                    Konstruktor aufgerufen wird, sondern die Methoden __set() und
                                    __get() für die einzelnen Eigenschaften aufgerufen werden.
  <info></info>             <strong>$typemap</strong>             Wird verwendet, um Typzuordnungen mit Hilfe benutzerdefinierter
                                    Callback-Funktionen zu definieren. Jede Typzuordnung ist ein
                                    Array mit den Schlüsseln <return>type_name</return> (eine Zeichenkette, die den
                                    Typ des XML-Elements angibt), <return>type_ns</return> (eine Zeichenkette mit dem
                                    Namesraum-URI), <return>from_xml</return> (ein <info>Callable</info>, das eine Zeichenkette
                                    als Parameter akzeptiert und ein Objekt zurückgibt) und <return>to_xml</return>
                                    (ein <info>Callable</info>, das ein Objekt als Parameter akzeptiert und eine
                                    Zeichenkette zurückgibt).
  <info></info>             <strong>$exceptions</strong>          Legt fest, ob Fehler Exceptions des Typs <class>SoapFault</class> auslösen.
                                    
                                    Der Standardwert ist <info>true</info>
  <info></info>             <strong>$connection_timeout</strong>  Legt das Zeitlimit für die Verbindung mit dem SOAP-Dienst fest
                                    (in Sekunden). Mit dieser Option wird kein Zeitlimit für Dienste
                                    mit langsamen Antworten festgelegt. Um die Zeit zu begrenzen,
                                    die auf den Abschluss von Aufrufen gewartet wird, steht die
                                    Konfigurationsoption default_socket_timeout zur Verfügung.
  <info></info>             <strong>$cache_wsdl</strong>          Wenn der Parameter <strong>$wsdl</strong> angegeben wird, und die
                                    Konfigurationsoption soap.wsdl_cache_enabled aktiviert ist,
                                    bestimmt diese Option die Art der Zwischenspeicherung. Es kann
                                    einer der Werte <info>WSDL_CACHE_NONE</info>, <info>WSDL_CACHE_DISK</info>,
                                    <info>WSDL_CACHE_MEMORY</info> oder <info>WSDL_CACHE_BOTH</info> sein.
                                    
                                    Es stehen zwei Arten von Caches zur Verfügung:
                                    In-Memory-Caching, bei dem die WSDL im Speicher des aktuellen
                                    Prozesses zwischenspeichert wird, und Festplatten-Caching, bei
                                    dem die WSDL auf der Festplatte in einer Datei zwischenspeichert
                                    wird, die von allen Prozessen gemeinsam genutzt werden kann. Das
                                    Verzeichnis, das für den Festplatten-Cache verwendet wird, kann
                                    durch die Konfigurationsoption soap.wsdl_cache_dir angegeben
                                    werden. Beide Caches verwenden die gleiche Lebensdauer, die
                                    durch die Konfigurationsoption soap.wsdl_cache_ttl festgelegt
                                    ist. Für den In-Memory-Cache kann die maximale Anzahl von
                                    Einträgen mit der Konfigurationsoption soap.wsdl_cache_limit
                                    festgelegt werden.
                                    
                                    Falls nicht angegeben, wird die Konfigurationsoption
                                    soap.wsdl_cache verwendet.
  <info></info>             <strong>$user_agent</strong>          Der Wert, der im HTTP-Header <return>User-Agent</return> bei Anfragen zu
                                    verwenden ist.
                                    
                                    Dieser Wert kann auch über <strong>$stream_context</strong> gesetzt werden.
                                    
                                    Falls nicht angegeben, ist der User-Agent <return>"PHP-SOAP/"</return>, gefolgt
                                    vom Wert der Konstante <info>PHP_VERSION</info>.
  <info></info>             <strong>$stream_context</strong>      Ein Stream-Kontext, der mit der Funktion <strong>stream_context_create()</strong>
                                    erstellt werden kann und es ermöglicht, zusätzliche Optionen zu
                                    setzen.
                                    
                                    Der Kontext kann Socket-Kontextoptionen, SSL-Kontextoptionen,
                                    sowie ausgewählte HTTP-Kontextoptionen enthalten: <return>content_type</return>,
                                    <return>header</return>, <return>max_redirects</return>, <return>protocol_version</return> und <return>user_agent</return>.
                                    
                                    Es ist zu beachten, dass die folgenden HTTP-Header automatisch
                                    oder aus anderen Optionen generiert werden, und dass sie
                                    ignoriert werden, wenn sie in der Kontextoption <return>'header'</return>
                                    angegeben werden: <return>host</return>, <return>connection</return>, <return>user-agent</return>, <return>content-length</return>,
                                    <return>content-type</return>, <return>cookie</return>, <return>authorization</return> und <return>proxy-authorization</return>.
  <info></info>             <strong>$features</strong>            Eine Bitmaske zur Aktivierung einer oder mehrerer der folgenden
                                    Funktionen: <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> Beim Dekodieren einer
                                    Antwort in ein Array wird standardmäßig automatisch erkannt, ob
                                    der Name eines Elements einmal oder mehrmals in einem bestimmten
                                    übergeordneten Element vorkommt. Bei Elementen, die nur einmal
                                    vorkommen, kann der Inhalt direkt über die Eigenschaften des
                                    Objekts abgerufen werden. Bei Elementen, die mehrfach vorkommen,
                                    enthält die Eigenschaft ein Array mit dem Inhalt der
                                    entsprechenden Elemente.  Wenn das Feature
                                    <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> aktiviert ist, werden die Elemente,
                                    die nur einmal vorkommen, in einem Array mit einem einzigen
                                    Element abgelegt, sodass der Zugriff für alle Elemente
                                    konsistent ist. Dies hat nur eine Auswirkung, wenn eine WSDL
                                    verwendet wird, die ein Schema für die Antwort enthält. Im
                                    Abschnitt Beispiele wird dies anschaulich dargestellt.
                                    <info>SOAP_USE_XSI_ARRAY_TYPE</info> Wenn die Option <return>use</return> oder die
                                    WSDL-Eigenschaft auf <return>encoded</return> gesetzt ist, verwenden Arrays statt
                                    eines schemaspezifischen Typs den Typ <return>SOAP-ENC:Array</return>.
                                    <info>SOAP_WAIT_ONE_WAY_CALLS</info> Auf eine Antwort warten, auch wenn die
                                    WSDL eine einseitige Anfrage angibt.
                                    
                                    Beim Dekodieren einer Antwort in ein Array wird standardmäßig
                                    automatisch erkannt, ob der Name eines Elements einmal oder
                                    mehrmals in einem bestimmten übergeordneten Element vorkommt.
                                    Bei Elementen, die nur einmal vorkommen, kann der Inhalt direkt
                                    über die Eigenschaften des Objekts abgerufen werden. Bei
                                    Elementen, die mehrfach vorkommen, enthält die Eigenschaft ein
                                    Array mit dem Inhalt der entsprechenden Elemente.
                                    
                                    Wenn das Feature <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> aktiviert ist,
                                    werden die Elemente, die nur einmal vorkommen, in einem Array
                                    mit einem einzigen Element abgelegt, sodass der Zugriff für alle
                                    Elemente konsistent ist. Dies hat nur eine Auswirkung, wenn eine
                                    WSDL verwendet wird, die ein Schema für die Antwort enthält. Im
                                    Abschnitt Beispiele wird dies anschaulich dargestellt.
                                    
                                    Wenn die Option <return>use</return> oder die WSDL-Eigenschaft auf <return>encoded</return>
                                    gesetzt ist, verwenden Arrays statt eines schemaspezifischen
                                    Typs den Typ <return>SOAP-ENC:Array</return>.
                                    
                                    Auf eine Antwort warten, auch wenn die WSDL eine einseitige
                                    Anfrage angibt.
  <info></info>             <strong>$keep_alive</strong>          Ein boolescher Wert, der definiert, ob der Header <return>Connection:
                                    Keep-Alive</return> oder der Header <return>Connection: close</return> gesendet wird.
                                    
                                    Der Standardwert ist <info>true</info>
  <info></info>             <strong>$ssl_method</strong>          Gibt die SSL- oder TLS-Protokollversion an, die für sichere
                                    HTTP-Verbindungen anstelle der Standardvereinbarung (default
                                    negotiation) verwendet werden soll. Die Angabe von
                                    <info>SOAP_SSL_METHOD_SSLv2</info> oder <info>SOAP_SSL_METHOD_SSLv3</info> erzwingt die
                                    Verwendung von SSL 2 bzw. SSL 3. Die Angabe von
                                    <info>SOAP_SSL_METHOD_SSLv23</info> hat keine Auswirkung; Diese Konstante
                                    existiert nur aus Gründen der Abwärtskompatibilität. Seit PHP
                                    7.2 hat auch die Angabe von <info>SOAP_SSL_METHOD_TLS</info> keine Auswirkung
                                    mehr; in früheren Versionen erzwang sie die Verwendung von TLS
                                    1.0.
                                    
                                    Es ist zu beachten, dass die SSL-Versionen 2 und 3 als unsicher
                                    gelten und von der installierten OpenSSL-Bibliothek
                                    möglicherweise nicht unterstützt werden.
                                    
                                    Diese Option ist seit PHP 8.1.0 als VERALTET markiert und sollte
                                    nicht mehr verwendet werden. Die Option <strong>$stream_context</strong> bietet
                                    mit dem Kontextparameter 'crypto_method' eine flexiblere
                                    Alternative, die es ermöglicht, einzelne Versionen von TLS
                                    anzugeben. Die Verwendung von TLS 1.3 vorschreiben [
                                    'crypto_method' => STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT ]
                                    ]);
                                    $client = new SoapClient("some.wsdl", ['context' => $context]);
                                    ]]>


id: SoapClient::__doRequest
type: function
doc:
<comment>Description:</comment>
  Führt eine SOAP-Anfrage aus
  
  Führt eine SOAP-Anfrage über HTTP aus.
  
  Diese Methode kann in einer vererbten Klasse überschrieben werden, um weitere Transportlayer, die
  Ausführung zusätzlichen XML-Processings oder andere Verwendungszwecke zu implementieren.

<comment>Param:</comment>
  <info>string</info>  <strong>$request</strong>   Die XML-SOAP-Anfrage.
  <info>string</info>  <strong>$location</strong>  Die anzufragende URL.
  <info>string</info>  <strong>$action</strong>    Die SOAP-Aktion.
  <info>int</info>     <strong>$version</strong>   Die SOAP-Version.
  <info>bool</info>    <strong>$oneWay</strong>    Wenn <strong>$oneWay</strong> auf <info>true</info> gesetzt ist, gibt diese Methode nichts zurück. Verwenden
                     Sie diesen Parameter, wenn Sie keine Antwort erwarten.

<comment>Return:</comment>
  <info>string|null</info>  Die XML-SOAP-Antwort.


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

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


id: SoapClient::__getFunctions
type: function
doc:
<comment>Description:</comment>
  Liefert eine Liste verfügbarer SOAP-Funktionen
  
  Gibt ein Array der im WSDL beschriebenen Funktionen für den Web-Service zurück.
  
  Diese Funktion funktioniert nur im WSDL-Modus.

<comment>Return:</comment>
  <info>array|null</info>  Das <info>Array</info> der SOAP-Funktionsprototypen mit detaillierter Angabe des Rückgabetyps, des
              Funktionsnamens und des Parametertyps.

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


id: SoapClient::__getLastRequest
type: function
doc:
<comment>Description:</comment>
  Gibt die letzte SOAP-Anfrage zurück
  
  Gibt das in der letzten SOAP-Anfrage gesendete XML zurück.
  
  Diese Methode funktioniert nur, wenn das <class>SoapClient</class>-Objekt mit der Option <return>trace</return> erstellt und diese
  auf <info>true</info> gesetzt wurde.

<comment>Return:</comment>
  <info>string|null</info>  Die letzte SOAP-Anfrage als XML-Zeichenkette.

<comment>See Also:</comment>
   * SoapClient::__getLastRequestHeaders
   * SoapClient::__getLastResponse
   * SoapClient::__getLastResponseHeaders


id: SoapClient::__getLastRequestHeaders
type: function
doc:
<comment>Description:</comment>
  Gibt die SOAP-Header der letzten Anfrage zurück
  
  Gibt die SOAP-Header der letzten Anfrage zurück.
  
  Diese Methode funktioniert nur, wenn das <class>SoapClient</class>-Objekt mit der auf <info>true</info> gesetzten <return>trace</return>-Option
  erstellt wurde.

<comment>Return:</comment>
  <info>string|null</info>  Die letzten SOAP-Requestheader.

<comment>See Also:</comment>
   * SoapClient::__getLastResponseHeaders
   * SoapClient::__getLastRequest
   * SoapClient::__getLastResponse


id: SoapClient::__getLastResponse
type: function
doc:
<comment>Description:</comment>
  Gibt die letzte SOAP-Antwort zurück
  
  Gibt das XML zurück, das mit der letzten SOAP-Antwort empfangen wurde.
  
  Diese Methode funktioniert nur, wenn das <class>SoapClient</class>-Objekt mit der auf <info>true</info> gesetzten <return>trace</return>-Option
  erstellt wurde.

<comment>Return:</comment>
  <info>string|null</info>  Die letzte SOAP-Antwort als XML-Zeichenkette.

<comment>See Also:</comment>
   * SoapClient::__getLastResponseHeaders
   * SoapClient::__getLastRequest
   * SoapClient::__getLastRequestHeaders


id: SoapClient::__getLastResponseHeaders
type: function
doc:
<comment>Description:</comment>
  Gibt die SOAP-Header der letzten Antwort zurück
  
  Gibt die SOAP-Header der letzten Anwort zurück.
  
  Diese Methode funktioniert nur, wenn das <class>SoapClient</class>-Objekt mit der auf <info>true</info> gesetzten <return>trace</return>-Option
  erstellt wurde.

<comment>Return:</comment>
  <info>string|null</info>  Die letzten SOAP-Responseheader.

<comment>See Also:</comment>
   * SoapClient::__getLastRequestHeaders
   * SoapClient::__getLastRequest
   * SoapClient::__getLastResponse


id: SoapClient::__getTypes
type: function
doc:
<comment>Description:</comment>
  Gibt eine Liste der SOAP-Typen zurück
  
  Gibt ein Array der Typen zurück, die im WSDL des Webservices beschrieben sind.
  
  Diese Funktion funktioniert nur im WSDL-Modus.

<comment>Return:</comment>
  <info>array|null</info>  Das <info>array</info> der SOAP-Typen mit detaillierter Angabe aller Strukturen und Typen.

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


id: SoapClient::__setCookie
type: function
doc:
<comment>Description:</comment>
  Definiert ein Cookie für Soap-Anfragen
  
  Definiert das Cookie, das bei SOAP-Anfragen gesendet werden soll.
  
  Das Aufrufen dieser Methode wirkt sich auf alle folgenden Aufrufe der <class>SoapClient</class>-Methoden aus.

<comment>Param:</comment>
  <info>string</info>       <strong>$name</strong>   Name des Cookies.
  <info>string|null</info>  <strong>$value</strong>  Wert des Cookies. Wenn kein Wert angegeben wurde, wird das Cookie gelöscht.

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


id: SoapClient::__setLocation
type: function
doc:
<comment>Description:</comment>
  Bestimmt die Adresse des zu nutzenden Webservices
  
  Bestimmt die URL, die von den folgenden SOAP-Aufrufen angesprochen werden soll. Dies entspricht
  der Angabe der <return>location</return>-Option bei der Erstellung des SoapClients.
  
  Der Aufruf dieser Methode ist optional. Der SoapClient verwendet standardmäßig die Adresse aus dem
  WSDL.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$location</strong>  Die neue Ziel-URL.

<comment>Return:</comment>
  <info>string|null</info>  Die alte Ziel-URL.

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


id: SoapClient::__setSoapHeaders
type: function
doc:
<comment>Description:</comment>
  Setzt die SOAP-Header für nachfolgende Aufrufe
  
  Legt die Header fest, die mit den nächsten SOAP-Anfragen gesendet werden.
  
  Der Aufruf dieser Methode ersetzt alle vorherigen Werte.

<comment>Param:</comment>
  <info>SoapHeader|array|null</info>  <strong>$headers</strong>  Die zu setzenden Header. Dies kann ein <class>SoapHeader</class>-Objekt oder ein
                                   Array von <class>SoapHeader</class>-Objekten sein. Ist der Parameter nicht
                                   angegeben oder hat er den Wert <info>null</info>, werden die Header gelöscht.

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


id: SoapClient::__soapCall
type: function
doc:
<comment>Description:</comment>
  Ruft eine SOAP-Funktion auf
  
  Es handelt sich um eine Low-Level-API-Funktion, die verwendet wird, um einen SOAP-Aufruf
  durchzuführen. Normalerweise, im WSDL-Modus, können SOAP-Funktionen als Methoden des
  <class>SoapClient</class>-Objekts aufgerufen werden. Diese Methode ist im non-WSDL-Modus nützlich, wenn die
  <return>soapaction</return> unbekannt ist, die <return>uri</return> vom Standard abweicht oder wenn SOAP-Header gesendet und/oder
  empfangen werden.
  
  Im Fehlerfall kann der Aufruf einer SOAP-Funktion PHP veranlassen, eine Exception auszulösen oder,
  wenn Exceptions deaktiviert wurden, ein <class>SoapFault</class>-Objekt zurückzugeben. Um zu prüfen, ob der
  Funktionsaufruf eine SoapFault-Exception nicht abgefangen hat, sollte die Rückgabe mit
  <strong>is_soap_fault()</strong> überprüft werden.

<comment>Param:</comment>
  <info>string</info>                 <strong>$name</strong>           Der Name der aufzurufenden SOAP-Funktion.
  <info>array</info>                  <strong>$args</strong>           Ein Array aus Parametern, die an die Funktion übergeben
                                         werden sollen. Dies kann entweder ein sortiertes oder ein
                                         assoziatives Array sein. Es ist zu beachten, dass die
                                         meisten SOAP-Server die Angabe von Parameternamen
                                         erfordern, so dass in diesen Fällen ein assoziatives Array
                                         verwendet werden muss.
  <info>array|null</info>             <strong>$options</strong>        Ein assoziatives Array von Optionen, die an den Client
                                         übergeben werden sollen.
                                         
                                         Die Option <return>location</return> enthält die URL des angesprochenen
                                         Webservices.
                                         
                                         Die Option <return>uri</return> enthält den Zielnamensraum des
                                         SOAP-Services.
                                         
                                         Die Option <return>soapaction</return> ist die aufzurufende Aktion.
  <info>SoapHeader|array|null</info>  <strong>$inputHeaders</strong>   Ein Array von Headern, die mit der SOAP-Anfrage gesendet
                                         werden sollen.
  <info>array</info>                  <strong>$outputHeaders</strong>  Sofern vorhanden, wird dieses Array mit den Headern des
                                         SOAP-Antwort gefüllt.

<comment>Return:</comment>
  <info>mixed</info>  SOAP-Funktionen können einen oder mehrere Werte zurückgeben. Wenn von einer SOAP-Funktion
         nur ein Wert zurückgegeben wird, ist der Rückgabewert ein primitiver Datentyp (einem sog.
         Skalar). Wenn mehrere Werte zurückgegeben werden, wird stattdessen ein assoziatives Array
         mit benannten Parametern zurückgegeben.
         
         Wenn das <class>SoapClient</class>-Objekt mit der auf <info>false</info> gesetzten Option <return>exceptions</return> erstellt wurde,
         wird bei einem Fehler ein <class>SoapFault</class>-Objekt zurückgegeben.

<comment>See Also:</comment>
   * SoapClient::__construct
   * SoapParam::__construct
   * SoapVar::__construct
   * SoapHeader::__construct
   * SoapFault::__construct
   * <strong>is_soap_fault()</strong>


id: SoapFault::__construct
type: function
doc:
<comment>Description:</comment>
  SoapFault-Konstruktor
  
  Diese Klasse wird verwendet, um SOAP-Fehlerrückmeldungen vom PHP-Handler zu senden. <strong>$faultcode</strong>,
  <strong>$faultstring</strong>, <strong>$faultactor</strong> und <strong>$detail</strong> sind die Standardelemente eines SOAP-Fehlers.

<comment>Param:</comment>
  <info></info>  <strong>$faultcode</strong>    Der Fehlercode von <class>SoapFault</class>.
  <info></info>  <strong>$faultstring</strong>  Die Fehlermeldung von <class>SoapFault</class>.
  <info></info>  <strong>$faultactor</strong>   Eine Zeichenkette, die den Verursacher des Fehlers identifiziert.
  <info></info>  <strong>$detail</strong>       Weitere Details über die Ursache des Fehlers.
  <info></info>  <strong>$faultname</strong>    Kann verwendet werden, um die genaue Fehlerkodierung aus WSDL zu erhalten.
  <info></info>  <strong>$headerfault</strong>  Kann bei der Verarbeitung der SOAP-Header verwendet werden, um einen Fehler im
                  Antwort-Header zu melden.

<comment>See Also:</comment>
   * SoapServer::fault
   * <strong>is_soap_fault()</strong>


id: SoapFault::__toString
type: function
doc:
<comment>Description:</comment>
  Obtain a string representation of a SoapFault
  
  Returns a string representation of the SoapFault.

<comment>Return:</comment>
  <info>string</info>  A string describing the SoapFault.


id: SoapHeader::__construct
type: function
doc:
<comment>Description:</comment>
  SoapHeader-Konstruktor
  
  Konstruiert ein neues SoapHeader-Objekt.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>       Namensraum des SOAP-Header-Elements.
  <info>string</info>  <strong>$name</strong>            Name des SOAP-Header-Objekts.
  <info>mixed</info>   <strong>$data</strong>            SOAP-Header-Inhalt. Der Inhalt kann ein PHP-Wert oder auch ein
                           <class>SoapVar</class>-Objekt sein.
  <info></info>        <strong>$mustUnderstand</strong>  Wert des <return>mustUnderstand</return>-Attributs des SOAP-Header-Elements.
  <info>string</info>  <strong>$actor</strong>           Wert des <return>actor</return>-Attributs des SOAP-Header-Elements.

<comment>See Also:</comment>
   * SoapClient::__soapCall
   * SoapVar::__construct
   * SoapParam::__construct
   * SoapServer::addSoapHeader


id: SoapParam::__construct
type: function
doc:
<comment>Description:</comment>
  SoapParam-Konstruktor
  
  Konstruiert ein neues <class>SoapParam</class>-Objekt.

<comment>Param:</comment>
  <info>mixed</info>   <strong>$data</strong>  Die Daten, die übergeben oder zurückgegeben werden sollen. Die Werte können auch
                 direkt als PHP-Wert übergeben werden. In diesem Fall werden sie mittels <return>paramN</return>
                 benannt und der SOAP-Service könnte Probleme mit der Interpretation bekommen.
  <info>string</info>  <strong>$name</strong>  Der Parametername.

<comment>See Also:</comment>
   * SoapClient::__soapCall
   * SoapVar::__construct


id: SoapServer
type: class
doc:
<comment>Description:</comment>
  Die Klasse SoapServer stellt einen Server für die SOAP 1.1- und SOAP 1.2-Protokolle zur Verfügung.
  Sie kann mit oder ohne Definition des WSDL-Dienstes verwendet werden.


id: SoapServer::__construct
type: function
doc:
<comment>Description:</comment>
  SoapServer-Konstruktor
  
  Dieser Konstruktor erlaubt das Erzeugen eines <class>SoapServer</class>-Objekts im WSDL- oder non-WSDL-Modus.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$wsdl</strong>     Wenn der WSDL-Modus verwendet werden soll, muss die URI auf eine WSDL-Datei
                         verweisen. Ansonsten muss <info>null</info> übergeben, und die <return>uri</return>-Option auf den
                         Zielnamensraum des Servers gesetzt werden.
  <info>array</info>        <strong>$options</strong>  Erlaubt das Setzen der Standard-SOAP-Version (<return>soap_version</return>), der internen
                         Zeichenkodierung (<return>encoding</return>), und der Actor-URI (<return>actor</return>).
                         
                         Die <return>classmap</return> Option kann genutzt werden, um einige WSDL-Typen auf
                         PHP-Klassen abzubilden. Die Option mussß ein Array sein mit den WSDL-Typen
                         als Schlüssel und den PHP-Klassennamen als Wert.
                         
                         Die Option <return>typemap</return> ist ein Array mit Typabbildungen. Jede Abbildung ist ein
                         Array mit den Schlüsseln <return>type_name</return>, <return>type_ns</return> (Namensraum-URI), <return>from_xml</return>
                         (Callback, der einen String-Parameter akzeptiert) und <return>to_xml</return> (Callback, der
                         einen Objekt-Parameter akzeptiert).
                         
                         Die <return>cache_wsdl</return>-Option ist entweder <info>WSDL_CACHE_NONE</info>, <info>WSDL_CACHE_DISK</info>,
                         <info>WSDL_CACHE_MEMORY</info> oder <info>WSDL_CACHE_BOTH</info>.
                         
                         Weiterhin gibt es eine <return>features</return>-Option, die auf <info>SOAP_WAIT_ONE_WAY_CALLS</info>,
                         <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> oder <info>SOAP_USE_XSI_ARRAY_TYPE</info> gesetzt werden
                         kann.
                         
                         Die <return>send_errors</return>-Option kann auf <info>false</info> gesetzt werden, um eine generische
                         Fehlermeldung ("Internal error") anstelle einer spezifischen zu senden.

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


id: SoapServer::addFunction
type: function
doc:
<comment>Description:</comment>
  Fügt eine oder mehrere Funktionen zur Verarbeitung von SOAP-Anfragen hinzu
    
  
  Exportiert eine oder mehrere Funktionen für entfernte Clients.

<comment>Param:</comment>
  <info>array|string|int</info>  <strong>$functions</strong>  Funktionsname als String übergeben, um eine Funktion zu exportieren.
                                
                                Array mit Funktionsnamen übergeben, um mehrere Funktionen zu
                                exportieren.
                                
                                Spezielle Konstante <info>SOAP_FUNCTIONS_ALL</info> übergeben, um alle Funktionen
                                zu exportieren.
                                
                                <strong>$functions</strong> muss alle Argumente in der gleichen Reihenfolge
                                entgegennehmen, wie sie in der WSDL-Datei beschrieben sind (es
                                sollten keine Rückgabewerte als Argumente definiert werden) und ein
                                oder mehrere Werte zurückgeben. Um mehrere Werte zurückzugeben,
                                müssen sich die Werte benannt in einem assoziativen Array befinden.

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

<comment>See Also:</comment>
   * SoapServer::__construct
   * SoapServer::setClass


id: SoapServer::addSoapHeader
type: function
doc:
<comment>Description:</comment>
  Add a SOAP header to the response
  
  Adds a SOAP header to be returned with the response to the current request.

<comment>Param:</comment>
  <info>SoapHeader</info>  <strong>$header</strong>  The header to be returned.

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


id: SoapServer::fault
type: function
doc:
<comment>Description:</comment>
  Erzeugt einen SoapServer-Fehler, der einen Fehlerzustand anzeigt
  
  Sendet dem Client der aktuellen Anfrage eine Antwort, die einen Fehler anzeigt.
  
  Diese Methode kann nur aufgerufen werden, wenn eine Anfrage verarbeitet wird.

<comment>Param:</comment>
  <info>string</info>  <strong>$code</strong>     Der Fehlercode, der zurückgegeben werden soll.
  <info>string</info>  <strong>$string</strong>   Eine kurze Beschreibung des Fehlers.
  <info>string</info>  <strong>$actor</strong>    Eine Zeichenkette, die den Akteur identifiziert, der den Fehler verursacht hat.
  <info>mixed</info>   <strong>$details</strong>  Weitere Details zum Fehler.
  <info>string</info>  <strong>$name</strong>     Der Name des Fehlers. Dies kann verwendet werden, um den Namen aus einer
                    WSDL-Datei auszuwählen.

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

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


id: SoapServer::getFunctions
type: function
doc:
<comment>Description:</comment>
  Gibt eine Liste aller definierten Funktionen zurück
  
  Gibt eine Liste aller Funktionen des SoapServer-Objekts zurück, die durch SoapServer::addFunction
  oder SoapServer::setClass hinzugefügt wurden.

<comment>Return:</comment>
  <info>array</info>  Ein <info>array</info> aller definierten Funktionen.

<comment>See Also:</comment>
   * SoapServer::__construct
   * SoapServer::addFunction
   * SoapServer::setClass


id: SoapServer::handle
type: function
doc:
<comment>Description:</comment>
  Verarbeitet eine SOAP-Anfrage
  
  Verarbeitet eine SOAP-Anfrage, ruft benötigte Funktionen auf und schickt eine Antwort zurück.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$request</strong>  SOAP-Anfrage. Wenn das Argument nicht gegeben ist, werden die originalen
                         (raw) POST-Daten der HTTP-Anfrage genutzt.

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

<comment>See Also:</comment>
   * SoapServer::__construct


id: SoapServer::setClass
type: function
doc:
<comment>Description:</comment>
  Setzt die Klasse, welche SOAP-Anfragen verarbeitet
  
  Exportiert alle Methoden der angegebenen Klasse.
  
  Das Objekt kann für eine gegebene PHP-Session mit Hilfe der SoapServer::setPersistence-Methode
  persistent gemacht werden.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  Name der zu exportierenden Klasse.
  <info>mixed</info>   <strong>$args</strong>   Die optionalen Parameter werden dem Standardkonstruktor der Klasse zur Laufzeit
                  übergeben.

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

<comment>See Also:</comment>
   * SoapServer::__construct
   * SoapServer::addFunction
   * SoapServer::setPersistence


id: SoapServer::setObject
type: function
doc:
<comment>Description:</comment>
  Sets the object which will be used to handle SOAP requests
  
  This sets a specific object as the handler for SOAP requests, rather than just a class as in
  SoapServer::setClass.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The object to handle the requests.

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

<comment>See Also:</comment>
   * SoapServer::setClass


id: SoapVar
type: class
doc:
<comment>Description:</comment>
  Eine Klasse, die eine Variable oder ein Objekt zur Verwendung mit SOAP-Diensten darstellt.


id: SoapVar::__construct
type: function
doc:
<comment>Description:</comment>
  SoapVar-Konstruktor
  
  Erstellt ein neues <class>SoapVar</class>-Objekt.

<comment>Param:</comment>
  <info>mixed</info>     <strong>$data</strong>            Die zu übergebenden oder zurückzugebenden Daten.
  <info>int|null</info>  <strong>$encoding</strong>        Die Encoding-ID, eine der <return>XSD_...</return>-Konstanten.
  <info></info>          <strong>$type_name</strong>       Der Type-Name.
  <info></info>          <strong>$type_namespace</strong>  Der Type-Namensraum.
  <info></info>          <strong>$node_name</strong>       Der XML-Nodename.
  <info></info>          <strong>$node_namespace</strong>  Der XML-Node-Namensraum.

<comment>See Also:</comment>
   * SoapClient::__soapCall
   * SoapParam::__construct


id: Socket
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces <return>Socket</return> resources as of PHP 8.0.0.


id: SolrClient
type: class
doc:
<comment>Description:</comment>
  Wird verwendet, um Anfragen an einen Solr-Server zu senden. Derzeit wird das Klonen und
  Serialisieren von SolrClient-Instanzen nicht unterstützt.


id: SolrClient::DEFAULT_SYSTEM_SERVLET
type: constant
doc:
<comment>Description:</comment>
  Dies ist der Anfangswert für das Systemservlet, das zum Abrufen von Solr-Server-Informationen
  verwendet wird.


id: SolrClient::DEFAULT_TERMS_SERVLET
type: constant
doc:
<comment>Description:</comment>
  Dies ist der Anfangswert für das Term-Servlet, das für die TermsComponent verwendet wird.


id: SolrClient::SYSTEM_SERVLET_TYPE
type: constant
doc:
<comment>Description:</comment>
  Wird verwendet, wenn Systeminformationen vom Systemservlet abgerufen werden.


id: SolrClient::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor for the SolrClient object
  
  Constructor for the SolrClient object

<comment>Param:</comment>
  <info>array</info>  <strong>$clientOptions</strong>  This is an array containing one of the following keys :
                         
                         

<comment>See Also:</comment>
   * SolrClient::getOptions


id: SolrClient::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructor for SolrClient
  
  Destructor

<comment>Return:</comment>
  <info>unknown</info>  Destructor for SolrClient

<comment>See Also:</comment>
   * SolrClient::__construct


id: SolrClient::addDocument
type: function
doc:
<comment>Description:</comment>
  Adds a document to the index
  
  This method adds a document to the index.

<comment>Param:</comment>
  <info>SolrInputDocument</info>  <strong>$doc</strong>           The SolrInputDocument instance.
  <info>bool</info>               <strong>$overwrite</strong>     Whether to overwrite existing document or not. If <info>false</info> there
                                    will be duplicates (several documents with the same ID).
                                    
                                    PECL Solr
                                    \< 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite bool flag.
                                    
                                    $allowDups = false is the same as $overwrite = true
  <info>int</info>                <strong>$commitWithin</strong>  Number of milliseconds within which to auto commit this
                                    document. Available since Solr 1.4 . Default (0) means disabled.
                                    
                                    When this value specified, it leaves the control of when to do
                                    the commit to Solr itself, optimizing number of commits to a
                                    minimum while still fulfilling the update latency requirements,
                                    and Solr will automatically do a commit when the oldest add in
                                    the buffer is due.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <info>SolrUpdateResponse</info> object or throws an Exception on failure.

<comment>See Also:</comment>
   * SolrClient::addDocuments
   * SolrClient::commit


id: SolrClient::addDocuments
type: function
doc:
<comment>Description:</comment>
  Adds a collection of SolrInputDocument instances to the index
  
  Adds a collection of documents to the index.

<comment>Param:</comment>
  <info>array</info>  <strong>$docs</strong>          An array containing the collection of SolrInputDocument instances. This
                        array must be an actual variable.
  <info>bool</info>   <strong>$overwrite</strong>     Whether to overwrite existing documents or not. If <info>false</info> there will be
                        duplicates (several documents with the same ID).
                        
                        PECL Solr
                        \< 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite bool flag.
                        
                        $allowDups = false is the same as $overwrite = true
  <info>int</info>    <strong>$commitWithin</strong>  Number of milliseconds within which to auto commit this document. Available
                        since Solr 1.4 . Default (0) means disabled.
                        
                        When this value specified, it leaves the control of when to do the commit to
                        Solr itself, optimizing number of commits to a minimum while still
                        fulfilling the update latency requirements, and Solr will automatically do a
                        commit when the oldest add in the buffer is due.

<comment>Return:</comment>
  <info>void</info>  Returns a <info>SolrUpdateResponse</info> object or throws an exception on failure.

<comment>See Also:</comment>
   * SolrClient::addDocument
   * SolrClient::commit


id: SolrClient::commit
type: function
doc:
<comment>Description:</comment>
  Finalizes all add/deletes made to the index
  
  This method finalizes all add/deletes made to the index.

<comment>Param:</comment>
  <info>bool</info>  <strong>$softCommit</strong>      This will refresh the 'view' of the index in a more performant manner, but
                         without "on-disk" guarantees. (Solr4.0+)
                         
                         A soft commit is much faster since it only makes index changes visible and
                         does not fsync index files or write a new index descriptor.  If the JVM
                         crashes or there is a loss of power, changes that occurred after the last
                         hard commit will be lost.  Search collections that have near-real-time
                         requirements (that want index changes to be quickly visible to searches)
                         will want to soft commit often but hard commit less frequently.
  <info>bool</info>  <strong>$waitSearcher</strong>    block until a new searcher is opened and registered as the main query
                         searcher, making the changes visible.
  <info>bool</info>  <strong>$expungeDeletes</strong>  Merge segments with deletes away. (Solr1.4+)

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <class>SolrUpdateResponse</class> object on success or throws an exception on
                      failure.

<comment>See Also:</comment>
   * SolrClient::optimize
   * SolrClient::rollback


id: SolrClient::deleteById
type: function
doc:
<comment>Description:</comment>
  Delete by Id
  
  Deletes the document with the specified ID. Where ID is the value of the uniqueKey field declared
  in the schema

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  The value of the uniqueKey field declared in the schema

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <info>SolrUpdateResponse</info> on success and throws an exception on failure.

<comment>See Also:</comment>
   * SolrClient::deleteByIds
   * SolrClient::deleteByQuery
   * SolrClient::deleteByQueries


id: SolrClient::deleteByIds
type: function
doc:
<comment>Description:</comment>
  Deletes by Ids
  
  Deletes a collection of documents with the specified set of ids.

<comment>Param:</comment>
  <info>array</info>  <strong>$ids</strong>  An array of IDs representing the uniqueKey field declared in the schema for each
               document to be deleted. This must be an actual php variable.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <info>SolrUpdateResponse</info> on success and throws an exception on failure.

<comment>See Also:</comment>
   * SolrClient::deleteById
   * SolrClient::deleteByQuery
   * SolrClient::deleteByQueries


id: SolrClient::deleteByQueries
type: function
doc:
<comment>Description:</comment>
  Removes all documents matching any of the queries
  
  Removes all documents matching any of the queries

<comment>Param:</comment>
  <info>array</info>  <strong>$queries</strong>  The array of queries. This must be an actual php variable.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a SolrUpdateResponse on success and throws a SolrClientException on
                      failure.

<comment>See Also:</comment>
   * SolrClient::deleteById
   * SolrClient::deleteByIds
   * SolrClient::deleteByQuery


id: SolrClient::deleteByQuery
type: function
doc:
<comment>Description:</comment>
  Deletes all documents matching the given query
  
  Deletes all documents matching the given query.

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

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <info>SolrUpdateResponse</info> on success and throws an exception on failure.

<comment>See Also:</comment>
   * SolrClient::deleteById
   * SolrClient::deleteByIds
   * SolrClient::deleteByQueries


id: SolrClient::getById
type: function
doc:
<comment>Description:</comment>
  Get Document By Id. Utilizes Solr Realtime Get (RTG)
  
  Get Document By Id. Utilizes Solr Realtime Get (RTG).

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  Document ID

<comment>Return:</comment>
  <info>SolrQueryResponse</info>  <info>SolrQueryResponse</info>

<comment>See Also:</comment>
   * SolrClient::getByIds


id: SolrClient::getByIds
type: function
doc:
<comment>Description:</comment>
  Get Documents by their Ids. Utilizes Solr Realtime Get (RTG)
  
  Get Documents by their Ids. Utilizes Solr Realtime Get (RTG).

<comment>Param:</comment>
  <info>array</info>  <strong>$ids</strong>  Document ids

<comment>Return:</comment>
  <info>SolrQueryResponse</info>  <info>SolrQueryResponse</info>

<comment>See Also:</comment>
   * SolrClient::getById


id: SolrClient::getDebug
type: function
doc:
<comment>Description:</comment>
  Returns the debug data for the last connection attempt
  
  Returns the debug data for the last connection attempt

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and null if there is nothing to return.


id: SolrClient::getOptions
type: function
doc:
<comment>Description:</comment>
  Returns the client options set internally
  
  Returns the client options set internally. Very useful for debugging. The values returned are
  readonly and can only be set when the object is instantiated.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing all the options for the SolrClient object set internally.

<comment>See Also:</comment>
   * SolrClient::__construct


id: SolrClient::optimize
type: function
doc:
<comment>Description:</comment>
  Defragments the index
  
  Defragments the index for faster search performance.

<comment>Param:</comment>
  <info>int</info>   <strong>$maxSegments</strong>   Optimizes down to at most this number of segments. Since Solr 1.3
  <info>bool</info>  <strong>$softCommit</strong>    This will refresh the 'view' of the index in a more performant manner, but
                       without "on-disk" guarantees. (Solr4.0+)
  <info>bool</info>  <strong>$waitSearcher</strong>  Block until a new searcher is opened and registered as the main query
                       searcher, making the changes visible.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a SolrUpdateResponse on success or throws an exception on failure.

<comment>See Also:</comment>
   * SolrClient::commit
   * SolrClient::rollback


id: SolrClient::ping
type: function
doc:
<comment>Description:</comment>
  Checks if Solr server is still up
  
  Checks if the Solr server is still alive. Sends a HEAD request to the Apache Solr server.

<comment>Return:</comment>
  <info>SolrPingResponse</info>  Returns a <info>SolrPingResponse</info> object on success and throws an exception on failure.


id: SolrClient::query
type: function
doc:
<comment>Description:</comment>
  Sends a query to the server
  
  Sends a query to the server.

<comment>Param:</comment>
  <info>SolrParams</info>  <strong>$query</strong>  A <info>SolrParams</info> object. It is recommended to use <info>SolrQuery</info> for advanced queries.

<comment>Return:</comment>
  <info>SolrQueryResponse</info>  Returns a <info>SolrQueryResponse</info> object on success and throws an exception on
                     failure.


id: SolrClient::request
type: function
doc:
<comment>Description:</comment>
  Sends a raw update request
  
  Sends a raw XML update request to the server

<comment>Param:</comment>
  <info>string</info>  <strong>$raw_request</strong>  An XML string with the raw request to the server.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <info>SolrUpdateResponse</info> on success. Throws an exception on failure.


id: SolrClient::rollback
type: function
doc:
<comment>Description:</comment>
  Rollbacks all add/deletes made to the index since the last commit
  
  Rollbacks all add/deletes made to the index since the last commit. It neither calls any event
  listeners nor creates a new searcher.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a SolrUpdateResponse on success or throws a SolrClientException on
                      failure.

<comment>See Also:</comment>
   * SolrClient::commit
   * SolrClient::optimize


id: SolrClient::setResponseWriter
type: function
doc:
<comment>Description:</comment>
  Sets the response writer used to prepare the response from Solr
  
  Sets the response writer used to prepare the response from Solr

<comment>Param:</comment>
  <info>string</info>  <strong>$responseWriter</strong>  One of the following:

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


id: SolrClient::setServlet
type: function
doc:
<comment>Description:</comment>
  Changes the specified servlet type to a new value
  
  Changes the specified servlet type to a new value

<comment>Param:</comment>
  <info>int</info>     <strong>$type</strong>   One of the following :
                  
                  
  <info>string</info>  <strong>$value</strong>  The new value for the servlet

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


id: SolrClient::system
type: function
doc:
<comment>Description:</comment>
  Retrieve Solr Server information
  
  Retrieve Solr Server information

<comment>Return:</comment>
  <info>void</info>  Returns a <info>SolrGenericResponse</info> object on success.


id: SolrClient::threads
type: function
doc:
<comment>Description:</comment>
  Checks the threads status
  
  Checks the threads status

<comment>Return:</comment>
  <info>void</info>  Returns a SolrGenericResponse object.


id: SolrClientException
type: class
doc:
<comment>Description:</comment>
  Eine Ausnahme, die ausgelöst wird, wenn bei einer Anforderung des Clients an den Server ein Fehler
  auftritt.


id: SolrClientException::getInternalInfo
type: function
doc:
<comment>Description:</comment>
  Returns internal information where the Exception was thrown
  
  Returns internal information where the Exception was thrown.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing internal information where the error was thrown. Used only for
         debugging by extension developers.


id: SolrCollapseFunction::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  Collapse Function constructor

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The field name to collapse on.
                  
                  In order to collapse a result. The field type must be a single valued String, Int
                  or Float.

<comment>See Also:</comment>
   * SolrQuery::collapse


id: SolrCollapseFunction::__toString
type: function
doc:
<comment>Description:</comment>
  Returns a string representing the constructed collapse function
  
  Returns a string representing the constructed collapse function

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


id: SolrCollapseFunction::getField
type: function
doc:
<comment>Description:</comment>
  Returns the field that is being collapsed on
  
  Returns the field that is being collapsed on.

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setField


id: SolrCollapseFunction::getHint
type: function
doc:
<comment>Description:</comment>
  Returns collapse hint
  
  Returns collapse hint

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setHint


id: SolrCollapseFunction::getMax
type: function
doc:
<comment>Description:</comment>
  Returns max parameter
  
  Returns max parameter

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setMax


id: SolrCollapseFunction::getMin
type: function
doc:
<comment>Description:</comment>
  Returns min parameter
  
  Returns min parameter

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setMin


id: SolrCollapseFunction::getNullPolicy
type: function
doc:
<comment>Description:</comment>
  Returns null policy
  
  Returns null policy used or null

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setNullPolicy


id: SolrCollapseFunction::getSize
type: function
doc:
<comment>Description:</comment>
  Returns size parameter
  
  Gets the initial size of the collapse data structures when collapsing on a numeric field only

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setSize


id: SolrCollapseFunction::setField
type: function
doc:
<comment>Description:</comment>
  Sets the field to collapse on
  
  The field name to collapse on.  In order to collapse a result. The field type must be a single
  valued String, Int or Float.

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setHint
type: function
doc:
<comment>Description:</comment>
  Sets collapse hint
  
  Sets collapse hint

<comment>Param:</comment>
  <info>string</info>  <strong>$hint</strong>  Currently there is only one hint available "top_fc", which stands for top level
                 FieldCache

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setMax
type: function
doc:
<comment>Description:</comment>
  Selects the group heads by the max value of a numeric field or function query
  
  Selects the group heads by the max value of a numeric field or function query.

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setMin
type: function
doc:
<comment>Description:</comment>
  Sets the initial size of the collapse data structures when collapsing on a numeric field only
  
  Sets the initial size of the collapse data structures when collapsing on a numeric field only

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setNullPolicy
type: function
doc:
<comment>Description:</comment>
  Sets the NULL Policy
  
  Sets the NULL Policy. One of the 3 policies defined as class constants shall be passed. Accepts
  ignore, expand, or collapse policies.

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setSize
type: function
doc:
<comment>Description:</comment>
  Sets the initial size of the collapse data structures when collapsing on a numeric field only
  
  Sets the initial size of the collapse data structures when collapsing on a numeric field only.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrDisMaxQuery::FACET_SORT_COUNT
type: constant
doc:
<comment>Description:</comment>
  Wird verwendet, um festzulegen, dass die Facette nach Anzahl sortiert werden soll (zur einfacheren
  Migration dupliziert).


id: SolrDisMaxQuery::FACET_SORT_INDEX
type: constant
doc:
<comment>Description:</comment>
  Wird verwendet, um festzulegen, dass die Facette nach Index sortiert werden soll (zur einfacheren
  Migration dupliziert).


id: SolrDisMaxQuery::ORDER_ASC
type: constant
doc:
<comment>Description:</comment>
  Wird verwendet, um anzugeben, dass die Sortierung in aufsteigender Reihenfolge erfolgen soll (zur
  einfacheren Migration dupliziert).


id: SolrDisMaxQuery::ORDER_DESC
type: constant
doc:
<comment>Description:</comment>
  Wird verwendet, um anzugeben, dass die Sortierung in absteigender Reihenfolge erfolgen soll (zur
  einfacheren Migration dupliziert).


id: SolrDisMaxQuery::TERMS_SORT_COUNT
type: constant
doc:
<comment>Description:</comment>
  Wird in der TermsComponent verwendet (zur einfacheren Migration dupliziert).


id: SolrDisMaxQuery::__construct
type: function
doc:
<comment>Description:</comment>
  Class Constructor
  
  Class constructor initializes the object and sets the q parameter if passed

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  Search Query (q parameter)


id: SolrDisMaxQuery::addBigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Adds a Phrase Bigram Field (pf2 parameter)
  
  Adds a Phrase Bigram Field (pf2 parameter) output format: field~slop^boost OR field^boost Slop is
  optional

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  
  <info>string</info>  <strong>$boost</strong>  
  <info>string</info>  <strong>$slop</strong>   

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeBigramPhraseField
   * SolrDisMaxQuery::setBigramPhraseFields
   * SolrDisMaxQuery::setBigramPhraseSlop


id: SolrDisMaxQuery::addBoostQuery
type: function
doc:
<comment>Description:</comment>
  Adds a boost query field with value and optional boost (bq parameter)
  
  Adds a Boost Query field with value [and boost] (bq parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  
  <info>string</info>  <strong>$value</strong>  
  <info>string</info>  <strong>$boost</strong>  

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeBoostQuery
   * SolrDisMaxQuery::setBoostQuery


id: SolrDisMaxQuery::addPhraseField
type: function
doc:
<comment>Description:</comment>
  Adds a Phrase Field (pf parameter)
  
  Adds a Phrase Field (pf parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  field name
  <info>string</info>  <strong>$boost</strong>  
  <info>string</info>  <strong>$slop</strong>   

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removePhraseField
   * SolrDisMaxQuery::setPhraseFields


id: SolrDisMaxQuery::addQueryField
type: function
doc:
<comment>Description:</comment>
  Add a query field with optional boost (qf parameter)
  
  Add a query field with optional boost (qf parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  field name
  <info>string</info>  <strong>$boost</strong>  Boost value. Boosts documents with matching terms.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeQueryField


id: SolrDisMaxQuery::addTrigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Adds a Trigram Phrase Field (pf3 parameter)
  
  Adds a Trigram Phrase Field (pf3 parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name
  <info>string</info>  <strong>$boost</strong>  Field Boost
  <info>string</info>  <strong>$slop</strong>   Field Slop

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields
   * SolrDisMaxQuery::setTrigramPhraseSlop


id: SolrDisMaxQuery::addUserField
type: function
doc:
<comment>Description:</comment>
  Adds a field to User Fields Parameter (uf)
  
  Adds a field to The User Fields Parameter (uf)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeUserField
   * SolrDisMaxQuery::setUserFields


id: SolrDisMaxQuery::removeBigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Removes phrase bigram field (pf2 parameter)
  
  Removes a Bigram Phrase Field (pf2 parameter) that was previously added using
  SolrDisMaxQuery::addBigramPhraseField

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addBigramPhraseField
   * SolrDisMaxQuery::setBigramPhraseFields
   * SolrDisMaxQuery::setBigramPhraseSlop


id: SolrDisMaxQuery::removeBoostQuery
type: function
doc:
<comment>Description:</comment>
  Removes a boost query partial by field name (bq)
  
  Removes a boost query partial from the existing query, only if SolrDisMaxQuery::addBoostQuery was
  used.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addBoostQuery
   * SolrDisMaxQuery::setBoostQuery


id: SolrDisMaxQuery::removePhraseField
type: function
doc:
<comment>Description:</comment>
  Removes a Phrase Field (pf parameter)
  
  Removes a Phrase Field (pf parameter) that was previously added using
  SolrDisMaxQuery::addPhraseField

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addPhraseField
   * SolrDisMaxQuery::setPhraseFields


id: SolrDisMaxQuery::removeQueryField
type: function
doc:
<comment>Description:</comment>
  Removes a Query Field (qf parameter)
  
  Removes a Query Field (qf parameter) from the field list added by SolrDisMaxQuery::addQueryField
  
  qf: When building DisjunctionMaxQueries from the user's query it specifies the fields to search
  in, and boosts for those fields.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addQueryField


id: SolrDisMaxQuery::removeTrigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Removes a Trigram Phrase Field (pf3 parameter)
  
  Removes a Trigram Phrase Field (pf3 parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields
   * SolrDisMaxQuery::setTrigramPhraseSlop


id: SolrDisMaxQuery::removeUserField
type: function
doc:
<comment>Description:</comment>
  Removes a field from The User Fields Parameter (uf)
  
  Removes a field from The User Fields Parameter (uf)
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addUserField
   * SolrDisMaxQuery::setUserFields


id: SolrDisMaxQuery::setBigramPhraseFields
type: function
doc:
<comment>Description:</comment>
  Sets Bigram Phrase Fields and their boosts (and slops) using pf2 parameter
  
  Sets Bigram Phrase Fields (pf2) and their boosts (and slops)

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Fields boosts (slops)

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::setBigramPhraseSlop
   * SolrDisMaxQuery::addBigramPhraseFields
   * SolrDisMaxQuery::removeBigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields


id: SolrDisMaxQuery::setBigramPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Sets Bigram Phrase Slop (ps2 parameter)
  
  Sets Bigram Phrase Slop (ps2 parameter). A default slop for Bigram phrase fields.

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setBoostFunction
type: function
doc:
<comment>Description:</comment>
  Sets a Boost Function (bf parameter)
  
  Sets Boost Function (bf parameter).
  
  Functions (with optional boosts) that will be included in the user's query to influence the score.
  Any function supported natively by Solr can be used, along with a boost value. e.g.:
  
  recip(rord(myfield),1,2,3)^1.5

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setBoostQuery
type: function
doc:
<comment>Description:</comment>
  Directly Sets Boost Query Parameter (bq)
  
  Sets Boost Query Parameter (bq)

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addBoostQuery
   * SolrDisMaxQuery::removeBoostQuery


id: SolrDisMaxQuery::setMinimumMatch
type: function
doc:
<comment>Description:</comment>
  Set Minimum "Should" Match (mm)
  
  Set Minimum "Should" Match parameter (mm). If the default query operator is AND then mm=100%, if
  the default query operator (q.op) is OR, then mm=0%.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  Minimum match value/expression

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setPhraseFields
type: function
doc:
<comment>Description:</comment>
  Sets  Phrase Fields and their boosts (and slops) using pf2 parameter
  
  Sets  Phrase Fields (pf) and their boosts (and slops)

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Fields, boosts [, slops]

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addPhraseFields
   * SolrDisMaxQuery::removePhraseField


id: SolrDisMaxQuery::setPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Sets the default slop on phrase queries (ps parameter)
  
  Sets the default amount of slop on phrase queries built with "pf", "pf2" and/or "pf3" fields
  (affects boosting). "ps" parameter

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setQueryAlt
type: function
doc:
<comment>Description:</comment>
  Set Query Alternate (q.alt parameter)
  
  Set Query Alternate (q.alt parameter)
  
  When the main q parameter is not specified or is blank. The q.alt parameter is used

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  Query String

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setQueryPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Specifies the amount of slop permitted on phrase queries explicitly included in the user's query
  string (qf parameter)
  
  The Query Phrase Slop is the amount of slop permitted on phrase queries explicitly included in the
  user's query string with the qf parameter.
  
  slop refers to the number of positions one token needs to be moved in relation to another token in
  order to match a phrase specified in a query.

<comment>Param:</comment>
  <info>string</info>  <strong>$slop</strong>  Amount of slop

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setTieBreaker
type: function
doc:
<comment>Description:</comment>
  Sets Tie Breaker parameter (tie parameter)
  
  Sets Tie Breaker parameter (tie parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$tieBreaker</strong>  The tie parameter specifies a float value (which should be something much
                       less than 1) to use as tiebreaker in DisMax queries.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setTrigramPhraseFields
type: function
doc:
<comment>Description:</comment>
  Directly Sets Trigram Phrase Fields (pf3 parameter)
  
  Directly Sets Trigram Phrase Fields (pf3 parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Trigram Phrase Fields

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addTrigramPhraseField
   * SolrDisMaxQuery::removeTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseSlop


id: SolrDisMaxQuery::setTrigramPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Sets Trigram Phrase Slop (ps3 parameter)
  
  Sets Trigram Phrase Slop (ps3 parameter)

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addTrigramPhraseField
   * SolrDisMaxQuery::removeTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields


id: SolrDisMaxQuery::setUserFields
type: function
doc:
<comment>Description:</comment>
  Sets User Fields parameter (uf)
  
  Sets User Fields parameter (uf)
  
  User Fields: Specifies which schema fields the end user shall be allowed to query.

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Fields names separated by space
                   
                   This parameter supports wildcards.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addUserField
   * SolrDisMaxQuery::removeUserField


id: SolrDisMaxQuery::useDisMaxQueryParser
type: function
doc:
<comment>Description:</comment>
  Switch QueryParser to be DisMax Query Parser
  
  Switch QueryParser to be DisMax Query Parser

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::useDisMaxQueryParser


id: SolrDisMaxQuery::useEDisMaxQueryParser
type: function
doc:
<comment>Description:</comment>
  Switch QueryParser to be EDisMax
  
  Switch QueryParser to be EDisMax. By default the query builder uses edismax, if it was switched
  using SolrDisMaxQuery::useDisMaxQueryParser, it can be switched back using this method.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDocument
type: class
doc:
<comment>Description:</comment>
  Stellt ein Solr-Dokument dar, das aus einer Abfrageantwort abgerufen wurde.


id: SolrDocument::SORT_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Standardmodus für die Sortierung von Feldern innerhalb des Dokuments.


id: SolrDocument::__clone
type: function
doc:
<comment>Description:</comment>
  Creates a copy of a SolrDocument object
  
  Creates a copy of a SolrDocument object. Not to be called directly.

<comment>Return:</comment>
  <info>void</info>  None.


id: SolrDocument::__get
type: function
doc:
<comment>Description:</comment>
  Access the field as a property
  
  Magic method for accessing the field as a property.

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

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Returns a SolrDocumentField instance.


id: SolrDocument::__isset
type: function
doc:
<comment>Description:</comment>
  Checks if a field exists
  
  Checks if a field exists

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Name of the field.

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


id: SolrDocument::__set
type: function
doc:
<comment>Description:</comment>
  Adds another field to the document
  
  Adds another field to the document. Used to set the fields as new properties.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>   Name of the field.
  <info>string</info>  <strong>$fieldValue</strong>  Field value.

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


id: SolrDocument::__unset
type: function
doc:
<comment>Description:</comment>
  Removes a field from the document
  
  Removes a field from the document when the field is access as an object property.

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

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


id: SolrDocument::addField
type: function
doc:
<comment>Description:</comment>
  Adds a field to the document
  
  This method adds a field to the SolrDocument instance.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>   The name of the field
  <info>string</info>  <strong>$fieldValue</strong>  The value of the field.

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


id: SolrDocument::clear
type: function
doc:
<comment>Description:</comment>
  Drops all the fields in the document
  
  Resets the current object. Discards all the fields and resets the document boost to zero.

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


id: SolrDocument::current
type: function
doc:
<comment>Description:</comment>
  Retrieves the current field
  
  Retrieves the current field

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Returns the field


id: SolrDocument::deleteField
type: function
doc:
<comment>Description:</comment>
  Removes a field from the document
  
  Removes a field from the document.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Name of the field

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


id: SolrDocument::fieldExists
type: function
doc:
<comment>Description:</comment>
  Checks if a field exists in the document
  
  Checks if the requested field as a valid fieldname in the document.

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

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the field is present and <info>false</info> if it does not.


id: SolrDocument::getChildDocuments
type: function
doc:
<comment>Description:</comment>
  Returns an array of child documents (SolrDocument)
  
  Returns an array of child documents (SolrDocument)

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

<comment>See Also:</comment>
   * SolrDocument::hasChildDocuments
   * SolrDocument::getChildDocumentsCount


id: SolrDocument::getChildDocumentsCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of child documents
  
  Returns the number of child documents

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

<comment>See Also:</comment>
   * SolrDocument::hasChildDocuments
   * SolrDocument::getChildDocuments


id: SolrDocument::getField
type: function
doc:
<comment>Description:</comment>
  Retrieves a field by name
  
  Retrieves a field by name.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Name of the field.

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Returns a SolrDocumentField on success and <info>false</info> on failure.


id: SolrDocument::getFieldCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of fields in this document
  
  Returns the number of fields in this document. Multi-value fields are only counted once.

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>false</info> on failure.


id: SolrDocument::getFieldNames
type: function
doc:
<comment>Description:</comment>
  Returns an array of fields names in the document
  
  Returns an array of fields names in the document.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing the names of the fields in this document.


id: SolrDocument::getInputDocument
type: function
doc:
<comment>Description:</comment>
  Returns a SolrInputDocument equivalent of the object
  
  Returns a SolrInputDocument equivalent of the object. This is useful if one wishes to
  resubmit/update a document retrieved from a query.

<comment>Return:</comment>
  <info>SolrInputDocument</info>  Returns a SolrInputDocument on success and <info>null</info> on failure.


id: SolrDocument::hasChildDocuments
type: function
doc:
<comment>Description:</comment>
  Checks whether the document has any child documents
  
  Checks whether the document has any child documents

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

<comment>See Also:</comment>
   * SolrDocument::getChildDocuments
   * SolrDocument::getChildDocumentsCount


id: SolrDocument::key
type: function
doc:
<comment>Description:</comment>
  Retrieves the current key
  
  Retrieves the current key.

<comment>Return:</comment>
  <info>string</info>  Returns the current key.


id: SolrDocument::merge
type: function
doc:
<comment>Description:</comment>
  Merges source to the current SolrDocument
  
  Merges source to the current SolrDocument.

<comment>Param:</comment>
  <info>SolrDocument</info>  <strong>$sourceDoc</strong>  The source document.
  <info>bool</info>          <strong>$overwrite</strong>  If this is <info>true</info> then fields with the same name in the destination
                            document will be overwritten.

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


id: SolrDocument::next
type: function
doc:
<comment>Description:</comment>
  Moves the internal pointer to the next field
  
  Moves the internal pointer to the next field.

<comment>Return:</comment>
  <info>void</info>  This method has no return value.


id: SolrDocument::offsetExists
type: function
doc:
<comment>Description:</comment>
  Checks if a particular field exists
  
  Checks if a particular field exists. This is used when the object is treated as an array.

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

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


id: SolrDocument::offsetGet
type: function
doc:
<comment>Description:</comment>
  Retrieves a field
  
  This is used to retrieve the field when the object is treated as an array.

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

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Returns a SolrDocumentField object.


id: SolrDocument::offsetSet
type: function
doc:
<comment>Description:</comment>
  Adds a field to the document
  
  Used when the object is treated as an array to add a field to the document.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>   The name of the field.
  <info>string</info>  <strong>$fieldValue</strong>  The value for this field.

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


id: SolrDocument::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Removes a field
  
  Removes a field from the document.

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

<comment>Return:</comment>
  <info>void</info>  No return value.


id: SolrDocument::reset
type: function
doc:
<comment>Description:</comment>
  Alias von SolrDocument::clear
  
  This is an alias to SolrDocument::clear()

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


id: SolrDocument::rewind
type: function
doc:
<comment>Description:</comment>
  Resets the internal pointer to the beginning
  
  Resets the internal pointer to the beginning.

<comment>Return:</comment>
  <info>void</info>  This method has no return value.


id: SolrDocument::serialize
type: function
doc:
<comment>Description:</comment>
  Used for custom serialization
  
  Used for custom serialization.

<comment>Return:</comment>
  <info>string</info>  Returns a string representing the serialized Solr document.


id: SolrDocument::sort
type: function
doc:
<comment>Description:</comment>
  Sorts the fields in the document
  
  

<comment>Param:</comment>
  <info>int</info>  <strong>$sortOrderBy</strong>    The sort criteria.
  <info>int</info>  <strong>$sortDirection</strong>  The sort direction.

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


id: SolrDocument::toArray
type: function
doc:
<comment>Description:</comment>
  Returns an array representation of the document
  
  Returns an array representation of the document.

<comment>Return:</comment>
  <info>array</info>  Returns an array representation of the document.


id: SolrDocument::unserialize
type: function
doc:
<comment>Description:</comment>
  Custom serialization of SolrDocument objects
  
  Custom serialization of SolrDocument objects

<comment>Param:</comment>
  <info>string</info>  <strong>$serialized</strong>  An XML representation of the document.

<comment>Return:</comment>
  <info>void</info>  None.


id: SolrDocument::valid
type: function
doc:
<comment>Description:</comment>
  Checks if the current position internally is still valid
  
  Checks if the current position internally is still valid. It is used during foreach operations.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success and <info>false</info> if the current position is no longer valid.


id: SolrDocumentField
type: class
doc:
<comment>Description:</comment>
  Dies stellt ein Feld in einem Solr-Dokument dar. Alle seine Eigenschaften sind schreibgeschützt.


id: SolrDocumentField::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  Constructor.

<comment>Return:</comment>
  <info>unknown</info>  None.


id: SolrDocumentField::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructor
  
  Destructor.

<comment>Return:</comment>
  <info>unknown</info>  None.


id: SolrException
type: class
doc:
<comment>Description:</comment>
  Dies ist die Basisklasse für alle Ausnahmen, die von den Solr-Erweiterungsklassen ausgelöst
  werden.


id: SolrGenericResponse::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  Constructor

<comment>Return:</comment>
  <info>unknown</info>  None


id: SolrGenericResponse::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructor
  
  Destructor.

<comment>Return:</comment>
  <info>unknown</info>  None


id: SolrIllegalArgumentException
type: class
doc:
<comment>Description:</comment>
  Dieses Objekt wird ausgelöst, wenn ein illegales oder ungültiges Argument an eine Methode
  übergeben wird.


id: SolrIllegalArgumentException::getInternalInfo
type: function
doc:
<comment>Description:</comment>
  Returns internal information where the Exception was thrown
  
  Returns internal information where the Exception was thrown.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing internal information where the error was thrown. Used only for
         debugging by extension developers.


id: SolrIllegalOperationException
type: class
doc:
<comment>Description:</comment>
  Dieses Objekt wird ausgelöst, wenn eine illegale oder nicht unterstützte Operation an einem Objekt
  durchgeführt wird.


id: SolrInputDocument
type: class
doc:
<comment>Description:</comment>
  Diese Klasse repräsentiert ein Solr-Dokument, das an den Solr-Index übermittelt werden soll.


id: SolrInputDocument::__clone
type: function
doc:
<comment>Description:</comment>
  Creates a copy of a SolrDocument
  
  Should not be called directly. It is used to create a deep copy of a SolrInputDocument.

<comment>Return:</comment>
  <info>void</info>  Creates a new SolrInputDocument instance.


id: SolrInputDocument::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructor
  
  Destructor

<comment>Return:</comment>
  <info>unknown</info>  None.


id: SolrInputDocument::addChildDocument
type: function
doc:
<comment>Description:</comment>
  Adds a child document for block indexing
  
  Adds a child document to construct a document block with nested documents.

<comment>Param:</comment>
  <info>SolrInputDocument</info>  <strong>$child</strong>  A <info>SolrInputDocument</info> object.

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::addChildDocuments
type: function
doc:
<comment>Description:</comment>
  Adds an array of child documents
  
  Adds an array of child documents to the current input document.

<comment>Param:</comment>
  <info>array</info>  <strong>$docs</strong>  An <info>array</info> of <info>SolrInputDocument</info> objects.

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::addField
type: function
doc:
<comment>Description:</comment>
  Adds a field to the document
  
  For multi-value fields, if a valid boost value is specified, the specified value will be
  multiplied by the current boost value for this field.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>        The name of the field
  <info>string</info>  <strong>$fieldValue</strong>       The value for the field.
  <info>float</info>   <strong>$fieldBoostValue</strong>  The index time boost for the field. Though this cannot be negative, you
                            can still pass values less than 1.0 but they must be greater than zero.

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


id: SolrInputDocument::clear
type: function
doc:
<comment>Description:</comment>
  Resets the input document
  
  Resets the document by dropping all the fields and resets the document boost to zero.

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


id: SolrInputDocument::deleteField
type: function
doc:
<comment>Description:</comment>
  Removes a field from the document
  
  Removes a field from the document.

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

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


id: SolrInputDocument::fieldExists
type: function
doc:
<comment>Description:</comment>
  Checks if a field exists
  
  Checks if a field exists

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Name of the field.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the field was found and <info>false</info> if it was not found.


id: SolrInputDocument::getBoost
type: function
doc:
<comment>Description:</comment>
  Retrieves the current boost value for the document
  
  Retrieves the current boost value for the document.

<comment>Return:</comment>
  <info>float</info>  Returns the boost value on success and <info>false</info> on failure.


id: SolrInputDocument::getChildDocuments
type: function
doc:
<comment>Description:</comment>
  Returns an array of child documents (SolrInputDocument)
  
  Returns an array of child documents (SolrInputDocument)

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::getChildDocumentsCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of child documents
  
  Returns the number of child documents

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocuments


id: SolrInputDocument::getField
type: function
doc:
<comment>Description:</comment>
  Retrieves a field by name
  
  Retrieves a field in the document.

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

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Returns a SolrDocumentField object on success and <info>false</info> on failure.


id: SolrInputDocument::getFieldBoost
type: function
doc:
<comment>Description:</comment>
  Retrieves the boost value for a particular field
  
  Retrieves the boost value for a particular field.

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

<comment>Return:</comment>
  <info>float</info>  Returns the boost value for the field or <info>false</info> if there was an error.


id: SolrInputDocument::getFieldCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of fields in the document
  
  Returns the number of fields in the document.

<comment>Return:</comment>
  <info>int|false</info>  Returns an integer on successBei einem Fehler wird <info>false</info> zurückgegeben..


id: SolrInputDocument::getFieldNames
type: function
doc:
<comment>Description:</comment>
  Returns an array containing all the fields in the document
  
  Returns an array containing all the fields in the document.

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>false</info> on failure.


id: SolrInputDocument::hasChildDocuments
type: function
doc:
<comment>Description:</comment>
  Returns true if the document has any child documents
  
  Checks whether the document has any child documents

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::getChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::merge
type: function
doc:
<comment>Description:</comment>
  Merges one input document into another
  
  Merges one input document into another.

<comment>Param:</comment>
  <info>SolrInputDocument</info>  <strong>$sourceDoc</strong>  The source document.
  <info>bool</info>               <strong>$overwrite</strong>  If this is <info>true</info> it will replace matching fields in the destination
                                 document.

<comment>Return:</comment>
  <info>bool</info>  Gibt bei Erfolg <info>true</info> zurück. Bei einem Fehler wird <info>false</info> zurückgegeben. In the future, this
        will be modified to return the number of fields in the new document.


id: SolrInputDocument::reset
type: function
doc:
<comment>Description:</comment>
  Alias von SolrInputDocument::clear
  
  This is an alias of SolrInputDocument::clear

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


id: SolrInputDocument::setBoost
type: function
doc:
<comment>Description:</comment>
  Sets the boost value for this document
  
  Sets the boost value for this document.

<comment>Param:</comment>
  <info>float</info>  <strong>$documentBoostValue</strong>  The index-time boost value for this document.

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


id: SolrInputDocument::setFieldBoost
type: function
doc:
<comment>Description:</comment>
  Sets the index-time boost value for a field
  
  Sets the index-time boost value for a field. This replaces the current boost value for this field.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>        The name of the field.
  <info>float</info>   <strong>$fieldBoostValue</strong>  The index time boost value.

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


id: SolrInputDocument::sort
type: function
doc:
<comment>Description:</comment>
  Sorts the fields within the document
  
  

<comment>Param:</comment>
  <info>int</info>  <strong>$sortOrderBy</strong>    The sort criteria
  <info>int</info>  <strong>$sortDirection</strong>  The sort direction

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


id: SolrInputDocument::toArray
type: function
doc:
<comment>Description:</comment>
  Returns an array representation of the input document
  
  Returns an array representation of the input document.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing the fields. It returns <info>false</info> on failure.


id: SolrModifiableParams
type: class
doc:
<comment>Description:</comment>
  Stellt eine Sammlung von Name-Wert-Paaren dar, die während einer Anfrage an den Solr-Server
  gesendet werden.


id: SolrModifiableParams::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructor
  
  Destructor

<comment>Return:</comment>
  <info>unknown</info>  None


id: SolrObject
type: class
doc:
<comment>Description:</comment>
  Dies ist ein Objekt, auf dessen Eigenschaften auch mit der Array-Syntax zugegriffen werden kann.
  Alle seine Eigenschaften sind schreibgeschützt.


id: SolrObject::__construct
type: function
doc:
<comment>Description:</comment>
  Creates Solr object
  
  Creates Solr object.

<comment>Return:</comment>
  <info>unknown</info>  None


id: SolrObject::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructor
  
  The destructor

<comment>Return:</comment>
  <info>unknown</info>  None.


id: SolrObject::getPropertyNames
type: function
doc:
<comment>Description:</comment>
  Returns an array of all the names of the properties
  
  Returns an array of all the names of the properties

<comment>Return:</comment>
  <info>array</info>  Returns an array.


id: SolrObject::offsetExists
type: function
doc:
<comment>Description:</comment>
  Checks if the property exists
  
  Checks if the property exists. This is used when the object is treated as an array.

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

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


id: SolrObject::offsetGet
type: function
doc:
<comment>Description:</comment>
  Used to retrieve a property
  
  Used to get the value of a property. This is used when the object is treated as an array.

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>  Name of the property.

<comment>Return:</comment>
  <info>mixed</info>  Returns the property value.


id: SolrObject::offsetSet
type: function
doc:
<comment>Description:</comment>
  Sets the value for a property
  
  Sets the value for a property. This is used when the object is treated as an array. This object is
  read-only. This should never be attempted.

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>   The name of the property.
  <info>string</info>  <strong>$property_value</strong>  The new value.

<comment>Return:</comment>
  <info>void</info>  None.


id: SolrObject::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Unsets the value for the property
  
  Unsets the value for the property. This is used when the object is treated as an array. This
  object is read-only. This should never be attempted.

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

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


id: SolrParams::add
type: function
doc:
<comment>Description:</comment>
  Alias von SolrParams::addParam
  
  This is an alias for SolrParams::addParam

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   The name of the parameter
  <info>string</info>  <strong>$value</strong>  The value of the parameter

<comment>Return:</comment>
  <info>SolrParams</info>  Returns a SolrParams instance on success


id: SolrParams::addParam
type: function
doc:
<comment>Description:</comment>
  Adds a parameter to the object
  
  Adds a parameter to the object. This is used for parameters that can be specified multiple times.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Name of parameter
  <info>string</info>  <strong>$value</strong>  Value of parameter

<comment>Return:</comment>
  <info>SolrParams</info>  Returns a SolrParam object on success and <info>false</info> on failure.


id: SolrParams::get
type: function
doc:
<comment>Description:</comment>
  Alias von SolrParams::getParam
  
  This is an alias for SolrParams::getParam

<comment>Param:</comment>
  <info>string</info>  <strong>$param_name</strong>  Then name of the parameter

<comment>Return:</comment>
  <info>mixed</info>  Returns an array or string depending on the type of parameter


id: SolrParams::getParam
type: function
doc:
<comment>Description:</comment>
  Returns a parameter value
  
  Returns a parameter with name param_name

<comment>Param:</comment>
  <info>string</info>  <strong>$param_name</strong>  The name of the parameter

<comment>Return:</comment>
  <info>mixed</info>  Returns a string or an array depending on the type of the parameter


id: SolrParams::getParams
type: function
doc:
<comment>Description:</comment>
  Returns an array of non URL-encoded parameters
  
  Returns an array of non URL-encoded parameters

<comment>Return:</comment>
  <info>array</info>  Returns an array of non URL-encoded parameters


id: SolrParams::getPreparedParams
type: function
doc:
<comment>Description:</comment>
  Returns an array of URL-encoded parameters
  
  Returns an array on URL-encoded parameters

<comment>Return:</comment>
  <info>array</info>  Returns an array on URL-encoded parameters


id: SolrParams::serialize
type: function
doc:
<comment>Description:</comment>
  Used for custom serialization
  
  Used for custom serialization

<comment>Return:</comment>
  <info>string</info>  Used for custom serialization


id: SolrParams::set
type: function
doc:
<comment>Description:</comment>
  Alias von SolrParams::setParam
  
  An alias of SolrParams::setParam

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Then name of the parameter
  <info>string</info>  <strong>$value</strong>  The parameter value

<comment>Return:</comment>
  <info>void</info>  Returns an instance of the SolrParams object on success


id: SolrParams::setParam
type: function
doc:
<comment>Description:</comment>
  Sets the parameter to the specified value
  
  Sets the query parameter to the specified value. This is used for parameters that can only be
  specified once. Subsequent calls with the same parameter name will override the existing value

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Name of the parameter
  <info>string</info>  <strong>$value</strong>  Value of the parameter

<comment>Return:</comment>
  <info>SolrParams</info>  Returns a SolrParam object on success and <info>false</info> on value.


id: SolrParams::toString
type: function
doc:
<comment>Description:</comment>
  Returns all the name-value pair parameters in the object
  
  Returns all the name-value pair parameters in the object

<comment>Param:</comment>
  <info>bool</info>  <strong>$url_encode</strong>  Whether to return URL-encoded values

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>false</info> on failure.


id: SolrParams::unserialize
type: function
doc:
<comment>Description:</comment>
  Used for custom serialization
  
  Used for custom serialization

<comment>Param:</comment>
  <info>string</info>  <strong>$serialized</strong>  The serialized representation of the object

<comment>Return:</comment>
  <info>void</info>  None


id: SolrPingResponse::getResponse
type: function
doc:
<comment>Description:</comment>
  Returns the response from the server
  
  Returns the response from the server. This should be empty because the request as a HEAD request.

<comment>Return:</comment>
  <info>string</info>  Returns an empty string.


id: SolrQuery::FACET_SORT_COUNT
type: constant
doc:
<comment>Description:</comment>
  Wird verwendet, um anzugeben, dass die Facette nach Anzahl sortiert werden soll.


id: SolrQuery::FACET_SORT_INDEX
type: constant
doc:
<comment>Description:</comment>
  Wird verwendet, um anzugeben, dass die Facette nach Index sortiert werden soll.


id: SolrQuery::ORDER_ASC
type: constant
doc:
<comment>Description:</comment>
  Wird verwendet, um anzugeben, dass die Sortierung in aufsteigender Reihenfolge erfolgen soll.


id: SolrQuery::ORDER_DESC
type: constant
doc:
<comment>Description:</comment>
  Wird verwendet, um anzugeben, dass die Sortierung in absteigender Reihenfolge erfolgen soll.


id: SolrQuery::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  Constructor.

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  Optional search query

<comment>Return:</comment>
  <info>unknown</info>  None


id: SolrQuery::addExpandFilterQuery
type: function
doc:
<comment>Description:</comment>
  Overrides main filter query, determines which documents to include in the main group
  
  Overrides main filter query, determines which documents to include in the main group.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::addExpandSortField
type: function
doc:
<comment>Description:</comment>
  Orders the documents within the expanded groups (expand.sort parameter)
  
  Orders the documents within the expanded groups (expand.sort parameter).

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  field name
  <info>string</info>  <strong>$order</strong>  Order ASC/DESC, utilizes SolrQuery::ORDER_* constants.
                  
                  Default: <info>SolrQuery::ORDER_DESC</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::addFacetDateField
type: function
doc:
<comment>Description:</comment>
  Maps to facet.date
  
  This method allows you to specify a field which should be treated as a facet.
  
  It can be used multiple times with different field names to indicate multiple facet fields

<comment>Param:</comment>
  <info>string</info>  <strong>$dateField</strong>  The name of the date field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns a SolrQuery object.


id: SolrQuery::addFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Adds another facet.date.other parameter
  
  Sets the facet.date.other parameter. Accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           The value to use.
  <info>string</info>  <strong>$field_override</strong>  The field name for the override.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addFacetField
type: function
doc:
<comment>Description:</comment>
  Adds another field to the facet
  
  Adds another field to the facet

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addFacetQuery
type: function
doc:
<comment>Description:</comment>
  Adds a facet query
  
  Adds a facet query

<comment>Param:</comment>
  <info>string</info>  <strong>$facetQuery</strong>  The facet query

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addField
type: function
doc:
<comment>Description:</comment>
  Specifies which fields to return in the result
  
  This method is used to used to specify a set of fields to return, thereby restricting the amount
  of data returned in the response.
  
  It should be called multiple time, once for each field name.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object


id: SolrQuery::addFilterQuery
type: function
doc:
<comment>Description:</comment>
  Specifies a filter query
  
  Specifies a filter query

<comment>Param:</comment>
  <info>string</info>  <strong>$fq</strong>  The filter query

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object.


id: SolrQuery::addGroupField
type: function
doc:
<comment>Description:</comment>
  Add a field to be used to group results
  
  The name of the field by which to group results. The field must be single-valued, and either be
  indexed or a field type that has a value source and works in a function query, such as
  ExternalFileField. It must also be a string-based field, such as StrField or TextField Uses
  group.field parameter

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns an instance of <class>SolrQuery</class>.

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addGroupFunction
type: function
doc:
<comment>Description:</comment>
  Allows grouping results based on the unique values of a function query (group.func parameter)
  
  Adds a group function (group.func parameter) Allows grouping results based on the unique values of
  a function query.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addGroupQuery
type: function
doc:
<comment>Description:</comment>
  Allows grouping of documents that match the given query
  
  Allows grouping of documents that match the given query. Adds query to the group.query parameter

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addGroupSortField
type: function
doc:
<comment>Description:</comment>
  Add a group sort field (group.sort parameter)
  
  Allow sorting group documents, using group sort field (group.sort parameter).

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field name
  <info>int</info>     <strong>$order</strong>  Order ASC/DESC, utilizes SolrQuery::ORDER_* constants

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addHighlightField
type: function
doc:
<comment>Description:</comment>
  Maps to hl.fl
  
  Maps to hl.fl. This is used to specify that highlighted snippets should be generated for a
  particular field

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addMltField
type: function
doc:
<comment>Description:</comment>
  Sets a field to use for similarity
  
  Maps to mlt.fl. It specifies that a field should be used for similarity.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addMltQueryField
type: function
doc:
<comment>Description:</comment>
  Maps to mlt.qf
  
  Maps to mlt.qf. It is used to specify query fields and their boosts

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field
  <info>float</info>   <strong>$boost</strong>  Its boost value

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addSortField
type: function
doc:
<comment>Description:</comment>
  Used to control how the results should be sorted
  
  Used to control how the results should be sorted.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field
  <info>int</info>     <strong>$order</strong>  The sort direction. This should be either SolrQuery::ORDER_ASC or
                  SolrQuery::ORDER_DESC.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object.


id: SolrQuery::addStatsFacet
type: function
doc:
<comment>Description:</comment>
  Requests a return of sub results for values within the given facet 
  
  Requests a return of sub results for values within the given facet. Maps to the stats.facet field

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addStatsField
type: function
doc:
<comment>Description:</comment>
  Maps to stats.field parameter
  
  Maps to stats.field parameter This methods adds another stats.field parameter.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::collapse
type: function
doc:
<comment>Description:</comment>
  Collapses the result set to a single document per group
  
  Collapses the result set to a single document per group before it forwards the result set to the
  rest of the search components.
  
  So all downstream components (faceting, highlighting, etc...) will work with the collapsed result
  set.

<comment>Param:</comment>
  <info>SolrCollapseFunction</info>  <strong>$collapseFunction</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current <info>SolrQuery</info> object


id: SolrQuery::getExpand
type: function
doc:
<comment>Description:</comment>
  Returns true if group expanding is enabled
  
  Returns <info>true</info> if group expanding is enabled

<comment>Return:</comment>
  <info>bool</info>  Returns whether group expanding is enabled.


id: SolrQuery::getExpandFilterQueries
type: function
doc:
<comment>Description:</comment>
  Returns the expand filter queries
  
  Returns the expand filter queries

<comment>Return:</comment>
  <info>array</info>  Returns the expand filter queries.


id: SolrQuery::getExpandQuery
type: function
doc:
<comment>Description:</comment>
  Returns the expand query expand.q parameter
  
  Returns the expand query expand.q parameter

<comment>Return:</comment>
  <info>array</info>  Returns the expand query.


id: SolrQuery::getExpandRows
type: function
doc:
<comment>Description:</comment>
  Returns The number of rows to display in each group (expand.rows)
  
  Returns The number of rows to display in each group (expand.rows)

<comment>Return:</comment>
  <info>int</info>  Returns the number of rows.


id: SolrQuery::getExpandSortFields
type: function
doc:
<comment>Description:</comment>
  Returns an array of fields
  
  Returns an array of fields

<comment>Return:</comment>
  <info>array</info>  Returns an array of fields.


id: SolrQuery::getFacet
type: function
doc:
<comment>Description:</comment>
  Returns the value of the facet parameter
  
  Returns the value of the facet parameter.

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set


id: SolrQuery::getFacetDateEnd
type: function
doc:
<comment>Description:</comment>
  Returns the value for the facet.date.end parameter
  
  Returns the value for the facet.date.end parameter. This method accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set


id: SolrQuery::getFacetDateFields
type: function
doc:
<comment>Description:</comment>
  Returns all the facet.date fields
  
  Returns all the facet.date fields

<comment>Return:</comment>
  <info>array</info>  Returns all the facet.date fields as an array or <info>null</info> if none was set


id: SolrQuery::getFacetDateGap
type: function
doc:
<comment>Description:</comment>
  Returns the value of the facet.date.gap parameter
  
  Returns the value of the facet.date.gap parameter. It accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set


id: SolrQuery::getFacetDateHardEnd
type: function
doc:
<comment>Description:</comment>
  Returns the value of the facet.date.hardend parameter
  
  Returns the value of the facet.date.hardend parameter. Accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set


id: SolrQuery::getFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Returns the value for the facet.date.other parameter
  
  Returns the value for the facet.date.other parameter. This method accepts an optional field
  override.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>array</info>  Returns an Array on success and <info>null</info> if not set.


id: SolrQuery::getFacetDateStart
type: function
doc:
<comment>Description:</comment>
  Returns the  lower bound for the first date range for all date faceting on this field
  
  Returns the  lower bound for the first date range for all date faceting on this field. Accepts an
  optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set


id: SolrQuery::getFacetFields
type: function
doc:
<comment>Description:</comment>
  Returns all the facet fields
  
  Returns all the facet fields

<comment>Return:</comment>
  <info>array</info>  Returns an array of all the fields and <info>null</info> if none was set


id: SolrQuery::getFacetLimit
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of constraint counts that should be returned for the facet fields
  
  Returns the maximum number of constraint counts that should be returned for the facet fields. This
  method accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field to override for

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set


id: SolrQuery::getFacetMethod
type: function
doc:
<comment>Description:</comment>
  Returns the value of the facet.method parameter
  
  Returns the value of the facet.method parameter. This accepts an optional field override.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set


id: SolrQuery::getFacetMinCount
type: function
doc:
<comment>Description:</comment>
  Returns the minimum counts for facet fields should be included in the response
  
  Returns the minimum counts for facet fields should be included in the response. It accepts an
  optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set


id: SolrQuery::getFacetMissing
type: function
doc:
<comment>Description:</comment>
  Returns the current state of the facet.missing parameter
  
  Returns the current state of the facet.missing parameter. This accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set


id: SolrQuery::getFacetOffset
type: function
doc:
<comment>Description:</comment>
  Returns an offset into the list of constraints to be used for pagination
  
  Returns an offset into the list of constraints to be used for pagination. Accepts an optional
  field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field to override for.

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set


id: SolrQuery::getFacetPrefix
type: function
doc:
<comment>Description:</comment>
  Returns the facet prefix
  
  Returns the facet prefix

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getFacetQueries
type: function
doc:
<comment>Description:</comment>
  Returns all the facet queries
  
  Returns all the facet queries

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getFacetSort
type: function
doc:
<comment>Description:</comment>
  Returns the facet sort type
  
  Returns an integer (SolrQuery::FACET_SORT_INDEX or SolrQuery::FACET_SORT_COUNT)

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>int</info>  Returns an integer (SolrQuery::FACET_SORT_INDEX or SolrQuery::FACET_SORT_COUNT) on success or
       <info>null</info> if not set.


id: SolrQuery::getFields
type: function
doc:
<comment>Description:</comment>
  Returns the list of fields that will be returned in the response
  
  Returns the list of fields that will be returned in the response

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getFilterQueries
type: function
doc:
<comment>Description:</comment>
  Returns an array of filter queries
  
  Returns an array of filter queries. These are queries that can be used to restrict the super set
  of documents that can be returned, without influencing score

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getGroup
type: function
doc:
<comment>Description:</comment>
  Returns true if grouping is enabled
  
  Returns true if grouping is enabled

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

<comment>See Also:</comment>
   * SolrQuery::setGroup


id: SolrQuery::getGroupCachePercent
type: function
doc:
<comment>Description:</comment>
  Returns group cache percent value
  
  Returns group cache percent value

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

<comment>See Also:</comment>
   * SolrQuery::setGroupCachePercent


id: SolrQuery::getGroupFacet
type: function
doc:
<comment>Description:</comment>
  Returns the group.facet parameter value
  
  Returns the group.facet parameter value

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

<comment>See Also:</comment>
   * SolrQuery::setGroupFacet


id: SolrQuery::getGroupFields
type: function
doc:
<comment>Description:</comment>
  Returns group fields (group.field parameter values)
  
  Returns group fields (group.field parameter values)

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

<comment>See Also:</comment>
   * SolrQuery::addGroupField


id: SolrQuery::getGroupFormat
type: function
doc:
<comment>Description:</comment>
  Returns the group.format value
  
  Returns the group.format value

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

<comment>See Also:</comment>
   * SolrQuery::setGroupFormat


id: SolrQuery::getGroupFunctions
type: function
doc:
<comment>Description:</comment>
  Returns group functions (group.func parameter values)
  
  Returns group functions (group.func parameter values)

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

<comment>See Also:</comment>
   * SolrQuery::addGroupFunction


id: SolrQuery::getGroupLimit
type: function
doc:
<comment>Description:</comment>
  Returns the group.limit value
  
  Returns the group.limit value

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

<comment>See Also:</comment>
   * SolrQuery::setGroupLimit


id: SolrQuery::getGroupMain
type: function
doc:
<comment>Description:</comment>
  Returns the group.main value
  
  Returns the group.main value

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

<comment>See Also:</comment>
   * SolrQuery::setGroupMain


id: SolrQuery::getGroupNGroups
type: function
doc:
<comment>Description:</comment>
  Returns the group.ngroups value
  
  Returns the group.ngroups value

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

<comment>See Also:</comment>
   * SolrQuery::setGroupNGroups


id: SolrQuery::getGroupOffset
type: function
doc:
<comment>Description:</comment>
  Returns the group.offset value
  
  Returns the group.offset value

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

<comment>See Also:</comment>
   * SolrQuery::setGroupOffset


id: SolrQuery::getGroupQueries
type: function
doc:
<comment>Description:</comment>
  Returns all the group.query parameter values
  
  Returns all the group.query parameter values

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

<comment>See Also:</comment>
   * SolrQuery::addGroupQuery


id: SolrQuery::getGroupSortFields
type: function
doc:
<comment>Description:</comment>
  Returns the group.sort value
  
  Returns the group.sort value

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

<comment>See Also:</comment>
   * SolrQuery::addGroupSortField


id: SolrQuery::getGroupTruncate
type: function
doc:
<comment>Description:</comment>
  Returns the group.truncate value
  
  Returns the group.truncate value

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

<comment>See Also:</comment>
   * SolrQuery::setGroupTruncate


id: SolrQuery::getHighlight
type: function
doc:
<comment>Description:</comment>
  Returns the state of the hl parameter
  
  Returns a boolean indicating whether or not to enable highlighted snippets to be generated in the
  query response.

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getHighlightAlternateField
type: function
doc:
<comment>Description:</comment>
  Returns the highlight field to use as backup or default
  
  Returns the highlight field to use as backup or default. It accepts an optional override.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightFields
type: function
doc:
<comment>Description:</comment>
  Returns all the fields that Solr should generate highlighted snippets for
  
  Returns all the fields that Solr should generate highlighted snippets for

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getHighlightFormatter
type: function
doc:
<comment>Description:</comment>
  Returns the formatter for the highlighted output
  
  Returns the formatter for the highlighted output

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightFragmenter
type: function
doc:
<comment>Description:</comment>
  Returns the text snippet generator for highlighted text
  
  Returns the text snippet generator for highlighted text. Accepts an optional field override.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightFragsize
type: function
doc:
<comment>Description:</comment>
  Returns the number of characters of fragments to consider for highlighting
  
  Returns the number of characters of fragments to consider for highlighting. Zero implies no
  fragmenting. The entire field should be used.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success or <info>null</info> if not set.


id: SolrQuery::getHighlightHighlightMultiTerm
type: function
doc:
<comment>Description:</comment>
  Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries
  
  Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getHighlightMaxAlternateFieldLength
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of characters of the field to return
  
  Returns the maximum number of characters of the field to return

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getHighlightMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of characters into a document to look for suitable snippets
  
  Returns the maximum number of characters into a document to look for suitable snippets

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getHighlightMergeContiguous
type: function
doc:
<comment>Description:</comment>
  Returns whether or not the collapse contiguous fragments into a single fragment
  
  Returns whether or not the collapse contiguous fragments into a single fragment. Accepts an
  optional field override.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getHighlightRegexMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of characters from a field when using the regex fragmenter
  
  Returns the maximum number of characters from a field when using the regex fragmenter

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getHighlightRegexPattern
type: function
doc:
<comment>Description:</comment>
  Returns the regular expression for fragmenting
  
  Returns the regular expression used for fragmenting

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightRegexSlop
type: function
doc:
<comment>Description:</comment>
  Returns the deviation factor from the ideal fragment size
  
  Returns the factor by which the regex fragmenter can deviate from the ideal fragment size to
  accommodate the regular expression

<comment>Return:</comment>
  <info>float</info>  Returns a <info>float</info> on success and <info>null</info> if not set.


id: SolrQuery::getHighlightRequireFieldMatch
type: function
doc:
<comment>Description:</comment>
  Returns if a field will only be highlighted if the query matched in this particular field
  
  Returns if a field will only be highlighted if the query matched in this particular field.

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getHighlightSimplePost
type: function
doc:
<comment>Description:</comment>
  Returns the text which appears after a highlighted term
  
  Returns the text which appears after a highlighted term. Accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightSimplePre
type: function
doc:
<comment>Description:</comment>
  Returns the text which appears before a highlighted term
  
  Returns the text which appears before a highlighted term. Accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightSnippets
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of highlighted snippets to generate per field
  
  Returns the maximum number of highlighted snippets to generate per field. Accepts an optional
  field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getHighlightUsePhraseHighlighter
type: function
doc:
<comment>Description:</comment>
  Returns the state of the hl.usePhraseHighlighter parameter
  
  Returns whether or not to use SpanScorer to highlight phrase terms only when they appear within
  the query phrase in the document.

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getMlt
type: function
doc:
<comment>Description:</comment>
  Returns whether or not MoreLikeThis results should be enabled
  
  Returns whether or not MoreLikeThis results should be enabled

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getMltBoost
type: function
doc:
<comment>Description:</comment>
  Returns whether or not the query will be boosted by the interesting term relevance
  
  Returns whether or not the query will be boosted by the interesting term relevance

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getMltCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of similar documents to return for each result
  
  Returns the number of similar documents to return for each result

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltFields
type: function
doc:
<comment>Description:</comment>
  Returns all the fields to use for similarity
  
  Returns all the fields to use for similarity

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getMltMaxNumQueryTerms
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of query terms that will be included in any generated query
  
  Returns the maximum number of query terms that will be included in any generated query

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltMaxNumTokens
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of tokens to parse in each document field that is not stored with
  TermVector support
  
  Returns the maximum number of tokens to parse in each document field that is not stored with
  TermVector support

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltMaxWordLength
type: function
doc:
<comment>Description:</comment>
  Returns the maximum word length above which words will be ignored
  
  Returns the maximum word length above which words will be ignored

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltMinDocFrequency
type: function
doc:
<comment>Description:</comment>
  Returns the treshold frequency at which words will be ignored which do not occur in at least this
  many docs
  
  Returns the treshold frequency at which words will be ignored which do not occur in at least this
  many docs

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltMinTermFrequency
type: function
doc:
<comment>Description:</comment>
  Returns the frequency below which terms will be ignored in the source document
  
  Returns the frequency below which terms will be ignored in the source document

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltMinWordLength
type: function
doc:
<comment>Description:</comment>
  Returns the minimum word length below which words will be ignored
  
  Returns the minimum word length below which words will be ignored

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltQueryFields
type: function
doc:
<comment>Description:</comment>
  Returns the query fields and their boosts
  
  Returns the query fields and their boosts

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getQuery
type: function
doc:
<comment>Description:</comment>
  Returns the main query
  
  Returns the main search query

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getRows
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of documents
  
  Returns the maximum number of documents from the complete result set to return to the client for
  every request

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getSortFields
type: function
doc:
<comment>Description:</comment>
  Returns all the sort fields
  
  Returns all the sort fields

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if none of the parameters was set.


id: SolrQuery::getStart
type: function
doc:
<comment>Description:</comment>
  Returns the offset in the complete result set 
  
  Returns the offset in the complete result set for the queries where the set of returned documents
  should begin.

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getStats
type: function
doc:
<comment>Description:</comment>
  Returns whether or not stats is enabled
  
  Returns whether or not stats is enabled

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getStatsFacets
type: function
doc:
<comment>Description:</comment>
  Returns all the stats facets that were set
  
  Returns all the stats facets that were set

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getStatsFields
type: function
doc:
<comment>Description:</comment>
  Returns all the statistics fields
  
  Returns all the statistics fields

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getTerms
type: function
doc:
<comment>Description:</comment>
  Returns whether or not the TermsComponent is enabled
  
  Returns whether or not the TermsComponent is enabled

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getTermsField
type: function
doc:
<comment>Description:</comment>
  Returns the field from which the terms are retrieved
  
  Returns the field from which the terms are retrieved

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getTermsIncludeLowerBound
type: function
doc:
<comment>Description:</comment>
  Returns whether or not to include the lower bound in the result set
  
  Returns whether or not to include the lower bound in the result set

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getTermsIncludeUpperBound
type: function
doc:
<comment>Description:</comment>
  Returns whether or not to include the upper bound term in the result set
  
  Returns whether or not to include the upper bound term in the result set

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getTermsLimit
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of terms Solr should return
  
  Returns the maximum number of terms Solr should return

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getTermsLowerBound
type: function
doc:
<comment>Description:</comment>
  Returns the term to start at
  
  Returns the term to start at

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getTermsMaxCount
type: function
doc:
<comment>Description:</comment>
  Returns the maximum document frequency
  
  Returns the maximum document frequency

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getTermsMinCount
type: function
doc:
<comment>Description:</comment>
  Returns the minimum document frequency to return in order to be included
  
  Returns the minimum document frequency to return in order to be included

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getTermsPrefix
type: function
doc:
<comment>Description:</comment>
  Returns the term prefix
  
  Returns the prefix to which matching terms must be restricted. This will restrict matches to only
  terms that start with the prefix

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getTermsReturnRaw
type: function
doc:
<comment>Description:</comment>
  Whether or not to return raw characters
  
  Returns a boolean indicating whether or not to return the raw characters of the indexed term,
  regardless of if it is human readable

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getTermsSort
type: function
doc:
<comment>Description:</comment>
  Returns an integer indicating how terms are sorted
  
  SolrQuery::TERMS_SORT_INDEX indicates that the terms are returned by index order.
  SolrQuery::TERMS_SORT_COUNT implies that the terms are sorted by term frequency (highest count
  first)

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getTermsUpperBound
type: function
doc:
<comment>Description:</comment>
  Returns the term to stop at
  
  Returns the term to stop at

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getTimeAllowed
type: function
doc:
<comment>Description:</comment>
  Returns the time in milliseconds allowed for the query to finish
  
  Returns the time in milliseconds allowed for the query to finish.

<comment>Return:</comment>
  <info>int</info>  Returns and integer on success and <info>null</info> if it is not set.


id: SolrQuery::removeExpandFilterQuery
type: function
doc:
<comment>Description:</comment>
  Removes an expand filter query
  
  Removes an expand filter query.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery


id: SolrQuery::removeExpandSortField
type: function
doc:
<comment>Description:</comment>
  Removes an expand sort field from the expand.sort parameter
  
  Removes an expand sort field from the expand.sort parameter.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::removeFacetDateField
type: function
doc:
<comment>Description:</comment>
  Removes one of the facet date fields
  
  The name of the field

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the date field to remove

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Removes one of the facet.date.other parameters
  
  Removes one of the facet.date.other parameters

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           The value
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeFacetField
type: function
doc:
<comment>Description:</comment>
  Removes one of the facet.date parameters
  
  Removes one of the facet.date parameters

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeFacetQuery
type: function
doc:
<comment>Description:</comment>
  Removes one of the facet.query parameters
  
  Removes one of the facet.query parameters.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeField
type: function
doc:
<comment>Description:</comment>
  Removes a field from the list of fields
  
  Removes a field from the list of fields

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeFilterQuery
type: function
doc:
<comment>Description:</comment>
  Removes a filter query
  
  Removes a filter query.

<comment>Param:</comment>
  <info>string</info>  <strong>$fq</strong>  The filter query to remove

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeHighlightField
type: function
doc:
<comment>Description:</comment>
  Removes one of the fields used for highlighting
  
  Removes one of the fields used for highlighting.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeMltField
type: function
doc:
<comment>Description:</comment>
  Removes one of the moreLikeThis fields
  
  Removes one of the moreLikeThis fields.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeMltQueryField
type: function
doc:
<comment>Description:</comment>
  Removes one of the moreLikeThis query fields
  
  Removes one of the moreLikeThis query fields.

<comment>Param:</comment>
  <info>string</info>  <strong>$queryField</strong>  The query field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeSortField
type: function
doc:
<comment>Description:</comment>
  Removes one of the sort fields
  
  Removes one of the sort fields

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeStatsFacet
type: function
doc:
<comment>Description:</comment>
  Removes one of the stats.facet parameters
  
  Removes one of the stats.facet parameters

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeStatsField
type: function
doc:
<comment>Description:</comment>
  Removes one of the stats.field parameters
  
  Removes one of the stats.field parameters

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setEchoHandler
type: function
doc:
<comment>Description:</comment>
  Toggles the echoHandler parameter
  
  If set to true, Solr places the name of the handle used in the response to the client for
  debugging purposes.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setEchoParams
type: function
doc:
<comment>Description:</comment>
  Determines what kind of parameters to include in the response
  
  Instructs Solr what kinds of Request parameters should be included in the response for debugging
  purposes, legal values include:
  
  

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  The type of parameters to include

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setExpand
type: function
doc:
<comment>Description:</comment>
  Enables/Disables the Expand Component
  
  Enables/Disables the Expand Component.

<comment>Param:</comment>
  <info>bool</info>  <strong>$value</strong>  Bool flag

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::setExpandQuery
type: function
doc:
<comment>Description:</comment>
  Sets the expand.q parameter
  
  Sets the expand.q parameter.
  
  Overrides the main q parameter,  determines which documents to include in the main group.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::setExpandRows
type: function
doc:
<comment>Description:</comment>
  Sets the number of rows to display in each group (expand.rows). Server Default 5
  
  Sets the number of rows to display in each group (expand.rows). Server Default 5

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::setExplainOther
type: function
doc:
<comment>Description:</comment>
  Sets the explainOther common query parameter
  
  Sets the explainOther common query parameter

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  The Lucene query to identify a set of documents

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacet
type: function
doc:
<comment>Description:</comment>
  Maps to the facet parameter. Enables or disables facetting
  
  Enables or disables faceting.

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  <info>true</info> enables faceting and <info>false</info> disables it.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetDateEnd
type: function
doc:
<comment>Description:</comment>
  Maps to facet.date.end
  
  Maps to facet.date.end

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           See facet.date.end
  <info>string</info>  <strong>$field_override</strong>  Name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetDateGap
type: function
doc:
<comment>Description:</comment>
  Maps to facet.date.gap
  
  Maps to facet.date.gap

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           See facet.date.gap
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetDateHardEnd
type: function
doc:
<comment>Description:</comment>
  Maps to facet.date.hardend
  
  Maps to facet.date.hardend

<comment>Param:</comment>
  <info>bool</info>    <strong>$value</strong>           See facet.date.hardend
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetDateStart
type: function
doc:
<comment>Description:</comment>
  Maps to facet.date.start
  
  Maps to facet.date.start

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           See facet.date.start
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetEnumCacheMinDefaultFrequency
type: function
doc:
<comment>Description:</comment>
  Sets the minimum document frequency used for determining term count
  
  Sets the minimum document frequency used for determining term count

<comment>Param:</comment>
  <info></info>        <strong>$value</strong>           The minimum frequency
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetLimit
type: function
doc:
<comment>Description:</comment>
  Maps to facet.limit
  
  Maps to facet.limit. Sets the maximum number of constraint counts that should be returned for the
  facet fields.

<comment>Param:</comment>
  <info>int</info>     <strong>$limit</strong>           The maximum number of constraint counts
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetMethod
type: function
doc:
<comment>Description:</comment>
  Specifies the type of algorithm to use when faceting a field
  
  Specifies the type of algorithm to use when faceting a field. This method accepts optional field
  override.

<comment>Param:</comment>
  <info>string</info>  <strong>$method</strong>          The method to use.
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetMinCount
type: function
doc:
<comment>Description:</comment>
  Maps to facet.mincount
  
  Sets the minimum counts for facet fields that should be included in the response

<comment>Param:</comment>
  <info>int</info>     <strong>$mincount</strong>        The minimum count
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetMissing
type: function
doc:
<comment>Description:</comment>
  Maps to facet.missing
  
  Used to indicate that in addition to the Term-based constraints of a facet field, a count of all
  matching results which have no value for the field should be computed

<comment>Param:</comment>
  <info>bool</info>    <strong>$flag</strong>            <info>true</info> turns this feature on. <info>false</info> disables it.
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetOffset
type: function
doc:
<comment>Description:</comment>
  Sets the offset into the list of constraints to allow for pagination
  
  Sets the offset into the list of constraints to allow for pagination.

<comment>Param:</comment>
  <info>int</info>     <strong>$offset</strong>          The offset
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetPrefix
type: function
doc:
<comment>Description:</comment>
  Specifies a string prefix with which to limits the terms on which to facet
  
  Specifies a string prefix with which to limits the terms on which to facet.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>          The prefix string
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetSort
type: function
doc:
<comment>Description:</comment>
  Determines the ordering of the facet field constraints
  
  Determines the ordering of the facet field constraints

<comment>Param:</comment>
  <info>int</info>     <strong>$facetSort</strong>       Use SolrQuery::FACET_SORT_INDEX for sorting by index order or
                           SolrQuery::FACET_SORT_COUNT for sorting by count.
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setGroup
type: function
doc:
<comment>Description:</comment>
  Enable/Disable result grouping (group parameter)
  
  Enable/Disable result grouping (group parameter)

<comment>Param:</comment>
  <info>bool</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::getGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupCachePercent
type: function
doc:
<comment>Description:</comment>
  Enables caching for result grouping
  
  Setting this parameter to a number greater than 0 enables caching for result grouping. Result
  Grouping executes two searches; this option caches the second search. The server default value is
  0.  Testing has shown that group caching only improves search time with Boolean, wildcard, and
  fuzzy queries. For simple queries like term or "match all" queries, group caching degrades
  performance. group.cache.percent parameter

<comment>Param:</comment>
  <info>int</info>  <strong>$percent</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat


id: SolrQuery::setGroupFacet
type: function
doc:
<comment>Description:</comment>
  Sets group.facet parameter
  
  Determines whether to compute grouped facets for the field facets specified in facet.field
  parameters. Grouped facets are computed based on the first specified group.

<comment>Param:</comment>
  <info>bool</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupFormat
type: function
doc:
<comment>Description:</comment>
  Sets the group format, result structure (group.format parameter)
  
  Sets the group.format parameter. If this parameter is set to simple, the grouped documents are
  presented in a single flat list, and the start and rows parameters affect the numbers of documents
  instead of groups. Accepts: grouped/simple

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupLimit
type: function
doc:
<comment>Description:</comment>
  Specifies the number of results to return for each group. The server default value is 1
  
  Specifies the number of results to return for each group. The server default value is 1.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupMain
type: function
doc:
<comment>Description:</comment>
  If true, the result of the first field grouping command is used as the main result list in the
  response, using group.format=simple
  
  If <info>true</info>, the result of the first field grouping command is used as the main result list in the
  response, using <return>group.format=simple</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  If <info>true</info>, the result of the first field grouping command is used as the main result
                  list in the response.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns an instance of <class>SolrQuery</class>.

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupNGroups
type: function
doc:
<comment>Description:</comment>
  If true, Solr includes the number of groups that have matched the query in the results
  
  If true, Solr includes the number of groups that have matched the query in the results.

<comment>Param:</comment>
  <info>bool</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupOffset
type: function
doc:
<comment>Description:</comment>
  Sets the group.offset parameter
  
  Sets the group.offset parameter.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupTruncate
type: function
doc:
<comment>Description:</comment>
  If true, facet counts are based on the most relevant document of each group matching the query
  
  If true, facet counts are based on the most relevant document of each group matching the query.
  The server default value is false. group.truncate parameter

<comment>Param:</comment>
  <info>bool</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setHighlight
type: function
doc:
<comment>Description:</comment>
  Enables or disables highlighting
  
  Setting it to <info>true</info> enables highlighted snippets to be generated in the query response.
  
  Setting it to <info>false</info> disables highlighting

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Enable or disable highlighting

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightAlternateField
type: function
doc:
<comment>Description:</comment>
  Specifies the backup field to use
  
  If a snippet cannot be generated because there were no matching terms, one can specify a field to
  use as the backup or default summary

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>           The name of the backup field
  <info>string</info>  <strong>$field_override</strong>  The name of the field we are overriding this setting for.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightFormatter
type: function
doc:
<comment>Description:</comment>
  Specify a formatter for the highlight output
  
  Specify a formatter for the highlight output.

<comment>Param:</comment>
  <info>string</info>  <strong>$formatter</strong>       Currently the only legal value is "simple"
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns an instance of <class>SolrQuery</class>.


id: SolrQuery::setHighlightFragmenter
type: function
doc:
<comment>Description:</comment>
  Sets a text snippet generator for highlighted text
  
  Specify a text snippet generator for highlighted text.

<comment>Param:</comment>
  <info>string</info>  <strong>$fragmenter</strong>      The standard fragmenter is gap. Another option is regex, which tries to
                           create fragments that resembles a certain regular expression
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightFragsize
type: function
doc:
<comment>Description:</comment>
  The size of fragments to consider for highlighting
  
  Sets the size, in characters, of fragments to consider for highlighting. "0" indicates that the
  whole field value should be used (no fragmenting).

<comment>Param:</comment>
  <info>int</info>     <strong>$size</strong>            The size, in characters, of fragments to consider for highlighting
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightHighlightMultiTerm
type: function
doc:
<comment>Description:</comment>
  Use SpanScorer to highlight phrase terms
  
  Use SpanScorer to highlight phrase terms only when they appear within the query phrase in the
  document.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Whether or not to use SpanScorer to highlight phrase terms only when they appear
               within the query phrase in the document.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightMaxAlternateFieldLength
type: function
doc:
<comment>Description:</comment>
  Sets the maximum number of characters of the field to return
  
  If SolrQuery::setHighlightAlternateField() was passed the value <info>true</info>, this parameter specifies the
  maximum number of characters of the field to return
  
  Any value less than or equal to 0 means unlimited.

<comment>Param:</comment>
  <info>int</info>     <strong>$fieldLength</strong>     The length of the field
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Specifies the number of characters into a document to look for suitable snippets
  
  Specifies the number of characters into a document to look for suitable snippets

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The number of characters into a document to look for suitable snippets

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightMergeContiguous
type: function
doc:
<comment>Description:</comment>
  Whether or not to collapse contiguous fragments into a single fragment
  
  Whether or not to collapse contiguous fragments into a single fragment

<comment>Param:</comment>
  <info></info>        <strong>$value</strong>           Whether or not to collapse contiguous fragments into a single fragment
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightRegexMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Specify the maximum number of characters to analyze
  
  Specify the maximum number of characters to analyze from a field when using the regex fragmenter

<comment>Param:</comment>
  <info>int</info>  <strong>$maxAnalyzedChars</strong>  The maximum number of characters to analyze from a field when using the
                          regex fragmenter

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightRegexPattern
type: function
doc:
<comment>Description:</comment>
  Specify the regular expression for fragmenting
  
  Specifies the regular expression for fragmenting. This could be used to extract sentences

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  The regular expression for fragmenting. This could be used to extract sentences

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightRegexSlop
type: function
doc:
<comment>Description:</comment>
  Sets the factor by which the regex fragmenter can stray from the ideal fragment size
  
  The factor by which the regex fragmenter can stray from the ideal fragment size ( specfied by
  SolrQuery::setHighlightFragsize )to accommodate the regular expression

<comment>Param:</comment>
  <info>float</info>  <strong>$factor</strong>  The factor by which the regex fragmenter can stray from the ideal fragment size

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightRequireFieldMatch
type: function
doc:
<comment>Description:</comment>
  Require field matching during highlighting
  
  If <info>true</info>, then a field will only be highlighted if the query matched in this particular field.
  
  This will only work if SolrQuery::setHighlightUsePhraseHighlighter() was set to <info>true</info>

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightSimplePost
type: function
doc:
<comment>Description:</comment>
  Sets the text which appears after a highlighted term
  
  Sets the text which appears before a highlighted term

<comment>Param:</comment>
  <info>string</info>  <strong>$simplePost</strong>      Sets the text which appears after a highlighted term
                           
                            ]]>
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns an instance of <class>SolrQuery</class>.


id: SolrQuery::setHighlightSimplePre
type: function
doc:
<comment>Description:</comment>
  Sets the text which appears before a highlighted term
  
  Sets the text which appears before a highlighted term
  
   ]]>

<comment>Param:</comment>
  <info>string</info>  <strong>$simplePre</strong>       The text which appears before a highlighted term
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightSnippets
type: function
doc:
<comment>Description:</comment>
  Sets the maximum number of highlighted snippets to generate per field
  
  Sets the maximum number of highlighted snippets to generate per field

<comment>Param:</comment>
  <info>int</info>     <strong>$value</strong>           The maximum number of highlighted snippets to generate per field
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightUsePhraseHighlighter
type: function
doc:
<comment>Description:</comment>
  Whether to highlight phrase terms only when they appear within the query phrase
  
  Sets whether or not to use SpanScorer to highlight phrase terms only when they appear within the
  query phrase in the document

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  Whether or not to use SpanScorer to highlight phrase terms only when they appear within
            the query phrase in the document

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMlt
type: function
doc:
<comment>Description:</comment>
  Enables or disables moreLikeThis
  
  Enables or disables moreLikeThis

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> enables it and <info>false</info> turns it off.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltBoost
type: function
doc:
<comment>Description:</comment>
  Set if the query will be boosted by the interesting term relevance
  
  Set if the query will be boosted by the interesting term relevance

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  Sets to <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltCount
type: function
doc:
<comment>Description:</comment>
  Set the number of similar documents to return for each result
  
  Set the number of similar documents to return for each result

<comment>Param:</comment>
  <info>int</info>  <strong>$count</strong>  The number of similar documents to return for each result

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMaxNumQueryTerms
type: function
doc:
<comment>Description:</comment>
  Sets the maximum number of query terms included
  
  Sets the maximum number of query terms that will be included in any generated query.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The maximum number of query terms that will be included in any generated query

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMaxNumTokens
type: function
doc:
<comment>Description:</comment>
  Specifies the maximum number of tokens to parse
  
  Specifies the maximum number of tokens to parse in each example doc field that is not stored with
  TermVector support.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The maximum number of tokens to parse

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMaxWordLength
type: function
doc:
<comment>Description:</comment>
  Sets the maximum word length
  
  Sets the maximum word length above which words will be ignored.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxWordLength</strong>  The maximum word length above which words will be ignored

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMinDocFrequency
type: function
doc:
<comment>Description:</comment>
  Sets the mltMinDoc frequency
  
  The frequency at which words will be ignored which do not occur in at least this many docs.

<comment>Param:</comment>
  <info>int</info>  <strong>$minDocFrequency</strong>  Sets the frequency at which words will be ignored which do not occur in at
                         least this many docs.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMinTermFrequency
type: function
doc:
<comment>Description:</comment>
  Sets the frequency below which terms will be ignored in the source docs
  
  Sets the frequency below which terms will be ignored in the source docs

<comment>Param:</comment>
  <info>int</info>  <strong>$minTermFrequency</strong>  The frequency below which terms will be ignored in the source docs

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMinWordLength
type: function
doc:
<comment>Description:</comment>
  Sets the minimum word length
  
  Sets the minimum word length below which words will be ignored.

<comment>Param:</comment>
  <info>int</info>  <strong>$minWordLength</strong>  The minimum word length below which words will be ignored

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setOmitHeader
type: function
doc:
<comment>Description:</comment>
  Exclude the header from the returned results
  
  Exclude the header from the returned results.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> excludes the header from the result.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setQuery
type: function
doc:
<comment>Description:</comment>
  Sets the search query
  
  Sets the search query.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  The search query

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object


id: SolrQuery::setRows
type: function
doc:
<comment>Description:</comment>
  Specifies the maximum number of rows to return in the result
  
  Specifies the maximum number of rows to return in the result

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  The maximum number of rows to return

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object.


id: SolrQuery::setShowDebugInfo
type: function
doc:
<comment>Description:</comment>
  Flag to show debug information
  
  Whether to show debug info

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Whether to show debug info. <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setStart
type: function
doc:
<comment>Description:</comment>
  Specifies the number of rows to skip
  
  Specifies the number of rows to skip. Useful in pagination of results.

<comment>Param:</comment>
  <info>int</info>  <strong>$start</strong>  The number of rows to skip.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object.


id: SolrQuery::setStats
type: function
doc:
<comment>Description:</comment>
  Enables or disables the Stats component
  
  Enables or disables the Stats component.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> turns on the stats component and <info>false</info> disables it.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTerms
type: function
doc:
<comment>Description:</comment>
  Enables or disables the TermsComponent
  
  Enables or disables the TermsComponent

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> enables it. <info>false</info> turns it off

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsField
type: function
doc:
<comment>Description:</comment>
  Sets the name of the field to get the Terms from
  
  Sets the name of the field to get the terms from

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldname</strong>  The field name

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsIncludeLowerBound
type: function
doc:
<comment>Description:</comment>
  Include the lower bound term in the result set
  
  Include the lower bound term in the result set.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Include the lower bound term in the result set

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsIncludeUpperBound
type: function
doc:
<comment>Description:</comment>
  Include the upper bound term in the result set
  
  Include the upper bound term in the result set.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsLimit
type: function
doc:
<comment>Description:</comment>
  Sets the maximum number of terms to return
  
  Sets the maximum number of terms to return

<comment>Param:</comment>
  <info>int</info>  <strong>$limit</strong>  The maximum number of terms to return. All the terms will be returned if the limit is
               negative.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsLowerBound
type: function
doc:
<comment>Description:</comment>
  Specifies the Term to start from
  
  Specifies the Term to start from

<comment>Param:</comment>
  <info>string</info>  <strong>$lowerBound</strong>  The lower bound Term

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsMaxCount
type: function
doc:
<comment>Description:</comment>
  Sets the maximum document frequency
  
  Sets the maximum document frequency.

<comment>Param:</comment>
  <info>int</info>  <strong>$frequency</strong>  The maximum document frequency.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsMinCount
type: function
doc:
<comment>Description:</comment>
  Sets the minimum document frequency
  
  Sets the minimum doc frequency to return in order to be included

<comment>Param:</comment>
  <info>int</info>  <strong>$frequency</strong>  The minimum frequency

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsPrefix
type: function
doc:
<comment>Description:</comment>
  Restrict matches to terms that start with the prefix
  
  Restrict matches to terms that start with the prefix

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>  Restrict matches to terms that start with the prefix

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsReturnRaw
type: function
doc:
<comment>Description:</comment>
  Return the raw characters of the indexed term
  
  If true, return the raw characters of the indexed term, regardless of if it is human readable

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsSort
type: function
doc:
<comment>Description:</comment>
  Specifies how to sort the returned terms
  
  If SolrQuery::TERMS_SORT_COUNT, sorts the terms by the term frequency (highest count first). If
  SolrQuery::TERMS_SORT_INDEX, returns the terms in index order

<comment>Param:</comment>
  <info>int</info>  <strong>$sortType</strong>  SolrQuery::TERMS_SORT_INDEX or SolrQuery::TERMS_SORT_COUNT

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsUpperBound
type: function
doc:
<comment>Description:</comment>
  Sets the term to stop at
  
  Sets the term to stop at

<comment>Param:</comment>
  <info>string</info>  <strong>$upperBound</strong>  The term to stop at

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTimeAllowed
type: function
doc:
<comment>Description:</comment>
  The time allowed for search to finish
  
  The time allowed for a search to finish. This value only applies to the search and not to requests
  in general. Time is in milliseconds. Values less than or equal to zero implies no time
  restriction. Partial results may be returned, if there are any.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeAllowed</strong>  The time allowed for a search to finish.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrResponse::getDigestedResponse
type: function
doc:
<comment>Description:</comment>
  Returns the XML response as serialized PHP data
  
  Returns the XML response as serialized PHP data

<comment>Return:</comment>
  <info>string</info>  Returns the XML response as serialized PHP data


id: SolrResponse::getHttpStatus
type: function
doc:
<comment>Description:</comment>
  Returns the HTTP status of the response
  
  Returns the HTTP status of the response.

<comment>Return:</comment>
  <info>int</info>  Returns the HTTP status of the response.


id: SolrResponse::getHttpStatusMessage
type: function
doc:
<comment>Description:</comment>
  Returns more details on the HTTP status
  
  Returns more details on the HTTP status.

<comment>Return:</comment>
  <info>string</info>  Returns more details on the HTTP status


id: SolrResponse::getRawRequest
type: function
doc:
<comment>Description:</comment>
  Returns the raw request sent to the Solr server
  
  Returns the raw request sent to the Solr server.

<comment>Return:</comment>
  <info>string</info>  Returns the raw request sent to the Solr server


id: SolrResponse::getRawRequestHeaders
type: function
doc:
<comment>Description:</comment>
  Returns the raw request headers sent to the Solr server
  
  Returns the raw request headers sent to the Solr server.

<comment>Return:</comment>
  <info>string</info>  Returns the raw request headers sent to the Solr server


id: SolrResponse::getRawResponse
type: function
doc:
<comment>Description:</comment>
  Returns the raw response from the server
  
  Returns the raw response from the server.

<comment>Return:</comment>
  <info>string</info>  Returns the raw response from the server.


id: SolrResponse::getRawResponseHeaders
type: function
doc:
<comment>Description:</comment>
  Returns the raw response headers from the server
  
  Returns the raw response headers from the server.

<comment>Return:</comment>
  <info>string</info>  Returns the raw response headers from the server.


id: SolrResponse::getRequestUrl
type: function
doc:
<comment>Description:</comment>
  Returns the full URL the request was sent to
  
  Returns the full URL the request was sent to.

<comment>Return:</comment>
  <info>string</info>  Returns the full URL the request was sent to


id: SolrResponse::getResponse
type: function
doc:
<comment>Description:</comment>
  Returns a SolrObject representing the XML response from the server
  
  Returns a SolrObject representing the XML response from the server.

<comment>Return:</comment>
  <info>SolrObject</info>  Returns a SolrObject representing the XML response from the server


id: SolrResponse::setParseMode
type: function
doc:
<comment>Description:</comment>
  Sets the parse mode
  
  Sets the parse mode.

<comment>Param:</comment>
  <info>int</info>  <strong>$parser_mode</strong>  SolrResponse::PARSE_SOLR_DOC parses documents in SolrDocument instances.
                     SolrResponse::PARSE_SOLR_OBJ parses document into SolrObjects.

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


id: SolrResponse::success
type: function
doc:
<comment>Description:</comment>
  Was the request a success
  
  Used to check if the request to the server was successful.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if it was successful and <info>false</info> if it was not.


id: SolrServerException
type: class
doc:
<comment>Description:</comment>
  Eine Ausnahme, die ausgelöst wird, wenn ein vom Solr-Server selbst verursachter Fehler vorliegt.


id: SolrUtils
type: class
doc:
<comment>Description:</comment>
  Enthält Hilfsmethoden zum Abrufen der aktuellen Erweiterungsversion und zur Vorbereitung von
  Abfragephrasen.
  
  Enthält auch Methoden für das Maskieren von Abfragezeichenfolgen und das Parsen von XML-Antworten.


id: SolrUtils::digestXmlResponse
type: function
doc:
<comment>Description:</comment>
  Parses an response XML string into a SolrObject
  
  This method parses an response XML string from the Apache Solr server into a SolrObject. It throws
  a SolrException if there was an error.

<comment>Param:</comment>
  <info>string</info>  <strong>$xmlresponse</strong>  The XML response string from the Solr server.
  <info>int</info>     <strong>$parse_mode</strong>   Use SolrResponse::PARSE_SOLR_OBJ or SolrResponse::PARSE_SOLR_DOC

<comment>Return:</comment>
  <info>SolrObject</info>  Returns the SolrObject representing the XML response.
              
              If the parse_mode parameter is set to SolrResponse::PARSE_SOLR_OBJ Solr documents will
              be parses as SolrObject instances.
              
              If it is set to SolrResponse::PARSE_SOLR_DOC, they will be parsed as SolrDocument
              instances.


id: SolrUtils::escapeQueryChars
type: function
doc:
<comment>Description:</comment>
  Escapes a lucene query string
  
  Lucene supports escaping special characters that are part of the query syntax.
  
  The current list special characters are:
  
  

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>  This is the query string to be escaped.

<comment>Return:</comment>
  <info>string|false</info>  Returns the escaped stringBei einem Fehler wird <info>false</info> zurückgegeben..


id: SolrUtils::getSolrVersion
type: function
doc:
<comment>Description:</comment>
  Returns the current version of the Solr extension
  
  Returns the current Solr version.

<comment>Return:</comment>
  <info>string</info>  The current version of the Apache Solr extension.


id: SolrUtils::queryPhrase
type: function
doc:
<comment>Description:</comment>
  Prepares a phrase from an unescaped lucene string
  
  Prepares a phrase from an unescaped lucene string.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>  The lucene phrase.

<comment>Return:</comment>
  <info>string</info>  Returns the phrase contained in double quotes.


id: SplDoublyLinkedList
type: class
doc:
<comment>Description:</comment>
  The SplDoublyLinkedList class provides the main functionalities of a doubly linked list.


id: SplDoublyLinkedList::IT_MODE_FIFO
type: constant
doc:
<comment>Description:</comment>
  The list will be iterated in a first in, first out order, like a queue.


id: SplDoublyLinkedList::IT_MODE_LIFO
type: constant
doc:
<comment>Description:</comment>
  The list will be iterated in a last in, first out order, like a stack.


id: SplDoublyLinkedList::add
type: function
doc:
<comment>Description:</comment>
  Add/insert a new value at the specified index
  
  Insert the value <strong>$value</strong> at the specified <strong>$index</strong>, shuffling the previous value at that index (and
  all subsequent values) up through the list.

<comment>Param:</comment>
  <info>int</info>    <strong>$index</strong>  The index where the new value is to be inserted.
  <info>mixed</info>  <strong>$value</strong>  The new value for the <strong>$index</strong>.

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


id: SplDoublyLinkedList::bottom
type: function
doc:
<comment>Description:</comment>
  Peeks at the node from the beginning of the doubly linked list

<comment>Return:</comment>
  <info>mixed</info>  The value of the first node.


id: SplDoublyLinkedList::count
type: function
doc:
<comment>Description:</comment>
  Counts the number of elements in the doubly linked list

<comment>Return:</comment>
  <info>int</info>  Returns the number of elements in the doubly linked list.


id: SplDoublyLinkedList::current
type: function
doc:
<comment>Description:</comment>
  Return current array entry
  
  Get the current doubly linked list node.

<comment>Return:</comment>
  <info>mixed</info>  The current node value.


id: SplDoublyLinkedList::getIteratorMode
type: function
doc:
<comment>Description:</comment>
  Returns the mode of iteration

<comment>Return:</comment>
  <info>int</info>  Returns the different modes and flags that affect the iteration.


id: SplDoublyLinkedList::isEmpty
type: function
doc:
<comment>Description:</comment>
  Checks whether the doubly linked list is empty

<comment>Return:</comment>
  <info>bool</info>  Returns whether the doubly linked list is empty.


id: SplDoublyLinkedList::key
type: function
doc:
<comment>Description:</comment>
  Return current node index
  
  This function returns the current node index

<comment>Return:</comment>
  <info>int</info>  The current node index.


id: SplDoublyLinkedList::next
type: function
doc:
<comment>Description:</comment>
  Move to next entry
  
  Move the iterator to the next node.

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


id: SplDoublyLinkedList::offsetExists
type: function
doc:
<comment>Description:</comment>
  Returns whether the requested $index exists

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index being checked.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the requested <strong>$index</strong> exists, otherwise <info>false</info>


id: SplDoublyLinkedList::offsetGet
type: function
doc:
<comment>Description:</comment>
  Returns the value at the specified $index

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index with the value.

<comment>Return:</comment>
  <info>mixed</info>  The value at the specified <strong>$index</strong>.


id: SplDoublyLinkedList::offsetSet
type: function
doc:
<comment>Description:</comment>
  Sets the value at the specified $index to $value
  
  Sets the value at the specified <strong>$index</strong> to <strong>$value</strong>.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$index</strong>  The index being set. If <info>null</info>, the next value will be added after the last item.
  <info>mixed</info>     <strong>$value</strong>  The new value for the <strong>$index</strong>.

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


id: SplDoublyLinkedList::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Unsets the value at the specified $index
  
  Unsets the value at the specified index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index being unset.

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


id: SplDoublyLinkedList::pop
type: function
doc:
<comment>Description:</comment>
  Pops a node from the end of the doubly linked list

<comment>Return:</comment>
  <info>mixed</info>  The value of the popped node.


id: SplDoublyLinkedList::prev
type: function
doc:
<comment>Description:</comment>
  Move to previous entry
  
  Move the iterator to the previous node.

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


id: SplDoublyLinkedList::push
type: function
doc:
<comment>Description:</comment>
  Pushes an element at the end of the doubly linked list
  
  Pushes <strong>$value</strong> at the end of the doubly linked list.

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

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


id: SplDoublyLinkedList::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind iterator back to the start
  
  This rewinds the iterator to the beginning.

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


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

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

<comment>See Also:</comment>
   * SplDoublyLinkedList::unserialize


id: SplDoublyLinkedList::setIteratorMode
type: function
doc:
<comment>Description:</comment>
  Sets the mode of iteration

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  There are two orthogonal sets of modes that can be set:
              
              The direction of the iteration (either one or the other):
              
              <info>SplDoublyLinkedList::IT_MODE_LIFO</info> (Stack style)
              
              <info>SplDoublyLinkedList::IT_MODE_FIFO</info> (Queue style)
              
              The behavior of the iterator (either one or the other):
              
              <info>SplDoublyLinkedList::IT_MODE_DELETE</info> (Elements are deleted by the iterator)
              
              <info>SplDoublyLinkedList::IT_MODE_KEEP</info> (Elements are traversed by the iterator)
              
              The default mode is: <info>SplDoublyLinkedList::IT_MODE_FIFO</info> |
              <info>SplDoublyLinkedList::IT_MODE_KEEP</info>
              
              The direction of iteration can not be changed for <class>SplStack</class> and <class>SplQueue</class> classes, it is
              always <info>SplDoublyLinkedList::IT_MODE_FIFO</info>. Trying to modify it will result in a
              <class>RuntimeException</class> being thrown.

<comment>Return:</comment>
  <info>int</info>  Returns the different modes and flags that affect the iteration.


id: SplDoublyLinkedList::shift
type: function
doc:
<comment>Description:</comment>
  Shifts a node from the beginning of the doubly linked list

<comment>Return:</comment>
  <info>mixed</info>  The value of the shifted node.


id: SplDoublyLinkedList::top
type: function
doc:
<comment>Description:</comment>
  Peeks at the node from the end of the doubly linked list

<comment>Return:</comment>
  <info>mixed</info>  The value of the last node.


id: SplDoublyLinkedList::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserializes the storage
  
  Unserializes the storage, from SplDoublyLinkedList::serialize.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

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

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

<comment>See Also:</comment>
   * SplDoublyLinkedList::serialize


id: SplDoublyLinkedList::unshift
type: function
doc:
<comment>Description:</comment>
  Prepends the doubly linked list with an element
  
  Prepends <strong>$value</strong> at the beginning of the doubly linked list.

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

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


id: SplDoublyLinkedList::valid
type: function
doc:
<comment>Description:</comment>
  Check whether the doubly linked list contains more nodes
  
  Checks if the doubly linked list contains any more nodes.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the doubly linked list contains any more nodes, <info>false</info> otherwise.


id: SplFileInfo
type: class
doc:
<comment>Description:</comment>
  The SplFileInfo class offers a high-level object-oriented interface to information for an
  individual file.


id: SplFileInfo::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new SplFileInfo object
  
  Creates a new SplFileInfo object for the file_name specified. The file does not need to exist, or
  be readable.

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


id: SplFileInfo::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the path to the file as a string
  
  This method will return the file name of the referenced file.

<comment>Return:</comment>
  <info>string</info>  Returns the path to the file.


id: SplFileInfo::getATime
type: function
doc:
<comment>Description:</comment>
  Gets last access time of the file
  
  Gets the last access time for the file.

<comment>Return:</comment>
  <info>int|false</info>  Returns the time the file was last accessed on success, or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>fileatime()</strong>
   * SplFileInfo::getCTime
   * SplFileInfo::getMTime


id: SplFileInfo::getBasename
type: function
doc:
<comment>Description:</comment>
  Gets the base name of the file
  
  This method returns the base name of the file, directory, or link without path info.
  
  <strong>SplFileInfo::getBasename()</strong> is locale aware, so for it to see the  correct basename with multibyte
  character paths, the matching locale must  be set using the <strong>setlocale()</strong> function.

<comment>Param:</comment>
  <info>string</info>  <strong>$suffix</strong>  Optional suffix to omit from the base name returned.

<comment>Return:</comment>
  <info>string</info>  Returns the base name without path information.

<comment>See Also:</comment>
   * SplFileInfo::getFilename


id: SplFileInfo::getCTime
type: function
doc:
<comment>Description:</comment>
  Gets the inode change time
  
  Returns the inode change time for the file. The time returned is a Unix timestamp.

<comment>Return:</comment>
  <info>int|false</info>  The last change time, in a Unix timestamp on success, or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>filectime()</strong>
   * SplFileInfo::getATime
   * SplFileInfo::getMTime


id: SplFileInfo::getExtension
type: function
doc:
<comment>Description:</comment>
  Gets the file extension
  
  Retrieves the file extension.

<comment>Return:</comment>
  <info>string</info>  Returns a <info>string</info> containing the file extension, or an empty <info>string</info> if the file has no
          extension.

<comment>See Also:</comment>
   * SplFileInfo::getFilename
   * SplFileInfo::getBasename
   * <strong>pathinfo()</strong>


id: SplFileInfo::getFileInfo
type: function
doc:
<comment>Description:</comment>
  Gets an SplFileInfo object for the file
  
  This method gets an <class>SplFileInfo</class> object for the referenced file.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$class</strong>  Name of an <class>SplFileInfo</class> derived class to use.

<comment>Return:</comment>
  <info>SplFileInfo</info>  An <class>SplFileInfo</class> object created for the file.

<comment>See Also:</comment>
   * SplFileInfo::setInfoClass


id: SplFileInfo::getFilename
type: function
doc:
<comment>Description:</comment>
  Gets the filename
  
  Gets the filename without any path information.

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

<comment>See Also:</comment>
   * SplFileInfo::getBasename


id: SplFileInfo::getGroup
type: function
doc:
<comment>Description:</comment>
  Gets the file group
  
  Gets the file group. The group ID is returned in numerical format.

<comment>Return:</comment>
  <info>int|false</info>  The group id in numerical format on success, or <info>false</info> on failure.

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


id: SplFileInfo::getInode
type: function
doc:
<comment>Description:</comment>
  Gets the inode for the file
  
  Gets the inode number for the filesystem object.

<comment>Return:</comment>
  <info>int|false</info>  Returns the inode number for the filesystem object on success, or <info>false</info> on failure.

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


id: SplFileInfo::getLinkTarget
type: function
doc:
<comment>Description:</comment>
  Gets the target of a link
  
  Gets the target of a filesystem link.
  
  The target may not be the real path on the filesystem. Use SplFileInfo::getRealPath to determine
  the true path on the filesystem.

<comment>Return:</comment>
  <info>string|false</info>  Returns the target of the filesystem link on success, or <info>false</info> on failure.

<comment>See Also:</comment>
   * SplFileInfo::isLink
   * SplFileInfo::getRealPath


id: SplFileInfo::getMTime
type: function
doc:
<comment>Description:</comment>
  Gets the last modified time
  
  Returns the time when the contents of the file were changed. The time returned is a Unix
  timestamp.

<comment>Return:</comment>
  <info>int|false</info>  Returns the last modified time for the file, in a Unix timestamp on success, or <info>false</info>
             on failure.

<comment>See Also:</comment>
   * <strong>filemtime()</strong>
   * SplFileInfo::getATime
   * SplFileInfo::getCTime


id: SplFileInfo::getOwner
type: function
doc:
<comment>Description:</comment>
  Gets the owner of the file
  
  Gets the file owner. The owner ID is returned in numerical format.

<comment>Return:</comment>
  <info>int|false</info>  The owner id in numerical format on success, or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>posix_getpwuid()</strong>
   * SplFileInfo::getGroup


id: SplFileInfo::getPath
type: function
doc:
<comment>Description:</comment>
  Gets the path without filename
  
  Returns the path to the file, omitting the filename and any trailing slash.

<comment>Return:</comment>
  <info>string</info>  Returns the path to the file.

<comment>See Also:</comment>
   * SplFileInfo::getRealPath
   * SplFileInfo::getFilename
   * SplFileInfo::getPathInfo


id: SplFileInfo::getPathInfo
type: function
doc:
<comment>Description:</comment>
  Gets an SplFileInfo object for the path
  
  Gets an <class>SplFileInfo</class> object for the parent of the current file.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$class</strong>  Name of an <class>SplFileInfo</class> derived class to use, or itself if <info>null</info>.

<comment>Return:</comment>
  <info>SplFileInfo|null</info>  Returns an <class>SplFileInfo</class> object for the parent path of the file on success, or
                    <info>null</info> on failure.

<comment>See Also:</comment>
   * SplFileInfo::setInfoClass


id: SplFileInfo::getPathname
type: function
doc:
<comment>Description:</comment>
  Gets the path to the file
  
  Returns the path to the file.

<comment>Return:</comment>
  <info>string</info>  The path to the file.

<comment>See Also:</comment>
   * SplFileInfo::getRealPath


id: SplFileInfo::getPerms
type: function
doc:
<comment>Description:</comment>
  Gets file permissions
  
  Gets the file permissions for the file.

<comment>Return:</comment>
  <info>int|false</info>  Returns the file permissions on success, or <info>false</info> on failure.


id: SplFileInfo::getRealPath
type: function
doc:
<comment>Description:</comment>
  Gets absolute path to file
  
  This method expands all symbolic links, resolves relative references and returns the real path to
  the file.

<comment>Return:</comment>
  <info>string|false</info>  Returns the path to the file, or <info>false</info> if the file does not exist.

<comment>See Also:</comment>
   * SplFileInfo::isLink
   * realpath


id: SplFileInfo::getSize
type: function
doc:
<comment>Description:</comment>
  Gets file size
  
  Returns the filesize in bytes for the file referenced.

<comment>Return:</comment>
  <info>int|false</info>  The filesize in bytes on success, or <info>false</info> on failure.

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


id: SplFileInfo::getType
type: function
doc:
<comment>Description:</comment>
  Gets file type
  
  Returns the type of the file referenced.

<comment>Return:</comment>
  <info>string|false</info>  A <info>string</info> representing the type of the entry. May be one of <return>file</return>, <return>link</return>, <return>dir</return>, <return>block</return>,
                <return>fifo</return>, <return>char</return>, <return>socket</return>, or <return>unknown</return>, or <info>false</info> on failure.


id: SplFileInfo::isDir
type: function
doc:
<comment>Description:</comment>
  Tells if the file is a directory
  
  This method can be used to determine if the file is a directory.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if a directory, <info>false</info> otherwise.


id: SplFileInfo::isExecutable
type: function
doc:
<comment>Description:</comment>
  Tells if the file is executable
  
  Checks if the file is executable.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if executable, <info>false</info> otherwise.


id: SplFileInfo::isFile
type: function
doc:
<comment>Description:</comment>
  Tells if the object references a regular file
  
  Checks if the file referenced by this SplFileInfo object exists and is a regular file.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the file exists and is a regular file (not a link), <info>false</info> otherwise.


id: SplFileInfo::isLink
type: function
doc:
<comment>Description:</comment>
  Tells if the file is a link
  
  Use this method to check if the file referenced by the SplFileInfo object is a link.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the file is a link, <info>false</info> otherwise.

<comment>See Also:</comment>
   * SplFileInfo::getRealPath


id: SplFileInfo::isReadable
type: function
doc:
<comment>Description:</comment>
  Tells if file is readable
  
  Check if the file is readable.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if readable, <info>false</info> otherwise.


id: SplFileInfo::isWritable
type: function
doc:
<comment>Description:</comment>
  Tells if the entry is writable
  
  Checks if the current entry is writable.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if writable, <info>false</info> otherwise;


id: SplFileInfo::openFile
type: function
doc:
<comment>Description:</comment>
  Gets an SplFileObject object for the file
  
  Creates an <class>SplFileObject</class> <info>object</info> of the file. This is useful because <class>SplFileObject</class> contains
  additional methods for manipulating the file whereas <class>SplFileInfo</class> is only useful for gaining
  information, like whether the file is writable.

<comment>Param:</comment>
  <info>string</info>         <strong>$mode</strong>            The mode for opening the file. See the <strong>fopen()</strong> documentation for
                                  descriptions of possible modes. The default  is read only.
  <info>bool</info>           <strong>$useIncludePath</strong>  Wenn dieser Parameter auf <info>true</info> gesetzt ist
                                  wird auch im include_path nach dem
                                  Dateinamen gesucht.
  <info>resource|null</info>  <strong>$context</strong>         Eine Beschreibung von <return>contexts</return>
                                  finden Sie im Abschnitt Kontextoptionen und -parameter
                                  dieses Handbuchs.

<comment>Return:</comment>
  <info>SplFileObject</info>  The opened file as an <class>SplFileObject</class> <info>object</info>.

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


id: SplFileInfo::setFileClass
type: function
doc:
<comment>Description:</comment>
  Sets the class used with SplFileInfo::openFile
  
  Use this method to set a custom class which will be used when SplFileInfo::openFile is called. The
  class name passed to this method must be <class>SplFileObject</class> or a class derived from <class>SplFileObject</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  The class name to use when SplFileInfo::openFile is called.

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

<comment>See Also:</comment>
   * SplFileInfo::openFile


id: SplFileInfo::setInfoClass
type: function
doc:
<comment>Description:</comment>
  Sets the class used with SplFileInfo::getFileInfo and SplFileInfo::getPathInfo
  
  Use this method to set a custom class which will be used when SplFileInfo::getFileInfo and
  SplFileInfo::getPathInfo are called. The class name passed to this method must be <class>SplFileInfo</class> or a
  class derived from <class>SplFileInfo</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  The class name to use when SplFileInfo::getFileInfo and SplFileInfo::getPathInfo
                  are called.

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

<comment>See Also:</comment>
   * SplFileInfo::getFileInfo


id: SplFileObject
type: class
doc:
<comment>Description:</comment>
  The SplFileObject class offers an object-oriented interface for a file.


id: SplFileObject::SKIP_EMPTY
type: constant
doc:
<comment>Description:</comment>
  Skips empty lines in the file. This requires the <info>READ_AHEAD</info> flag be enabled, to work as expected.


id: SplFileObject::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new file object
  
  Construct a new file object.

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>        The file to read.
                                  
                                  Wenn
                                  fopen wrappers aktiviert ist, kann
                                  mit dieser Funktion eine URL als Dateiname verwendet werden. Mehr
                                  Details dazu,
                                  wie der Dateiname angeben werden muss, sind bei <strong>fopen()</strong> zu
                                  finden. Eine Liste der unterstützten URL-Protokolle, die
                                  Fähigkeiten der
                                  verschiedenen Wrapper, Hinweise zu deren Verwendung und
                                  Informationen zu den
                                  eventuell vorhandenen vordefinierten Variablen sind unter
                                   zu finden.
  <info>string</info>         <strong>$mode</strong>            The mode in which to open the file. See <strong>fopen()</strong> for a list of
                                  allowed modes.
  <info>bool</info>           <strong>$useIncludePath</strong>  Whether to search in the include_path for <strong>$filename</strong>.
  <info>resource|null</info>  <strong>$context</strong>         A valid context resource created with <strong>stream_context_create()</strong>.

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


id: SplFileObject::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the current line as a string
  
  This method will return the current line as a string.

<comment>Return:</comment>
  <info>string</info>  Returns the current line as a string.


id: SplFileObject::current
type: function
doc:
<comment>Description:</comment>
  Retrieve current line of file
  
  Retrieves the current line of the file.

<comment>Return:</comment>
  <info>string|array|false</info>  Retrieves the current line of the file. If the <info>SplFileObject::READ_CSV</info> flag is
                      set, this method returns an array containing the current line parsed as CSV
                      data. If the end of the file is reached, <info>false</info> is returned.

<comment>See Also:</comment>
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::eof
type: function
doc:
<comment>Description:</comment>
  Reached end of file
  
  Determine whether the end of file has been reached

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if file is at EOF, <info>false</info> otherwise.

<comment>See Also:</comment>
   * SplFileObject::valid
   * <strong>feof()</strong>


id: SplFileObject::fflush
type: function
doc:
<comment>Description:</comment>
  Flushes the output to the file
  
  Forces a write of all buffered output to the file.

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

<comment>See Also:</comment>
   * SplFileObject::fwrite


id: SplFileObject::fgetc
type: function
doc:
<comment>Description:</comment>
  Gets character from file
  
  Gets a character from the file.

<comment>Return:</comment>
  <info>string|false</info>  Returns a string containing a single character read from the file or <info>false</info> on EOF.
                
                Diese Funktion kann sowohl das
                boolsche <info>false</info> zurückliefern, als auch einen nicht-boolschen Wert, welcher zu <info>false</info>
                ausgewertet wird.
                Weitere Informationen entnehmen Sie bitte dem Abschnitt über die
                 boolschen Typen. Benutzen Sie deshalb
                den === Operator,
                um den Rückgabewert dieser Funktion zu überprüfen.

<comment>See Also:</comment>
   * SplFileObject::fgets


id: SplFileObject::fgetcsv
type: function
doc:
<comment>Description:</comment>
  Gets line from file and parse as CSV fields
  
  Gets a line from the file which is in CSV format and returns an array containing the fields read.
  
  The locale settings are taken into account by this function. If <return>LC_CTYPE</return> is e.g. <return>en_US.UTF-8</return>,
  files in one-byte encodings may be read wrongly by this function.

<comment>Param:</comment>
  <info>string</info>  <strong>$separator</strong>  The field delimiter (one single-byte character only). Defaults as a comma or
                      the value set using SplFileObject::setCsvControl.
  <info>string</info>  <strong>$enclosure</strong>  The field enclosure character (one single-byte character only). Defaults as a
                      double quotation mark or the value set using SplFileObject::setCsvControl.
  <info>string</info>  <strong>$escape</strong>     The escape character (at most one single-byte character). Defaults as a
                      backslash (<return>\</return>) or the value set using SplFileObject::setCsvControl. An empty
                      string (<return>""</return>) disables the proprietary escape mechanism.
                      
                      Usually an <strong>$enclosure</strong> character is escaped inside a field by doubling it;
                      however, the <strong>$escape</strong> character can be used as an alternative. So for the
                      default parameter values <return>""</return> and <return>\"</return> have the same meaning. Other than allowing
                      to escape the <strong>$enclosure</strong> character the <strong>$escape</strong> character has no special
                      meaning; it isn't even meant to escape itself.

<comment>Return:</comment>
  <info>array|false</info>  Returns an indexed array containing the fields read, or <info>false</info> on error.
               
               A blank line in a CSV file will be returned as an array comprising a single <info>null</info>
               field unless using <info>SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE</info>,  in
               which case empty lines are skipped.

<comment>See Also:</comment>
   * SplFileObject::setCsvControl
   * SplFileObject::setFlags
   * SplFileObject::READ_CSV
   * SplFileObject::current


id: SplFileObject::fgets
type: function
doc:
<comment>Description:</comment>
  Gets line from file
  
  Gets a line from the file.

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the next line from the file.

<comment>See Also:</comment>
   * <strong>fgets()</strong>
   * SplFileObject::fgetss
   * SplFileObject::fgetc
   * SplFileObject::current


id: SplFileObject::fgetss
type: function
doc:
<comment>Description:</comment>
  Gets line from file and strip HTML tags
  
  Identical to SplFileObject::fgets, except that SplFileObject::fgetss attempts to strip any HTML
  and PHP tags from the text it reads. The function retains the parsing state from call to call, and
  as such is not equivalent to calling <strong>strip_tags()</strong> on the return value of SplFileObject::fgets.

<comment>Param:</comment>
  <info>string</info>  <strong>$allowable_tags</strong>  Optional parameter to specify tags which should not be stripped.

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the next line of the file with HTML and PHP code stripped, or
          <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fgetss()</strong>
   * SplFileObject::fgets
   * SplFileObject::fgetc
   * SplFileObject::current
   * The string.strip_tags filter


id: SplFileObject::flock
type: function
doc:
<comment>Description:</comment>
  Portable file locking
  
  Locks or unlocks the file in the same portable way as <strong>flock()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$operation</strong>   <strong>$operation</strong> is one of the following: <info>LOCK_SH</info> to acquire a shared lock (reader).
                    <info>LOCK_EX</info> to acquire an exclusive lock (writer). <info>LOCK_UN</info> to release a lock (shared
                    or exclusive).
                    
                    <info>LOCK_SH</info> to acquire a shared lock (reader).
                    
                    <info>LOCK_EX</info> to acquire an exclusive lock (writer).
                    
                    <info>LOCK_UN</info> to release a lock (shared or exclusive).
                    
                    It is also possible to add <info>LOCK_NB</info> as a bitmask to one  of the above operations,
                    if <strong>flock()</strong> should not block during the locking attempt.
  <info>int</info>  <strong>$wouldBlock</strong>  Set to <info>true</info> if the lock would block (EWOULDBLOCK errno condition).

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


id: SplFileObject::fpassthru
type: function
doc:
<comment>Description:</comment>
  Output all remaining data on a file pointer
  
  Reads to EOF on the given file pointer from the current position and writes the results to the
  output buffer.
  
  You may need to call SplFileObject::rewind to reset the file pointer to the beginning of the file
  if you have already written data to the file.

<comment>Return:</comment>
  <info>int</info>  Returns the number of characters read from <strong>$handle</strong> and passed through to the output.

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


id: SplFileObject::fputcsv
type: function
doc:
<comment>Description:</comment>
  Write a field array as a CSV line
  
  Writes the <strong>$fields</strong> array to the file as a CSV line.

<comment>Param:</comment>
  <info>array</info>   <strong>$fields</strong>     An array of values.
  <info>string</info>  <strong>$separator</strong>  The optional <strong>$separator</strong> parameter sets the field delimiter (one single-byte
                      character only).
  <info>string</info>  <strong>$enclosure</strong>  The optional <strong>$enclosure</strong> parameter sets the field enclosure (one single-byte
                      character only).
  <info>string</info>  <strong>$escape</strong>     The optional <strong>$escape</strong> parameter sets the escape character (at most one
                      single-byte character). An empty string (<return>""</return>) disables the proprietary escape
                      mechanism.
  <info>string</info>  <strong>$eol</strong>        The optional <strong>$eol</strong> parameter sets a custom End of Line sequence.

<comment>Return:</comment>
  <info>int|false</info>  Returns the length of the written stringBei einem Fehler wird <info>false</info> zurückgegeben..
             
             Returns <info>false</info>, and does not write the CSV line to the file, if the <strong>$separator</strong> or
             <strong>$enclosure</strong> parameter is not a single character.

<comment>See Also:</comment>
   * <strong>fputcsv()</strong>
   * SplFileObject::fgetcsv


id: SplFileObject::fread
type: function
doc:
<comment>Description:</comment>
  Read from file
  
  Reads the given number of bytes from the file.

<comment>Param:</comment>
  <info>int</info>  <strong>$length</strong>  The number of bytes to read.

<comment>Return:</comment>
  <info>string|false</info>  Returns the string read from the file Bei einem Fehler wird <info>false</info> zurückgegeben..

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


id: SplFileObject::fscanf
type: function
doc:
<comment>Description:</comment>
  Parses input from file according to a format
  
  Reads a line from the file and interprets it according to the specified <strong>$format</strong>.
  
  Any whitespace in the <strong>$format</strong> string matches any whitespace in the line from the file. This means
  that even a tab (<return>\t</return>) in the format string can match a single space character in the input stream.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  Das interpretierte Format für <strong>$string</strong>, wie es in der Dokumentation zu <strong>sprintf()</strong>
                   beschrieben ist, mit den folgenden Unterschieden:  Die Funktion beachtet die
                   Locale nicht. <return>F</return>, <return>g</return>, <return>G</return> und <return>b</return> werden nicht unterstützt. <return>D</return> steht für eine
                   Dezimalzahl. <return>i</return> steht für eine Ganzzahl mit Angabe der Basis. <return>n</return> steht für die
                   Anzahl der bisher verarbeiteten Zeichen. <return>s</return> beendet das Lesen beim ersten
                   Whitespace-Zeichen. <return>*</return> anstelle von <return>argnum$</return> unterdrückt die Zuweisung dieser
                   Umwandlungsspezifikation.
  <info>mixed</info>   <strong>$vars</strong>    The optional assigned values.

<comment>Return:</comment>
  <info>array|int|null</info>  If only one parameter is passed to this method, the values parsed will be returned
                  as an array. Otherwise, if optional parameters are passed, the function will
                  return the number of assigned values. The optional parameters must be passed by
                  reference.

<comment>See Also:</comment>
   * <strong>fscanf()</strong>
   * <strong>sscanf()</strong>
   * <strong>printf()</strong>
   * <strong>sprintf()</strong>


id: SplFileObject::fseek
type: function
doc:
<comment>Description:</comment>
  Seek to a position
  
  Seek to a position in the file measured in bytes from the beginning of the file, obtained by
  adding <strong>$offset</strong> to the position specified by <strong>$whence</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  The offset. A negative value can be used to move backwards through the file which is
                useful when SEEK_END is used as the <strong>$whence</strong> value.
  <info>int</info>  <strong>$whence</strong>  <strong>$whence</strong> values are: <info>SEEK_SET</info> - Set position equal to <strong>$offset</strong> bytes.<info>SEEK_CUR</info> - Set
                position to current location plus <strong>$offset</strong>.<info>SEEK_END</info> - Set position to end-of-file
                plus <strong>$offset</strong>.
                
                If <strong>$whence</strong> is not specified, it is assumed to be <info>SEEK_SET</info>.

<comment>Return:</comment>
  <info>int</info>  Returns 0 if the seek was successful, -1 otherwise. Note that seeking past EOF is not
       considered an error.

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


id: SplFileObject::fstat
type: function
doc:
<comment>Description:</comment>
  Gets information about the file
  
  Gathers the statistics of the file. Behaves identically to <strong>fstat()</strong>.

<comment>Return:</comment>
  <info>array</info>  Returns an array with the statistics of the file; the format of the array is described in
         detail on the <strong>stat()</strong> manual page.

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


id: SplFileObject::ftell
type: function
doc:
<comment>Description:</comment>
  Return current file position
  
  Returns the position of the file pointer which represents the current offset in the file stream.

<comment>Return:</comment>
  <info>int|false</info>  Returns the position of the file pointer as an integer, or <info>false</info> on error.

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


id: SplFileObject::ftruncate
type: function
doc:
<comment>Description:</comment>
  Truncates the file to a given length
  
  Truncates the file to <strong>$size</strong> bytes.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  The size to truncate to.
              
              If <strong>$size</strong> is larger than the file it is extended with null bytes.
              
              If <strong>$size</strong> is smaller than the file, the extra data will be lost.

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


id: SplFileObject::fwrite
type: function
doc:
<comment>Description:</comment>
  Write to file
  
  Writes the contents of <strong>$string</strong> to the file

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>    The string to be written to the file.
  <info>int</info>     <strong>$length</strong>  If the <strong>$length</strong> argument is given, writing will stop after <strong>$length</strong> bytes have been
                   written or the end of <strong>$string</strong> is reached, whichever comes first.

<comment>Return:</comment>
  <info>int|false</info>  Returns the number of bytes written, or <info>false</info> on error.

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


id: SplFileObject::getChildren
type: function
doc:
<comment>Description:</comment>
  No purpose
  
  An <class>SplFileObject</class> does not have children so this method returns <info>null</info>.

<comment>Return:</comment>
  <info>null</info>  Returns <info>null</info>.

<comment>See Also:</comment>
   * RecursiveIterator::getChildren


id: SplFileObject::getCsvControl
type: function
doc:
<comment>Description:</comment>
  Get the delimiter, enclosure and escape character for CSV
  
  Gets the delimiter, enclosure and escape character used for parsing CSV fields.

<comment>Return:</comment>
  <info>array</info>  Returns an indexed array containing the delimiter, enclosure and escape character.

<comment>See Also:</comment>
   * SplFileObject::setCsvControl
   * SplFileObject::fgetcsv


id: SplFileObject::getCurrentLine
type: function
doc:
<comment>Description:</comment>
  Alias von SplFileObject::fgets
  
  Diese Methode ist ein Alias für:  SplFileObject::fgets.


id: SplFileObject::getFlags
type: function
doc:
<comment>Description:</comment>
  Gets flags for the SplFileObject
  
  Gets the flags set for an instance of SplFileObject as an <info>int</info>.

<comment>Return:</comment>
  <info>int</info>  Returns an <info>int</info> representing the flags.

<comment>See Also:</comment>
   * SplFileObject::setFlags


id: SplFileObject::getMaxLineLen
type: function
doc:
<comment>Description:</comment>
  Get maximum line length
  
  Gets the maximum line length as set by SplFileObject::setMaxLineLen.

<comment>Return:</comment>
  <info>int</info>  Returns the maximum line length if one has been set with SplFileObject::setMaxLineLen,
       default is <return>0</return>.

<comment>See Also:</comment>
   * SplFileObject::setMaxLineLen


id: SplFileObject::hasChildren
type: function
doc:
<comment>Description:</comment>
  SplFileObject does not have children
  
  An <class>SplFileObject</class> does not have children so this method always return <info>false</info>.

<comment>Return:</comment>
  <info>false</info>  Returns <info>false</info>

<comment>See Also:</comment>
   * RecursiveIterator::hasChildren


id: SplFileObject::key
type: function
doc:
<comment>Description:</comment>
  Get line number
  
  Gets the current line number.
  
  This number may not reflect the actual line number in the file  if SplFileObject::setMaxLineLen is
  used to  read fixed lengths of the file.

<comment>Return:</comment>
  <info>int</info>  Returns the current line number.

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::next
type: function
doc:
<comment>Description:</comment>
  Read next line
  
  Moves ahead to the next line in the file.

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

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind the file to the first line
  
  Rewinds the file back to the first line.

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

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::valid


id: SplFileObject::seek
type: function
doc:
<comment>Description:</comment>
  Seek to specified line
  
  Seek to specified line in the file.

<comment>Param:</comment>
  <info>int</info>  <strong>$line</strong>  The zero-based line number to seek to.

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

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::setCsvControl
type: function
doc:
<comment>Description:</comment>
  Set the delimiter, enclosure and escape character for CSV
  
  Sets the delimiter, enclosure and escape character for parsing CSV fields.

<comment>Param:</comment>
  <info>string</info>  <strong>$separator</strong>  The field delimiter (one single-byte character only).
  <info>string</info>  <strong>$enclosure</strong>  The field enclosure character (one single-byte character only).
  <info>string</info>  <strong>$escape</strong>     The field escape character (at most one single-byte character). An empty
                      string (<return>""</return>) disables the proprietary escape mechanism.

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

<comment>See Also:</comment>
   * SplFileObject::getCsvControl
   * SplFileObject::fgetcsv


id: SplFileObject::setFlags
type: function
doc:
<comment>Description:</comment>
  Sets flags for the SplFileObject
  
  Sets the flags to be used by the <class>SplFileObject</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Bit mask of the flags to set. See  SplFileObject constants  for the available flags.

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

<comment>See Also:</comment>
   * SplFileObject::getFlags


id: SplFileObject::setMaxLineLen
type: function
doc:
<comment>Description:</comment>
  Set maximum line length
  
  Sets the maximum length of a line to be read.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxLength</strong>  The maximum length of a line.

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

<comment>See Also:</comment>
   * SplFileObject::getMaxLineLen


id: SplFileObject::valid
type: function
doc:
<comment>Description:</comment>
  Not at EOF
  
  Check whether EOF has been reached.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if not reached EOF, <info>false</info> otherwise.

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind


id: SplFixedArray
type: class
doc:
<comment>Description:</comment>
  The SplFixedArray class provides the main functionalities of array. The  main difference between a
  SplFixedArray and a normal PHP array is that  the SplFixedArray must be resized manually and
  allows only integers within  the range as indexes. The advantage is that it uses less memory than
  a standard <info>array</info>.


id: SplFixedArray::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new fixed array
  
  Initializes a fixed array with a number of <info>null</info> values equal to <strong>$size</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  The size of the fixed array.  This expects a number between <return>0</return> and <info>PHP_INT_MAX</info>.


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

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


id: SplFixedArray::__unserialize
type: function
doc:
<comment>Description:</comment>
  Deserializes the data parameter into an SplFixedArray object
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  The value being deserialized.

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


id: SplFixedArray::__wakeup
type: function
doc:
<comment>Description:</comment>
  Reinitialises the array after being unserialised
  
  Reinitialises the array after being unserialised.

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


id: SplFixedArray::count
type: function
doc:
<comment>Description:</comment>
  Returns the size of the array
  
  Returns the size of the array.

<comment>Return:</comment>
  <info>int</info>  Returns the size of the array.

<comment>See Also:</comment>
   * SplFixedArray::getSize


id: SplFixedArray::current
type: function
doc:
<comment>Description:</comment>
  Return current array entry
  
  Get the current array element.

<comment>Return:</comment>
  <info>mixed</info>  The current element value.


id: SplFixedArray::fromArray
type: function
doc:
<comment>Description:</comment>
  Import a PHP array in a SplFixedArray instance
  
  Import the PHP array <strong>$array</strong>  in a new <class>SplFixedArray</class> instance

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>         The array to import.
  <info>bool</info>   <strong>$preserveKeys</strong>  Try to save the numeric indexes used in the original array.

<comment>Return:</comment>
  <info>SplFixedArray</info>  Returns an instance of <class>SplFixedArray</class>  containing the array content.


id: SplFixedArray::getIterator
type: function
doc:
<comment>Description:</comment>
  Retrieve the iterator to go through the array
  
  Returns the iterator to go through the array.

<comment>Return:</comment>
  <info>Iterator</info>  An instance of an object implementing <class>Iterator</class> to go through the array.


id: SplFixedArray::getSize
type: function
doc:
<comment>Description:</comment>
  Gets the size of the array
  
  Gets the size of the array.

<comment>Return:</comment>
  <info>int</info>  Returns the size of the array, as an <info>int</info>.

<comment>See Also:</comment>
   * SplFixedArray::count


id: SplFixedArray::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON
  
  Serializes the array to a value that can be serialized natively by <strong>json_encode()</strong>.

<comment>Return:</comment>
  <info>mixed</info>  Returns array data which can be serialized by <strong>json_encode()</strong>, which is a value of any type
         other than a Ressource.


id: SplFixedArray::key
type: function
doc:
<comment>Description:</comment>
  Return current array index
  
  Returns the current array index.

<comment>Return:</comment>
  <info>int</info>  The current array index.


id: SplFixedArray::next
type: function
doc:
<comment>Description:</comment>
  Move to next entry
  
  Move the iterator to the next array entry.

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


id: SplFixedArray::offsetExists
type: function
doc:
<comment>Description:</comment>
  Returns whether the requested index exists
  
  Checks whether the requested index <strong>$index</strong>  exists.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index being checked.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the requested <strong>$index</strong> exists, otherwise <info>false</info>


id: SplFixedArray::offsetGet
type: function
doc:
<comment>Description:</comment>
  Returns the value at the specified index
  
  Returns the value at the index <strong>$index</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index with the value.

<comment>Return:</comment>
  <info>mixed</info>  The value at the specified <strong>$index</strong>.


id: SplFixedArray::offsetSet
type: function
doc:
<comment>Description:</comment>
  Sets a new value at a specified index
  
  Sets the value at the specified <strong>$index</strong> to <strong>$value</strong>.

<comment>Param:</comment>
  <info>int</info>    <strong>$index</strong>  The index being set.
  <info>mixed</info>  <strong>$value</strong>  The new value for the <strong>$index</strong>.

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


id: SplFixedArray::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind iterator back to the start
  
  Rewinds the iterator to the beginning.

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


id: SplFixedArray::setSize
type: function
doc:
<comment>Description:</comment>
  Change the size of an array
  
  Change the size of an array to the new size of <strong>$size</strong>. If  <strong>$size</strong> is less than the current array
  size, any values after the new size  will be discarded. If <strong>$size</strong> is greater than the current array
  size, the  array will be padded with <info>null</info> values.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  The new array size. This should be a value between <return>0</return> and <info>PHP_INT_MAX</info>.

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


id: SplFixedArray::toArray
type: function
doc:
<comment>Description:</comment>
  Returns a PHP array from the fixed array
  
  Returns a PHP array from the fixed array.

<comment>Return:</comment>
  <info>array</info>  Returns a PHP <info>array</info>, similar to the fixed array.


id: SplFixedArray::valid
type: function
doc:
<comment>Description:</comment>
  Check whether the array contains more elements
  
  Checks if the array contains any more elements.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the array contains any more elements, <info>false</info> otherwise.


id: SplHeap::compare
type: function
doc:
<comment>Description:</comment>
  Compare elements in order to place them correctly in the heap while sifting up
  
  Compare <strong>$value1</strong> with <strong>$value2</strong>.
  
  Throwing exceptions in SplHeap::compare can corrupt the Heap and place it in a blocked state. You
  can unblock it by calling SplHeap::recoverFromCorruption.  However, some elements might not be
  placed correctly and it may hence break the heap-property.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value1</strong>  The value of the first node being compared.
  <info>mixed</info>  <strong>$value2</strong>  The value of the second node being compared.

<comment>Return:</comment>
  <info>int</info>  Result of the comparison, positive integer if <strong>$value1</strong> is greater than <strong>$value2</strong>, 0 if they are
       equal, negative integer otherwise.
       
       Having multiple elements with the same value in a Heap is not recommended. They will end up
       in an arbitrary relative position.


id: SplHeap::count
type: function
doc:
<comment>Description:</comment>
  Counts the number of elements in the heap

<comment>Return:</comment>
  <info>int</info>  Returns the number of elements in the heap.


id: SplHeap::current
type: function
doc:
<comment>Description:</comment>
  Return current node pointed by the iterator
  
  Get the current datastructure node.

<comment>Return:</comment>
  <info>mixed</info>  The current node value.


id: SplHeap::extract
type: function
doc:
<comment>Description:</comment>
  Extracts a node from top of the heap and sift up

<comment>Return:</comment>
  <info>mixed</info>  The value of the extracted node.


id: SplHeap::insert
type: function
doc:
<comment>Description:</comment>
  Inserts an element in the heap by sifting it up
  
  Insert <strong>$value</strong> in the heap.

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

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


id: SplHeap::isCorrupted
type: function
doc:
<comment>Description:</comment>
  Tells if the heap is in a corrupted state

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the heap is corrupted, <info>false</info> otherwise.


id: SplHeap::isEmpty
type: function
doc:
<comment>Description:</comment>
  Checks whether the heap is empty

<comment>Return:</comment>
  <info>bool</info>  Returns whether the heap is empty.


id: SplHeap::next
type: function
doc:
<comment>Description:</comment>
  Move to the next node
  
  Move to the next node. This will delete the top node of the heap.

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


id: SplHeap::recoverFromCorruption
type: function
doc:
<comment>Description:</comment>
  Recover from the corrupted state and allow further actions on the heap

<comment>Return:</comment>
  <info>bool</info>  Always returns <info>true</info>.


id: SplHeap::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind iterator back to the start (no-op)
  
  This rewinds the iterator to the beginning. This is a no-op for heaps as the iterator is virtual
  and in fact never moves from the top of the  heap.

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


id: SplHeap::top
type: function
doc:
<comment>Description:</comment>
  Peeks at the node from the top of the heap

<comment>Return:</comment>
  <info>mixed</info>  The value of the node on the top.


id: SplHeap::valid
type: function
doc:
<comment>Description:</comment>
  Check whether the heap contains more nodes
  
  Checks if the heap contains any more nodes.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the heap contains any more nodes, <info>false</info> otherwise.


id: SplMaxHeap
type: class
doc:
<comment>Description:</comment>
  The SplMaxHeap class provides the main functionalities of a heap, keeping the maximum on the top.


id: SplMaxHeap::compare
type: function
doc:
<comment>Description:</comment>
  Compare elements in order to place them correctly in the heap while sifting up
  
  Compare <strong>$value1</strong> with <strong>$value2</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value1</strong>  The value of the first node being compared.
  <info>mixed</info>  <strong>$value2</strong>  The value of the second node being compared.

<comment>Return:</comment>
  <info>int</info>  Result of the comparison, positive integer if <strong>$value1</strong> is greater than <strong>$value2</strong>, 0 if they are
       equal, negative integer otherwise.
       
       Having multiple elements with the same value in a Heap is not recommended. They will end up
       in an arbitrary relative position.


id: SplMinHeap
type: class
doc:
<comment>Description:</comment>
  The SplMinHeap class provides the main functionalities of a heap, keeping the minimum on the top.


id: SplMinHeap::compare
type: function
doc:
<comment>Description:</comment>
  Compare elements in order to place them correctly in the heap while sifting up
  
  Compare <strong>$value1</strong> with <strong>$value2</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value1</strong>  The value of the first node being compared.
  <info>mixed</info>  <strong>$value2</strong>  The value of the second node being compared.

<comment>Return:</comment>
  <info>int</info>  Result of the comparison, positive integer if <strong>$value1</strong> is lower than <strong>$value2</strong>, 0 if they are
       equal, negative integer otherwise.
       
       Having multiple elements with the same value in a Heap is not recommended. They will end up
       in an arbitrary relative position.


id: SplObjectStorage
type: class
doc:
<comment>Description:</comment>
  The SplObjectStorage class provides a map from objects to data or, by ignoring data, an object
  set. This dual purpose can be useful in many cases involving the need to uniquely identify
  objects.


id: SplObjectStorage::addAll
type: function
doc:
<comment>Description:</comment>
  Adds all objects from another storage
  
  Adds all objects-data pairs from a different storage in the current storage.

<comment>Param:</comment>
  <info>SplObjectStorage</info>  <strong>$storage</strong>  The storage you want to import.

<comment>Return:</comment>
  <info>int</info>  The number of objects in the storage.

<comment>See Also:</comment>
   * SplObjectStorage::removeAll


id: SplObjectStorage::attach
type: function
doc:
<comment>Description:</comment>
  Adds an object in the storage
  
  Adds an <info>object</info> inside the storage, and optionally associate it to some data.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The <info>object</info> to add.
  <info>mixed</info>   <strong>$info</strong>    The data to associate with the <info>object</info>.

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

<comment>See Also:</comment>
   * SplObjectStorage::detach
   * SplObjectStorage::offsetSet


id: SplObjectStorage::contains
type: function
doc:
<comment>Description:</comment>
  Checks if the storage contains a specific object
  
  Checks if the storage contains the <info>object</info> provided.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The <info>object</info> to look for.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the <info>object</info> is in the storage, <info>false</info> otherwise.

<comment>See Also:</comment>
   * SplObjectStorage::offsetExists


id: SplObjectStorage::count
type: function
doc:
<comment>Description:</comment>
  Returns the number of objects in the storage
  
  Counts the number of objects in the storage.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  If the optional <strong>$mode</strong> parameter is set to <info>COUNT_RECURSIVE</info> (or 1),
              <strong>SplObjectStorage::count()</strong> will recursively count the storage.

<comment>Return:</comment>
  <info>int</info>  The number of objects in the storage.

<comment>See Also:</comment>
   * SplObjectStorage::attach
   * SplObjectStorage::detach


id: SplObjectStorage::current
type: function
doc:
<comment>Description:</comment>
  Returns the current storage entry
  
  Returns the current storage entry.

<comment>Return:</comment>
  <info>object</info>  The <info>object</info> at the current iterator position.

<comment>See Also:</comment>
   * SplObjectStorage::rewind
   * SplObjectStorage::key
   * SplObjectStorage::next
   * SplObjectStorage::valid
   * SplObjectStorage::getInfo


id: SplObjectStorage::detach
type: function
doc:
<comment>Description:</comment>
  Removes an object from the storage
  
  Removes the <info>object</info> from the storage.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The <info>object</info> to remove.

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

<comment>See Also:</comment>
   * SplObjectStorage::attach
   * SplObjectStorage::removeAll


id: SplObjectStorage::getHash
type: function
doc:
<comment>Description:</comment>
  Calculate a unique identifier for the contained objects
    
  
  This method calculates an identifier for the objects added to an <class>SplObjectStorage</class> object.
  
  The implementation in <class>SplObjectStorage</class> returns the same value as <strong>spl_object_hash()</strong>.
  
  The storage object will never contain more than one object with the same identifier. As such, it
  can be used to implement a set (a collection of unique values) where the quality of an object
  being unique is determined by the value returned by this function being unique.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The object whose identifier is to be calculated.

<comment>Return:</comment>
  <info>string</info>  A <info>string</info> with the calculated identifier.

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


id: SplObjectStorage::getInfo
type: function
doc:
<comment>Description:</comment>
  Returns the data associated with the current iterator entry
  
  Returns the data, or info, associated with the object pointed by the current iterator position.

<comment>Return:</comment>
  <info>mixed</info>  The data associated with the current iterator position.

<comment>See Also:</comment>
   * SplObjectStorage::current
   * SplObjectStorage::rewind
   * SplObjectStorage::key
   * SplObjectStorage::next
   * SplObjectStorage::valid
   * SplObjectStorage::setInfo


id: SplObjectStorage::key
type: function
doc:
<comment>Description:</comment>
  Returns the index at which the iterator currently is
  
  Returns the index at which the iterator currently is.

<comment>Return:</comment>
  <info>int</info>  The index corresponding to the position of the iterator.

<comment>See Also:</comment>
   * SplObjectStorage::rewind
   * SplObjectStorage::current
   * SplObjectStorage::next
   * SplObjectStorage::valid


id: SplObjectStorage::next
type: function
doc:
<comment>Description:</comment>
  Move to the next entry
  
  Moves the iterator to the next <info>object</info> in the storage.

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

<comment>See Also:</comment>
   * SPLObjectStorage::rewind


id: SplObjectStorage::offsetExists
type: function
doc:
<comment>Description:</comment>
  Checks whether an object exists in the storage
  
  Checks whether an <info>object</info> exists in the storage.
  
  SplObjectStorage::offsetExists is an alias of SplObjectStorage::contains.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The <info>object</info> to look for.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the <info>object</info> exists in the storage, and <info>false</info> otherwise.

<comment>See Also:</comment>
   * SplObjectStorage::offsetSet
   * SplObjectStorage::offsetGet
   * SplObjectStorage::offsetUnset


id: SplObjectStorage::offsetGet
type: function
doc:
<comment>Description:</comment>
  Returns the data associated with an object
  
  Returns the data associated with an <info>object</info> in the storage.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The <info>object</info> to look for.

<comment>Return:</comment>
  <info>mixed</info>  The data previously associated with the <info>object</info> in the storage.

<comment>See Also:</comment>
   * SplObjectStorage::offsetSet
   * SplObjectStorage::offsetExists
   * SplObjectStorage::offsetUnset


id: SplObjectStorage::offsetSet
type: function
doc:
<comment>Description:</comment>
  Associates data to an object in the storage
  
  Associate data to an <info>object</info> in the storage.
  
  SplObjectStorage::offsetSet is an alias of SplObjectStorage::attach.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The <info>object</info> to associate data with.
  <info>mixed</info>   <strong>$info</strong>    The data to associate with the <info>object</info>.

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

<comment>See Also:</comment>
   * SplObjectStorage::attach
   * SplObjectStorage::offsetGet
   * SplObjectStorage::offsetExists
   * SplObjectStorage::offsetUnset


id: SplObjectStorage::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Removes an object from the storage
  
  Removes an <info>object</info> from the storage.
  
  SplObjectStorage::offsetUnset is an alias of SplObjectStorage::detach.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The <info>object</info> to remove.

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

<comment>See Also:</comment>
   * SplObjectStorage::offsetGet
   * SplObjectStorage::offsetSet
   * SplObjectStorage::offsetExists


id: SplObjectStorage::removeAll
type: function
doc:
<comment>Description:</comment>
  Removes objects contained in another storage from the current storage
  
  Removes objects contained in another storage from the current storage.

<comment>Param:</comment>
  <info>SplObjectStorage</info>  <strong>$storage</strong>  The storage containing the elements to remove.

<comment>Return:</comment>
  <info>int</info>  Returns the number of remaining objects.

<comment>See Also:</comment>
   * SplObjectStorage::addAll


id: SplObjectStorage::removeAllExcept
type: function
doc:
<comment>Description:</comment>
  Removes all objects except for those contained in another storage from the current storage
  
  Removes all objects except for those contained in another storage from the current storage.

<comment>Param:</comment>
  <info>SplObjectStorage</info>  <strong>$storage</strong>  The storage containing the elements to retain in the current storage.

<comment>Return:</comment>
  <info>int</info>  Returns the number of remaining objects.


id: SplObjectStorage::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind the iterator to the first storage element
  
  Rewind the iterator to the first storage element.

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

<comment>See Also:</comment>
   * SplObjectStorage::next


id: SplObjectStorage::serialize
type: function
doc:
<comment>Description:</comment>
  Serializes the storage
  
  Returns a string representation of the storage.

<comment>Return:</comment>
  <info>string</info>  A string representing the storage.

<comment>See Also:</comment>
   * SplObjectStorage::unserialize


id: SplObjectStorage::setInfo
type: function
doc:
<comment>Description:</comment>
  Sets the data associated with the current iterator entry
  
  Associates data, or info, with the object currently pointed to by the iterator.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$info</strong>  The data to associate with the current iterator entry.

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

<comment>See Also:</comment>
   * SplObjectStorage::current
   * SplObjectStorage::rewind
   * SplObjectStorage::key
   * SplObjectStorage::next
   * SplObjectStorage::valid
   * SplObjectStorage::getInfo


id: SplObjectStorage::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserializes a storage from its string representation
  
  Unserializes storage entries and attach them to the current storage.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized representation of a storage.

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

<comment>See Also:</comment>
   * SplObjectStorage::serialize


id: SplObjectStorage::valid
type: function
doc:
<comment>Description:</comment>
  Returns if the current iterator entry is valid
  
  Returns if the current iterator entry is valid.

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

<comment>See Also:</comment>
   * SplObjectStorage::current
   * SplObjectStorage::getInfo


id: SplObserver
type: class
doc:
<comment>Description:</comment>
  The <class>SplObserver</class> interface is used alongside <class>SplSubject</class> to implement the Observer Design Pattern.


id: SplObserver::update
type: function
doc:
<comment>Description:</comment>
  Receive update from subject
  
  This method is called when any <class>SplSubject</class> to which the observer is attached calls
  SplSubject::notify.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>SplSubject</info>  <strong>$subject</strong>  The <class>SplSubject</class> notifying the observer of an update.

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


id: SplPriorityQueue
type: class
doc:
<comment>Description:</comment>
  The SplPriorityQueue class provides the main functionalities of a  prioritized queue, implemented
  using a max heap.
  
  The order of elements with identical priority is undefined. It may differ from the order in which
  they have been inserted.


id: SplPriorityQueue::compare
type: function
doc:
<comment>Description:</comment>
  Compare priorities in order to place elements correctly in the heap while sifting up
  
  Compare <strong>$priority1</strong> with <strong>$priority2</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$priority1</strong>  The priority of the first node being compared.
  <info>mixed</info>  <strong>$priority2</strong>  The priority of the second node being compared.

<comment>Return:</comment>
  <info>int</info>  Result of the comparison, positive integer if <strong>$priority1</strong> is greater than <strong>$priority2</strong>, 0 if
       they are equal, negative integer otherwise.
       
       Multiple elements with the same priority will get dequeued in no particular order.


id: SplPriorityQueue::count
type: function
doc:
<comment>Description:</comment>
  Counts the number of elements in the queue

<comment>Return:</comment>
  <info>int</info>  Returns the number of elements in the queue.


id: SplPriorityQueue::current
type: function
doc:
<comment>Description:</comment>
  Return current node pointed by the iterator
  
  Get the current datastructure node.

<comment>Return:</comment>
  <info>mixed</info>  The value or priority (or both) of the current node, depending on the extract flag.


id: SplPriorityQueue::extract
type: function
doc:
<comment>Description:</comment>
  Extracts a node from top of the heap and sift up

<comment>Return:</comment>
  <info>mixed</info>  The value or priority (or both) of the extracted node, depending on the extract flag.


id: SplPriorityQueue::getExtractFlags
type: function
doc:
<comment>Description:</comment>
  Get the flags of extraction
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>int</info>  Returns the flags of extraction.


id: SplPriorityQueue::insert
type: function
doc:
<comment>Description:</comment>
  Inserts an element in the queue by sifting it up
  
  Insert <strong>$value</strong> with the priority <strong>$priority</strong> in the queue.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>     The value to insert.
  <info>mixed</info>  <strong>$priority</strong>  The associated priority.

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


id: SplPriorityQueue::isCorrupted
type: function
doc:
<comment>Description:</comment>
  Tells if the priority queue is in a corrupted state

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the priority queue is corrupted, <info>false</info> otherwise.


id: SplPriorityQueue::isEmpty
type: function
doc:
<comment>Description:</comment>
  Checks whether the queue is empty

<comment>Return:</comment>
  <info>bool</info>  Returns whether the queue is empty.


id: SplPriorityQueue::next
type: function
doc:
<comment>Description:</comment>
  Move to the next node
  
  Extracts the top node from the queue.

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


id: SplPriorityQueue::recoverFromCorruption
type: function
doc:
<comment>Description:</comment>
  Recover from the corrupted state and allow further actions on the queue

<comment>Return:</comment>
  <info>bool</info>  Always returns <info>true</info>.


id: SplPriorityQueue::setExtractFlags
type: function
doc:
<comment>Description:</comment>
  Sets the mode of extraction

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Defines what is extracted by SplPriorityQueue::current, SplPriorityQueue::top and
               SplPriorityQueue::extract.
               
               <info>SplPriorityQueue::EXTR_DATA</info> (0x00000001): Extract the data
               
               <info>SplPriorityQueue::EXTR_PRIORITY</info> (0x00000002): Extract the priority
               
               <info>SplPriorityQueue::EXTR_BOTH</info> (0x00000003): Extract an array containing both
               
               The default mode is <info>SplPriorityQueue::EXTR_DATA</info>.

<comment>Return:</comment>
  <info>int</info>  Returns the flags of extraction.


id: SplPriorityQueue::top
type: function
doc:
<comment>Description:</comment>
  Peeks at the node from the top of the queue

<comment>Return:</comment>
  <info>mixed</info>  The value or priority (or both) of the top node, depending on the extract flag.


id: SplPriorityQueue::valid
type: function
doc:
<comment>Description:</comment>
  Check whether the queue contains more nodes
  
  Checks if the queue contains any more nodes.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the queue contains any more nodes, <info>false</info> otherwise.


id: SplQueue
type: class
doc:
<comment>Description:</comment>
  The SplQueue class provides the main functionalities of a queue implemented using a doubly linked
  list by setting the iterator mode to <info>SplDoublyLinkedList::IT_MODE_FIFO</info>.


id: SplQueue::dequeue
type: function
doc:
<comment>Description:</comment>
  Dequeues a node from the queue
  
  Dequeues <strong>$value</strong> from the top of the queue.
  
  SplQueue::dequeue is an alias of SplDoublyLinkedList::shift.

<comment>Return:</comment>
  <info>mixed</info>  The value of the dequeued node.


id: SplQueue::enqueue
type: function
doc:
<comment>Description:</comment>
  Adds an element to the queue
  
  Enqueues <strong>$value</strong> at the end of the queue.
  
  SplQueue::enqueue is an alias of SplDoublyLinkedList::push.

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

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


id: SplStack
type: class
doc:
<comment>Description:</comment>
  The SplStack class provides the main functionalities of a stack implemented using a doubly linked
  list by setting the iterator mode to <info>SplDoublyLinkedList::IT_MODE_LIFO</info>.


id: SplSubject
type: class
doc:
<comment>Description:</comment>
  The <class>SplSubject</class> interface is used alongside <class>SplObserver</class> to implement the Observer Design Pattern.


id: SplSubject::attach
type: function
doc:
<comment>Description:</comment>
  Attach an SplObserver
  
  Attaches an <class>SplObserver</class> so that it can be notified of updates.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>SplObserver</info>  <strong>$observer</strong>  The <class>SplObserver</class> to attach.

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


id: SplSubject::detach
type: function
doc:
<comment>Description:</comment>
  Detach an observer
  
  Detaches an observer from the subject to no longer notify it of updates.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>SplObserver</info>  <strong>$observer</strong>  The <class>SplObserver</class> to detach.

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


id: SplSubject::notify
type: function
doc:
<comment>Description:</comment>
  Notify an observer
  
  Notifies all attached observers.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

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


id: SplTempFileObject
type: class
doc:
<comment>Description:</comment>
  The SplTempFileObject class offers an object-oriented interface for a temporary file.


id: SplTempFileObject::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new temporary file object
  
  Construct a new temporary file object.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxMemory</strong>  The maximum amount of memory (in bytes, default is 2 MB) for  the temporary file
                   to use. If the temporary file exceeds this  size, it will be moved to a file in
                   the system's temp directory.
                   
                   If <strong>$maxMemory</strong> is negative, only memory will be used. If <strong>$maxMemory</strong> is zero,  no
                   memory will be used.

<comment>See Also:</comment>
   * <class>SplFileObject</class>
   * PHP input/output streams 
     (for <return>php://temp</return> and <return>php://memory</return>)
    


id: Spoofchecker
type: class
doc:
<comment>Description:</comment>
  This class is provided because Unicode contains large number of characters and incorporates the
  varied writing systems of the world and their incorrect usage can expose programs or systems to
  possible security attacks using characters similarity.
  
  Provided methods allow to check whether an individual string is likely an attempt at confusing the
  reader (<return>spoof detection</return>), such as  "pаypаl" spelled with Cyrillic 'а' characters.


id: Spoofchecker::areConfusable
type: function
doc:
<comment>Description:</comment>
  Checks if given strings can be confused
  
  Checks whether two given strings can easily be mistaken.

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>    First string to check.
  <info>string</info>  <strong>$string2</strong>    Second string to check.
  <info>int</info>     <strong>$errorCode</strong>  This variable is set by-reference to Integer containing an error, if there was
                      any.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if two given strings can be confused, <info>false</info> otherwise.


id: Spoofchecker::isSuspicious
type: function
doc:
<comment>Description:</comment>
  Checks if a given text contains any suspicious characters
  
  Checks if given string contains any suspicious characters like letters which are almost identical
  visually, but are Unicode characters from different sets.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>     String to test.
  <info>int</info>     <strong>$errorCode</strong>  This variable is set by-reference to Integer containing an error, if there was
                      any.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if there are suspicious characters, <info>false</info> otherwise.


id: Spoofchecker::setAllowedLocales
type: function
doc:
<comment>Description:</comment>
  Locales to use when running checks
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

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

<comment>Return:</comment>
  <info>void</info>  


id: Spoofchecker::setChecks
type: function
doc:
<comment>Description:</comment>
  Set the checks to run
  
  Sets the checks that will be performed by SpoofChecker::isSuspicious.

<comment>Param:</comment>
  <info>int</info>  <strong>$checks</strong>  The checks that will be performed by SpoofChecker::isSuspicious. A bitmask of
                <info>Spoofchecker::SINGLE_SCRIPT_CONFUSABLE</info>, <info>Spoofchecker::MIXED_SCRIPT_CONFUSABLE</info>,
                <info>Spoofchecker::WHOLE_SCRIPT_CONFUSABLE</info>, <info>Spoofchecker::ANY_CASE</info>,
                <info>Spoofchecker::SINGLE_SCRIPT</info>, <info>Spoofchecker::INVISIBLE</info>, or <info>Spoofchecker::CHAR_LIMIT</info>.
                Defaults to all checks as of ICU 58; prior to that version,
                <info>Spoofchecker::SINGLE_SCRIPT</info> was excluded.

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


id: Spoofchecker::setRestrictionLevel
type: function
doc:
<comment>Description:</comment>
  Set the restriction level
  
  Sets the restriction level of SpoofChecker::isSuspicious.

<comment>Param:</comment>
  <info>int</info>  <strong>$level</strong>  The restriction level of SpoofChecker::isSuspicious. One of <info>Spoofchecker::ASCII</info>,
               <info>Spoofchecker::SINGLE_SCRIPT_RESTRICTIVE</info>, <info>Spoofchecker::HIGHLY_RESTRICTIVE</info>,
               <info>Spoofchecker::MODERATELY_RESTRICTIVE</info>, <info>Spoofchecker::MINIMALLY_RESTRICTIVE</info>, or
               <info>Spoofchecker::UNRESTRICTIVE</info>. Defaults to <info>Spoofchecker::HIGHLY_RESTRICTIVE</info>.

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


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


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

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

<comment>Return:</comment>
  <info>mysql_xdevapi\SqlStatement</info>  


id: SqlStatement::execute
type: function
doc:
<comment>Description:</comment>
  Führt eine Operation aus
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  


id: SqlStatement::getNextResult
type: function
doc:
<comment>Description:</comment>
  Ruft das nächste Ergebnis ab
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  


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

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  


id: SqlStatement::hasMoreResults
type: function
doc:
<comment>Description:</comment>
  Prüft, ob es weitere Ergebnisse gibt
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn die Ergebnismenge weitere Objekte enthält, die abgerufen werden
        können.


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


id: SqlStatementResult::fetchAll
type: function
doc:
<comment>Description:</comment>
  Ruft alle Zeilen aus dem Ergebnis ab
  
  Ruft alle Zeilen aus der Ergebnismenge ab.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>array</info>  Gibt ein numerisches Array mit allen Ergebnissen der Abfrage zurück; jedes Ergebnis ist ein
         assoziatives Array. Wenn keine Zeilen vorliegen, wird ein leeres Array zurückgegeben.


id: SqlStatementResult::fetchOne
type: function
doc:
<comment>Description:</comment>
  Ruft eine Zeile aus dem Ergebnis ab
  
  Ruft eine Zeile aus der Ergebnismenge ab.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>array</info>  Gibt das Ergebnis als assoziatives Arrays zurück. Falls es kein Ergebnis gibt, wird <info>null</info>
         zurückgegeben.


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

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


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

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


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

<comment>Return:</comment>
  <info>Array</info>  


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

<comment>Return:</comment>
  <info>int</info>  Gibt die Anzahl der Spalten zurück; 0, wenn es keine gibt.


id: SqlStatementResult::getGeneratedIds
type: function
doc:
<comment>Description:</comment>
  Ruft die zuletzt erzeugten IDs ab
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>array</info>  Gibt ein Array der _id-Werte zurück, die bei der letzten Operation erzeugt wurden, oder ein
         leeres Array, wenn es keine _id-Werte gibt.


id: SqlStatementResult::getLastInsertId
type: function
doc:
<comment>Description:</comment>
  Ruft die ID der letzten Einfügung ab
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>String</info>  Gibt die ID für die letzte Einfügeoperation zurück.


id: SqlStatementResult::getWarnings
type: function
doc:
<comment>Description:</comment>
  Ruft die Warnungen der letzten Operation ab
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>array</info>  Gibt ein Array von Warning-Objekten der letzten Operation zurück. Jedes Objekt enthält eine
         Fehlermeldung ("message"), eine Fehlerstufe ("level") und einen Fehlercode ("code"). Wenn
         kein Fehler aufgetreten ist, wird ein leeres Array zurückgegeben.


id: SqlStatementResult::getWarningsCount
type: function
doc:
<comment>Description:</comment>
  Ermittelt die Anzahl der Warnungen der letzten Operation
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>int</info>  Gibt die Anzahl der Warnungen zurück, die bei der letzten CRUD-Operation ausgelöst wurden.


id: SqlStatementResult::hasData
type: function
doc:
<comment>Description:</comment>
  Prüft, ob die Ergebnismenge Daten enthält
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>bool</info>  Gibt <info>true</info> zurück, wenn die Ergebnismenge Daten enthält.


id: SqlStatementResult::nextResult
type: function
doc:
<comment>Description:</comment>
  Ruft das nächste Ergebnis ab
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  Gibt das nächste Result-Objekt aus der Ergebnismenge zurück.


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


id: Statement::hasMoreResults
type: function
doc:
<comment>Description:</comment>
  Prüft, ob es weitere Ergebnisse gibt
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

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


id: Stomp
type: class
doc:
<comment>Description:</comment>
  Represents a connection between PHP and a Stomp compliant Message Broker.


id: Stomp::__construct
type: function
doc:
<comment>Description:</comment>
  Opens a connection
  
  Objektorientierter Stil (constructor):
  
  Prozeduraler Stil:
  
  Opens a connection to a stomp compliant Message Broker.

<comment>Param:</comment>
  <info>string</info>  <strong>$broker</strong>    The broker URI
  <info>string</info>  <strong>$username</strong>  The username.
  <info>string</info>  <strong>$password</strong>  The password.
  <info>array</info>   <strong>$headers</strong>   Assoziatives Array, welches alle zusätzlichen Header beinhaltet (z. B.
                     receipt).

<comment>Return:</comment>
  <info>resource</info>  Ein Transaktionsheader kann angegeben werden. Dies zeigt an, dass die Bestätigung der
            Nachricht ein Bestandteil der benanten Transaktion sein soll.


id: Stomp::__destruct
type: function
doc:
<comment>Description:</comment>
  Closes stomp connection
  
  Objektorientierter Stil (destructor):
  
  Prozeduraler Stil:
  
  Closes a previously opened connection.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Nur für prozedurale Aufrufe: Die Stomp-Verbindung, die von <strong>stomp_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.


id: Stomp::abort
type: function
doc:
<comment>Description:</comment>
  Rolls back a transaction in progress
  
  Objektorientierter Stil (method):
  
  Prozeduraler Stil:
  
  Rolls back a transaction in progress.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>            Nur für prozedurale Aufrufe: Die Stomp-Verbindung, die von
                             <strong>stomp_connect()</strong> zurückgegeben wurde.
  <info>string</info>    <strong>$transaction_id</strong>  The transaction to abort.
  <info>array</info>     <strong>$headers</strong>         Assoziatives Array, welches alle zusätzlichen Header beinhaltet (z. B.
                             receipt).

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


id: Stomp::ack
type: function
doc:
<comment>Description:</comment>
  Acknowledges consumption of a message
  
  Objektorientierter Stil (method):
  
  Prozeduraler Stil:
  
  Acknowledges consumption of a message from a subscription using client acknowledgment.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>     Nur für prozedurale Aufrufe: Die Stomp-Verbindung, die von <strong>stomp_connect()</strong>
                      zurückgegeben wurde.
  <info>mixed</info>     <strong>$msg</strong>      The message/messageId to be acknowledged.
  <info>array</info>     <strong>$headers</strong>  Assoziatives Array, welches alle zusätzlichen Header beinhaltet (z. B.
                      receipt).

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


id: Stomp::begin
type: function
doc:
<comment>Description:</comment>
  Starts a transaction
  
  Objektorientierter Stil (method):
  
  Prozeduraler Stil:
  
  Starts a transaction.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>            Nur für prozedurale Aufrufe: Die Stomp-Verbindung, die von
                             <strong>stomp_connect()</strong> zurückgegeben wurde.
  <info>string</info>    <strong>$transaction_id</strong>  The transaction id.
  <info>array</info>     <strong>$headers</strong>         Assoziatives Array, welches alle zusätzlichen Header beinhaltet (z. B.
                             receipt).

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


id: Stomp::commit
type: function
doc:
<comment>Description:</comment>
  Commits a transaction in progress
  
  Objektorientierter Stil (method):
  
  Prozeduraler Stil:
  
  Commits a transaction in progress.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>            Nur für prozedurale Aufrufe: Die Stomp-Verbindung, die von
                             <strong>stomp_connect()</strong> zurückgegeben wurde.
  <info>string</info>    <strong>$transaction_id</strong>  The transaction id.
  <info>array</info>     <strong>$headers</strong>         Assoziatives Array, welches alle zusätzlichen Header beinhaltet (z. B.
                             receipt).

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


id: Stomp::error
type: function
doc:
<comment>Description:</comment>
  Gets the last stomp error
  
  Objektorientierter Stil (method):
  
  Prozeduraler Stil:
  
  Gets the last stomp error.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Nur für prozedurale Aufrufe: Die Stomp-Verbindung, die von <strong>stomp_connect()</strong>
                   zurückgegeben wurde.

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


id: Stomp::getReadTimeout
type: function
doc:
<comment>Description:</comment>
  Gets read timeout
  
  Objektorientierter Stil (method):
  
  Prozeduraler Stil:
  
  Gets read timeout

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Nur für prozedurale Aufrufe: Die Stomp-Verbindung, die von <strong>stomp_connect()</strong>
                   zurückgegeben wurde.

<comment>Return:</comment>
  <info>array</info>  Returns an array with 2 elements: sec and usec.


id: Stomp::getSessionId
type: function
doc:
<comment>Description:</comment>
  Gets the current stomp session ID
  
  Objektorientierter Stil (method):
  
  Prozeduraler Stil:
  
  Gets the current stomp session ID.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Nur für prozedurale Aufrufe: Die Stomp-Verbindung, die von <strong>stomp_connect()</strong>
                   zurückgegeben wurde.

<comment>Return:</comment>
  <info>string|false</info>  String session id on successBei einem Fehler wird <info>false</info> zurückgegeben..


id: Stomp::hasFrame
type: function
doc:
<comment>Description:</comment>
  Indicates whether or not there is a frame ready to read
  
  Objektorientierter Stil (method):
  
  Prozeduraler Stil:
  
  Indicates whether or not there is a frame ready to read.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Nur für prozedurale Aufrufe: Die Stomp-Verbindung, die von <strong>stomp_connect()</strong>
                   zurückgegeben wurde.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if a frame is ready to read, or <info>false</info> otherwise.


id: Stomp::readFrame
type: function
doc:
<comment>Description:</comment>
  Reads the next frame
  
  Objektorientierter Stil (method):
  
  Prozeduraler Stil:
  
  Reads the next frame. It is possible to instantiate an object of a specific class, and pass
  parameters to that class's constructor.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>        Nur für prozedurale Aufrufe: Die Stomp-Verbindung, die von <strong>stomp_connect()</strong>
                         zurückgegeben wurde.
  <info>string</info>    <strong>$class_name</strong>  The name of the class to instantiate. If not specified, a stompFrame object
                         is returned.

<comment>Return:</comment>
  <info>stompframe</info>  Ein Transaktionsheader kann angegeben werden. Dies zeigt an, dass die Bestätigung der
              Nachricht ein Bestandteil der benanten Transaktion sein soll.


id: Stomp::send
type: function
doc:
<comment>Description:</comment>
  Sends a message
  
  Objektorientierter Stil (method):
  
  Prozeduraler Stil:
  
  Sends a message to the Message Broker.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>         Nur für prozedurale Aufrufe: Die Stomp-Verbindung, die von <strong>stomp_connect()</strong>
                          zurückgegeben wurde.
  <info>string</info>    <strong>$destination</strong>  Where to send the message
  <info>mixed</info>     <strong>$msg</strong>          Message to send.
  <info>array</info>     <strong>$headers</strong>      Assoziatives Array, welches alle zusätzlichen Header beinhaltet (z. B.
                          receipt).

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


id: Stomp::setReadTimeout
type: function
doc:
<comment>Description:</comment>
  Sets read timeout
  
  Objektorientierter Stil (method):
  
  Prozeduraler Stil:
  
  Sets read timeout.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>          Nur für prozedurale Aufrufe: Die Stomp-Verbindung, die von
                           <strong>stomp_connect()</strong> zurückgegeben wurde.
  <info>int</info>       <strong>$seconds</strong>       The seconds part of the timeout to be set.
  <info>int</info>       <strong>$microseconds</strong>  The microseconds part of the timeout to be set.

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


id: Stomp::subscribe
type: function
doc:
<comment>Description:</comment>
  Registers to listen to a given destination
  
  Objektorientierter Stil (method):
  
  Prozeduraler Stil:
  
  Registers to listen to a given destination.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>         Nur für prozedurale Aufrufe: Die Stomp-Verbindung, die von <strong>stomp_connect()</strong>
                          zurückgegeben wurde.
  <info>string</info>    <strong>$destination</strong>  Destination to subscribe to.
  <info>array</info>     <strong>$headers</strong>      Assoziatives Array, welches alle zusätzlichen Header beinhaltet (z. B.
                          receipt).

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


id: Stomp::unsubscribe
type: function
doc:
<comment>Description:</comment>
  Removes an existing subscription
  
  Objektorientierter Stil (method):
  
  Prozeduraler Stil:
  
  Removes an existing subscription.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>         Nur für prozedurale Aufrufe: Die Stomp-Verbindung, die von <strong>stomp_connect()</strong>
                          zurückgegeben wurde.
  <info>string</info>    <strong>$destination</strong>  Subscription to remove.
  <info>array</info>     <strong>$headers</strong>      Assoziatives Array, welches alle zusätzlichen Header beinhaltet (z. B.
                          receipt).

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


id: StompException
type: class
doc:
<comment>Description:</comment>
  Represents an error raised by the stomp extension. See Exceptions for more information about
  Exceptions in PHP.


id: StompException::getDetails
type: function
doc:
<comment>Description:</comment>
  Get exception details
  
  Get exception details.

<comment>Return:</comment>
  <info>string</info>  String containing the error details.


id: StompFrame
type: class
doc:
<comment>Description:</comment>
  Represents a message which was sent or received from a Stomp compliant Message Broker.


id: StompFrame::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  Constructor.

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>  Frame command
  <info>array</info>   <strong>$headers</strong>  Frame headers (Array).
  <info>string</info>  <strong>$body</strong>     Frame body.


id: Stringable
type: class
doc:
<comment>Description:</comment>
  Das Interface Stringable kennzeichnet, dass eine Klasse eine __toString()-Methode enthält. Anders
  als die meisten anderen Interfaces, ist das Interface Stringable implizit bei allen Klassen
  präsent, welche die magische Methode __toString() enthalten. Das Interface kann und sollte jedoch
  explizit deklariert werden.
  
  Der primäre Anwendungsfall ist es, Funktionen eine Typenüberprüfung gegen den Vereinigungstypen
  <return>string|Stringable</return> zu ermöglichen. Damit können diese entweder eine Zeichenkette oder ein Objekt
  akzeptieren, welches in eine Zeichenkette umgewandelt werden kann.


id: Stringable::__toString
type: function
doc:
<comment>Description:</comment>
  Liefert die String-Darstellung eines Objekts

<comment>Return:</comment>
  <info>string</info>  Gibt die String-Darstellung des Objekts zurück.

<comment>See Also:</comment>
   * __toString()


id: Superglobals
type: function
doc:
<comment>Description:</comment>
  Interne Variablen, die immer in allen Gültigkeitsbereichen verfügbar sind
    
  
  Etliche vordefinierte Variablen in PHP sind sogenannte "Superglobals", was bedeutet, dass sie in
  allen Gültigkeitsbereichen (sogenannte Scopes) eines Skripts verfügbar sind. Daher ist es nicht
  nötig, global $variable; zu verwenden, um innerhalb einer Funktion oder Methode auf sie
  zuzugreifen.
  
  Diese Superglobals sind: $GLOBALS$_SERVER$_GET$_POST$_FILES$_COOKIE$_SESSION$_REQUEST$_ENV

<comment>See Also:</comment>
   * Gültigkeit von Variablen
   * Die Direktive variables_order
   * Die Filter-Erweiterung


id: Swoole\Async::dnsLookup
type: function
doc:
<comment>Description:</comment>
  Async and non-blocking hostname to IP lookup.
  
  Diese Funktion ist bis jetzt
  nicht dokumentiert. Es steht nur die Liste der Parameter zur
  Verfügung.

<comment>Param:</comment>
  <info>string</info>    <strong>$hostname</strong>  The host name.
  <info>callable</info>  <strong>$callback</strong>  The host name.
                       
                       The IP address.
  <info>string</info>    <strong>$hostname</strong>  The host name.
  <info></info>          <strong>$IP</strong>        The IP address.

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Async::read
type: function
doc:
<comment>Description:</comment>
  Read file stream asynchronously.

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>    The name of the file.
  <info>callable</info>  <strong>$callback</strong>    The name of the file.
                         
                         The content readed from the file stream.
  <info>string</info>    <strong>$filename</strong>    The name of the file.
  <info>string</info>    <strong>$content</strong>     The content readed from the file stream.
  <info>int</info>       <strong>$chunk_size</strong>  The chunk length.
  <info>int</info>       <strong>$offset</strong>      The offset.

<comment>Return:</comment>
  <info>bool</info>  Whether the read is succeed.


