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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
<?php
/**
* TJuiControlOptions class file.
*
* @author Fabio Bas <ctrlaltca@gmail.com>
* @link https://github.com/pradosoft/prado
* @copyright Copyright © 2013-2015 PradoSoft
* @license https://github.com/pradosoft/prado/blob/master/COPYRIGHT
* @package System.Web.UI.JuiControls
*/
/**
* IJuiOptions interface
*
* IJuiOptions is the interface that must be implemented by controls using
* {@link TJuiControlOptions}.
*
* @author Fabio Bas <ctrlaltca@gmail.com>
* @package System.Web.UI.JuiControls
* @since 3.3
*/
interface IJuiOptions
{
public function getWidget();
public function getWidgetID();
public function getOptions();
public function getValidOptions();
public function getValidEvents();
}
/**
* TJuiControlOptions interface
*
* TJuiControlOptions is an helper class that can collect a list of options
* for a control. The control must implement {@link IJuiOptions}.
* The options are validated againg an array of valid options provided by the control itself.
* Since component properties are case insensitive, the array of valid options is used
* to ensure the option name has the correct case.
* The options array can then get retrieved using {@link toArray} and applied to the jQuery-ui widget.
* In addition to the options, this class will render the needed javascript to raise a callback
* for any event for which an handler is defined in the control.
*
* @author Fabio Bas <ctrlaltca@gmail.com>
* @package System.Web.UI.JuiControls
* @since 3.3
*/
class TJuiControlOptions
{
/**
* @var TMap map of javascript options.
*/
private $_options;
/**
* @var TControl parent control.
*/
private $_control;
/**
* Constructor. Set the parent control owning these options.
* @param TControl parent control
*/
public function __construct($control)
{
$this->setControl($control);
}
/**
* Sets the parent control.
* @param TControl $control
* @throws THttpException
*/
public function setControl($control)
{
if(!$control instanceof IJuiOptions)
throw new THttpException(500,'juioptions_control_invalid',$control->ID);
$this->_control=$control;
}
/**
* Sets a named options with a value. Options are used to store and retrive
* named values for the javascript control.
* @param string option name.
* @param mixed option value.
* @throws THttpException
*/
public function __set($name,$value)
{
if($this->_options===null)
$this->_options=array();
foreach($this->_control->getValidOptions() as $option)
{
if(0 == strcasecmp($name, $option))
{
$low = strtolower($value);
if($low === 'null')
{
$this->_options[$option] = null;
} elseif($low === 'true') {
$this->_options[$option] = true;
} elseif($low === 'false') {
$this->_options[$option] = false;
} elseif(is_numeric($value)) {
// trick to get float or integer automatically when needed
$this->_options[$option] = $value + 0;
} elseif(substr($low,0,8)=='function') {
$this->_options[$option] = new TJavaScriptLiteral($value);
} else {
$this->_options[$option] = $value;
}
return;
}
}
throw new TConfigurationException('juioptions_option_invalid',$this->_control->ID, $name);
}
/**
* Gets an option named value. Options are used to store and retrive
* named values for the base active controls.
* @param string option name.
* @return mixed options value or null if not set.
*/
public function __get($name)
{
if($this->_options===null)
$this->_options=array();
foreach($this->_control->getValidOptions() as $option)
{
if(0 == strcasecmp($name, $option) && isset($this->_options[$option]))
{
return $this->_options[$option];
}
}
return null;
}
/**
* Only serialize the options itself, not the corresponding parent control.
* @return mixed array with the names of all variables of that object that should be serialized.
*/
public function __sleep() {
return array('_options');
}
/**
* @return Array of active control options
*/
public function toArray()
{
$ret= ($this->_options===null) ? array() : $this->_options;
foreach($this->_control->getValidEvents() as $event)
if($this->_control->hasEventHandler('on'.$event))
$ret[$event]=new TJavaScriptLiteral("function( event, ui ) { Prado.JuiCallback(".TJavascript::encode($this->_control->getUniqueID()).", ".TJavascript::encode($event).", event, ui, this); }");
return $ret;
}
/**
* Raise the specific callback event handler of the target control.
* @param mixed callback parameters
*/
public function raiseCallbackEvent($param)
{
$callbackParam=$param->CallbackParameter;
if(isset($callbackParam->event))
{
$eventName = 'On'.ucfirst($callbackParam->event);
if($this->_control->hasEventHandler($eventName))
{
$this->_control->$eventName( new TJuiEventParameter(
$this->_control->getResponse(),
isset($callbackParam->ui) ? $callbackParam->ui : null)
);
}
}
}
}
|
