Index: phpdoc/de/functions/ircg.xml +++ phpdoc/de/functions/ircg.xml IRC Gateway Functions IRC Gateway Internet Relay Chat Gateway ... Die ircg-Funktionen benötigen die IRCG-Library IRCG von Sascha Schumann. ircg_pconnect Verbindung zum IRC-Server aufbauen Beschreibung resource ircg_pconnect string username string server_ip int server_port string msg_format array ctcp_messages array user_settings ircg_pconnect Stellt eine Verbindung zum einem IRC Server her, und liefert eine Verbindunskennung. Der Parameter username muss angeben werden, er legt den Benutzernamen auf dem Server fest. server_ip und server_port sind optional. Werden diese nicht angegben wird für server_ip der Wert 127.0.0.1 (localhost) und für server_port der Wert 6667 gesetzt. Der Parameter server_ip muss aus einer IP-Adresse in numerischer Form bestehen. Die Ausgabe der IRC Meldungen und Ereignisse wird mit einem formatierten String, der vor dem Aufruf mit der Funktion ircg_register_format_messages im Parameter msg_format definiert. ctcp_messages user_settings Siehe auch: ircg_disconnect, ircg_is_conn_alive, ircg_register_format_messages. ircg_fetch_error_msg Liefert den Fehler des letzten ircg Funktionsaufrufes. Beschreibung array ircg_fetch_error_msg resource connection ircg_fetch_error_msg Liefet den Fehler der Verbindung connection der letzten aufgerufenen ircg Funktion zurück. Die Fehlernummer wird im ersten Element des Arrays zurückgeliefert, der Fehlertext im zweiten Parameter. <function>ircg_fetch_error_msg</function> Beispiel if (!ircg_join ($id, "#php")){ $error = ircg_fetch_error_msg($id); print ("Can't join channel #php. Errorcode: $error[0] Description: $error[1]"); } ircg_set_current Setzt die Verbindung für die Ausgabe der IRC-Server Meldungen Beschreibung boolean ircg_set_current resource connection Setzt die Verbindung für die Ausgabe. Alle Meldungen des verbundenen IRC-Servers, der über den Parameter connection spezifiziert wurde, werden über die in der Funktion ircg_register_format_messages angegebenen Formatierungen ausgegeben. Siehe auch: ircg_register_format_messages and ircg_lookup_format_messages. ircg_join Einen Channel auf dem verbundenen IRC-Server betreten Beschreibung boolean ircg_join resource connection string channel Betritt den Channel channel auf dem IRC-Server connection. Siehe auch: ircg_part Einen Channel auf dem IRC-Server verlassen Description boolean ircg_part resource connection string channel Verlässt den Channel channel auf dem IRC-Server connection. Siehe auch: ircg_msg Sendet eine Nachricht an einen Channel oder Benutzer Beschreibung boolean ircg_msg resource connection string recipient string message boolean suppress ircg_msg sendet eine Nachricht an einen Channel oder Benutzer auf dem IRC-Server connection. Der Parameter recipient, beginnend mit einem # oder & sendet die Nachricht an einen Channel, andere Angaben werden als Benutzername interpretiert. Wird der optionale Parameter suppress auf &true; gesetzt, wird die Ausgabe der Nachricht auf der eigenen Verbindung unterbunden. ircg_notice Sendet eine Notiz zu einem anderen Benutzer Beschreibung boolean ircg_notice resource connection string string message Sendet eine Nachricht message zum angegebenen Benutzer nick auf dem verbunden IRC-Server connection. Der genaue Unterschied zwischen einer Nachricht und einer Notiz ist dem IRC-Manual zu entnehmen. Siehe auch: ircg_nick ändert den Benutzernamen auf dem IRC-Server Beschreibung boolean ircg_nick resource connection string nick Ändert den Benutzernamen auf dem IRC-Server connection auf den neuen Benutzernamen nick. liefert bei erfolgreicher Änderung &true; oder &false; falls der name nicht geändert werden konnte. ircg_topic Setzt das Thema für einen Channel Beschreibung boolean ircg_topic resource connection string channel string new_topic Ändert das Thema (Topic) für den Channel channel des verbundenen IRC-Servers connection in new_topic. ircg_channel_mode Setzt die Channel Attribute für einen Benutzer Beschreibung boolean ircg_channel_mode resource connection string channel string mode_spec string nick Setzt die Attribute mode_spec in einem Channel channel auf dem verbundenen Server connection für den Benutzer nick. Die Attribute werden gesetzt oder gelöscht durch Angabe eines Zeichen verbunden mit einem Plus oder Minuszeichen. Ein Operator-Attribut beispielsweise wird mittels '+o' gesetzt oder durch '-o' entfernt. Siehe auch: ircg_html_encode Wandelt einen HTML string für die Ausgabe um Beschreibung boolean ircg_html_encode string html_string Wandelt den HTML-String html_string für die Ausgabe um. Dies ist beispielsweise sinnvoll, wenn in einem Channel über HTML oder Beispiele diskutiert wird. Siehe auch: ircg_whois Liefert die Information über einen bestimmten Benutzer Beschreibung boolean ircg_whois resource connection string nick Weist den verbunden IRC-Server connection an, Informationen über den Benutzer nick anzuzeigen. Siehe auch: ircg_kick Entfernt einen Benutzer aus einem Channel Beschreibung boolean ircg_kick resource connection string channel string nick string reason Entfernt den Benutzer nick vom Channel channel auf dem verbundenen IRC-Server connection. reason gibt den Grund an, warum der User aus dem Channel geworfen wird. ircg_ignore_add Fügt einen Benutzer an die Liste der zu ignorierenden Personen an. Beschreibung boolean ircg_ignore_add resource connection string nick Die Function fügt den Benutzer nick zur persönlichen Liste der ignorierten Benutzer auf dem verbundenen IRC-Server connection hinzu. Dadurch werden von diesem Benutzer keine Nachrichten mehr angezeigt. Siehe auch: ircg_ignore_del . ircg_ignore_del Entfernt einen Benutzer von der Liste ignorierter Personen Description boolean ircg_ignore_del resource connection string nick Diese Funktion entfernt den Benutzer nick von der Liste der ignorierten Personen auf dem verbunden IRC-Server connection. Siehe auch: ircg_ignore_add. ircg_disconnect Beendet die Verbindung zum IRC-Server Beschreibung boolean ircg_disconnect resource connection string reason ircg_disconnect beendet die Verbindung connection zu einem IRC-Server, die mittels der Funktion ircg-pconnect hergestellt wurde Siehe auch: ircg_pconnect. ircg_is_conn_alive Check connection status Beschreibung boolean ircg_is_conn_alive resource connection ircg_is_conn_alive gibt den Wert &true; zurück, wenn die Verbindung connection zum IRC-Server besteht, oder &false; falls keine gültige Verbindung mehr besteht. ircg_lookup_format_messages Wählt ein Format für die Ausgabe von IRC-Nachrichten und Ereignissen aus. Beschreibung boolean ircg_lookup_format_messages string name Wählt ein über die Funktion ircg_register_format definiertes Format string zur Formatierung der Ausgabe von IRC-Server Nachrichten und Ereignissen aus. Unter dem Namen ircg steht ein Standardformat zur Verfügung. Siehe auch: ircg_register_format_messages ircg_register_format_messages Registriert die Ausgabeformatierungen für Nachrichten und Ereignisse vom IRC-Server Beschreibung boolean ircg_register_format_messages string name array messages Mit der Funktion ircg_register_format_messages kann die Formatierung der Ausgabe von IRC-Servermeldungen und -ereignissen festgelegt werden. Dabei ist es möglich mehrere Formate (Layer) zu definieren, die mit der Funktion ircg_lookup_format_messages ausgewählt werden können. Die Funktionen für die Ausgabe werden in dem Array messages in folgender Reihenfolge übergeben: Nachricht an den Channel Erhalten einer privaten Nachricht Private Nachricht gesendet Ein Benutzer verlässt den Channel Ein Benutzer betritt den Channel Ein Benutzer wurde aus dem Channel geworfen (gekicked) Thema (Topic) des Channels hat sich geändert Fehler schwerer Fehler Ende der Benutzerliste (wird beim Betreten eines Channels gesendet) Meldung beim eigenen Betreten eines Channels Ein Benutzer ändert seinen Namen Ein Benutzer beendet die Verbindung zum IRC-Server Eine grössere Anzahl von Benutzern betritt den Channel (z.B. Bei netsplit/join) Ein Benutzer aus der Liste bei massenhaftem Betreten eines Channels Ende des massenhaften Betretens eines Channels Benutzerinformation Serverinformation Information über Inaktivität Information über den Channel Ende Meldung bei Information über Channel (Listenende) Benachrichtigung über Änderung des voice-Attributs Benachrichtung über Änderung des Operator-Attributs für den Channel gesperrter Benutzer Ende der Liste gesperrter Benutzer %f - von %t - an %c - channel %r - vollständige Nachricht %m - umgewandelte Nachricht %j - für Javascript umgewandelte Nachricht 1 - mod encode 2 - decodierter Benutzername Siehe auch: ircg_lookup_format_messages.