Form.php
4.98 KB
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
<?php
namespace Phalcon\Forms {
/**
* Phalcon\Forms\Form
*
* This component allows to build forms using an object-oriented interface
*/
class Form extends \Phalcon\DI\Injectable implements \Phalcon\Events\EventsAwareInterface, \Phalcon\DI\InjectionAwareInterface, \Countable, \Iterator, \Traversable {
protected $_position;
protected $_entity;
protected $_options;
protected $_data;
protected $_elements;
protected $_elementsIndexed;
protected $_messages;
protected $_action;
/**
* \Phalcon\Forms\Form constructor
*
* @param object $entity
* @param array $userOptions
*/
public function __construct($entity=null, $userOptions=null){ }
/**
* Sets the form's action
*
* @param string $action
* @return \Phalcon\Forms\Form
*/
public function setAction($action){ }
/**
* Returns the form's action
*
* @return string
*/
public function getAction(){ }
/**
* Sets an option for the form
*
* @param string $option
* @param mixed $value
* @return \Phalcon\Forms\Form
*/
public function setUserOption($option, $value){ }
/**
* Returns the value of an option if present
*
* @param string $option
* @param mixed $defaultValue
* @return mixed
*/
public function getUserOption($option, $defaultValue=null){ }
/**
* Sets options for the element
*
* @param array $options
* @return \Phalcon\Forms\ElementInterface
*/
public function setUserOptions($options){ }
/**
* Returns the options for the element
*
* @return array
*/
public function getUserOptions(){ }
/**
* Sets the entity related to the model
*
* @param object $entity
* @return \Phalcon\Forms\Form
*/
public function setEntity($entity){ }
/**
* Returns the entity related to the model
*
* @return object
*/
public function getEntity(){ }
/**
* Returns the form elements added to the form
*
* @return \Phalcon\Forms\ElementInterface[]
*/
public function getElements(){ }
/**
* Binds data to the entity
*
* @param array $data
* @param object $entity
* @param array $whitelist
* @return \Phalcon\Forms\Form
*/
public function bind($data, $entity, $whitelist=null){ }
/**
* Validates the form
*
* @param array $data
* @param object $entity
* @return boolean
*/
public function isValid($data=null, $entity=null){ }
/**
* Returns the messages generated in the validation
*
* @param boolean $byItemName
* @return array
*/
public function getMessages($byItemName=null){ }
/**
* Returns the messages generated for a specific element
*
* @return \Phalcon\Validation\Message\Group[]
*/
public function getMessagesFor($name){ }
/**
* Check if messages were generated for a specific element
*
* @return boolean
*/
public function hasMessagesFor($name){ }
/**
* Adds an element to the form
*
* @param \Phalcon\Forms\ElementInterface $element
* @return \Phalcon\Forms\Form
*/
public function add($element){ }
/**
* Renders a specific item in the form
*
* @param string $name
* @param array $attributes
* @return string
*/
public function render($name, $attributes=null){ }
/**
* Returns an element added to the form by its name
*
* @param string $name
* @return \Phalcon\Forms\ElementInterface
*/
public function get($name){ }
/**
* Generate the label of a element added to the form including HTML
*
* @param string $name
* @return string
*/
public function label($name){ }
/**
* Returns a label for an element
*
* @param string $name
* @return string
*/
public function getLabel($name){ }
/**
* Gets a value from the internal related entity or from the default value
*
* @param string $name
* @return mixed
*/
public function getValue($name){ }
/**
* Check if the form contains an element
*
* @param string $name
* @return boolean
*/
public function has($name){ }
/**
* Removes an element from the form
*
* @param string $name
* @return boolean
*/
public function remove($name){ }
/**
* Clears every element in the form to its default value
*
* @param array $fields
* @return \Phalcon\Forms\Form
*/
public function clear($fields=null){ }
/**
* Returns the number of elements in the form
*
* @return int
*/
public function count(){ }
/**
* Rewinds the internal iterator
*/
public function rewind(){ }
/**
* Returns the current element in the iterator
*
* @return \Phalcon\Validation\Message
*/
public function current(){ }
/**
* Returns the current position/key in the iterator
*
* @return int
*/
public function key(){ }
/**
* Moves the internal iteration pointer to the next position
*
*/
public function next(){ }
/**
* Check if the current element in the iterator is valid
*
* @return boolean
*/
public function valid(){ }
}
}