PEAR   PEAR API Documentation :: Net_SmartIRC Package Homepage |  Download ApiDoc  
[ class tree: Net_SmartIRC ] [ index: Net_SmartIRC ] [ all elements ]  

Packages:

Class Net_SmartIRC_messagehandler 
Net_SmartIRC_base
   |
   --Net_SmartIRC_irccommands
      |
      --Net_SmartIRC_messagehandler

$Id: Net_SmartIRC_messagehandler.html,v 1.1 2003/07/23 18:08:55 meebey Exp $
Child classes:
Net_SmartIRC
$Id: Net_SmartIRC_messagehandler.html,v 1.1 2003/07/23 18:08:55 meebey Exp $
Inherited Variables

Class: Net_SmartIRC_base

Net_SmartIRC_base::$channel
Net_SmartIRC_base::$nreplycodes
Net_SmartIRC_base::$replycodes
Inherited Methods

Class: Net_SmartIRC_irccommands

ban - bans a hostmask for the given channel or requests the current banlist
changeNick - changes the own nickname
channel - returns an object reference to the specified channel
deop - deops an user in the given channel
devoice - devoice a user in the given channel
getList - gets a list of one ore more channels
getTopic - gets the topic of a channel
invite - invites a user to the specified channel
join - Joins one or more IRC channels with an optional key.
kick - Kicks one or more user from an IRC channel with an optional reason.
message - sends a new message
mode - sets or gets the mode of an user or channel
names - requests all nicknames of one or more channels
op - ops an user in the given channel
part - parts from one or more IRC channels with an optional reason
quit - sends QUIT to IRC server and disconnects
setTopic - sets a new topic of a channel
unban - unbans a hostmask on the given channel
voice - voice a user in the given channel
who - requests a 'WHO' from the specified target
whois - requests a 'WHOIS' from the specified target
whowas - requests a 'WHOWAS' from the specified target (if he left the IRC network)

Class: Net_SmartIRC_base

connect - Creates the sockets and connects to the IRC server on the given port.
disconnect - Disconnects from the IRC server nicely with a QUIT or just destroys the socket.
getMotd - Returns the full motd.
getUsermode - Returns the usermode.
isBanned - Checks if the hostmask is on the specified channel banned and returns the result.
isError
isJoined - checks if we or the given user is joined to the specified channel and returns the result ChannelSyncing is required for this.
isOpped - Checks if we or the given user is opped on the specified channel and returns the result.
isVoiced - Checks if we or the given user is voiced on the specified channel and returns the result.
listen - goes into receive mode
listenFor - waits for a special message type and puts the answer in $result
log - Adds an entry to the log.
login - login and register nickname on the IRC network
Net_SmartIRC - Constructor. Initiales the messagebuffer and "links" the replycodes from global into properties. Also some PHP runtime settings are configured.
reconnect - Reconnects to the IRC server with the same login info, it also rejoins the channels
registerActionhandler - registers a new actionhandler and returns the assigned id
registerTimehandler - registers a timehandler and returns the assigned id
setAutoReconnect - Enables/disables autoreconnecting.
setAutoRetry - Enables/disables autoretry for connecting to a server.
setBenchmark - Enables/disables the benchmark engine.
setChannelSynching - Deprecated, use setChannelSyncing() instead!
setChannelSyncing - Enables/disables channel syncing.
setCtcpVersion - Sets the CTCP version reply string.
setDebug - Sets the level of debug messages.
setDisconnecttime - Sets the delaytime before closing the socket when disconnect.
setLogdestination - Sets the destination of all log messages.
setLogfile - Sets the file for the log if the destination is set to file.
setReceivedelay - Sets the delay for receiving data from the IRC server.
setReceiveTimeout - Sets the receive timeout.
setSenddelay - Sets the delay for sending data to the IRC server.
setTransmitTimeout - Sets the transmit timeout.
setUseSockets - Enables/disables the usage of real sockets.
showBenchmark - Shows the benchmark result.
startBenchmark - Starts the benchmark (sets the counters).
stopBenchmark - Stops the benchmark and displays the result.
throwError
unregisterActionhandler - unregisters an existing actionhandler
unregisterActionid - unregisters an existing actionhandler via the id
unregisterTimeid - unregisters an existing timehandler via the id

Class Methods

_event_error (line 35)
void _event_error ( &$ircdata )

[ Top ]
_event_err_nicknameinuse (line 402)
void _event_err_nicknameinuse ( &$ircdata )

[ Top ]
_event_join (line 44)
void _event_join ( &$ircdata )

[ Top ]
_event_kick (line 77)
void _event_kick ( &$ircdata )

[ Top ]
_event_mode (line 131)
void _event_mode ( &$ircdata )

[ Top ]
_event_nick (line 91)
void _event_nick ( &$ircdata )

[ Top ]
_event_part (line 70)
void _event_part ( &$ircdata )

[ Top ]
_event_ping (line 30)
void _event_ping ( &$ircdata )

[ Top ]
_event_privmsg (line 231)
void _event_privmsg ( &$ircdata )

[ Top ]
_event_quit (line 84)
void _event_quit ( &$ircdata )

[ Top ]
_event_rpl_banlist (line 383)
void _event_rpl_banlist ( &$ircdata )

[ Top ]
_event_rpl_channelmodeis (line 279)
void _event_rpl_channelmodeis ( &$ircdata )

[ Top ]
_event_rpl_endofmotd (line 269)
void _event_rpl_endofmotd ( &$ircdata )

[ Top ]
_event_rpl_motd (line 264)
void _event_rpl_motd ( &$ircdata )

[ Top ]
_event_rpl_motdstart (line 259)
void _event_rpl_motdstart ( &$ircdata )

[ Top ]
_event_rpl_namreply (line 354)
void _event_rpl_namreply ( &$ircdata )

[ Top ]
_event_rpl_topic (line 392)
void _event_rpl_topic ( &$ircdata )

[ Top ]
_event_rpl_umodeis (line 274)
void _event_rpl_umodeis ( &$ircdata )

[ Top ]
_event_rpl_welcome (line 250)
void _event_rpl_welcome ( &$ircdata )

[ Top ]
_event_rpl_whoreply (line 298)
void _event_rpl_whoreply ( &$ircdata )

[ Top ]
_event_topic (line 223)
void _event_topic ( &$ircdata )

[ Top ]

Documentation generated on Wed, 23 Jul 2003 19:59:10 +0200 by phpDocumentor 1.2.0beta1c
HTML layout done by Christian Dickmann and originally inspired by PHPEdit