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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
|
<?php
/**
* TRatingList class file.
*
* @author Wei Zhuo <weizhuo[at]gmail[dot]com>
* @link http://www.pradosoft.com/
* @copyright Copyright © 2005-2014 PradoSoft
* @license http://www.pradosoft.com/license/
* @package Prado\Web\UI\WebControls
*/
namespace Prado\Web\UI\WebControls;
/**
* Includes TRadioButtonList class
*/
Prado::using('System.Web.UI.WebControls.TRadioButtonList');
/**
* TRatingList class.
*
* This class is EXPERIMENTAL.
*
* @author Wei Zhuo <weizhuo[at]gmail[dot]com>
* @author Bradley Booms <bradley[dot]booms[at]gmail[dot]com>
* @package Prado\Web\UI\WebControls
* @since 3.0
*/
class TRatingList extends TRadioButtonList
{
/**
* Script path relative to the TClientScriptManager::SCRIPT_PATH
*/
const SCRIPT_PATH='prado/ratings';
/**
* @var array list of published rating images.
*/
private $_ratingImages = array();
/**
* Sets the default repeat direction to horizontal.
*/
public function __construct()
{
parent::__construct();
$this->setRepeatDirection(TRepeatDirection::Horizontal);
}
/**
* @return boolean whether the items in the column can be edited. Defaults to false.
*/
public function getReadOnly()
{
return $this->getViewState('ReadOnly',false);
}
/**
* @param boolean whether the items in the column can be edited
*/
public function setReadOnly($value)
{
$this->setViewState('ReadOnly',TPropertyValue::ensureBoolean($value),false);
}
/**
* Wrapper for {@link setReadOnly ReadOnly} property.
* @return boolean whether the rating list can be edited. Defaults to true.
*/
public function getAllowInput()
{
return !$this->getReadOnly();
}
/**
* Wrapper for {@link setReadOnly ReadOnly} property.
* @param boolean whether the rating list can be edited
*/
public function setAllowInput($value)
{
$this->setReadOnly(!TPropertyValue::ensureBoolean($value));
}
/**
* Wrapper for {@link setReadOnly ReadOnly} property.
* @param boolean whether the rating list can be edited
*/
public function setEnabled($value)
{
$this->setReadOnly(!TPropertyValue::ensureBoolean($value));
}
/**
* The repeat layout must be Table.
* @param string repeat layout type
* @throws TInvaliddataValueException when repeat layout is not Table.
*/
public function setRepeatLayout($value)
{
if($value!==TRepeatLayout::Table)
throw new TInvalidDataValueException('ratinglist_table_layout_only');
else
parent::setRepeatLayout($value);
}
/**
* @return float rating value.
*/
public function getRating()
{
$rating = $this->getViewState('Rating', null);
if ($rating === null)
return $this->getSelectedIndex()+1;
else
return $rating;
}
/**
* @param float rating value, also sets the selected Index
*/
public function setRating($value)
{
$value = TPropertyValue::ensureFloat($value);
$this->setViewState('Rating', $value, null);
$index = $this->getRatingIndex($value);
parent::setSelectedIndex($index);
}
public function setSelectedIndex($value)
{
$this->setRating($value+1);
parent::setSelectedIndex($value);
}
/**
* @param float rating value
* @return int rating as integer
*/
protected function getRatingIndex($rating)
{
$interval = $this->getHalfRatingInterval();
$base = intval($rating)-1;
$remainder = $rating-$base-1;
return $remainder > $interval[1] ? $base+1 : $base;
}
/**
* @param int change the rating selection index
*/
public function onSelectedIndexChanged($param)
{
$value = $this->getRating();
$value = TPropertyValue::ensureInteger($value);
$this->setRating($value);
parent::onSelectedIndexChanged($param);
}
/**
* @return string control or html element ID for displaying a caption.
*/
public function getCaptionID()
{
return $this->getViewState('CaptionID', '');
}
/**
* @param string control or html element ID for displaying a caption.
*/
public function setCaptionID($value)
{
$this->setViewState('CaptionID', $value, '');
}
protected function getCaptionControl()
{
if(($id=$this->getCaptionID())!=='')
{
if($control=$this->getPage()->findControl($id))
return $control;
if($control=$this->getNamingContainer()->findControl($id))
return $control;
}
throw new TInvalidDataValueException(
'ratinglist_invalid_caption_id',$id,$this->getID());
}
/**
* @return string caption text. Default is "Rate It:".
*/
public function getCaption()
{
return $this->getCaptionControl()->getText();
}
/**
* @return TRatingListStyle current rating style
*/
public function setCaption($value)
{
$this->getCaptionControl()->setText($value);
}
/**
* @param string set the rating style, default is "default"
*/
public function setRatingStyle($value)
{
$this->setViewState('RatingStyle', $value, 'default');
}
/**
* @return TRatingListStyle current rating style
*/
public function getRatingStyle()
{
return $this->getViewState('RatingStyle', 'default');
}
/**
* @return string rating style css class name.
*/
protected function getRatingStyleCssClass()
{
return 'TRatingList_'.$this->getRatingStyle();
}
/**
* Sets the interval such that those rating values within the interval
* will be considered as a half star rating.
* @param array rating display half value interval, default is array(0.3, 0.7);
*/
public function setHalfRatingInterval($value)
{
$this->setViewState('HalfRating',
TPropertyValue::ensureArray($value), array(0.3, 0.7));
}
/**
* @return array rating display half value interval, default is array(0.3, 0.7);
*/
public function getHalfRatingInterval()
{
return $this->getViewState('HalfRating', array(0.3, 0.7));
}
/**
* @return array list of post back options.
*/
protected function getPostBackOptions()
{
$options = parent::getPostBackOptions();
$options['AutoPostBack'] = $this->getAutoPostBack();
$options['ReadOnly'] = $this->getReadOnly();
$options['Style'] = $this->getRatingStyleCssClass();
$options['CaptionID'] = $this->getCaptionControlID();
$options['SelectedIndex'] = $this->getSelectedIndex();
$options['Rating'] = $this->getRating();
$options['HalfRating'] = $this->getHalfRatingInterval();
return $options;
}
/**
* @return string find the client ID of the caption control.
*/
protected function getCaptionControlID()
{
if(($id=$this->getCaptionID())!=='')
{
if($control=$this->getParent()->findControl($id))
{
if($control->getVisible(true))
return $control->getClientID();
}
else
return $id;
}
return '';
}
/**
* Publish the the rating style css file and rating image files.
*/
public function onPreRender($param)
{
parent::onPreRender($param);
$this->publishStyle($this->getRatingStyle());
$this->_ratingImages = $this->publishImages($this->getRatingStyle());
$this->registerClientScript();
}
/**
* @param string rating style name
* @return string URL of the css style file
*/
protected function publishStyle($style)
{
$cs = $this->getPage()->getClientScript();
$url = $this->getAssetUrl($style.'.css');
if(!$cs->isStyleSheetFileRegistered($url))
$cs->registerStyleSheetFile($url, $url);
return $url;
}
/**
* @param string rating style name
* @param string rating image file extension, default is '.gif'
* @return array URL of publish the rating images
*/
protected function publishImages($style, $fileExt='.gif')
{
$types = array('blank', 'selected', 'half', 'combined');
$files = array();
foreach($types as $type)
$files[$type] = $this->getAssetUrl("{$style}_{$type}{$fileExt}");
return $files;
}
/**
* Registers the relevant JavaScript.
*/
protected function registerClientScript()
{
$cs=$this->getPage()->getClientScript();
$cs->registerPradoScript('ratings');
}
/**
* @param string asset file in the self::SCRIPT_PATH directory.
* @return string asset file url.
*/
protected function getAssetUrl($file='')
{
$base = $this->getPage()->getClientScript()->getPradoScriptAssetUrl();
return $base.'/'.self::SCRIPT_PATH.'/'.$file;
}
/**
* Add rating style class name to the class attribute
* when {@link setReadOnly ReadOnly} property is true and when the
* {@link setCssClass CssClass} property is empty.
* @param THtmlWriter renderer
*/
public function render($writer)
{
$writer->addAttribute('id',$this->getClientID());
$this->getPage()->getClientScript()->registerPostBackControl(
$this->getClientClassName(), $this->getPostBackOptions());
parent::render($writer);
}
/**
* Gets the name of the javascript class responsible for performing postback for this control.
* This method overrides the parent implementation.
* @return string the javascript class name
*/
protected function getClientClassName()
{
return 'Prado.WebUI.TRatingList';
}
}
|