1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* Fwk |
4
|
|
|
* |
5
|
|
|
* Copyright (c) 2011-2014, Julien Ballestracci <[email protected]>. |
6
|
|
|
* All rights reserved. |
7
|
|
|
* |
8
|
|
|
* For the full copyright and license information, please view the LICENSE |
9
|
|
|
* file that was distributed with this source code. |
10
|
|
|
* |
11
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
12
|
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
13
|
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
14
|
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
15
|
|
|
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
16
|
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
17
|
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
18
|
|
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
19
|
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
20
|
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
21
|
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
22
|
|
|
* POSSIBILITY OF SUCH DAMAGE. |
23
|
|
|
* |
24
|
|
|
* PHP Version 5.3 |
25
|
|
|
* |
26
|
|
|
* @category Database |
27
|
|
|
* @package Fwk |
28
|
|
|
* @subpackage Db |
29
|
|
|
* @author Julien Ballestracci <[email protected]> |
30
|
|
|
* @copyright 2011-2014 Julien Ballestracci <[email protected]> |
31
|
|
|
* @license http://www.opensource.org/licenses/bsd-license.php BSD License |
32
|
|
|
* @link http://www.nitronet.org/fwk |
33
|
|
|
*/ |
34
|
|
|
namespace Fwk\Db\Events; |
35
|
|
|
|
36
|
|
|
use Fwk\Db\Table; |
37
|
|
|
use Fwk\Events\Event; |
38
|
|
|
use Fwk\Db\Connection; |
39
|
|
|
|
40
|
|
|
/** |
41
|
|
|
* Abstract class for Entity-events. |
42
|
|
|
* |
43
|
|
|
* Entity-events are events catchable by an EventSubscriberInterface entity. |
44
|
|
|
* |
45
|
|
|
* @category Events |
46
|
|
|
* @package Fwk\Db |
47
|
|
|
* @author Julien Ballestracci <[email protected]> |
48
|
|
|
* @license http://www.opensource.org/licenses/bsd-license.php BSD License |
49
|
|
|
* @link http://www.nitronet.org/fwk |
50
|
|
|
*/ |
51
|
|
|
abstract class AbstractEntityEvent extends Event |
52
|
|
|
{ |
53
|
|
|
const EVENT_NAME = 'dbEvent'; |
54
|
|
|
|
55
|
|
|
/** |
56
|
|
|
* Constructor |
57
|
|
|
* |
58
|
|
|
* @param Connection $connection The Database connection |
59
|
|
|
* @param Table $table The entity's table |
60
|
|
|
* @param object $entity The entity |
61
|
|
|
* |
62
|
|
|
* @return void |
|
|
|
|
63
|
|
|
*/ |
64
|
|
|
public function __construct(Connection $connection, Table $table, $entity) |
65
|
|
|
{ |
66
|
|
|
parent::__construct( |
67
|
|
|
static::EVENT_NAME, array( |
68
|
|
|
'connection' => $connection, |
69
|
|
|
'table' => $table, |
70
|
|
|
'entity' => $entity |
71
|
|
|
) |
72
|
|
|
); |
73
|
|
|
} |
74
|
|
|
|
75
|
|
|
/** |
76
|
|
|
* Returns the Database Connection |
77
|
|
|
* |
78
|
|
|
* @return Connection |
79
|
|
|
*/ |
80
|
|
|
public function getConnection() |
81
|
|
|
{ |
82
|
|
|
return $this->connection; |
|
|
|
|
83
|
|
|
} |
84
|
|
|
|
85
|
|
|
/** |
86
|
|
|
* Returns the entity's table instance |
87
|
|
|
* |
88
|
|
|
* @return Table |
89
|
|
|
*/ |
90
|
|
|
public function getTable() |
91
|
|
|
{ |
92
|
|
|
return $this->table; |
|
|
|
|
93
|
|
|
} |
94
|
|
|
|
95
|
|
|
/** |
96
|
|
|
* Returns the entity |
97
|
|
|
* |
98
|
|
|
* @return object |
99
|
|
|
*/ |
100
|
|
|
public function getEntity() |
101
|
|
|
{ |
102
|
|
|
return $this->entity; |
|
|
|
|
103
|
|
|
} |
104
|
|
|
} |
Adding a
@return
annotation to a constructor is not recommended, since a constructor does not have a meaningful return value.Please refer to the PHP core documentation on constructors.