Net_SmartIRC |
[ class tree: Net_SmartIRC ] [ index: Net_SmartIRC ] [ all elements ] |
Packages: Net_SmartIRC Classes: Files:
defines.php
example.php example2.php example3.php example4.php example5.php example6.php example7.php irccommands.php messagehandler.php SmartIRC.php |
[ Top ] $_messagebuffersize =[line 190]
[ Top ] $_mintimer = false[line 312]
[ Top ] $_modulepath = '.'[line 295] Stores the path to the modules that can be loaded.
[ Top ] $_modules = array()[line 302] Stores all objects of the modules.
[ Top ] $_motd = array()[line 255]
[ Top ] $_nick =[line 131]
[ Top ] $_password =[line 151]
[ Top ] $_performs = array()[line 156]
[ Top ] $_port =[line 121]
[ Top ] $_realname =[line 141]
[ Top ] $_receivedelay = self::DEF_RECEIVE_DELAY[line 195]
[ Top ] $_reconnectdelay = self::DEF_RECONNECT_DELAY[line 347]
[ Top ] $_runasdaemon = false[line 372]
[ Top ] $_rxtimeout = self::DEF_TX_RX_TIMEOUT[line 327]
[ Top ] $_senddelay = self::DEF_SEND_DELAY[line 200]
[ Top ] $_socket =[line 111]
[ Top ] $_state = SMARTIRC_STATE_DISCONNECTED[line 161]
[ Top ] $_timehandler = array()[line 171]
[ Top ] $_timehandlerid = 0[line 250]
[ Top ] $_txtimeout = self::DEF_TX_RX_TIMEOUT[line 322]
[ Top ] $_usermode =[line 146]
[ Top ] $_username =[line 136]
[ Top ] $_users = array()[line 283] Stores all users that had/have contact with us (channel/query/notice etc.), works only if usersyncing is activated.Eg. for accessing a user, use it like this: (in this example the SmartIRC object is stored in $irc) $irc->user['meebey']->host;
[ Top ] $_usersyncing = false[line 288]
[ Top ] Method Detailconnect [line 1056]
Creates the sockets and connects to the IRC server on the given port. Returns this SmartIRC object on success, and false on failure.
Parameters:
[ Top ]
__construct (Constructor) [line 396]
Constructor. Initiates the messagebuffer and "links" the replycodes from global into properties. Also some PHP runtime settings are configured.
Parameters:
[ Top ]
disconnect [line 1125]
Disconnects from the IRC server nicely with a QUIT or just destroys the socket. Disconnects from the IRC server in the given quickness mode. $quick:
Parameters:
[ Top ]
getChannel [line 999]
Returns a reference to the channel object of the specified channelname.
Parameters:
[ Top ]
getMotd [line 976]getUser [line 1030]
Returns a reference to the user object for the specified username and channelname.
Parameters:
[ Top ]
getUsermode [line 987]interrupt [line 1597]
Provides a mechanism to interrupt a listen() loop by a bot or something
Parameters:
[ Top ]
isAdmin [line 1458]
Checks if we or the given user is admin on the specified channel and returns the result. ChannelSyncing is required for this.
Parameters:
[ Top ]
isBanned [line 1574]
Checks if the hostmask is on the specified channel banned and returns the result. ChannelSyncing is required for this.
Parameters:
[ Top ]
isConnected [line 1365]isError [line 2702]isFounder [line 1429]
Checks if we or the given user is founder on the specified channel and returns the result. ChannelSyncing is required for this.
Parameters:
[ Top ]
isHopped [line 1516]
Checks if we or the given user is hopped on the specified channel and returns the result. ChannelSyncing is required for this.
Parameters:
[ Top ]
isJoined [line 1392]
checks if we or the given user is joined to the specified channel and returns the result ChannelSyncing is required for this.
Parameters:
[ Top ]
isMe [line 1377]
checks if the passed nickname is our own nickname
Parameters:
[ Top ]
isOpped [line 1487]
Checks if we or the given user is opped on the specified channel and returns the result. ChannelSyncing is required for this.
Parameters:
[ Top ]
isVoiced [line 1545]
Checks if we or the given user is voiced on the specified channel and returns the result. ChannelSyncing is required for this.
Parameters:
[ Top ]
listen [line 1611]
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!
[ Top ]
listenFor [line 2085]
waits for a special message type and returns the answer 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.
Parameters:
[ Top ]
listenOnce [line 1627]
goes into receive mode _only_ for one pass Goes into receive mode. It will return when one pass is complete. Use this when you want to connect to multiple IRC servers.
[ Top ]
loadedModules [line 2445]
Returns an array of the module names that are currently loaded
[ Top ]
loadModule [line 2311]
loads a module using preset path and given name
Parameters:
[ Top ]
log [line 901]
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
Parameters:
[ Top ]
login [line 1251]
login and register nickname on the IRC network Registers the nickname and user information on the IRC network.
Parameters:
[ Top ]
perform [line 1314]
adds a command to the list of commands to be sent after login() info
Parameters:
[ Top ]
reconnect [line 1176]
Reconnects to the IRC server with the same login info, it also rejoins the channels
[ Top ]
registerActionHandler [line 2107]
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.
Parameters:
[ Top ]
registerTimeHandler [line 2231]
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.
Parameters:
[ Top ]
send [line 1335]
sends an IRC message Adds a message to the messagequeue, with the optional priority. $priority: SMARTIRC_CRITICAL SMARTIRC_HIGH SMARTIRC_MEDIUM SMARTIRC_LOW
Parameters:
[ Top ]
setAutoRetry [line 475]
Enables/disables autoretry for connecting to a server.
Parameters:
[ Top ]
setAutoRetryMax [line 488]
Sets the maximum number of attempts to connect to a server before giving up.
Parameters:
[ Top ]
setBenchmark [line 509]
Enables/disables the benchmark engine.
Parameters:
[ Top ]
setBindAddress [line 525]
Sets an IP address (and optionally, a port) to bind the socket to. Limits the bot to claiming only one of the machine's IPs as its home. Call with no parameters to unbind.
Parameters:
[ Top ]
setChannelSyncing [line 543]
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.
Parameters:
[ Top ]
setCtcpVersion [line 568]
Sets the CTCP version reply string.
Parameters:
[ Top ]
setDebugLevel [line 600]
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
Parameters:
[ Top ]
setDisconnectTime [line 612]
Sets the delaytime before closing the socket when disconnect.
Parameters:
[ Top ]
setLogDestination [line 639]
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
Parameters:
[ Top ]
setLogFile [line 669]
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!
Parameters:
[ Top ]
setModulePath [line 681]
Sets the paths for the modules.
Parameters:
[ Top ]
setReceiveDelay [line 697]
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
Parameters:
[ Top ]
setReceiveTimeout [line 775]
Sets the receive timeout. If the timeout occurs, the connection will be reinitialized Default: 300 seconds
Parameters:
[ Top ]
setReconnectDelay [line 717]
Sets the delaytime before attempting reconnect. Value of 0 disables the delay entirely.
Parameters:
[ Top ]
setRunAsDaemon [line 735]
Sets whether the script should be run as a daemon or not ( actually disables/enables ignore_user_abort() )
Parameters:
[ Top ]
setSendDelay [line 755]
Sets the delay for sending data to the IRC server. Sets the delay time between sending messages, to avoid flooding IRC servers. If your bot has special flooding permissions on the network you're connected to, you can set this quite low to send messages faster. Default: 250
Parameters:
[ Top ]
setTransmitTimeout [line 795]
Sets the transmit timeout. If the timeout occurs, the connection will be reinitialized Default: 300 seconds
Parameters:
[ Top ]
setUserSyncing [line 815]
Enables/disables user syncing. User syncing means, all users we have or had contact with through channel, query or notice are tracked in the $irc->user array. This is very handy for botcoding.
Parameters:
[ Top ]
showBenchmark [line 865]startBenchmark [line 835]stopBenchmark [line 848]throwError [line 2709]unloadModule [line 2414]
unloads a module by the name originally loaded with
Parameters:
[ Top ]
unregisterActionHandler [line 2145]
unregisters an existing actionhandler
Parameters:
[ Top ]
unregisterActionId [line 2190]
unregisters an existing actionhandler via the id
Parameters:
[ Top ]
unregisterTimeId [line 2264]
unregisters an existing timehandler via the id
Parameters:
[ Top ]
_adduser [line 2459]
adds an user to the channelobject or updates his info
Parameters:
[ Top ]
_callTimeHandlers [line 2510]
looks for any time handlers that have timed out and calls them if valid
[ Top ]
_pingcheck [line 2548]
An active-pinging system to keep the bot from dropping the connection
[ Top ]
_rawsend [line 2568]
sends a raw message to the IRC server Don't use this directly! Use message() or send() instead.
Parameters:
[ Top ]
_removeuser [line 2597]
removes an user from one channel or all if he quits
Parameters:
[ Top ]
_updatestate [line 2685]__call [line 439]
Handle calls to renamed or deprecated functions
Parameters:
[ Top ]
__get [line 422]
Keeps BC since private properties were once publicly accessible.
Parameters:
[ Top ]
Documentation generated on Thu, 25 Jul 2019 12:49:09 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004. |