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
|
<?php
/**
* TForm class file
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.pradosoft.com/
* @copyright Copyright © 2005-2014 PradoSoft
* @license http://www.pradosoft.com/license/
* @package Prado\Web\UI
*/
namespace Prado\Web\UI;
use Prado\Exceptions\TInvalidDataValueException;
use Prado\TPropertyValue;
/**
* TForm class
*
* TForm displays an HTML form. Besides regular body content,
* it displays hidden fields, javascript blocks and files that are registered
* through {@link TClientScriptManager}.
*
* A TForm is required for a page that needs postback.
* Each page can contain at most one TForm. If multiple HTML forms are needed,
* please use regular HTML form tags for those forms that post to different
* URLs.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @package Prado\Web\UI
* @since 3.0
*/
class TForm extends TControl
{
/**
* Registers the form with the page.
* @param mixed event parameter
*/
public function onInit($param)
{
parent::onInit($param);
$this->getPage()->setForm($this);
}
/**
* Adds form specific attributes to renderer.
* @param THtmlWriter writer
*/
protected function addAttributesToRender($writer)
{
$writer->addAttribute('id',$this->getClientID());
$writer->addAttribute('method',$this->getMethod());
$uri=$this->getRequest()->getRequestURI();
$writer->addAttribute('action',str_replace('&','&',str_replace('&','&',$uri)));
if(($enctype=$this->getEnctype())!=='')
$writer->addAttribute('enctype',$enctype);
$attributes=$this->getAttributes();
$attributes->remove('action');
$writer->addAttributes($attributes);
if(($butt=$this->getDefaultButton())!=='')
{
if(($button=$this->findControl($butt))!==null)
$this->getPage()->getClientScript()->registerDefaultButton($this, $button);
else
throw new TInvalidDataValueException('form_defaultbutton_invalid',$butt);
}
}
/**
* Renders the form.
* @param THtmlWriter writer
*/
public function render($writer)
{
$page=$this->getPage();
$this->addAttributesToRender($writer);
$writer->renderBeginTag('form');
$cs=$page->getClientScript();
if($page->getClientSupportsJavaScript())
{
$cs->renderHiddenFieldsBegin($writer);
$cs->renderScriptFilesBegin($writer);
$cs->renderBeginScripts($writer);
$page->beginFormRender($writer);
$this->renderChildren($writer);
$cs->renderHiddenFieldsEnd($writer);
$page->endFormRender($writer);
$cs->renderScriptFilesEnd($writer);
$cs->renderEndScripts($writer);
}
else
{
$cs->renderHiddenFieldsBegin($writer);
$page->beginFormRender($writer);
$this->renderChildren($writer);
$page->endFormRender($writer);
$cs->renderHiddenFieldsEnd($writer);
}
$writer->renderEndTag();
}
/**
* @return string id path to the default button control.
*/
public function getDefaultButton()
{
return $this->getViewState('DefaultButton','');
}
/**
* Sets a button to be default one in a form.
* A default button will be clicked if a user presses 'Enter' key within
* the form.
* @param string id path to the default button control.
*/
public function setDefaultButton($value)
{
$this->setViewState('DefaultButton',$value,'');
}
/**
* @return string form submission method. Defaults to 'post'.
*/
public function getMethod()
{
return $this->getViewState('Method','post');
}
/**
* @param string form submission method. Valid values include 'post' and 'get'.
*/
public function setMethod($value)
{
$this->setViewState('Method',TPropertyValue::ensureEnum($value,'post','get'),'post');
}
/**
* @return string the encoding type a browser uses to post data back to the server
*/
public function getEnctype()
{
return $this->getViewState('Enctype','');
}
/**
* @param string the encoding type a browser uses to post data back to the server.
* Commonly used types include
* - application/x-www-form-urlencoded : Form data is encoded as name/value pairs. This is the standard encoding format.
* - multipart/form-data : Form data is encoded as a message with a separate part for each control on the page.
* - text/plain : Form data is encoded in plain text, without any control or formatting characters.
*/
public function setEnctype($value)
{
$this->setViewState('Enctype',$value,'');
}
/**
* @return string form name, which is equal to {@link getUniqueID UniqueID}.
*/
public function getName()
{
return $this->getUniqueID();
}
}
|
