From 2e552ae911d4836609f3a74df1e22c06b2209fa8 Mon Sep 17 00:00:00 2001 From: Hartmut Holzgraefe Date: Fri, 8 Jun 2001 21:18:25 +0000 Subject: [PATCH] initial work on ircg extension docs git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@49431 c90b9560-bf6c-de11-be94-00142212c4b1 --- functions/ircg.xml | 600 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 600 insertions(+) create mode 100644 functions/ircg.xml diff --git a/functions/ircg.xml b/functions/ircg.xml new file mode 100644 index 0000000000..8ca5f69a30 --- /dev/null +++ b/functions/ircg.xml @@ -0,0 +1,600 @@ + + IRC Gateway Functions + IRC Gateway + + + Internet Relay Chat Gateway ... + + + + + + ircg_pconnect + + Connect to an IRC server + + + + Description + + + resource ircg_pconnect + string username + string server_ip + int server_port + string msg_format + array ctcp_messages + array user_settings + + + + ircg_pconnect will try to establish a connection to + an IRC server and return a connection resource handle for further + use. + + + The only mandatory parameter is username, + this will set your initial nicknake on the + server. server_ip and + server_port are optional and default to + 127.0.0.1 and 6667. + + + For now parameter server_ip will not do + any hostname lookups and will only accept IP addresses in + numerical form. + + + + + You can customize the output of IRC messages and events by + selection a format string set previously created with + ircg_register_format_messages + by specifing the sets name in msg_format. + + + ctcp_messages + + + user_settings + + + See also: ircg_disconnect, + ircg_is_conn_alive, + ircg_register_format_messages. + + + + + + + ircg_set_current + + Set current connection for output + + + + Description + + + boolean ircg_set_current + resource + connection + + + + Select the current connection for output in this execution + context. Every output sent from the server connected to by + connection will be copied to standard + output while using default formating or a formar string set + specified by ircg_register_format_messages + and selected by irct_lookup_format_messages. + + + See also: ircg_register_format_messages and + ircg_lookup_format_messages. + + + + + + + ircg_join + + Join a channel on a connected server + + + + Description + + + boolean ircg_join + resource connection + string channel + + + + Join the channel channel on the server + connected to by connection. + + + See also: + + + + + + + ircg_part + + Leave a channel on server + + + + Description + + + boolean ircg_part + resource connection + string channel + + + + Leave the channel channel on the server + connected to by connection. + + + See also: + + + + + + + ircg_msg + + Send message to channel or user on server + + + + Description + + + boolean ircg_msg + resource connection + string recipient + string message + boolean suppress + + + + ircg_msg will send the message to a channel + or user on the server connected to by + connection. A + recipient starting with + # or & will send the + message to a channel, anything else will + be interpreted as a username. + + + Setting the optional parameter suppress to + a true value will suppress output of your message to your own + connection. + + + + + + + ircg_notice + + Send a notice to a user on server + + + + Description + + + boolean ircg_notice + resource connection + string + string message + + + + This function will send the message text + to the user nick on the server connected + to by connection. Query your IRC + documentation of choice for the exact difference between a MSG + and a NOTICE. + + + See also: + + + + + + + ircg_nick + + Change nickname on server + + + + Description + + + boolean ircg_nick + resource connection + string nick + + + + Change your nickname on the given + connection to the one given in + nick if possible. + + + Will return true on success and false on failure. + + + + + + + ircg_topic + + Set topic for channel on server + + + + Description + + + boolean ircg_topic + resource connection + string channel + string new_topic + + + + Change the topic for channel channel on + the server connected to by connection to + new_topic. + + + + + + + ircg_channel_mode + + Set channel mode flags for user + + + + Description + + + boolean ircg_channel_mode + resource connection + string channel + string mode_spec + string nick + + + + Set channel mode flags for channel on + server connected to by channel. Mode flags + are passed in mode_spec and are applied to + the user specified by nick. + + + Mode flags are set or cleared by specifind a mode character and + prepending it with a plus or minus character + respectively. E.g. operator mode is granted by '+o' and revoked + by '-o' passed as mode_spec. + + + See also: + + + + + + + ircg_html_encode + + Encode HTML preserving output modes as ... + + + + Description + + + boolean ircg_html_encode + string html_string + + + + ... + + + See also: + + + + + + + ircg_whois + + Query user information for nick on server + + + + Description + + + boolean ircg_whois + resource connection + string nick + + + + + + + See also: + + + + + + + ircg_kick + + Kick a user out of a channel on server + + + + Description + + + boolean ircg_kick + resource connection + string channel + string nick + string reason + + + + Kick user nick from + channel on server connected to by + connection. reason + should give a short message describing why this action was performed. + + + + + + + ircg_ignore_add + + Add a user to your ignore list on a server + + + + Description + + + boolean ircg_ignore_add + resource connection + string nick + + + + This function will add user nick to your + ignore list on the server connected to by + connection. By doing so you will suppress + all messages from this user from being send to you. + + + See also: ircg_ignore_del . + + + + + + + ircg_ignore_del + + Remove a user from your ignore list on a server + + + + Description + + + boolean ircg_ignore_del + resource connection + string nick + + + + This function remove user nick to your + ignore list on the server connected to by + connection. + + + See also: ircg_ignore_add. + + + + + + + ircg_disconnect + + Close connection to server + + + + Description + + + boolean ircg_disconnect + resource connection + string reason + + + + ircg_disconnect will close a + connection to a server previously + established with ircg-pconnect. + + + See also: ircg_pconnect. + + + + + + + ircg_is_conn_alive + + Check connection status + + + + Description + + + boolean ircg_is_conn_alive + resource connection + + + + ircg_is_conn_alive returns true if + connection is still alive and working or + false if the server no longer talks to us. + + + + + + + ircg_lookup_format_messages + + Select a set of format strings for display of IRC messages + + + + Description + + + boolean ircg_lookup_format_messages + string name + + + + Select the set of format strings to use for display of IRC + messages and events. Sets may be registered with + ircg_register_format_messages, a default set + named ircg is always available. + + + See also: ircg_register_format_messages + + + + + + + ircg_register_format_messages + + Register a set of format strings for display of IRC messages + + + + Description + + + boolean ircg_register_format_messages + string name + array messages + + + + With ircg_register_format_messages you can + customize the way your IRC output looks like. You can even + register different format string sets and switch between them on + the fly with ircg_lookup_format_messages. + + + + Plain channel message + Private message received + Private message sent + Some user leaves channel + Some user enters channel + Some user was kicked from the channel + Topic has been changed + Error + Fatal error + Join list end(?) + Self part(?) + Some user changes his nick + Some user quits his connection + Mass join begin + Mass join element + Mass join end + Whois user + Whois server + Whois server + Whois idle + Whois channel + Whois end + Voice status change on user + Operator status change on user + Banlist + Banlist end + + + %f - from + %t - to + %c - channel + %r - plain message + %m - encoded message + %j - js encoded message + + + 1 - mod encode + 2 - nickname decode + + + + See also: ircg_lookup_format_messages. + + + + + + +