-
Notifications
You must be signed in to change notification settings - Fork 1
/
form_field.php
280 lines (237 loc) · 6.4 KB
/
form_field.php
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
<?php
/**
* Form Field.
*
*
*
*/
class Form_Field extends Form
{
/**
* Type of field (input, textarea, select, etc)
* @var string $_field
*/
protected $_field;
/**
* Type of input (text, email, select, etc)
* @var string $_type
*/
protected $_type;
/**
* Unique field name
* @var string $_name
*/
protected $_name;
/**
* Unique field ID
* @var string $_id
*/
protected $_id;
/**
* Additional field attributes stored in key/value pairs
* @var array $_attributes
*/
protected $_attributes;
/**
* Optional label text for field
* @var string $_label
*/
protected $_label;
/**
* Code formatting option (inline, block, raw, etc.)
* @var array $_format
*/
protected $_format;
/**
* Field validation requirements
* @var array $_validation
*/
protected $_validations;
/**
* Collection to iterate
* @var array $_collection
*/
protected $_collection;
/**
* Field validation errors
* @var array $_errors
*/
protected $_errors;
/**
* Valid HTML5 input types
* @var array $input_types
*/
public $input_types = array( 'button', 'checkbox', 'color', 'date', 'datetime', 'datetime-local', 'email', 'file', 'hidden', 'image', 'month', 'number', 'password', 'radio', 'range', 'reset', 'search', 'submit', 'tel', 'text', 'time', 'url', 'week' );
/**
* Valid HTML5 fields with options
* @var array $input_types
*/
public $field_types = array( 'input', 'textarea', 'button', 'select' );
/**
* Class Constructor
*
* This class constructor instantiates the creation of a new form field
* element contained in the HTML5 Helper.
*
* @param string $field (required)
* @param string $name (required)
* @param string $value (optional)
* @param array $options (optional)
* @param array $validations (optional)
*/
function __construct( $field_type, $name, $value = null, $options = array(), $validations = array() )
{
$options = ( isset( $options ) ) ? $options : array();
$validations = ( isset( $validations ) ) ? $validations : array();
// Decode $field_type alias
if ( in_array( $field_type, $this->input_types ) )
{
$this->_field = 'input';
$this->_type = $field_type;
}
else
{
$this->_field = $field_type;
}
$this->_name = $name;
$this->_value = $value;
$this->_validations = ( isset( $validations ) ) ? $validations : array();
$this->process_options( $options );
}
/**
* Process Options
*
* Evaluate the options array and handle custom processing necessary to
* alter the field code at render.
*
* @param array $options (required)
*/
private function process_options( $options )
{
extract( $options );
$this->_attributes = ( isset( $attributes ) ) ? $attributes : array();
$this->_collection = ( isset( $collection ) ) ? $collection : null;
$this->_format = ( isset( $format ) ) ? $format : 'block';
$this->_label = ( isset( $label ) ) ? $label : $this->to_label( $this->_name );
$this->_id = ( isset( $id ) ) ? $id : $this->_name;
}
/**
* Process Validations
*
* Evaluate custom validation callbacks passed in as an array. Valid options
* are:
*
* * presence_of
* * email
* @return array collection of errors
*/
public function process_validations()
{
if ( 0 == count( $this->_validations ) ) return array();
$errors = array();
foreach ( $this->_validations as $validation )
{
$method = 'validate_'.$validation;
// Ignore any method that doesn't exist
if ( true == method_exists( $this, $method ) )
{
$response = call_user_func( array( $this, $method ), $this->_value );
if ( "valid" != $response )
{
$errors[$validation] = $response;
}
}
else
{
error_log( 'Invalid Method Call: ' . $method . '("'.$this->_value.'")' );
}
}
$this->_errors = ( count( $errors ) > 0 ) ? $errors : null;
return $this->_errors;
}
/**
* Validates presence of $value
*
* @param mixed $value
*/
private function validate_presence_of( $value = null )
{
return ( ! empty( $value ) ) ? "valid" : "cannot be left blank";
}
/**
* Alias for validate_presence_of
*
* @param mixed $value
*/
private function validate_required( $value = null )
{
return $this->validate_presence_of( $value );
}
/**
* Validates format of $value is a valid email
*
* @param string $value
*/
private function validate_email( $value )
{
return ( preg_match( '/^([.0-9a-z_-]+)@(([0-9a-z-]+\.)+[0-9a-z]{2,4})$/i', trim( $value ) ) ) ? "valid" : "not a valid email address";
}
private function build_field()
{
$this->_attributes['id'] = $this->_id;
if ( true == method_exists( $this, $this->_field ) )
{
/** todo: this is a hack and and pretends to know too much about another class - needs to be refactored */
// Method call will require a fourth argument
if ( isset( $this->_collection ) || isset( $this->_type ) )
{
// Collection superseds Type
$data = ( isset( $this->_collection ) ) ? $this->_collection : $this->_type;
return call_user_func( array( $this, $this->_field ), $this->_name, $this->_value, $data, $this->_attributes );
}
return call_user_func( array( $this, $this->_field ), $this->_name, $this->_value, $this->_attributes );
}
else
{
// Backup, may produce uexpected results
if ( isset( $this->_value ) && "input" == $this->_field )
{
$this->_attributes['value'] = $this->_value;
}
if ( isset( $this->_value ) && "input" != $this->_field )
{
$content = $this->_value;
}
$this->_attributes['name'] = $this->_name;
return $this->tag( $this->_field, $this->_attributes, $content );
}
}
function render( $options = array() )
{
$field = $this->build_field();
$label = $this->label( $this->_label, $this->_id );
$attributes = array();
$attributes['class'] = 'field';
if ( is_array( $options ) )
{
if ( isset( $options['show_errors'] ) && is_array( $this->_errors ) && count( $this->_errors ) > 0 )
{
$errors = $this->tag( 'span', array( 'class' => 'message' ), join( ', ', $this->_errors ) );
$attributes['class'] = $attributes['class'] . ' error';
}
else
{
$errors = '';
}
}
/** todo: allow option to reorder tags */
$content = "$label $field $errors";
return $this->wrap( $content, $attributes );
}
}
$options = array(
"attributes" => array( "id" => "my-unique-id", "class" => "required", "size" => 33 ),
"format" => 'inline',
"label" => 'My Custom Label'
);
?>