mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-17 01:18:55 +00:00
Only whitespace.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@56025 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Egon Schmid
parent
f6545ca4d4
commit
3a09637b00
1 changed files with 236 additions and 211 deletions
|
|
@ -1,22 +1,22 @@
|
|||
<?xml encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<reference id="ref.ircg">
|
||||
<title>IRC Gateway Functions</title>
|
||||
<titleabbrev>IRC Gateway</titleabbrev>
|
||||
<partintro>
|
||||
<para>
|
||||
Internet Relay Chat Gateway ...
|
||||
</para>
|
||||
<para>
|
||||
Based on <ulink url="&url.ircg;">IRCG</ulink>, from Sascha Schumann.
|
||||
</para>
|
||||
<para>
|
||||
Internet Relay Chat Gateway ...
|
||||
</para>
|
||||
<para>
|
||||
Based on <ulink url="&url.ircg;">IRCG</ulink>, from Sascha Schumann.
|
||||
</para>
|
||||
</partintro>
|
||||
|
||||
<refentry id="function.ircg-pconnect">
|
||||
<refnamediv>
|
||||
<refname>ircg_pconnect</refname>
|
||||
<refpurpose>
|
||||
Connect to an IRC server
|
||||
Connect to an IRC server
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
|
|
@ -25,48 +25,58 @@
|
|||
<funcprototype>
|
||||
<funcdef>resource <function>ircg_pconnect</function></funcdef>
|
||||
<paramdef>string <parameter>username</parameter></paramdef>
|
||||
<paramdef>string <parameter><optional>server_ip</optional></parameter></paramdef>
|
||||
<paramdef>int <parameter><optional>server_port</optional></parameter></paramdef>
|
||||
<paramdef>string <parameter><optional>msg_format</optional></parameter></paramdef>
|
||||
<paramdef>array <parameter><optional>ctcp_messages</optional></parameter></paramdef>
|
||||
<paramdef>array <parameter><optional>user_settings</optional></parameter></paramdef>
|
||||
<paramdef>string
|
||||
<parameter><optional>server_ip</optional></parameter>
|
||||
</paramdef>
|
||||
<paramdef>int
|
||||
<parameter><optional>server_port</optional></parameter>
|
||||
</paramdef>
|
||||
<paramdef>string
|
||||
<parameter><optional>msg_format</optional></parameter>
|
||||
</paramdef>
|
||||
<paramdef>array
|
||||
<parameter><optional>ctcp_messages</optional></parameter>
|
||||
</paramdef>
|
||||
<paramdef>array
|
||||
<parameter><optional>user_settings</optional></parameter>
|
||||
</paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
<function>ircg_pconnect</function> will try to establish a connection to
|
||||
an IRC server and return a connection resource handle for further
|
||||
use.
|
||||
<function>ircg_pconnect</function> will try to establish a
|
||||
connection to an IRC server and return a connection resource
|
||||
handle for further use.
|
||||
</para>
|
||||
<para>
|
||||
The only mandatory parameter is <parameter>username</parameter>,
|
||||
this will set your initial nickname on the
|
||||
server. <parameter>server_ip</parameter> and
|
||||
<parameter>server_port</parameter> are optional and default to
|
||||
<literal>127.0.0.1</literal> and <literal>6667</literal>.
|
||||
<note>
|
||||
<para>
|
||||
For now parameter <parameter>server_ip</parameter> will not do
|
||||
any hostname lookups and will only accept IP addresses in
|
||||
numerical form.
|
||||
</para>
|
||||
</note>
|
||||
</para>
|
||||
<para>
|
||||
You can customize the output of IRC messages and events by
|
||||
selection a format string set previously created with
|
||||
<function>ircg_register_format_messages</function> by specifing
|
||||
the sets name in <parameter>msg_format</parameter>.
|
||||
</para>
|
||||
<para>
|
||||
<parameter>ctcp_messages</parameter>
|
||||
</para>
|
||||
<para>
|
||||
<parameter>user_settings</parameter>
|
||||
</para>
|
||||
<para>
|
||||
The only mandatory parameter is <parameter>username</parameter>,
|
||||
this will set your initial nickname on the
|
||||
server. <parameter>server_ip</parameter> and
|
||||
<parameter>server_port</parameter> are optional and default to
|
||||
<literal>127.0.0.1</literal> and <literal>6667</literal>.
|
||||
<note>
|
||||
<para>
|
||||
For now parameter <parameter>server_ip</parameter> will not do
|
||||
any hostname lookups and will only accept IP addresses in
|
||||
numerical form.
|
||||
</para>
|
||||
</note>
|
||||
</para>
|
||||
<para>
|
||||
You can customize the output of IRC messages and events by
|
||||
selection a format string set previously created with
|
||||
<function>ircg_register_format_messages</function>
|
||||
by specifing the sets name in <parameter>msg_format</parameter>.
|
||||
</para>
|
||||
<para>
|
||||
<parameter>ctcp_messages</parameter>
|
||||
</para>
|
||||
<para>
|
||||
<parameter>user_settings</parameter>
|
||||
</para>
|
||||
<para>
|
||||
See also: <function>ircg_disconnect</function>,
|
||||
<function>ircg_is_conn_alive</function>,
|
||||
<function>ircg_register_format_messages</function>.
|
||||
<function>ircg_is_conn_alive</function>,
|
||||
<function>ircg_register_format_messages</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
@ -74,7 +84,7 @@
|
|||
<refnamediv>
|
||||
<refname>ircg_fetch_error_msg</refname>
|
||||
<refpurpose>
|
||||
Returns the error from previous ircg operation
|
||||
Returns the error from previous ircg operation
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
|
|
@ -86,32 +96,33 @@
|
|||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
<function>ircg_fetch_error_msg</function>
|
||||
returns the error from the last called ircg function.
|
||||
<function>ircg_fetch_error_msg</function> returns the error from
|
||||
the last called ircg function.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
Errorcode is stored in first array element, errortext in second.
|
||||
</para>
|
||||
</note>
|
||||
<note>
|
||||
<para>
|
||||
Errorcode is stored in first array element, errortext in second.
|
||||
</para>
|
||||
</note>
|
||||
<para>
|
||||
<example>
|
||||
<title><function>ircg_fetch_error_msg</function> example</title>
|
||||
<programlisting role="php">
|
||||
<title><function>ircg_fetch_error_msg</function> example</title>
|
||||
<programlisting role="php">
|
||||
if (!ircg_join ($id, "#php")){
|
||||
$error = ircg_fetch_error_msg($id);
|
||||
print ("Can't join channel #php. Errorcode: $error[0] Description: $error[1]");
|
||||
print ("Can't join channel #php. Errorcode:
|
||||
$error[0] Description: $error[1]");
|
||||
}
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
<refentry id="function.ircg-set-current">
|
||||
<refnamediv>
|
||||
<refname>ircg_set_current</refname>
|
||||
<refpurpose>
|
||||
Set current connection for output
|
||||
Set current connection for output
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
|
|
@ -120,20 +131,20 @@ if (!ircg_join ($id, "#php")){
|
|||
<funcprototype>
|
||||
<funcdef>boolean <function>ircg_set_current</function></funcdef>
|
||||
<paramdef>resource
|
||||
<parameter>connection</parameter></paramdef>
|
||||
<parameter>connection</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
Select the current connection for output in this execution
|
||||
context. Every output sent from the server connected to by
|
||||
<parameter>connection</parameter> will be copied to standard
|
||||
output while using default formating or a formar string set
|
||||
specified by <function>ircg_register_format_messages</function>
|
||||
and selected by <function>ircg_lookup_format_messages</function>.
|
||||
Select the current connection for output in this execution
|
||||
context. Every output sent from the server connected to by
|
||||
<parameter>connection</parameter> will be copied to standard
|
||||
output while using default formating or a formar string set
|
||||
specified by <function>ircg_register_format_messages</function>
|
||||
and selected by <function>ircg_lookup_format_messages</function>.
|
||||
</para>
|
||||
<para>
|
||||
See also: <function>ircg_register_format_messages</function> and
|
||||
<function>ircg_lookup_format_messages</function>.
|
||||
<function>ircg_lookup_format_messages</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
@ -142,7 +153,7 @@ if (!ircg_join ($id, "#php")){
|
|||
<refnamediv>
|
||||
<refname>ircg_join</refname>
|
||||
<refpurpose>
|
||||
Join a channel on a connected server
|
||||
Join a channel on a connected server
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
|
|
@ -151,12 +162,12 @@ if (!ircg_join ($id, "#php")){
|
|||
<funcprototype>
|
||||
<funcdef>boolean <function>ircg_join</function></funcdef>
|
||||
<paramdef>resource <parameter>connection</parameter></paramdef>
|
||||
<paramdef>string <parameter>channel</parameter></paramdef>
|
||||
<paramdef>string <parameter>channel</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
Join the channel <parameter>channel</parameter> on the server
|
||||
connected to by <parameter>connection</parameter>.
|
||||
Join the channel <parameter>channel</parameter> on the server
|
||||
connected to by <parameter>connection</parameter>.
|
||||
</para>
|
||||
<para>
|
||||
See also:
|
||||
|
|
@ -168,7 +179,7 @@ if (!ircg_join ($id, "#php")){
|
|||
<refnamediv>
|
||||
<refname>ircg_part</refname>
|
||||
<refpurpose>
|
||||
Leave a channel on server
|
||||
Leave a channel on server
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
|
|
@ -177,12 +188,12 @@ if (!ircg_join ($id, "#php")){
|
|||
<funcprototype>
|
||||
<funcdef>boolean <function>ircg_part</function></funcdef>
|
||||
<paramdef>resource <parameter>connection</parameter></paramdef>
|
||||
<paramdef>string <parameter>channel</parameter></paramdef>
|
||||
<paramdef>string <parameter>channel</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
Leave the channel <parameter>channel</parameter> on the server
|
||||
connected to by <parameter>connection</parameter>.
|
||||
Leave the channel <parameter>channel</parameter> on the server
|
||||
connected to by <parameter>connection</parameter>.
|
||||
</para>
|
||||
<para>
|
||||
See also:
|
||||
|
|
@ -194,7 +205,7 @@ if (!ircg_join ($id, "#php")){
|
|||
<refnamediv>
|
||||
<refname>ircg_msg</refname>
|
||||
<refpurpose>
|
||||
Send message to channel or user on server
|
||||
Send message to channel or user on server
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
|
|
@ -203,24 +214,26 @@ if (!ircg_join ($id, "#php")){
|
|||
<funcprototype>
|
||||
<funcdef>boolean <function>ircg_msg</function></funcdef>
|
||||
<paramdef>resource <parameter>connection</parameter></paramdef>
|
||||
<paramdef>string <parameter>recipient</parameter></paramdef>
|
||||
<paramdef>string <parameter>message</parameter></paramdef>
|
||||
<paramdef>boolean <parameter><optional>suppress</optional></parameter></paramdef>
|
||||
<paramdef>string <parameter>recipient</parameter></paramdef>
|
||||
<paramdef>string <parameter>message</parameter></paramdef>
|
||||
<paramdef>boolean
|
||||
<parameter><optional>suppress</optional></parameter>
|
||||
</paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
<function>ircg_msg</function> will send the message to a channel
|
||||
or user on the server connected to by
|
||||
<parameter>connection</parameter>. A
|
||||
<parameter>recipient</parameter> starting with
|
||||
<literal>#</literal> or <literal>&</literal> will send the
|
||||
<parameter>message</parameter> to a channel, anything else will
|
||||
be interpreted as a username.
|
||||
<function>ircg_msg</function> will send the message to a channel
|
||||
or user on the server connected to by
|
||||
<parameter>connection</parameter>. A
|
||||
<parameter>recipient</parameter> starting with
|
||||
<literal>#</literal> or <literal>&</literal> will send the
|
||||
<parameter>message</parameter> to a channel, anything else will
|
||||
be interpreted as a username.
|
||||
</para>
|
||||
<para>
|
||||
Setting the optional parameter <parameter>suppress</parameter> to
|
||||
a &true; value will suppress output of your message to your own
|
||||
<parameter>connection</parameter>.
|
||||
Setting the optional parameter <parameter>suppress</parameter> to
|
||||
a &true; value will suppress output of your message to your own
|
||||
<parameter>connection</parameter>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
@ -229,7 +242,7 @@ if (!ircg_join ($id, "#php")){
|
|||
<refnamediv>
|
||||
<refname>ircg_notice</refname>
|
||||
<refpurpose>
|
||||
Send a notice to a user on server
|
||||
Send a notice to a user on server
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
|
|
@ -238,19 +251,19 @@ if (!ircg_join ($id, "#php")){
|
|||
<funcprototype>
|
||||
<funcdef>boolean <function>ircg_notice</function></funcdef>
|
||||
<paramdef>resource <parameter>connection</parameter></paramdef>
|
||||
<paramdef>string <parameter></parameter></paramdef>
|
||||
<paramdef>string <parameter>message</parameter></paramdef>
|
||||
<paramdef>string <parameter></parameter></paramdef>
|
||||
<paramdef>string <parameter>message</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
This function will send the <parameter>message</parameter> text
|
||||
to the user <parameter>nick</parameter> on the server connected
|
||||
to by <parameter>connection</parameter>. Query your IRC
|
||||
documentation of choice for the exact difference between a MSG
|
||||
and a NOTICE.
|
||||
This function will send the <parameter>message</parameter> text
|
||||
to the user <parameter>nick</parameter> on the server connected
|
||||
to by <parameter>connection</parameter>. Query your IRC
|
||||
documentation of choice for the exact difference between a MSG
|
||||
and a NOTICE.
|
||||
</para>
|
||||
<para>
|
||||
See also:
|
||||
See also <!-- what -->:
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
@ -259,7 +272,7 @@ if (!ircg_join ($id, "#php")){
|
|||
<refnamediv>
|
||||
<refname>ircg_nick</refname>
|
||||
<refpurpose>
|
||||
Change nickname on server
|
||||
Change nickname on server
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
|
|
@ -268,16 +281,16 @@ if (!ircg_join ($id, "#php")){
|
|||
<funcprototype>
|
||||
<funcdef>boolean <function>ircg_nick</function></funcdef>
|
||||
<paramdef>resource <parameter>connection</parameter></paramdef>
|
||||
<paramdef>string <parameter>nick</parameter></paramdef>
|
||||
<paramdef>string <parameter>nick</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
Change your nickname on the given
|
||||
<parameter>connection</parameter> to the one given in
|
||||
<parameter>nick</parameter> if possible.
|
||||
Change your nickname on the given
|
||||
<parameter>connection</parameter> to the one given in
|
||||
<parameter>nick</parameter> if possible.
|
||||
</para>
|
||||
<para>
|
||||
Will return &true; on success and &false; on failure.
|
||||
Will return &true; on success and &false; on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
@ -286,7 +299,7 @@ if (!ircg_join ($id, "#php")){
|
|||
<refnamediv>
|
||||
<refname>ircg_topic</refname>
|
||||
<refpurpose>
|
||||
Set topic for channel on server
|
||||
Set topic for channel on server
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
|
|
@ -295,14 +308,14 @@ if (!ircg_join ($id, "#php")){
|
|||
<funcprototype>
|
||||
<funcdef>boolean <function>ircg_topic</function></funcdef>
|
||||
<paramdef>resource <parameter>connection</parameter></paramdef>
|
||||
<paramdef>string <parameter>channel</parameter></paramdef>
|
||||
<paramdef>string <parameter>new_topic</parameter></paramdef>
|
||||
<paramdef>string <parameter>channel</parameter></paramdef>
|
||||
<paramdef>string <parameter>new_topic</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
Change the topic for channel <parameter>channel</parameter> on
|
||||
the server connected to by <parameter>connection</parameter> to
|
||||
<parameter>new_topic</parameter>.
|
||||
Change the topic for channel <parameter>channel</parameter> on
|
||||
the server connected to by <parameter>connection</parameter> to
|
||||
<parameter>new_topic</parameter>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
@ -311,7 +324,7 @@ if (!ircg_join ($id, "#php")){
|
|||
<refnamediv>
|
||||
<refname>ircg_channel_mode</refname>
|
||||
<refpurpose>
|
||||
Set channel mode flags for user
|
||||
Set channel mode flags for user
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
|
|
@ -320,23 +333,22 @@ if (!ircg_join ($id, "#php")){
|
|||
<funcprototype>
|
||||
<funcdef>boolean <function>ircg_channel_mode</function></funcdef>
|
||||
<paramdef>resource <parameter>connection</parameter></paramdef>
|
||||
<paramdef>string <parameter>channel</parameter></paramdef>
|
||||
<paramdef>string <parameter>mode_spec</parameter></paramdef>
|
||||
<paramdef>string <parameter>nick</parameter></paramdef>
|
||||
<paramdef>string <parameter>channel</parameter></paramdef>
|
||||
<paramdef>string <parameter>mode_spec</parameter></paramdef>
|
||||
<paramdef>string <parameter>nick</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
Set channel mode flags for <parameter>channel</parameter> on
|
||||
server connected to by <parameter>channel</parameter>. Mode flags
|
||||
are passed in <parameter>mode_spec</parameter> and are applied to
|
||||
the user specified by <parameter>nick</parameter>.
|
||||
Set channel mode flags for <parameter>channel</parameter> on
|
||||
server connected to by <parameter>channel</parameter>. Mode flags
|
||||
are passed in <parameter>mode_spec</parameter> and are applied to
|
||||
the user specified by <parameter>nick</parameter>.
|
||||
</para>
|
||||
<para>
|
||||
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 <parameter>mode_spec</parameter>.
|
||||
</para>
|
||||
<para>
|
||||
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 <parameter>mode_spec</parameter>. </para>
|
||||
<para>
|
||||
See also:
|
||||
</para>
|
||||
|
|
@ -347,7 +359,7 @@ if (!ircg_join ($id, "#php")){
|
|||
<refnamediv>
|
||||
<refname>ircg_html_encode</refname>
|
||||
<refpurpose>
|
||||
Encode HTML preserving output modes as ...
|
||||
Encode HTML preserving output modes as ...
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
|
|
@ -355,14 +367,14 @@ if (!ircg_join ($id, "#php")){
|
|||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>boolean <function>ircg_html_encode</function></funcdef>
|
||||
<paramdef>string <parameter>html_string</parameter></paramdef>
|
||||
<paramdef>string <parameter>html_string</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
...
|
||||
</para>
|
||||
<para>
|
||||
See also:
|
||||
See also: <!-- what -->
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
@ -371,7 +383,7 @@ if (!ircg_join ($id, "#php")){
|
|||
<refnamediv>
|
||||
<refname>ircg_whois</refname>
|
||||
<refpurpose>
|
||||
Query user information for nick on server
|
||||
Query user information for nick on server
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
|
|
@ -380,7 +392,7 @@ if (!ircg_join ($id, "#php")){
|
|||
<funcprototype>
|
||||
<funcdef>boolean <function>ircg_whois</function></funcdef>
|
||||
<paramdef>resource <parameter>connection</parameter></paramdef>
|
||||
<paramdef>string <parameter>nick</parameter></paramdef>
|
||||
<paramdef>string <parameter>nick</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
|
|
@ -396,7 +408,7 @@ if (!ircg_join ($id, "#php")){
|
|||
<refnamediv>
|
||||
<refname>ircg_kick</refname>
|
||||
<refpurpose>
|
||||
Kick a user out of a channel on server
|
||||
Kick a user out of a channel on server
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
|
|
@ -405,16 +417,17 @@ if (!ircg_join ($id, "#php")){
|
|||
<funcprototype>
|
||||
<funcdef>boolean <function>ircg_kick</function></funcdef>
|
||||
<paramdef>resource <parameter>connection</parameter></paramdef>
|
||||
<paramdef>string <parameter>channel</parameter></paramdef>
|
||||
<paramdef>string <parameter>nick</parameter></paramdef>
|
||||
<paramdef>string <parameter>reason</parameter></paramdef>
|
||||
<paramdef>string <parameter>channel</parameter></paramdef>
|
||||
<paramdef>string <parameter>nick</parameter></paramdef>
|
||||
<paramdef>string <parameter>reason</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
Kick user <parameter>nick</parameter> from
|
||||
<parameter>channel</parameter> on server connected to by
|
||||
<parameter>connection</parameter>. <parameter>reason</parameter>
|
||||
should give a short message describing why this action was performed.
|
||||
Kick user <parameter>nick</parameter> from
|
||||
<parameter>channel</parameter> on server connected to by
|
||||
<parameter>connection</parameter>. <parameter>reason</parameter>
|
||||
should give a short message describing why this action was
|
||||
performed.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
@ -423,7 +436,7 @@ if (!ircg_join ($id, "#php")){
|
|||
<refnamediv>
|
||||
<refname>ircg_ignore_add</refname>
|
||||
<refpurpose>
|
||||
Add a user to your ignore list on a server
|
||||
Add a user to your ignore list on a server
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
|
|
@ -432,14 +445,14 @@ if (!ircg_join ($id, "#php")){
|
|||
<funcprototype>
|
||||
<funcdef>boolean <function>ircg_ignore_add</function></funcdef>
|
||||
<paramdef>resource <parameter>connection</parameter></paramdef>
|
||||
<paramdef>string <parameter>nick</parameter></paramdef>
|
||||
<paramdef>string <parameter>nick</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
This function will add user <parameter>nick</parameter> to your
|
||||
ignore list on the server connected to by
|
||||
<parameter>connection</parameter>. By doing so you will suppress
|
||||
all messages from this user from being send to you.
|
||||
This function will add user <parameter>nick</parameter> to your
|
||||
ignore list on the server connected to by
|
||||
<parameter>connection</parameter>. By doing so you will suppress
|
||||
all messages from this user from being send to you.
|
||||
</para>
|
||||
<para>
|
||||
See also: <function>ircg_ignore_del</function> .
|
||||
|
|
@ -451,7 +464,7 @@ if (!ircg_join ($id, "#php")){
|
|||
<refnamediv>
|
||||
<refname>ircg_ignore_del</refname>
|
||||
<refpurpose>
|
||||
Remove a user from your ignore list on a server
|
||||
Remove a user from your ignore list on a server
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
|
|
@ -460,13 +473,13 @@ if (!ircg_join ($id, "#php")){
|
|||
<funcprototype>
|
||||
<funcdef>boolean <function>ircg_ignore_del</function></funcdef>
|
||||
<paramdef>resource <parameter>connection</parameter></paramdef>
|
||||
<paramdef>string <parameter>nick</parameter></paramdef>
|
||||
<paramdef>string <parameter>nick</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
This function remove user <parameter>nick</parameter> to your
|
||||
ignore list on the server connected to by
|
||||
<parameter>connection</parameter>.
|
||||
This function remove user <parameter>nick</parameter> to your
|
||||
ignore list on the server connected to by
|
||||
<parameter>connection</parameter>.
|
||||
</para>
|
||||
<para>
|
||||
See also: <function>ircg_ignore_add</function>.
|
||||
|
|
@ -478,7 +491,7 @@ if (!ircg_join ($id, "#php")){
|
|||
<refnamediv>
|
||||
<refname>ircg_disconnect</refname>
|
||||
<refpurpose>
|
||||
Close connection to server
|
||||
Close connection to server
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
|
|
@ -487,13 +500,13 @@ if (!ircg_join ($id, "#php")){
|
|||
<funcprototype>
|
||||
<funcdef>boolean <function>ircg_disconnect</function></funcdef>
|
||||
<paramdef>resource <parameter>connection</parameter></paramdef>
|
||||
<paramdef>string <parameter>reason</parameter></paramdef>
|
||||
<paramdef>string <parameter>reason</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
<function>ircg_disconnect</function> will close a
|
||||
<parameter>connection</parameter> to a server previously
|
||||
established with <function>ircg-pconnect</function>.
|
||||
<function>ircg_disconnect</function> will close a
|
||||
<parameter>connection</parameter> to a server previously
|
||||
established with <function>ircg-pconnect</function>.
|
||||
</para>
|
||||
<para>
|
||||
See also: <function>ircg_pconnect</function>.
|
||||
|
|
@ -505,7 +518,7 @@ if (!ircg_join ($id, "#php")){
|
|||
<refnamediv>
|
||||
<refname>ircg_is_conn_alive</refname>
|
||||
<refpurpose>
|
||||
Check connection status
|
||||
Check connection status
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
|
|
@ -517,9 +530,9 @@ if (!ircg_join ($id, "#php")){
|
|||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
<function>ircg_is_conn_alive</function> returns &true; if
|
||||
<parameter>connection</parameter> is still alive and working or
|
||||
&false; if the server no longer talks to us.
|
||||
<function>ircg_is_conn_alive</function> returns &true; if
|
||||
<parameter>connection</parameter> is still alive and working or
|
||||
&false; if the server no longer talks to us.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
@ -528,22 +541,24 @@ if (!ircg_join ($id, "#php")){
|
|||
<refnamediv>
|
||||
<refname>ircg_lookup_format_messages</refname>
|
||||
<refpurpose>
|
||||
Select a set of format strings for display of IRC messages
|
||||
Select a set of format strings for display of IRC messages
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>boolean <function>ircg_lookup_format_messages</function></funcdef>
|
||||
<funcdef>boolean
|
||||
<function>ircg_lookup_format_messages</function>
|
||||
</funcdef>
|
||||
<paramdef>string <parameter>name</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
Select the set of format strings to use for display of IRC
|
||||
messages and events. Sets may be registered with
|
||||
<function>ircg_register_format_messages</function>, a default set
|
||||
named <literal>ircg</literal> is always available.
|
||||
Select the set of format strings to use for display of IRC
|
||||
messages and events. Sets may be registered with
|
||||
<function>ircg_register_format_messages</function>, a default set
|
||||
named <literal>ircg</literal> is always available.
|
||||
</para>
|
||||
<para>
|
||||
See also: <function>ircg_register_format_messages</function>
|
||||
|
|
@ -555,66 +570,76 @@ if (!ircg_join ($id, "#php")){
|
|||
<refnamediv>
|
||||
<refname>ircg_register_format_messages</refname>
|
||||
<refpurpose>
|
||||
Register a set of format strings for display of IRC messages
|
||||
Register a set of format strings for display of IRC messages
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>boolean <function>ircg_register_format_messages</function></funcdef>
|
||||
<funcdef>boolean
|
||||
<function>ircg_register_format_messages</function>
|
||||
</funcdef>
|
||||
<paramdef>string <parameter>name</parameter></paramdef>
|
||||
<paramdef>array <parameter>messages</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
With <function>ircg_register_format_messages</function> 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 <function>ircg_lookup_format_messages</function>.
|
||||
With <function>ircg_register_format_messages</function> 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 <function>ircg_lookup_format_messages</function>.
|
||||
</para>
|
||||
<para>
|
||||
<itemizedlist>
|
||||
<listitem><simpara>Plain channel message</simpara></listitem>
|
||||
<listitem><simpara>Private message received</simpara></listitem>
|
||||
<listitem><simpara>Private message sent</simpara></listitem>
|
||||
<listitem><simpara>Some user leaves channel</simpara></listitem>
|
||||
<listitem><simpara>Some user enters channel</simpara></listitem>
|
||||
<listitem>
|
||||
<simpara>Some user was kicked from the channel</simpara>
|
||||
</listitem>
|
||||
<listitem><simpara>Topic has been changed</simpara></listitem>
|
||||
<listitem><simpara>Error</simpara></listitem>
|
||||
<listitem><simpara>Fatal error</simpara></listitem>
|
||||
<listitem><simpara>Join list end(?)</simpara></listitem>
|
||||
<listitem><simpara>Self part(?)</simpara></listitem>
|
||||
<listitem><simpara>Some user changes his nick</simpara></listitem>
|
||||
<listitem>
|
||||
<simpara>Some user quits his connection</simpara>
|
||||
</listitem>
|
||||
<listitem><simpara>Mass join begin</simpara></listitem>
|
||||
<listitem><simpara>Mass join element</simpara></listitem>
|
||||
<listitem><simpara>Mass join end</simpara></listitem>
|
||||
<listitem><simpara>Whois user</simpara></listitem>
|
||||
<listitem><simpara>Whois server</simpara></listitem>
|
||||
<listitem><simpara>Whois server</simpara></listitem>
|
||||
<listitem><simpara>Whois idle</simpara></listitem>
|
||||
<listitem><simpara>Whois channel</simpara></listitem>
|
||||
<listitem><simpara>Whois end</simpara></listitem>
|
||||
<listitem>
|
||||
<simpara>Voice status change on user</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>Operator status change on user</simpara>
|
||||
</listitem>
|
||||
<listitem><simpara>Banlist</simpara></listitem>
|
||||
<listitem><simpara>Banlist end</simpara></listitem>
|
||||
</itemizedlist>
|
||||
<itemizedlist>
|
||||
<listitem><simpara>%f - from</simpara></listitem>
|
||||
<listitem><simpara>%t - to</simpara></listitem>
|
||||
<listitem><simpara>%c - channel</simpara></listitem>
|
||||
<listitem><simpara>%r - plain message</simpara></listitem>
|
||||
<listitem><simpara>%m - encoded message</simpara></listitem>
|
||||
<listitem><simpara>%j - js encoded message</simpara></listitem>
|
||||
</itemizedlist>
|
||||
<itemizedlist>
|
||||
<listitem><simpara>1 - mod encode</simpara></listitem>
|
||||
<listitem><simpara>2 - nickname decode</simpara></listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
<para>
|
||||
<itemizedlist>
|
||||
<listitem><simpara>Plain channel message</simpara></listitem>
|
||||
<listitem><simpara>Private message received</simpara></listitem>
|
||||
<listitem><simpara>Private message sent</simpara></listitem>
|
||||
<listitem><simpara>Some user leaves channel</simpara></listitem>
|
||||
<listitem><simpara>Some user enters channel</simpara></listitem>
|
||||
<listitem><simpara>Some user was kicked from the channel</simpara></listitem>
|
||||
<listitem><simpara>Topic has been changed</simpara></listitem>
|
||||
<listitem><simpara>Error</simpara></listitem>
|
||||
<listitem><simpara>Fatal error</simpara></listitem>
|
||||
<listitem><simpara>Join list end(?)</simpara></listitem>
|
||||
<listitem><simpara>Self part(?)</simpara></listitem>
|
||||
<listitem><simpara>Some user changes his nick</simpara></listitem>
|
||||
<listitem><simpara>Some user quits his connection</simpara></listitem>
|
||||
<listitem><simpara>Mass join begin</simpara></listitem>
|
||||
<listitem><simpara>Mass join element</simpara></listitem>
|
||||
<listitem><simpara>Mass join end</simpara></listitem>
|
||||
<listitem><simpara>Whois user</simpara></listitem>
|
||||
<listitem><simpara>Whois server</simpara></listitem>
|
||||
<listitem><simpara>Whois server</simpara></listitem>
|
||||
<listitem><simpara>Whois idle</simpara></listitem>
|
||||
<listitem><simpara>Whois channel</simpara></listitem>
|
||||
<listitem><simpara>Whois end</simpara></listitem>
|
||||
<listitem><simpara>Voice status change on user</simpara></listitem>
|
||||
<listitem><simpara>Operator status change on user</simpara></listitem>
|
||||
<listitem><simpara>Banlist</simpara></listitem>
|
||||
<listitem><simpara>Banlist end</simpara></listitem>
|
||||
</itemizedlist>
|
||||
<itemizedlist>
|
||||
<listitem><simpara>%f - from</simpara></listitem>
|
||||
<listitem><simpara>%t - to</simpara></listitem>
|
||||
<listitem><simpara>%c - channel</simpara></listitem>
|
||||
<listitem><simpara>%r - plain message</simpara></listitem>
|
||||
<listitem><simpara>%m - encoded message</simpara></listitem>
|
||||
<listitem><simpara>%j - js encoded message</simpara></listitem>
|
||||
</itemizedlist>
|
||||
<itemizedlist>
|
||||
<listitem><simpara>1 - mod encode</simpara></listitem>
|
||||
<listitem><simpara>2 - nickname decode</simpara></listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
<para>
|
||||
See also: <function>ircg_lookup_format_messages</function>.
|
||||
</para>
|
||||
|
|
|
|||
Loading…
Reference in a new issue