connect (line
822)
void connect ( $address, $port )
Parameters:
Description:Creates the sockets and connects to the IRC server on the given port.
Tags:
disconnect (line
890)
boolean disconnect ( [$quickdisconnect = false] )
Parameters:
Description:Disconnects from the IRC server nicely with a QUIT or just destroys the socket.
Disconnects from the IRC server in the given quickness mode. $quickdisconnect: true, just close the socket false, send QUIT and wait $_disconnectime before closing the socket
Tags:
getMotd (line
798)
array getMotd ( )
Description:Returns the full motd.
Tags:
getUsermode (line
809)
string getUsermode ( )
Description:Returns the usermode.
Tags:
isBanned (line
1108)
boolean isBanned ( $channel, $hostmask )
Parameters:
Description:Checks if the hostmask is on the specified channel banned and returns the result.
ChannelSyncing is required for this.
Tags:
isError (line
2191)
void isError ( $object )
isJoined (line
1020)
boolean isJoined ( $channel, [$nickname = null] )
Parameters:
Description:checks if we or the given user is joined to the specified channel and returns the result ChannelSyncing is required for this.
Tags:
isOpped (line
1048)
boolean isOpped ( $channel, [$nickname = null] )
Parameters:
Description:Checks if we or the given user is opped on the specified channel and returns the result.
ChannelSyncing is required for this.
Tags:
isVoiced (line
1078)
boolean isVoiced ( $channel, [$nickname = null] )
Parameters:
Description:Checks if we or the given user is voiced on the specified channel and returns the result.
ChannelSyncing is required for this.
Tags:
listen (line
1135)
boolean listen ( )
Description:goes into receive mode
Goes into receive and idle mode. Only call this if you want to "spawn" the bot. No further lines of PHP code will be processed after this call, only the bot methods!
Tags:
listenFor (line
1156)
array listenFor ( $messagetype )
Parameters:
Description:waits for a special message type and puts the answer in $result
Creates a special actionhandler for that given TYPE and returns the answer. This will only receive the requested type, immediately quit and disconnect from the IRC server. Made for showing IRC statistics on your homepage, or other IRC related information.
Tags:
log (line
735)
void log ( $level, $entry, [$file = null], [$line = null] )
Parameters:
Description:Adds an entry to the log.
Adds an entry to the log with Linux style log format. Possible $level constants (can also be combined with "|"s) SMARTIRC_DEBUG_NONE SMARTIRC_DEBUG_NOTICE SMARTIRC_DEBUG_CONNECTION SMARTIRC_DEBUG_SOCKET SMARTIRC_DEBUG_IRCMESSAGES SMARTIRC_DEBUG_MESSAGETYPES SMARTIRC_DEBUG_ACTIONHANDLER SMARTIRC_DEBUG_TIMEHANDLER SMARTIRC_DEBUG_MESSAGEHANDLER SMARTIRC_DEBUG_CHANNELSYNCING SMARTIRC_DEBUG_MODULES SMARTIRC_DEBUG_USERSYNCING SMARTIRC_DEBUG_ALL
Tags:
login (line
981)
void login ( $nick, $realname, [$usermode = 0], [$username = null], [$password = null] )
Parameters:
Description:login and register nickname on the IRC network
Registers the nickname and user information on the IRC network.
Tags:
Net_SmartIRC (line
340)
void Net_SmartIRC ( )
Description:Constructor. Initiales the messagebuffer and "links" the replycodes from global into properties. Also some PHP runtime settings are configured.
Tags:
reconnect (line
940)
void reconnect ( )
Description:Reconnects to the IRC server with the same login info, it also rejoins the channels
Tags:
registerActionhandler (line
1184)
integer registerActionhandler ( $handlertype, $regexhandler, &$object, $methodname )
Parameters:
Description:registers a new actionhandler and returns the assigned id
Registers an actionhandler in Net_SmartIRC for calling it later. The actionhandler id is needed for unregistering the actionhandler.
Tags:
registerTimehandler (line
1292)
integer registerTimehandler ( $interval, &$object, $methodname )
Parameters:
Description:registers a timehandler and returns the assigned id
Registers a timehandler in Net_SmartIRC, which will be called in the specified interval. The timehandler id is needed for unregistering the timehandler.
Tags:
setAutoReconnect (line
608)
void setAutoReconnect ( $boolean )
Parameters:
Description:Enables/disables autoreconnecting.
Tags:
setAutoRetry (line
624)
void setAutoRetry ( $boolean )
Parameters:
Description:Enables/disables autoretry for connecting to a server.
Tags:
setBenchmark (line
439)
void setBenchmark ( $boolean )
Parameters:
Description:Enables/disables the benchmark engine.
Tags:
setChannelSynching (line
456)
void setChannelSynching ( $boolean )
Parameters:
Description:Deprecated, use setChannelSyncing() instead!
Tags:
setChannelSyncing (line
472)
void setChannelSyncing ( $boolean )
Parameters:
Description:Enables/disables channel syncing.
Channel syncing means, all users on all channel we are joined are tracked in the channel array. This makes it very handy for botcoding.
Tags:
setCtcpVersion (line
494)
void setCtcpVersion ( $versionstring )
Parameters:
Description:Sets the CTCP version reply string.
Tags:
setDebug (line
427)
void setDebug ( $level )
Parameters:
Description:Sets the level of debug messages.
Sets the debug level (bitwise), useful for testing/developing your code. Here the list of all possible debug levels: SMARTIRC_DEBUG_NONE SMARTIRC_DEBUG_NOTICE SMARTIRC_DEBUG_CONNECTION SMARTIRC_DEBUG_SOCKET SMARTIRC_DEBUG_IRCMESSAGES SMARTIRC_DEBUG_MESSAGETYPES SMARTIRC_DEBUG_ACTIONHANDLER SMARTIRC_DEBUG_TIMEHANDLER SMARTIRC_DEBUG_MESSAGEHANDLER SMARTIRC_DEBUG_CHANNELSYNCING SMARTIRC_DEBUG_MODULES SMARTIRC_DEBUG_USERSYNCING SMARTIRC_DEBUG_ALL
Default: SMARTIRC_DEBUG_NOTICE
Tags:
setDisconnecttime (line
552)
void setDisconnecttime ( $milliseconds )
Parameters:
Description:Sets the delaytime before closing the socket when disconnect.
Tags:
setLogdestination (line
514)
void setLogdestination ( $type )
Parameters:
Description:Sets the destination of all log messages.
Sets the destination of log messages. $type can be: SMARTIRC_FILE for saving the log into a file SMARTIRC_STDOUT for echoing the log to stdout SMARTIRC_SYSLOG for sending the log to the syslog Default: SMARTIRC_STDOUT
Tags:
setLogfile (line
540)
void setLogfile ( $file )
Parameters:
Description:Sets the file for the log if the destination is set to file.
Sets the logfile, if logdestination is set to SMARTIRC_FILE. This should be only used with full path!
Tags:
setReceivedelay (line
572)
void setReceivedelay ( $milliseconds )
Parameters:
Description:Sets the delay for receiving data from the IRC server.
Sets the delaytime between messages that are received, this reduces your CPU load. Don't set this too low (min 100ms). Default: 100
Tags:
setReceiveTimeout (line
643)
void setReceiveTimeout ( $seconds )
Parameters:
Description:Sets the receive timeout.
If the timeout occurs, the connection will be reinitialized Default: 300 seconds
Tags:
setSenddelay (line
592)
void setSenddelay ( $milliseconds )
Parameters:
Description:Sets the delay for sending data to the IRC server.
Sets the delaytime between messages that are sent, because IRC servers doesn't like floods. This will avoid sending your messages too fast to the IRC server. Default: 250
Tags:
setTransmitTimeout (line
662)
void setTransmitTimeout ( $seconds )
Parameters:
Description:Sets the transmit timeout.
If the timeout occurs, the connection will be reinitialized Default: 300 seconds
Tags:
setUseSockets (line
378)
void setUseSockets ( $boolean )
Parameters:
Description:Enables/disables the usage of real sockets.
Enables/disables the usage of real sockets instead of fsocks (works only if your PHP build has loaded the PHP socket extension) Default: false
Tags:
showBenchmark (line
705)
void showBenchmark ( )
Description:Shows the benchmark result.
Tags:
startBenchmark (line
677)
void startBenchmark ( )
Description:Starts the benchmark (sets the counters).
Tags:
stopBenchmark (line
689)
void stopBenchmark ( )
Description:Stops the benchmark and displays the result.
Tags:
throwError (line
2195)
void &throwError ( $message )
unregisterActionhandler (line
1216)
boolean unregisterActionhandler ( $handlertype, $regexhandler, &$object, $methodname )
Parameters:
Description:unregisters an existing actionhandler
Tags:
unregisterActionid (line
1257)
boolean unregisterActionid ( $id )
Parameters:
Description:unregisters an existing actionhandler via the id
Tags:
unregisterTimeid (line
1321)
boolean unregisterTimeid ( $id )
Parameters:
Description:unregisters an existing timehandler via the id
Tags:
