DeBot Framework

_ A B C D G I J K L M N O P R S T U V

_

__construct() - Method in class DeBot\Connection
Our construct.
__construct() - Method in class DeBot\Bot
This function loads all settings from the config based on provided nick.
__construct() - Method in class DeBot\m_RawEval
__construct() - Method in class DeBot\Channel
Begins the creation of this channel (onJoin)
__construct() - Method in class DeBot\m_Cmds
__construct() - Method in class DeBot\Singleton
__construct() - Method in class DeBot\Bots
Returns the bots that are created.
__construct() - Method in class DeBot\Modules
Our construction function.

A

aConfig() - Global in package DeBot
ACTION() - Global in package DeBot
A shortcut of the ACTION command.
add() - Method in class DeBot\Servers
Adds a server to the array list.
addBot() - Method in class DeBot\Bots
This adds a new bot to the Bots class.
addDebug() - Method in class DeBot\Logs
Adds a debug line to the logs, assuming debug is enabled in the config
addLog() - Method in class DeBot\Logs
Add a new line to our logs.
addServer() - Method in class DeBot\Bot
This method adds a server to the bot (or reconnects if the connection already exists).
addTimer() - Method in class DeBot\Timers
Add a timer to be used.
AUTH_CHAN() - Global in package DeBot

B

Bot() - Class in package DeBot
DeBot Core - Bot Created by dab ??? ?? 2009 Last Edited: Jul 29 2010 Last Edited: Aug 15 2010 This file contains the structure for a SINGLE complete bot.
BOT_PATH() - Global in package DeBot
Bots() - Class in package DeBot
DeBot Core - Bots Created by dab ??? ?? 2009 Last Edited: Jul 29 2010 This is our Bot handler.

C

Channel() - Class in package DeBot
DeBot Core - Channel Created by dab ??? ?? 2009 Last Edited: Aug 14 2010 This class stores all information about a channel.
check() - Method in class DeBot\Bot
This command performs a check for incoming messages.
check() - Method in class DeBot\Bots
This is called in our main loop.
Check() - Method in class DeBot\Connection
This performs the check for new info.
CMD() - Global in package DeBot
CMD_ERROR() - Global in package DeBot
CMD_RAW() - Global in package DeBot
CMD_SUCCESS() - Global in package DeBot
Config() - Class in package DeBot
DeBot Core - Singleton Created by dab ??? ?? 2009 Last Edited: Aug 15 2010 This class lets us makes all of the classes available anywhere via a static call.
Connect() - Method in class DeBot\Connection
Connect to the server.
Connection() - Class in package DeBot
DeBot Core - Server Created by dab ??? ?? 2009 Last Edited: Aug 15 2010 Our average socket is stored here along with some other things.

D

delBot() - Method in class DeBot\Bots
This does the opposite of the addBot.
delServer() - Method in class DeBot\Bot
This function removes a server from a bot.
delTimer() - Method in class DeBot\Timers
Delete a timer (Duh?)
Disconnect() - Method in class DeBot\Connection
We must disconnect from this server.
download() - Function in package DeBot

G

get() - Method in class DeBot\Servers
Used before I realized what ArrayAccess was capable of.
getBot() - Method in class DeBot\Config
A re-route of the getBotConfig
getBot() - Method in class DeBot\Bots
Fetches the object for the bot so we can use its methods
getBotConfig() - Method in class DeBot\Config
Fetches the bot's config
getBots() - Method in class DeBot\Config
Get the config for all the bots
getConfig() - Method in class DeBot\Config
Returns the whole config
getDef() - Method in class DeBot\Bot
This returns the default bot...
getDef() - Method in class DeBot\Bots
This returns the default bot.
getModules() - Method in class DeBot\Modules
This returns all of the modules loaded by the bot.
getServers() - Method in class DeBot\Config
Fetch all of our servers.
getSock() - Method in class DeBot\Connection

I

isAuthed() - Method in class DeBot\m_RawEval

J

join() - Method in class DeBot\Bot
Just like the msg method but for joining channels.

K

Killed() - Method in class DeBot\Connection
Um, the server doesn't like us.

L

load() - Method in class DeBot\Logs
Initiate our Logs object
load() - Method in class DeBot\Bots
This function loads all of the bots from the Config.
load() - Method in class DeBot\Servers
Load function parses config for the servers and stores them for future connections.
load() - Method in class DeBot\Config
Load the config and the instance of the config handler
load() - Method in class DeBot\Timers
load() - Method in class DeBot\Modules
Load a module to this bot.
Logs() - Class in package DeBot
DeBot Core - Logs Created by dab Jul ?? 2010 Last Edited: Aug 14 2010 Handles the config, and allows for a global access through singleton (Static).
LOGS_DEBUG() - Global in package DeBot

M

m_Cmds() - Class in package DeBot
DeBot Core - Module Created by dab Jul ?? 2010 Last Edited: Aug 15 2010 This outlines all of the currently possible callbacks available to the bot.
m_RawEval() - Class in package DeBot
DeBot Module - Raw Eval Created by dab ??? ?? 2009 Last Edited: Jul 29 2010 This module allows you to perform raw php commands.
me() - Method in class DeBot\Bot
I noticed some people want to use a shortcut instead of writing out PRIVMSG #CHANNEL :OHI THERE! so I decided to add a quick method to send a message.
MOD_END() - Global in package DeBot
mode() - Method in class DeBot\Connection
A shortcut method to sending a mode change to the server through Raw
Module() - Class in package DeBot
DeBot Core - Module Created by dab Jul ?? 2010 Last Edited: Aug 15 2010 This outlines all of the currently possible callbacks available to the bot.
Modules() - Class in package DeBot
DeBot Core - Modules Created by dab ??? ?? 2009 Last Edited: Jul 29 2010 Last Edited: Aug 2 2010 Last Edited: Aug 15 2010 This file maintains all the extensions to the DeBot Framework.
msg() - Method in class DeBot\Bot
I noticed some people want to use a shortcut instead of writing out PRIVMSG #CHANNEL :OHI THERE! so I decided to add a quick method to send a message.
msg() - Method in class DeBot\Connection
A shortcut method to sending a privmsg to the server through Raw

N

notice() - Method in class DeBot\Connection
A shortcut method to sending a notice to the server through Raw

O

obj() - Method in class DeBot\Singleton
Use this to fetch the object of the er...
offsetExists() - Method in class DeBot\Servers
offsetExists() - Method in class DeBot\Config
offsetExists() - Method in class DeBot\Modules
offsetExists() - Method in class DeBot\Channel
offsetExists() - Method in class DeBot\Bot
offsetGet() - Method in class DeBot\Servers
offsetGet() - Method in class DeBot\Modules
offsetGet() - Method in class DeBot\Bot
offsetGet() - Method in class DeBot\Config
offsetGet() - Method in class DeBot\Channel
offsetSet() - Method in class DeBot\Channel
offsetSet() - Method in class DeBot\Modules
offsetSet() - Method in class DeBot\Servers
offsetSet() - Method in class DeBot\Bot
offsetSet() - Method in class DeBot\Config
offsetUnset() - Method in class DeBot\Modules
offsetUnset() - Method in class DeBot\Config
offsetUnset() - Method in class DeBot\Servers
offsetUnset() - Method in class DeBot\Bot
offsetUnset() - Method in class DeBot\Channel
onConnect() - Method in class DeBot\m_RawEval
Once the MOTD is done, the bot is declared connected.
onConnect() - Method in class DeBot\Module
Once the MOTD is done, the bot is declared connected.
onError() - Method in class DeBot\Logs
This function is called by the Error handler of PHP.
onFatal() - Method in class DeBot\Logs
Called on fatal errors.
onJoin() - Method in class DeBot\Module
When a user joins the channel
onKick() - Method in class DeBot\Module
This is called when a user is kickd.
onKick() - Method in class DeBot\m_RawEval
This is called when a user is kickd.
onMode() - Method in class DeBot\Servers
Called onmode changes/listing
onMode() - Method in class DeBot\Channel
The mode and the parameters used on a channel
onMode() - Method in class DeBot\Module
When a mode is changed on the channel
onMsg() - Method in class DeBot\m_Cmds
Most obvious.
onMsg() - Method in class DeBot\Module
Most obvious.
onMsg() - Method in class DeBot\m_RawEval
Most obvious.
onNames() - Method in class DeBot\Servers
Called on a /names call return.
onNames() - Method in class DeBot\Channel
Run this function onNames callback.
onNick() - Method in class DeBot\Module
This is called when a user changes his/her nickname
onNick() - Method in class DeBot\m_RawEval
This is called when a user changes his/her nickname
onNotice() - Method in class DeBot\Module
When a channel notice is received.
onPart() - Method in class DeBot\Module
When a user parts
onPart() - Method in class DeBot\m_RawEval
When a user parts
onPrivMsg() - Method in class DeBot\m_RawEval
Called when someone sends a message directly to the bot
onPrivMsg() - Method in class DeBot\m_Cmds
Called when someone sends a message directly to the bot
onPrivMsg() - Method in class DeBot\Module
Called when someone sends a message directly to the bot
onPrivNotice() - Method in class DeBot\m_Cmds
Private notice (/notice DeBot ohi! )
onPrivNotice() - Method in class DeBot\Module
Private notice (/notice DeBot ohi! )
onQuit() - Method in class DeBot\Module
When a user Quits the IRC network
onQuit() - Method in class DeBot\m_RawEval
When a user Quits the IRC network
onRaw() - Method in class DeBot\Module
This is called when we receive a raw command.
onTopic() - Method in class DeBot\Module
When the topic is changed
onTopic() - Method in class DeBot\Servers
When a topic is changed
onTopic() - Method in class DeBot\Channel
Set the chanenl's topic
onWhois() - Method in class DeBot\Module
onWhois.

P

parse() - Method in class DeBot\m_RawEval
part() - Method in class DeBot\Bot
Just like the join method but for joining channels.
process() - Method in class DeBot\Bot
This is our motherload of methods.

R

raw() - Method in class DeBot\Bot
I'm kind of proud of this command.
raw() - Method in class DeBot\m_RawEval
raw() - Method in class DeBot\Connection
As I knew would happen, we don't want to do fwrite() everywhere.
reload() - Method in class DeBot\Modules
This method reloads a module from the disk.

S

saveCmds() - Method in class DeBot\m_Cmds
Servers() - Class in package DeBot
DeBot Core - Servers Created by dab ??? ?? 2009 Last Edited: Aug 15 2010 This manages all of our known networks.
setDef() - Method in class DeBot\Bots
This sets the default bot.
setDef() - Method in class DeBot\Bot
This sets the default bot...
setNick() - Method in class DeBot\Module
what? Why would we want to change the module bot's nick? Oh..
Singleton() - Class in package DeBot
DeBot Core - Singleton Created by dab ??? ?? 2009 Last Edited: Aug 15 2010 This class lets us makes all of the classes available anywhere via a static call.

T

tick() - Method in class DeBot\Timers
TICK TOCK TICK TOCK.
Timers() - Class in package DeBot
DeBot Core - Timers Created by dab ??? ?? 2009 Last Edited: Aug 15 2010 We maintain a time based

U

unload() - Method in class DeBot\Modules
We can unload a module so none of the callbacks are called.
updateLogHandle() - Method in class DeBot\Logs
This occurs every so often (seconds) to update the file we are writing to if the time of day changes (midnight).
userLevel() - Method in class DeBot\m_RawEval

V

VERSION() - Global in package DeBot
Defines the version of the bot.
VERSION_STR() - Global in package DeBot
Defines the string version of the bot.

DeBot Framework