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
|
<?php
/**
* THiddenField class file.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.xisc.com/
* @copyright Copyright © 2005-2014 PradoSoft
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @package Prado\Web\UI\WebControls
*/
namespace Prado\Web\UI\WebControls;
use Prado\Exceptions\TNotSupportedException;
use Prado\TPropertyValue;
/**
* THiddenField class
*
* THiddenField displays a hidden input field on a Web page.
* The value of the input field can be accessed via {@link getValue Value} property.
* If upon postback the value is changed, a {@link onValueChanged OnValueChanged}
* event will be raised.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @package Prado\Web\UI\WebControls
* @since 3.0
*/
class THiddenField extends \Prado\Web\UI\TControl implements \Prado\Web\UI\IPostBackDataHandler, \Prado\Web\UI\IValidatable, \Prado\IDataRenderer
{
private $_dataChanged=false;
private $_isValid=true;
/**
* @return string tag name of the hidden field.
*/
protected function getTagName()
{
return 'input';
}
/**
* Sets focus to this control.
* This method overrides the parent implementation by forbidding setting focus to this control.
*/
public function focus()
{
throw new TNotSupportedException('hiddenfield_focus_unsupported');
}
/**
* Renders the control.
* This method overrides the parent implementation by rendering
* the hidden field input element.
* @param THtmlWriter the writer used for the rendering purpose
*/
public function render($writer)
{
$uniqueID=$this->getUniqueID();
$this->getPage()->ensureRenderInForm($this);
$writer->addAttribute('type','hidden');
if($uniqueID!=='')
$writer->addAttribute('name',$uniqueID);
if($this->getID()!=='')
$writer->addAttribute('id',$this->getClientID());
if(($value=$this->getValue())!=='')
$writer->addAttribute('value',$value);
if($this->getHasAttributes())
{
foreach($this->getAttributes() as $name=>$value)
$writer->addAttribute($name,$value);
}
$writer->renderBeginTag('input');
$writer->renderEndTag();
}
/**
* Loads hidden field data.
* This method is primarly used by framework developers.
* @param string the key that can be used to retrieve data from the input data collection
* @param array the input data collection
* @return boolean whether the data of the component has been changed
*/
public function loadPostData($key,$values)
{
$value=$values[$key];
if($value===$this->getValue())
return false;
else
{
$this->setValue($value);
return $this->_dataChanged=true;
}
}
/**
* Returns a value indicating whether postback has caused the control data change.
* This method is required by the \Prado\Web\UI\IPostBackDataHandler interface.
* @return boolean whether postback has caused the control data change. False if the page is not in postback mode.
*/
public function getDataChanged()
{
return $this->_dataChanged;
}
/**
* Returns the value to be validated.
* This methid is required by \Prado\Web\UI\IValidatable interface.
* @return mixed the value of the property to be validated.
*/
public function getValidationPropertyValue()
{
return $this->getValue();
}
/**
* Returns true if this control validated successfully.
* Defaults to true.
* @return bool wether this control validated successfully.
*/
public function getIsValid()
{
return $this->_isValid;
}
/**
* @param bool wether this control is valid.
*/
public function setIsValid($value)
{
$this->_isValid=TPropertyValue::ensureBoolean($value);
}
/**
* Raises postdata changed event.
* This method calls {@link onValueChanged} method.
* This method is primarly used by framework developers.
*/
public function raisePostDataChangedEvent()
{
$this->onValueChanged(null);
}
/**
* This method is invoked when the value of the {@link getValue Value} property changes between posts to the server.
* The method raises 'OnValueChanged' event to fire up the event delegates.
* If you override this method, be sure to call the parent implementation
* so that the attached event handlers can be invoked.
* @param TEventParameter event parameter to be passed to the event handlers
*/
public function onValueChanged($param)
{
$this->raiseEvent('OnValueChanged',$this,$param);
}
/**
* @return string the value of the THiddenField
*/
public function getValue()
{
return $this->getViewState('Value','');
}
/**
* Sets the value of the THiddenField
* @param string the value to be set
*/
public function setValue($value)
{
$this->setViewState('Value',$value,'');
}
/**
* Returns the value of the hidden field.
* This method is required by {@link \Prado\IDataRenderer}.
* It is the same as {@link getValue()}.
* @return string value of the hidden field
* @see getValue
* @since 3.1.0
*/
public function getData()
{
return $this->getValue();
}
/**
* Sets the value of the hidden field.
* This method is required by {@link \Prado\IDataRenderer}.
* It is the same as {@link setValue()}.
* @param string value of the hidden field
* @see setValue
* @since 3.1.0
*/
public function setData($value)
{
$this->setValue($value);
}
/**
* @return boolean whether theming is enabled for this control. Defaults to false.
*/
public function getEnableTheming()
{
return false;
}
/**
* @param boolean whether theming is enabled for this control.
* @throws TNotSupportedException This method is always thrown when calling this method.
*/
public function setEnableTheming($value)
{
throw new TNotSupportedException('hiddenfield_theming_unsupported');
}
/**
* @param string Skin ID
* @throws TNotSupportedException This method is always thrown when calling this method.
*/
public function setSkinID($value)
{
throw new TNotSupportedException('hiddenfield_skinid_unsupported');
}
}
|
