ElementInterface.php
5.2 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
<?php
namespace Phalcon\Forms {
/**
* Phalcon\Forms\ElementInterface initializer
*/
interface ElementInterface {
/**
* Sets the parent form to the element
*
* @param \Phalcon\Forms\Form $form
* @return \Phalcon\Forms\ElementInterface
*/
public function setForm($form);
/**
* Returns the parent form to the element
*
* @return \Phalcon\Forms\ElementInterface
*/
public function getForm();
/**
* Sets the element's name
*
* @param string $name
* @return \Phalcon\Forms\ElementInterface
*/
public function setName($name);
/**
* Returns the element's name
*
* @return string
*/
public function getName();
/**
* Sets the element's filters
*
* @param array|string $filters
* @return \Phalcon\Forms\ElementInterface
*/
public function setFilters($filters);
/**
* Adds a filter to current list of filters
*
* @param string $filter
* @return \Phalcon\Forms\ElementInterface
*/
public function addFilter($filter);
/**
* Returns the element's filters
*
* @return mixed
*/
public function getFilters();
/**
* Adds a group of validators
*
* @param \Phalcon\Validation\ValidatorInterface[]
* @return \Phalcon\Forms\ElementInterface
*/
public function addValidators($validators, $merge=null);
/**
* Adds a validator to the element
*
* @param \Phalcon\Validation\ValidatorInterface
* @return \Phalcon\Forms\ElementInterface
*/
public function addValidator($validator);
/**
* Returns the validators registered for the element
*
* @return \Phalcon\Validation\ValidatorInterface[]
*/
public function getValidators();
/**
* Returns an array of prepared attributes for \Phalcon\Tag helpers
* according to the element's parameters
*
* @param array $attributes
* @param boolean $useChecked
* @return array
*/
public function prepareAttributes($attributes=null, $useChecked=null);
/**
* Sets a default attribute for the element
*
* @param string $attribute
* @param mixed $value
* @return \Phalcon\Forms\ElementInterface
*/
public function setAttribute($attribute, $value);
/**
* Returns the value of an attribute if present
*
* @param string $attribute
* @param mixed $defaultValue
* @return mixed
*/
public function getAttribute($attribute, $defaultValue=null);
/**
* Sets default attributes for the element
*
* @param array $attributes
* @return \Phalcon\Forms\ElementInterface
*/
public function setAttributes($attributes);
/**
* Returns the default attributes for the element
*
* @return array
*/
public function getAttributes();
/**
* Sets an option for the element
*
* @param string $option
* @param mixed $value
* @return \Phalcon\Forms\ElementInterface
*/
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 element label
*
* @param string $label
* @return \Phalcon\Forms\ElementInterface
*/
public function setLabel($label);
/**
* Returns the element's label
*
* @return string
*/
public function getLabel();
/**
* Generate the HTML to label the element
*
* @return string
*/
public function label();
/**
* Sets a default value in case the form does not use an entity
* or there is no value available for the element in $_POST
*
* @param mixed $value
* @return \Phalcon\Forms\ElementInterface
*/
public function setDefault($value);
/**
* Returns the default value assigned to the element
*
* @return mixed
*/
public function getDefault();
/**
* Returns the element's value
*
* @return mixed
*/
public function getValue();
/**
* Returns the messages that belongs to the element
* The element needs to be attached to a form
*
* @return \Phalcon\Validation\Message\Group
*/
public function getMessages();
/**
* Checks whether there are messages attached to the element
*
* @return boolean
*/
public function hasMessages();
/**
* Sets the validation messages related to the element
*
* @param \Phalcon\Validation\Message\Group $group
* @return \Phalcon\Forms\ElementInterface
*/
public function setMessages($group);
/**
* Appends a message to the internal message list
*
* @param \Phalcon\Validation\Message $message
* @return \Phalcon\Forms\ElementInterface
*/
public function appendMessage($message);
/**
* Clears every element in the form to its default value
*
* @return \Phalcon\Forms\Element
*/
public function clear();
/**
* Renders the element widget
*
* @param array $attributes
* @return string
*/
public function render($attributes=null);
}
}