9 * This source file is subject to the new BSD license that is bundled
10 * with this package in the file LICENSE.
11 * It is also available through the world-wide-web at this URL:
12 * http://phergie.org/license
16 * @author Phergie Development Team <team@phergie.org>
17 * @copyright 2008-2010 Phergie Development Team (http://phergie.org)
18 * @license http://phergie.org/license New BSD License
19 * @link http://pear.phergie.org/package/Phergie
23 * Base class for end-user interfaces.
27 * @author Phergie Development Team <team@phergie.org>
28 * @license http://phergie.org/license New BSD License
29 * @link http://pear.phergie.org/package/Phergie
31 abstract class Phergie_Ui_Abstract
34 * Handler for when a server connection is attempted.
36 * @param string $host Server hostname
40 public function onConnect($host)
45 * Handler for when an attempt is made to load a plugin.
47 * @param string $plugin Short name of the plugin
51 public function onPluginLoad($plugin)
56 * Handler for when a plugin fails to load.
58 * @param string $plugin Short name of the plugin
59 * @param string $message Message describing the reason for the failure
63 public function onPluginFailure($plugin, $message)
68 * Handler for when the bot receives an IRC event.
70 * @param Phergie_Event_Abstract $event Received event
71 * @param Phergie_Connection $connection Connection on which the event
76 public function onEvent(Phergie_Event_Abstract $event,
77 Phergie_Connection $connection
82 * Handler for when the bot sends a command to a server.
84 * @param Phergie_Event_Command $event Event representing the command
86 * @param Phergie_Connection $connection Connection on which the command
91 public function onCommand(Phergie_Event_Command $event,
92 Phergie_Connection $connection
97 * Handler for when the bot terminates a connection to a server.
99 * @param Phergie_Connection $connection Terminated connection
103 public function onQuit(Phergie_Connection $connection)
108 * Handler for when the bot shuts down after terminating all server
113 public function onShutdown()