PHP Class Phergie_Ui_Abstract, phergie

Author: Phergie Development Team ([email protected])
Exibir arquivo Open project: phergie/phergie Class Usage Examples

Public Methods

Method Description
onCommand ( Phergie_Event_Command $event, Phergie_Connection $connection ) : void Handler for when the bot sends a command to a server.
onConnect ( string $host ) : void Handler for when a server connection is attempted.
onEvent ( Phergie_Event_Abstract $event, Phergie_Connection $connection ) : void Handler for when the bot receives an IRC event.
onPluginFailure ( string $plugin, string $message ) : void Handler for when a plugin fails to load.
onPluginLoad ( string $plugin ) : void Handler for when an attempt is made to load a plugin.
onQuit ( Phergie_Connection $connection ) : void Handler for when the bot terminates a connection to a server.
onShutdown ( ) : void Handler for when the bot shuts down after terminating all server connections.

Method Details

onCommand() public method

Handler for when the bot sends a command to a server.
public onCommand ( Phergie_Event_Command $event, Phergie_Connection $connection ) : void
$event Phergie_Event_Command Event representing the command being sent
$connection Phergie_Connection Connection on which the command is being sent
return void

onConnect() public method

Handler for when a server connection is attempted.
public onConnect ( string $host ) : void
$host string Server hostname
return void

onEvent() public method

Handler for when the bot receives an IRC event.
public onEvent ( Phergie_Event_Abstract $event, Phergie_Connection $connection ) : void
$event Phergie_Event_Abstract Received event
$connection Phergie_Connection Connection on which the event was received
return void

onPluginFailure() public method

Handler for when a plugin fails to load.
public onPluginFailure ( string $plugin, string $message ) : void
$plugin string Short name of the plugin
$message string Message describing the reason for the failure
return void

onPluginLoad() public method

Handler for when an attempt is made to load a plugin.
public onPluginLoad ( string $plugin ) : void
$plugin string Short name of the plugin
return void

onQuit() public method

Handler for when the bot terminates a connection to a server.
public onQuit ( Phergie_Connection $connection ) : void
$connection Phergie_Connection Terminated connection
return void

onShutdown() public method

Handler for when the bot shuts down after terminating all server connections.
public onShutdown ( ) : void
return void