downloads | documentation | faq | getting help | mailing lists | reporting bugs | sites | links | my 
search for in the  
view the version of this page
Last updated: Thu, 21 Aug 2003

XLV. IRC Gateway Functions


With IRCG you can rapidly stream XML data to thousands of concurrently connected users. This can be used to build powerful, extensible interactive platforms such as online games and webchats. IRCG also features support for a non-streaming mode where a helper application reformats incoming data and supplies static file snippets in special formats such as cHTML (i-mode) or WML (WAP). These static files are then delivered by the high-performance web server.

Up to v3, IRCG runs under these platforms:

  • AIX

  • FreeBSD

  • HP-UX

  • Irix

  • Linux

  • Solaris

  • Tru64


Detailed installation instructions can be found here. We urge you to use the provided installation script.

It is not recommended, but you can try enable IRCG support yourself. Provide the path to the ircg-config script, --with-ircg-config=path/to/irc-config and in addition add --with-ircg to your configure line.

Runtime Configuration

This extension has no configuration directives defined in php.ini.

Resource Types

Predefined Constants

This extension has no constants defined.

Table of Contents
ircg_channel_mode --  Set channel mode flags for user
ircg_disconnect --  Close connection to server
ircg_fetch_error_msg --  Returns the error from previous IRCG operation
ircg_get_username --  Get username for connection
ircg_html_encode --  Encodes HTML preserving output
ircg_ignore_add --  Add a user to your ignore list on a server
ircg_ignore_del --  Remove a user from your ignore list on a server
ircg_is_conn_alive --  Check connection status
ircg_join --  Join a channel on a connected server
ircg_kick --  Kick a user out of a channel on server
ircg_lookup_format_messages --  Check for the existence of a format message set
ircg_msg --  Send message to channel or user on server
ircg_nick --  Change nickname on server
ircg_nickname_escape --  Encode special characters in nickname to be IRC-compliant
ircg_nickname_unescape --  Decodes encoded nickname
ircg_notice --  Send a notice to a user on server
ircg_part --  Leave a channel on server
ircg_pconnect --  Connect to an IRC server
ircg_register_format_messages --  Register a format message set
ircg_set_current --  Set current connection for output
ircg_set_file --  Set logfile for connection
ircg_set_on_die --  Set action to be executed when connection dies
ircg_topic --  Set topic for channel on server
ircg_whois --  Query server for user information

add a note add a note User Contributed Notes
IRC Gateway Functions
meebey at php dot net
02-Jun-2003 06:23
If you just need an IRC client/bot in PHP without this IRCG extension, you want to look at the PEAR::SmartIRC class. Here the direct link to this class:
darkelder at php dot net
12-Nov-2002 01:16
This is an example to show how to connect to a IRC server, how to join a channel, send and receive messages.


/* change it to your own nickname                                               */
$nickname               "myOwnNick";
/* choice your irc server                                                       */
$server                 "";
/* change to your channel                                                       */
$channel                "#linux";
/* do not change it if you do not know what means :-)                           */
$port                   "6667";

/* as ircg cannot resolve hosts, we use PHP internal function to get the IP     */
$ip                     gethostbyname($server);

/* connection                                                                   */
$id                     ircg_pconnect($nickname,$ip,$port);

/* checking if  connected                                                       */
if (!ircg_is_conn_alive($id))
"Cannot connect<br>";

/* joining a channel                                                            */
if (!ircg_join($id,$channel))
"Cannot join to $chanell<br>";

/* getting messages - you must have this in your php file                       */

/* send messages to your channel and you                                        */
ircg_msg($id,$channel,"Hello $channel!!");
ircg_msg($id,$nickname,"This message goes to me!!!");

ssruprai at hotmail dot com
03-May-2002 08:55
You may face problems with php 4.20 configure script when using "--with-ircg-config" without providing any path to script file. When it tries to configure ircg it just starts printing --ldflags continuously.

checking for IRCG support... yes

So always provide path to ircg-config file as in --with-ircg-config=/user/local/bin/ircg-config

 Last updated: Thu, 21 Aug 2003
show source | credits | sitemap | mirror sites 
Copyright © 2001-2003 The PHP Group
All rights reserved.
This mirror generously provided by:
Last updated: Sat 01 Nov 2003 04:13:36 EST EST