PEAR API Documentation :: Net_SmartIRC

|  | PEAR API Documentation :: Net_SmartIRC | Package Homepage | Download ApiDoc

CHANGELOG README Packages: Net_SmartIRC
Class Net_SmartIRC_irccommands
    Net_SmartIRC_base
       |
       --Net_SmartIRC_irccommands
$Id$ Author: - Mirco 'meebey' Bauer <mailto:mail@meebey.net> Package: - Net_SmartIRC Version: - 0.5.5
Child classes: Net_SmartIRC_messagehandler $Id$ Inherited Variables Class: Net_SmartIRC_base Net_SmartIRC_base::$channel Net_SmartIRC_base::$nreplycodes Net_SmartIRC_base::$replycodes Inherited Methods 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 ban (line 323) void ban ( $channel, [$hostmask = null], [$priority = SMARTIRC_MEDIUM] ) Parameters:
| string | $channel |
| string | $hostmask |
| integer | $priority | message priority, default is SMARTIRC_MEDIUM
Description: bans a hostmask for the given channel or requests the current banlist The banlist will be requested if no hostmask is specified Tags: Access: - public [ Top ] changeNick (line 370) void changeNick ( $newnick, [$priority = SMARTIRC_MEDIUM] ) Parameters:
| string | $newnick |
| integer | $priority | message priority, default is SMARTIRC_MEDIUM
Description: changes the own nickname Trys to set a new nickname, nickcollisions are handled. Tags: Access: - public [ Top ] channel (line 77) object &channel ( $channelname ) Parameters:
| string | $channelname |
Description: returns an object reference to the specified channel If the channel does not exist (because not joint) false will be returned. Tags: Return: - reference to the channel object Access: - public [ Top ] deop (line 279) void deop ( $channel, $nickname, [$priority = SMARTIRC_MEDIUM] ) Parameters:
| string | $channel |
| string | $nickname |
| integer | $priority | message priority, default is SMARTIRC_MEDIUM
Description: deops an user in the given channel Tags: Access: - public [ Top ] devoice (line 307) void devoice ( $channel, $nickname, [$priority = SMARTIRC_MEDIUM] ) Parameters:
| string | $channel |
| string | $nickname |
| integer | $priority | message priority, default is SMARTIRC_MEDIUM
Description: devoice a user in the given channel Tags: Access: - public [ Top ] getList (line 171) void getList ( [$channelarray = null], [$priority = SMARTIRC_MEDIUM] ) Parameters:
| mixed | $channelarray |
| integer | $priority | message priority, default is SMARTIRC_MEDIUM
Description: gets a list of one ore more channels Requests a full channellist if $channelarray is not given. (use it with care, usualy its a looooong list) Tags: Access: - public [ Top ] getTopic (line 231) void getTopic ( $channel, [$priority = SMARTIRC_MEDIUM] ) Parameters:
| string | $channel |
| integer | $priority | message priority, default is SMARTIRC_MEDIUM
Description: gets the topic of a channel Tags: Access: - public [ Top ] invite (line 355) void invite ( $nickname, $channel, [$priority = SMARTIRC_MEDIUM] ) Parameters:
| string | $nickname |
| string | $channel |
| integer | $priority | message priority, default is SMARTIRC_MEDIUM
Description: invites a user to the specified channel Tags: Access: - public [ Top ] join (line 96) void join ( $channelarray, [$key = null], [$priority = SMARTIRC_MEDIUM] ) Parameters:
| mixed | $channelarray |
| string | $key |
| integer | $priority | message priority, default is SMARTIRC_MEDIUM
Description: Joins one or more IRC channels with an optional key. Tags: Access: - public [ Top ] kick (line 145) void kick ( $channel, $nicknamearray, [$reason = null], [$priority = SMARTIRC_MEDIUM] ) Parameters:
| string | $channel |
| mixed | $nicknamearray |
| string | $reason |
| integer | $priority | message priority, default is SMARTIRC_MEDIUM
Description: Kicks one or more user from an IRC channel with an optional reason. Tags: Access: - public [ Top ] message (line 41) boolean message ( $type, $destination, $message, [$priority = SMARTIRC_MEDIUM] ) Parameters:
| integer | $type | specifies the type, like QUERY/ACTION or CTCP see 'Message Types'
| string | $destination | can be a user or channel
| string | $message | the message
Description: sends a new message Sends a message to a channel or user. Tags: Access: - public See: - DOCUMENTATION [ Top ] mode (line 247) void mode ( $target, [$newmode = null], [$priority = SMARTIRC_MEDIUM] ) Parameters:
| string | $target | the target, can be an user (only yourself) or a channel
| string | $newmode | the new mode like +mt
| integer | $priority | message priority, default is SMARTIRC_MEDIUM
Description: sets or gets the mode of an user or channel Changes/requests the mode of the given target. Tags: Access: - public [ Top ] names (line 195) void names ( [$channelarray = null], [$priority = SMARTIRC_MEDIUM] ) Parameters:
| mixed | $channelarray |
| integer | $priority | message priority, default is SMARTIRC_MEDIUM
Description: requests all nicknames of one or more channels The requested nickname list also includes op and voice state Tags: Access: - public [ Top ] op (line 265) void op ( $channel, $nickname, [$priority = SMARTIRC_MEDIUM] ) Parameters:
| string | $channel |
| string | $nickname |
| integer | $priority | message priority, default is SMARTIRC_MEDIUM
Description: ops an user in the given channel Tags: Access: - public [ Top ] part (line 120) void part ( $channelarray, [$reason = null], [$priority = SMARTIRC_MEDIUM] ) Parameters:
| mixed | $channelarray |
| string | $reason |
| integer | $priority | message priority, default is SMARTIRC_MEDIUM
Description: parts from one or more IRC channels with an optional reason Tags: Access: - public [ Top ] quit (line 423) void quit ( [$quitmessage = null], [$priority = SMARTIRC_MEDIUM] ) Parameters:
| string | $quitmessage | optional quitmessage
| integer | $priority | message priority, default is SMARTIRC_MEDIUM
Description: sends QUIT to IRC server and disconnects Tags: Access: - public [ Top ] setTopic (line 218) void setTopic ( $channel, $newtopic, [$priority = SMARTIRC_MEDIUM] ) Parameters:
| string | $channel |
| string | $newtopic |
| integer | $priority | message priority, default is SMARTIRC_MEDIUM
Description: sets a new topic of a channel Tags: Access: - public [ Top ] unban (line 341) void unban ( $channel, $hostmask, [$priority = SMARTIRC_MEDIUM] ) Parameters:
| string | $channel |
| string | $hostmask |
| integer | $priority | message priority, default is SMARTIRC_MEDIUM
Description: unbans a hostmask on the given channel Tags: Access: - public [ Top ] voice (line 293) void voice ( $channel, $nickname, [$priority = SMARTIRC_MEDIUM] ) Parameters:
| string | $channel |
| string | $nickname |
| integer | $priority | message priority, default is SMARTIRC_MEDIUM
Description: voice a user in the given channel Tags: Access: - public [ Top ] who (line 383) void who ( $target, [$priority = SMARTIRC_MEDIUM] ) Parameters:
| string | $target |
| integer | $priority | message priority, default is SMARTIRC_MEDIUM
Description: requests a 'WHO' from the specified target Tags: Access: - public [ Top ] whois (line 396) void whois ( $target, [$priority = SMARTIRC_MEDIUM] ) Parameters:
| string | $target |
| integer | $priority | message priority, default is SMARTIRC_MEDIUM
Description: requests a 'WHOIS' from the specified target Tags: Access: - public [ Top ] whowas (line 410) void whowas ( $target, [$priority = SMARTIRC_MEDIUM] ) Parameters:
| string | $target |
| integer | $priority | message priority, default is SMARTIRC_MEDIUM
Description: requests a 'WHOWAS' from the specified target (if he left the IRC network) Tags: Access: - public [ Top ] Documentation generated on Wed, 23 Jul 2003 19:59:09 +0200 by phpDocumentor 1.2.0beta1c HTML layout done by Christian Dickmann and originally inspired by PHPEdit