• Home
• Phergie_Plugin_Abstract

PHP Class Phergie_Plugin_Abstract, phergie

ファイルを表示 Open project: phergie/phergie Class Usage Examples

Protected Properties

Property	Type	Description
$config	Phergie_Config	Current configuration handler
$connection	Phergie_Connection	Current connection instance
$event	Phergie_Event_Request | Phergie_Event_Response	Current incoming event being handled
$events	Phergie_Event_Handler	Current event handler instance for outgoing events
$name	string	Plugin short name
$plugins	Phergie_Plugin_Handler	Plugin handler used to provide access to other plugins

Public Methods

Method	Description
__call ( string $name, array $args ) : mixed	Provides do* methods with signatures identical to those of Phergie_Driver_Abstract but that queue up events to be dispatched later.
findDataFile ( string $filename ) : string | null	Locates a given data file used by this plugin and returns the path to it. This is currently used mainly for compatibility with PEAR packaging.
getConfig ( string $name = null, mixed $default = null ) : Phergie_Config | mixed	Returns the current configuration handler or the value of a single setting from it.
getConnection ( ) : Phergie_Connection	Returns the current event connection.
getEvent ( ) : Phergie_Event_Request | Phergie_Event_Response	Returns the current incoming event to be handled.
getEventHandler ( ) : Phergie_Event_Handler	Returns the current event handler.
getName ( ) : string	Returns the short name for the plugin based on its class name.
getPluginHandler ( ) : Phergie_Plugin_Handler	Returns the current plugin handler.
onAction ( ) : void	Handler for when the bot receives a CTCP ACTION request.
onConnect ( ) : void	Handler for when the bot initially connects to a server.
onCtcp ( ) : void	Handler for when the bot receives a CTCP request of an unknown type.
onCtcpPing ( ) : void	Handler for when the bot receives a CTCP PING request.
onCtcpReply ( ) : void	Handler for when a reply received for a CTCP request of an unknown type.
onInvite ( ) : void	Handler for when the bot receives an invitation to join a channel.
onJoin ( ) : void	Handler for when a user joins a channel.
onKick ( ) : void	Handler for when a user is kicked from a channel.
onKill ( ) : void	Handler for when the bot receives a kill request from a server.
onLoad ( ) : void	Handler for when the plugin is initially loaded - useful for checking runtime dependencies or performing any setup necessary for the plugin to function properly such as initializing a database.
onMode ( ) : void	Handler for when a user or channel mode is changed.
onNick ( ) : void	Handler for when the server prompts the client for a nick.
onNotice ( ) : void	Handler for when a notice is received.
onOper ( ) : void	Handler for when a user obtains operator privileges.
onPart ( ) : void	Handler for when a user leaves a channel.
onPing ( ) : void	Handler for when the bot receives a ping event from a server, at which point it is expected to respond with a pong request within a short period else the server may terminate its connection.
onPingReply ( ) : void	Handler for when a reply is received for a CTCP PING request sent by the bot.
onPrivmsg ( ) : void	Handler for when a message is received from a channel or user.
onQuit ( ) : void	Handler for when the client session is about to be terminated.
onResponse ( ) : void	Handler for when a server response is received to a command issued by the bot.
onTick ( ) : void	Handler for each tick, a single iteration of the continuous loop executed by the bot to receive, handle, and send events - useful for repeated execution of tasks on a time interval.
onTime ( ) : void	Handler for when the bot receives a CTCP TIME request.
onTimeReply ( ) : void	Handler for when a reply is received for a CTCP TIME request sent by the bot.
onTopic ( ) : void	Handler for when a channel topic is viewed or changed.
onVersion ( ) : void	Handler for when the bot receives a CTCP VERSION request.
onVersionReply ( ) : void	Handler for when a reply is received for a CTCP VERSION request sent by the bot.
postDispatch ( ) : void	Handler for after any events triggered by plugins in response to a received event are sent to the server.
preDispatch ( ) : void	Handler for after plugin processing of an event has concluded but before any events triggered in response by plugins are sent to the server - useful for modifying outgoing events before they are sent.
preEvent ( ) : boolean | null | void	Handler for when any event is received but has not yet been dispatched to the plugin handler method specific to its event type.
setConfig ( Phergie_Config $config ) : Phergie_Plugin_Abstract	Sets the current configuration handler.
setConnection ( Phergie_Connection $connection ) : Phergie_Plugin_Abstract	Sets the current connection.
setEvent ( Phergie_Event_Request | Phergie_Event_Response $event ) : Phergie_Plugin_Abstract	Sets the current incoming event to be handled.
setEventHandler ( Phergie_Event_Handler $handler ) : Phergie_Plugin_Abstract	Sets the current event handler.
setName ( string $name ) : Phergie_Plugin_Abstract	Sets the short name for the plugin.
setPluginHandler ( Phergie_Plugin_Handler $handler ) : Phergie_Plugin_Abstract	Sets the current plugin handler.

Protected Methods

Method	Description
fail ( string $message ) : Phergie_Plugin_Abstract	Indicates that the plugin failed to load due to an unsatisfied runtime requirement, such as a missing dependency.

Method Details

Property Details