blob: b2833140307fd6d26a36f2df477225690c582cca (
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
<?php
/**
* CBehavior class file.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.yiiframework.com/
* @copyright Copyright © 2008-2009 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
/**
* CBehavior is a convenient base class for behavior classes.
* @author Qiang Xue <qiang.xue@gmail.com>
* @version $Id: CBehavior.php 564 2009-01-21 22:07:10Z qiang.xue $
* @package system.base
* @since 1.0.2
*/
class TBehavior extends TComponent implements IBehavior
{
private $_enabled;
private $_owner;
/**
* Declares events and the corresponding event handler methods.
* The events are defined by the {@link owner} component, while the handler
* methods by the behavior class. The handlers will be attached to the corresponding
* events when the behavior is attached to the {@link owner} component; and they
* will be detached from the events when the behavior is detached from the component.
* @return array events (array keys) and the corresponding event handler methods (array values).
*/
public function events()
{
return array();
}
/**
* Attaches the behavior object to the component.
* The default implementation will set the {@link owner} property
* and attach event handlers as declared in {@link events}.
* Make sure you call the parent implementation if you override this method.
* @param CComponent the component that this behavior is to be attached to.
*/
public function attach($owner)
{
$this->_owner=$owner;
foreach($this->events() as $event=>$handler)
$owner->attachEventHandler($event,array($this,$handler));
}
/**
* Detaches the behavior object from the component.
* The default implementation will unset the {@link owner} property
* and detach event handlers declared in {@link events}.
* Make sure you call the parent implementation if you override this method.
* @param CComponent the component that this behavior is to be detached from.
*/
public function detach($owner)
{
foreach($this->events() as $event=>$handler)
$owner->detachEventHandler($event,array($this,$handler));
$this->_owner=null;
}
/**
* @return CComponent the owner component that this behavior is attached to.
*/
public function getOwner()
{
return $this->_owner;
}
/**
* @return boolean whether this behavior is enabled
*/
public function getEnabled()
{
return $this->_enabled;
}
/**
* @param boolean whether this behavior is enabled
*/
public function setEnabled($value)
{
$this->_enabled=$value;
}
}
/**
* IBehavior interfaces is implemented by all behavior classes.
*
* A behavior is a way to enhance a component with additional methods that
* are defined in the behavior class and not available in the component class.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @version $Id: interfaces.php 956 2009-04-21 15:16:03Z qiang.xue@gmail.com $
* @package system.base
* @since 1.0.2
*/
interface IBehavior
{
/**
* Attaches the behavior object to the component.
* @param CComponent the component that this behavior is to be attached to.
*/
public function attach($component);
/**
* Detaches the behavior object from the component.
* @param CComponent the component that this behavior is to be detached from.
*/
public function detach($component);
/**
* @return boolean whether this behavior is enabled
*/
public function getEnabled();
/**
* @param boolean whether this behavior is enabled
*/
public function setEnabled($value);
}
|
