From 6a7bf552bdbc4c7b023c8300dea76884ade4a557 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Sun, 10 Jun 2007 22:23:59 +0000 Subject: [PATCH] WS, prepare for new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@237370 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../ircg/functions/ircg-channel-mode.xml | 60 ++++--- reference/ircg/functions/ircg-disconnect.xml | 48 +++--- .../functions/ircg-eval-ecmascript-params.xml | 8 +- .../ircg/functions/ircg-fetch-error-msg.xml | 68 ++++---- .../ircg/functions/ircg-get-username.xml | 42 +++-- reference/ircg/functions/ircg-html-encode.xml | 48 +++--- reference/ircg/functions/ircg-ignore-add.xml | 50 +++--- reference/ircg/functions/ircg-ignore-del.xml | 46 +++--- reference/ircg/functions/ircg-invite.xml | 8 +- .../ircg/functions/ircg-is-conn-alive.xml | 40 +++-- reference/ircg/functions/ircg-join.xml | 44 +++--- reference/ircg/functions/ircg-kick.xml | 50 +++--- reference/ircg/functions/ircg-list.xml | 76 ++++----- .../functions/ircg-lookup-format-messages.xml | 50 +++--- reference/ircg/functions/ircg-msg.xml | 68 ++++---- reference/ircg/functions/ircg-names.xml | 4 +- reference/ircg/functions/ircg-nick.xml | 48 +++--- .../ircg/functions/ircg-nickname-escape.xml | 44 +++--- .../ircg/functions/ircg-nickname-unescape.xml | 44 +++--- reference/ircg/functions/ircg-notice.xml | 48 +++--- reference/ircg/functions/ircg-part.xml | 40 +++-- reference/ircg/functions/ircg-pconnect.xml | 124 ++++++++------- .../ircg-register-format-messages.xml | 146 +++++++++--------- reference/ircg/functions/ircg-set-current.xml | 50 +++--- reference/ircg/functions/ircg-set-file.xml | 44 +++--- reference/ircg/functions/ircg-set-on-die.xml | 60 ++++--- reference/ircg/functions/ircg-topic.xml | 44 +++--- reference/ircg/functions/ircg-whois.xml | 42 +++-- 28 files changed, 698 insertions(+), 746 deletions(-) diff --git a/reference/ircg/functions/ircg-channel-mode.xml b/reference/ircg/functions/ircg-channel-mode.xml index 4f1c476013..e06f807e74 100644 --- a/reference/ircg/functions/ircg-channel-mode.xml +++ b/reference/ircg/functions/ircg-channel-mode.xml @@ -1,36 +1,34 @@ - + - - - ircg_channel_mode - - Set channel mode flags for user - - - - Description - - boolircg_channel_mode - resourceconnection - stringchannel - stringmode_spec - stringnick - - - Set channel mode flags for channel on - server connected to by connection. Mode flags - are passed in mode_spec and are applied to - the user specified by nick. - - - Mode flags are set or cleared by specifying 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', as passed as mode_spec. - - - + + + ircg_channel_mode + Set channel mode flags for user + + + Description + + boolircg_channel_mode + resourceconnection + stringchannel + stringmode_spec + stringnick + + + Set channel mode flags for channel on + server connected to by connection. Mode flags + are passed in mode_spec and are applied to + the user specified by nick. + + + Mode flags are set or cleared by specifying 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', as passed as mode_spec. + + + + - - - ircg_disconnect - - Close connection to server - - - - Description - - boolircg_disconnect - resourceconnection - stringreason - - - ircg_disconnect will close a - connection to a server previously - established with ircg_pconnect. - - - See also: ircg_pconnect. - - - + + + ircg_disconnect + Close connection to server + + + Description + + boolircg_disconnect + resourceconnection + stringreason + + + ircg_disconnect will close a + connection to a server previously + established with ircg_pconnect. + + + See also: ircg_pconnect. + + + + ircg_eval_ecmascript_params @@ -11,7 +11,7 @@ arrayircg_eval_ecmascript_params stringparams - + &warn.undocumented.func; @@ -24,9 +24,9 @@ * State 4: Looking for ",", skipping whitespace */ - + - See also + See also ircg_lookup_format_messages. diff --git a/reference/ircg/functions/ircg-fetch-error-msg.xml b/reference/ircg/functions/ircg-fetch-error-msg.xml index 6ee99d7aa5..158bed3f78 100644 --- a/reference/ircg/functions/ircg-fetch-error-msg.xml +++ b/reference/ircg/functions/ircg-fetch-error-msg.xml @@ -1,48 +1,46 @@ - + - - - ircg_fetch_error_msg - - Returns the error from previous IRCG operation - - - - Description - - arrayircg_fetch_error_msg - resourceconnection - - - ircg_fetch_error_msg returns the error from - a failed connection. - - - - Error code is stored in first array element, error text in second. - The error code is equivalent to IRC reply codes as defined by - RFC 2812. - - - - - <function>ircg_fetch_error_msg</function> example - + + + ircg_fetch_error_msg + Returns the error from previous IRCG operation + + + Description + + arrayircg_fetch_error_msg + resourceconnection + + + ircg_fetch_error_msg returns the error from + a failed connection. + + + + Error code is stored in first array element, error text in second. + The error code is equivalent to IRC reply codes as defined by + RFC 2812. + + + + + <function>ircg_fetch_error_msg</function> example + ]]> - - - - - + + + + + + - - - ircg_get_username - - Get username for connection - - - - Description - - stringircg_get_username - resourceconnection - - - Function ircg_get_username returns the - username for the specified connection connection. - Returns &false; if connection died or is - not valid. - - - + + + ircg_get_username + Get username for connection + + + Description + + stringircg_get_username + resourceconnection + + + Function ircg_get_username returns the + username for the specified connection connection. + Returns &false; if connection died or is + not valid. + + + + - - - ircg_html_encode - - Encodes HTML preserving output - - - - Description - - stringircg_html_encode - stringhtml_string - boolauto_links - boolconv_br - - - Encodes a HTML string html_string for - output. This exposes the interface which the IRCG extension - uses internally to reformat data coming from an IRC link. - The function causes IRC color/font codes to be encoded in - HTML and escapes certain entities. - - - + + + ircg_html_encode + Encodes HTML preserving output + + + Description + + stringircg_html_encode + stringhtml_string + boolauto_links + boolconv_br + + + Encodes a HTML string html_string for + output. This exposes the interface which the IRCG extension + uses internally to reformat data coming from an IRC link. + The function causes IRC color/font codes to be encoded in + HTML and escapes certain entities. + + + + - - - ircg_ignore_add - - Add a user to your ignore list on a server - - - - Description - - voidircg_ignore_add - resourceconnection - stringnick - - - This function adds user nick to the - ignore list of connection - connection. Afterwards, IRCG will suppress - all messages from this user through the associated connection. - - - See also: ircg_ignore_del. - - - + + + ircg_ignore_add + Add a user to your ignore list on a server + + + Description + + voidircg_ignore_add + resourceconnection + stringnick + + + This function adds user nick to the + ignore list of connection + connection. Afterwards, IRCG will suppress + all messages from this user through the associated connection. + + + See also: ircg_ignore_del. + + + + - - - ircg_ignore_del - - Remove a user from your ignore list on a server - - - - Description - - boolircg_ignore_del - resourceconnection - stringnick - - - This function removes user nick from the IRCG - ignore list associated with connection. - - - See also: ircg_ignore_add. - - - + + + ircg_ignore_del + Remove a user from your ignore list on a server + + + Description + + boolircg_ignore_del + resourceconnection + stringnick + + + This function removes user nick from the IRCG + ignore list associated with connection. + + + See also: ircg_ignore_add. + + + + ircg_invite @@ -9,9 +9,9 @@ Description boolircg_invite - resourceconnection - stringchannel - stringnickname + resourceconnection + stringchannel + stringnickname ircg_invite will send an invitation to the diff --git a/reference/ircg/functions/ircg-is-conn-alive.xml b/reference/ircg/functions/ircg-is-conn-alive.xml index b05337c405..46502c86df 100644 --- a/reference/ircg/functions/ircg-is-conn-alive.xml +++ b/reference/ircg/functions/ircg-is-conn-alive.xml @@ -1,26 +1,24 @@ - + - - - ircg_is_conn_alive - - Check connection status - - - - Description - - boolircg_is_conn_alive - resourceconnection - - - ircg_is_conn_alive returns &true; if - connection is still alive and working or - &false;, if the connection has died for some reason. - - - + + + ircg_is_conn_alive + Check connection status + + + Description + + boolircg_is_conn_alive + resourceconnection + + + ircg_is_conn_alive returns &true; if + connection is still alive and working or + &false;, if the connection has died for some reason. + + + + - - - ircg_join - - Join a channel on a connected server - - - - Description - - boolircg_join - resourceconnection - stringchannel - stringkey - - - Join the channel channel on the server - connected to by connection. IRCG will - optionally pass the room key key. - - - + + + ircg_join + Join a channel on a connected server + + + Description + + boolircg_join + resourceconnection + stringchannel + stringkey + + + Join the channel channel on the server + connected to by connection. IRCG will + optionally pass the room key key. + + + + - - - ircg_kick - - Kick a user out of a channel on server - - - - Description - - boolircg_kick - resourceconnection - stringchannel - stringnick - stringreason - - - Kick user nick from - channel on server connected to by - connection. reason - should give a short message describing why this action was - performed. - - - + + + ircg_kick + Kick a user out of a channel on server + + + Description + + boolircg_kick + resourceconnection + stringchannel + stringnick + stringreason + + + Kick user nick from + channel on server connected to by + connection. reason + should give a short message describing why this action was + performed. + + + + - - ircg_list - List topic/user count of channel(s) - - - Description - - boolircg_list - resourceconnection - stringchannel - - - ircg_list will request a list of users in the - channel. The answer is sent to the output - defined by ircg_set_file or - ircg_set_current. - &return.success; - - - - <function>ircg_list</function> example - + + ircg_list + List topic/user count of channel(s) + + + Description + + boolircg_list + resourceconnection + stringchannel + + + ircg_list will request a list of users in the + channel. The answer is sent to the output + defined by ircg_set_file or + ircg_set_current. + &return.success; + + + + <function>ircg_list</function> example + ]]> - - - This example will output something similar to: - - + + + This example will output something similar to: + + - - - - - See also: ircg_set_file, - ircg_set_current, and - ircg_who. - - - + + + + + See also: ircg_set_file, + ircg_set_current, and + ircg_who. + + + + - - - ircg_lookup_format_messages - - Check for the existence of a format message set - - - - Description - - boolircg_lookup_format_messages - stringname - - - Check for the existence of the format message set - name. Sets may be registered with - ircg_register_format_messages, a default set - named ircg is always available. Returns &true;, - if the set exists and &false; otherwise. - - - See also: ircg_register_format_messages - - - + + + ircg_lookup_format_messages + Check for the existence of a format message set + + + Description + + boolircg_lookup_format_messages + stringname + + + Check for the existence of the format message set + name. Sets may be registered with + ircg_register_format_messages, a default set + named ircg is always available. Returns &true;, + if the set exists and &false; otherwise. + + + See also: ircg_register_format_messages + + + + - - - ircg_msg - - Send message to channel or user on server - - - - Description - - boolircg_msg - resourceconnection - stringrecipient - stringmessage - boolsuppress - - - 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. This so-called loopback is - necessary, because the IRC server does not echo PRIVMSG commands - back to us. - - - + + + ircg_msg + Send message to channel or user on server + + + Description + + boolircg_msg + resourceconnection + stringrecipient + stringmessage + boolsuppress + + + 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. This so-called loopback is + necessary, because the IRC server does not echo PRIVMSG commands + back to us. + + + + ircg_names @@ -19,7 +19,7 @@ - See also + See also ircg_get_username and ircg_lusers. diff --git a/reference/ircg/functions/ircg-nick.xml b/reference/ircg/functions/ircg-nick.xml index fa4cf4cabd..a249fa1c1e 100644 --- a/reference/ircg/functions/ircg-nick.xml +++ b/reference/ircg/functions/ircg-nick.xml @@ -1,30 +1,28 @@ - + - - - ircg_nick - - Change nickname on server - - - - Description - - boolircg_nick - resourceconnection - stringnick - - - 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_nick + Change nickname on server + + + Description + + boolircg_nick + resourceconnection + stringnick + + + 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_nickname_escape - - Encode special characters in nickname to be IRC-compliant - - - - Description - - stringircg_nickname_escape - stringnick - - - Function ircg_nickname_escape returns an encoded - nickname specified by nick which is IRC-compliant. - - - See also: ircg_nickname_unescape - - - + + + ircg_nickname_escape + Encode special characters in nickname to be IRC-compliant + + + Description + + stringircg_nickname_escape + stringnick + + + Function ircg_nickname_escape returns an encoded + nickname specified by nick which is IRC-compliant. + + + See also: ircg_nickname_unescape + + + + - - - ircg_nickname_unescape - - Decodes encoded nickname - - - - Description - - stringircg_nickname_unescape - stringnick - - - Function ircg_nickname_unescape returns a - decoded nickname, which is specified in nick. - - - See also: ircg_nickname_escape - - - + + + ircg_nickname_unescape + Decodes encoded nickname + + + Description + + stringircg_nickname_unescape + stringnick + + + Function ircg_nickname_unescape returns a + decoded nickname, which is specified in nick. + + + See also: ircg_nickname_escape + + + + - - - ircg_notice - - Send a notice to a user on server - - - - Description - - boolircg_notice - resourceconnection - stringnick - stringmessage - - - This function will send the message text - to the user nick on the server connected - to by connection. IRC servers and other - software will not automatically generate replies to NOTICEs - in contrast to other message types. - - - + + + ircg_notice + Send a notice to a user on server + + + Description + + boolircg_notice + resourceconnection + stringnick + stringmessage + + + This function will send the message text + to the user nick on the server connected + to by connection. IRC servers and other + software will not automatically generate replies to NOTICEs + in contrast to other message types. + + + + - - - ircg_part - - Leave a channel on server - - - - Description - - boolircg_part - resourceconnection - stringchannel - - - Leave the channel channel on the server - connected to by connection. - - - + + + ircg_part + Leave a channel on server + + + Description + + boolircg_part + resourceconnection + stringchannel + + + Leave the channel channel on the server + connected to by connection. + + + + - - - ircg_pconnect - - Connect to an IRC server - - - - Description - - resourceircg_pconnect - stringusername - stringserver_ip - intserver_port - stringmsg_format - arrayctcp_messages - arrayuser_settings - boolbailout_on_trivial - + + + ircg_pconnect + Connect to an IRC server + + + Description + + resourceircg_pconnect + stringusername + stringserver_ip + intserver_port + stringmsg_format + arrayctcp_messages + arrayuser_settings + boolbailout_on_trivial + + + 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 nickname on the + server. server_ip and + server_port are optional and default to + 127.0.0.1 and 6667. + - ircg_pconnect will try to establish a - connection to an IRC server and return a connection resource - handle for further use. + For now parameter server_ip will not do + any hostname lookups and will only accept IP addresses in + numerical form. DNS lookups are expensive and should be done in the + context of IRCG. - - The only mandatory parameter is username, - this will set your initial nickname 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. DNS lookups are expensive and should be done in the - context of IRCG. - - - - - You can customize the output of IRC messages and events by - selecting a format message set previously created with - ircg_register_format_messages by specifying - the set's name in msg_format. - - - If you want to handle CTCP messages such as ACTION (/me), you need to - define a mapping from CTCP type (e.g. ACTION) to a custom format - string. Do this by passing an associative array as - ctcp_messages. The keys of the array - are the CTCP type and the respective value is the format message. - - - You can define "ident", "password", and "realname" tokens which - are sent to the IRC server by setting these in an associative - array. Pass that array as user_settings. - - - See also: ircg_disconnect, - ircg_is_conn_alive, - ircg_register_format_messages. - - - + + + + You can customize the output of IRC messages and events by + selecting a format message set previously created with + ircg_register_format_messages by specifying + the set's name in msg_format. + + + If you want to handle CTCP messages such as ACTION (/me), you need to + define a mapping from CTCP type (e.g. ACTION) to a custom format + string. Do this by passing an associative array as + ctcp_messages. The keys of the array + are the CTCP type and the respective value is the format message. + + + You can define "ident", "password", and "realname" tokens which + are sent to the IRC server by setting these in an associative + array. Pass that array as user_settings. + + + See also: ircg_disconnect, + ircg_is_conn_alive, + ircg_register_format_messages. + + + + - - - ircg_register_format_messages - - Register a format message set - - - - Description - - boolircg_register_format_messages - stringname - arraymessages - - - With ircg_register_format_messages you can - customize the way your IRC output looks like or which script - functions are invoked on the client side. - - - - 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 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. - - - + + + ircg_register_format_messages + Register a format message set + + + Description + + boolircg_register_format_messages + stringname + arraymessages + + + With ircg_register_format_messages you can + customize the way your IRC output looks like or which script + functions are invoked on the client side. + + + + 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 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. + + + + - - - ircg_set_current - - Set current connection for output - - - - Description - - boolircg_set_current - resourceconnection - - - Select the current HTTP 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 formatting or a format message set - specified by ircg_register_format_messages. - - - See also: ircg_register_format_messages. - - - + + + ircg_set_current + Set current connection for output + + + Description + + boolircg_set_current + resourceconnection + + + Select the current HTTP 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 formatting or a format message set + specified by ircg_register_format_messages. + + + See also: ircg_register_format_messages. + + + + - - - ircg_set_file - - Set logfile for connection - - - - Description - - boolircg_set_file - resourceconnection - stringpath - - - Function ircg_set_file specifies a logfile - path in which all output from connection - connection will be logged. - Returns &true; on success, otherwise &false;. - - - + + + ircg_set_file + Set logfile for connection + + + Description + + boolircg_set_file + resourceconnection + stringpath + + + Function ircg_set_file specifies a logfile + path in which all output from connection + connection will be logged. + Returns &true; on success, otherwise &false;. + + + + - - - ircg_set_on_die - - Set action to be executed when connection dies - - - - Description - - boolircg_set_on_die - resourceconnection - stringhost - intport - stringdata - - - In case of the termination of connection connection - IRCG will connect to host at - port (Note: host must be an IPv4 address, - IRCG does not resolve host-names due to blocking issues), send - data to the new host connection and will - wait until the remote part closes connection. This can be used to - trigger a PHP script for example. - - - This feature requires IRCG 3. - - - + + + ircg_set_on_die + Set action to be executed when connection dies + + + Description + + boolircg_set_on_die + resourceconnection + stringhost + intport + stringdata + + + In case of the termination of connection connection + IRCG will connect to host at + port (Note: host must be an IPv4 address, + IRCG does not resolve host-names due to blocking issues), send + data to the new host connection and will + wait until the remote part closes connection. This can be used to + trigger a PHP script for example. + + + This feature requires IRCG 3. + + + + - - - ircg_topic - - Set topic for channel on server - - - - Description - - boolircg_topic - resourceconnection - stringchannel - stringnew_topic - - - Change the topic for channel channel on - the server connected to by connection to - new_topic. - - - + + + ircg_topic + Set topic for channel on server + + + Description + + boolircg_topic + resourceconnection + stringchannel + stringnew_topic + + + Change the topic for channel channel on + the server connected to by connection to + new_topic. + + + + - - - ircg_whois - - Query server for user information - - - - Description - - boolircg_whois - resourceconnection - stringnick - - - Sends a query to the connected server - connection to ask for information about the - specified user nick. - - - + + + ircg_whois + Query server for user information + + + Description + + boolircg_whois + resourceconnection + stringnick + + + Sends a query to the connected server + connection to ask for information about the + specified user nick. + + +