gnu-social/plugins/Irc/extlib/phergie/Phergie/Process/Abstract.php

131 lines
3.2 KiB
PHP
Raw Normal View History

2010-06-16 01:55:39 +01:00
<?php
/**
2010-08-03 17:42:02 +01:00
* Phergie
2010-06-16 01:55:39 +01:00
*
* PHP version 5
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.
* It is also available through the world-wide-web at this URL:
* http://phergie.org/license
*
2010-08-03 17:42:02 +01:00
* @category Phergie
2010-06-16 01:55:39 +01:00
* @package Phergie
* @author Phergie Development Team <team@phergie.org>
* @copyright 2008-2010 Phergie Development Team (http://phergie.org)
* @license http://phergie.org/license New BSD License
* @link http://pear.phergie.org/package/Phergie
*/
/**
* Base class for obtaining and processing incoming events.
*
2010-08-03 17:42:02 +01:00
* @category Phergie
2010-06-16 01:55:39 +01:00
* @package Phergie
* @author Phergie Development Team <team@phergie.org>
* @license http://phergie.org/license New BSD License
* @link http://pear.phergie.org/package/Phergie
*/
abstract class Phergie_Process_Abstract
{
/**
* Current driver instance
*
* @var Phergie_Driver_Abstract
*/
protected $driver;
/**
2010-08-03 17:42:02 +01:00
* Current connection handler instance
2010-06-16 01:55:39 +01:00
*
2010-08-03 17:42:02 +01:00
* @var Phergie_Connection_Handler
2010-06-16 01:55:39 +01:00
*/
protected $connections;
/**
* Current plugin handler instance
*
* @var Phergie_Plugin_Handler
*/
protected $plugins;
/**
* Current event handler instance
*
* @var Phergie_Event_Handler
*/
protected $events;
/**
* Current end-user interface instance
*
* @var Phergie_Ui_Abstract
*/
protected $ui;
/**
* List of arguments for use within the instance
*
* @var array
*/
protected $options = array();
/**
* Gets the required class refences from Phergie_Bot.
*
2010-08-03 17:42:02 +01:00
* @param Phergie_Bot $bot Current bot instance in use
2010-06-16 01:55:39 +01:00
* @param array $options Optional processor arguments
2010-08-03 17:42:02 +01:00
*
2010-06-16 01:55:39 +01:00
* @return void
*/
public function __construct(Phergie_Bot $bot, array $options = array())
{
$this->driver = $bot->getDriver();
$this->plugins = $bot->getPluginHandler();
$this->connections = $bot->getConnectionHandler();
$this->events = $bot->getEventHandler();
$this->ui = $bot->getUi();
$this->options = $options;
}
/**
* Sends resulting outgoing events from ealier processing in handleEvents.
*
* @param Phergie_Connection $connection Active connection
*
* @return void
*/
protected function processEvents(Phergie_Connection $connection)
{
2010-08-03 17:42:02 +01:00
$this->plugins->preDispatch();
2010-06-16 01:55:39 +01:00
if (count($this->events)) {
foreach ($this->events as $event) {
$this->ui->onCommand($event, $connection);
$method = 'do' . ucfirst(strtolower($event->getType()));
call_user_func_array(
array($this->driver, $method),
$event->getArguments()
);
}
2010-08-03 17:42:02 +01:00
}
$this->plugins->postDispatch();
2010-06-16 01:55:39 +01:00
2010-08-03 17:42:02 +01:00
if ($this->events->hasEventOfType(Phergie_Event_Request::TYPE_QUIT)) {
$this->ui->onQuit($connection);
$this->connections->removeConnection($connection);
2010-06-16 01:55:39 +01:00
}
2010-08-03 17:42:02 +01:00
$this->events->clearEvents();
2010-06-16 01:55:39 +01:00
}
/**
* Obtains and processes incoming events.
*
* @return void
*/
public abstract function handleEvents();
}