plugins/Irc/extlib/phergie/Phergie/Event/Command.php

   1 <?php
   2 /**
   3  * Phergie
   4  *
   5  * PHP version 5
   6  *
   7  * LICENSE
   8  *
   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
  13  *
  14  * @category  Phergie
  15  * @package   Phergie
  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
  20  */
  21
  22 /**
  23  * Event originating from a plugin for the bot.
  24  *
  25  * @category Phergie
  26  * @package  Phergie
  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
  30  */
  31 class Phergie_Event_Command extends Phergie_Event_Request
  32 {
  33     /**
  34      * Reference to the plugin instance that created the event
  35      *
  36      * @var Phergie_Plugin_Abstract
  37      */
  38     protected $plugin;
  39
  40     /**
  41      * Stores a reference to the plugin instance that created the event.
  42      *
  43      * @param Phergie_Plugin_Abstract $plugin Plugin instance
  44      *
  45      * @return Phergie_Event_Command Provides a fluent interface
  46      */
  47     public function setPlugin(Phergie_Plugin_Abstract $plugin)
  48     {
  49         $this->plugin = $plugin;
  50         return $this;
  51     }
  52
  53     /**
  54      * Returns a reference to the plugin instance that created the event.
  55      *
  56      * @return Phergie_Plugin_Abstract
  57      */
  58     public function getPlugin()
  59     {
  60         return $this->plugin;
  61     }
  62 }