gnu-social/plugins/Irc/extlib/phergie/Phergie/Plugin/Quit.php

61 lines
1.6 KiB
PHP
Raw Normal View History

2010-06-16 01:55:39 +01:00
<?php
/**
* 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
*
* @category Phergie
2010-06-16 01:55:39 +01:00
* @package Phergie_Plugin_Quit
* @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_Plugin_Quit
*/
/**
* Terminates the current connection upon command.
*
* @category Phergie
2010-06-16 01:55:39 +01:00
* @package Phergie_Plugin_Quit
* @author Phergie Development Team <team@phergie.org>
* @license http://phergie.org/license New BSD License
* @link http://pear.phergie.org/package/Phergie_Plugin_Quit
* @uses Phergie_Plugin_Command pear.phergie.org
*
* @pluginDesc Terminates the current connection upon command.
2010-06-16 01:55:39 +01:00
*/
class Phergie_Plugin_Quit extends Phergie_Plugin_Abstract
{
/**
* Checks for dependencies.
*
* @return void
*/
public function onLoad()
{
$this->getPluginHandler()->getPlugin('Command');
$help = $this->getPluginHandler()->getPlugin('Help');
$help->register($this);
2010-06-16 01:55:39 +01:00
}
/**
* Issues a quit command when a message is received requesting that the
2010-06-16 01:55:39 +01:00
* bot terminate the current connection.
*
* @return void
*
* @pluginCmd terminates the connection
2010-06-16 01:55:39 +01:00
*/
public function onCommandQuit()
{
$this->doQuit('Requested by ' . $this->getEvent()->getNick());
}
}