summaryrefslogtreecommitdiff
path: root/plugins/Irc/extlib/phergie/Phergie/Event/Command.php
blob: 5940636ba7503d50fc577c401e2a67a198772108 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<?php
/**
 * Phergie 
 *
 * 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 
 * @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
 */

/**
 * Event originating from a plugin for the bot.
 *
 * @category Phergie 
 * @package  Phergie
 * @author   Phergie Development Team <team@phergie.org>
 * @license  http://phergie.org/license New BSD License
 * @link     http://pear.phergie.org/package/Phergie
 */
class Phergie_Event_Command extends Phergie_Event_Request
{
    /**
     * Reference to the plugin instance that created the event
     *
     * @var Phergie_Plugin_Abstract
     */
    protected $plugin;

    /**
     * Stores a reference to the plugin instance that created the event.
     *
     * @param Phergie_Plugin_Abstract $plugin Plugin instance
     *
     * @return Phergie_Event_Command Provides a fluent interface
     */
    public function setPlugin(Phergie_Plugin_Abstract $plugin)
    {
        $this->plugin = $plugin;
        return $this;
    }

    /**
     * Returns a reference to the plugin instance that created the event.
     *
     * @return Phergie_Plugin_Abstract
     */
    public function getPlugin()
    {
        return $this->plugin;
    }
}