1<?php
2
3/**
4 * Hoa
5 *
6 *
7 * @license
8 *
9 * New BSD License
10 *
11 * Copyright © 2007-2017, Hoa community. All rights reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions are met:
15 *     * Redistributions of source code must retain the above copyright
16 *       notice, this list of conditions and the following disclaimer.
17 *     * Redistributions in binary form must reproduce the above copyright
18 *       notice, this list of conditions and the following disclaimer in the
19 *       documentation and/or other materials provided with the distribution.
20 *     * Neither the name of the Hoa nor the names of its contributors may be
21 *       used to endorse or promote products derived from this software without
22 *       specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37namespace Hoa\Event;
38
39/**
40 * Class \Hoa\Event\Bucket.
41 *
42 * This class is the object which is transmit through event channels.
43 *
44 * @copyright  Copyright © 2007-2017 Hoa community
45 * @license    New BSD License
46 */
47class Bucket
48{
49    /**
50     * Source object.
51     *
52     * @var \Hoa\Event\Source
53     */
54    protected $_source = null;
55
56    /**
57     * Data.
58     *
59     * @var mixed
60     */
61    protected $_data   = null;
62
63
64
65    /**
66     * Set data.
67     *
68     * @param   mixed   $data    Data.
69     */
70    public function __construct($data = null)
71    {
72        $this->setData($data);
73
74        return;
75    }
76
77    /**
78     * Send this object on the event channel.
79     *
80     * @param   string             $eventId    Event ID.
81     * @param   \Hoa\Event\Source  $source     Source.
82     * @return  void
83     */
84    public function send($eventId, Source $source)
85    {
86        return Event::notify($eventId, $source, $this);
87    }
88
89    /**
90     * Set source.
91     *
92     * @param   \Hoa\Event\Source  $source    Source.
93     * @return  \Hoa\Event\Source
94     */
95    public function setSource(Source $source)
96    {
97        $old           = $this->_source;
98        $this->_source = $source;
99
100        return $old;
101    }
102
103    /**
104     * Get source.
105     *
106     * @return  \Hoa\Event\Source
107     */
108    public function getSource()
109    {
110        return $this->_source;
111    }
112
113    /**
114     * Set data.
115     *
116     * @param   mixed   $data    Data.
117     * @return  mixed
118     */
119    public function setData($data)
120    {
121        $old         = $this->_data;
122        $this->_data = $data;
123
124        return $old;
125    }
126
127    /**
128     * Get data.
129     *
130     * @return  mixed
131     */
132    public function getData()
133    {
134        return $this->_data;
135    }
136}
137