-
Notifications
You must be signed in to change notification settings - Fork 201
/
InputfieldWrapper.php
524 lines (449 loc) · 15.5 KB
/
InputfieldWrapper.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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
<?php
/**
* ProcessWire InputfieldWrapper
*
* Classes built to provide a wrapper for Inputfield instances.
*
* ProcessWire 2.x
* Copyright (C) 2012 by Ryan Cramer
* Licensed under GNU/GPL v2, see LICENSE.TXT
*
* http://www.processwire.com
* http://www.ryancramer.com
*
*/
/**
* A WireArray of Inputfield instances.
*
* The default numeric indexing of a WireArray is not overridden.
*
*/
class InputfieldsArray extends WireArray {
/**
* Per WireArray interface, only Inputfield instances are accepted.
*
*/
public function isValidItem($item) {
return $item instanceof Inputfield;
}
/**
* Extends the find capability of WireArray to descend into the Inputfield children
*
*/
public function find($selector) {
$a = parent::find($selector);
foreach($this as $item) {
if(!$item instanceof InputfieldWrapper) continue;
$children = $item->children();
if(count($children)) $a->import($children->find($selector));
}
return $a;
}
public function makeBlankItem() {
return null; // Inputfield is abstract, so there is nothing to return here
}
public function usesNumericKeys() {
return true;
}
}
/**
* A type of Inputfield that is designed specifically to wrap other Inputfields
*
* The most common example of an InputfieldWrapper is a <form>
*
* InputfieldWrapper is not designed to render an Inputfield specifically, but you can set a value attribute
* containing content that will be rendered before the wrapper.
*
*/
class InputfieldWrapper extends Inputfield {
/**
* Markup used during the render() method - customize with InputfieldWrapper::setMarkup($array)
*
*/
static protected $defaultMarkup = array(
'list' => "\n<ul {attrs}>\n{out}\n</ul>\n",
'item' => "\n\t<li {attrs}>\n{out}\n\t</li>",
'item_label' => "\n\t\t<label class='ui-widget-header' for='{for}'>{out}</label>",
'item_content' => "\n\t\t<div class='ui-widget-content'>\n{out}\n\t\t</div>",
'item_error' => "\n<p><span class='ui-state-error'>{out}</span></p>",
'item_description' => "\n<p class='description'>{out}</p>",
'item_head' => "\n<h2>{out}</h2>",
'item_notes' => "\n<p class='notes'>{out}</p>",
);
static protected $markup = array();
/**
* Classes used during the render() method - customize with InputfieldWrapper::setClasses($array)
*
*/
static protected $defaultClasses = array(
'list' => 'Inputfields',
'list_clearfix' => 'ui-helper-clearfix',
'item' => 'Inputfield {class} Inputfield_{name} ui-widget',
'item_required' => 'InputfieldStateRequired',
'item_error' => 'ui-state-error InputfieldStateError',
'item_collapsed' => 'InputfieldStateCollapsed',
'item_column_width' => 'InputfieldColumnWidth',
'item_column_width_first' => 'InputfieldColumnWidthFirst',
);
static protected $classes = array();
/**
* Instance of InputfieldsArray, if this Inputfield contains child Inputfields
*
*/
protected $children = null;
/**
* Construct the Inputfield, setting defaults for all properties
*
*/
public function __construct() {
parent::__construct();
$this->children = new InputfieldsArray();
$this->set('skipLabel', Inputfield::skipLabelFor);
$this->set('renderValueMode', false);
}
/**
* By default, calls to get() are finding a child Inputfield based on the name attribute
*
*/
public function get($key) {
if($inputfield = $this->getChildByName($key)) return $inputfield;
if($this->fuel($key)) return $this->fuel($key);
if($key == 'children') return $this->children;
if(($value = parent::get($key)) !== null) return $value;
return null;
}
/**
* Add an Inputfield a child
*
* @param Inputfield $item
*
*/
public function add(Inputfield $item) {
$item->setParent($this);
$this->children->add($item);
return $this;
}
/**
* Prepend another Inputfield to this Inputfield's children
*
*/
public function prepend(Inputfield $item) {
$item->setParent($this);
$this->children->prepend($item);
return $this;
}
/**
* Append another Inputfield to this Inputfield's children
*
*/
public function append(Inputfield $item) {
$item->setParent($this);
$this->children->append($item);
return $this;
}
/**
* Insert one Inputfield before one that's already there
*
*/
public function insertBefore(Inputfield $item, Inputfield $existingItem) {
$item->setParent($this);
$this->children->insertBefore($item, $existingItem);
return $this;
}
/**
* Insert one Inputfield after one that's already there
*
*/
public function insertAfter(Inputfield $item, Inputfield $existingItem) {
$item->setParent($this);
$this->children->insertAfter($item, $existingItem);
return $this;
}
/**
* Remove an Inputfield from this Inputfield's children
*
*/
public function remove($item) {
$this->children->remove($item);
return $this;
}
/**
* Prepare children for rendering by creating any fieldset groups
*
*/
protected function preRenderChildren() {
if($this->InputfieldWrapper_isPreRendered) return $this->children;
$children = new InputfieldWrapper();
$wrappers = array($children);
foreach($this->children as $inputfield) {
$wrapper = end($wrappers);
if($inputfield instanceof InputfieldFieldsetClose) {
if(count($wrappers) > 1) array_pop($wrappers);
continue;
} else if($inputfield instanceof InputfieldFieldsetOpen) {
$inputfield->set('InputfieldWrapper_isPreRendered', true);
array_push($wrappers, $inputfield);
}
$wrapper->add($inputfield);
}
return $children;
}
/**
* Return the completed output of this Inputfield, ready for insertion in an XHTML form
*
* This includes the output of any child Inputfields (if applicable). Children are presented as list items in an unordered list.
*
* @return string
*
*/
public function ___render() {
$out = '';
$children = $this->preRenderChildren();
$columnWidthTotal = 0;
$lastInputfield = null;
$renderValueMode = $this->renderValueMode;
$markup = array_merge(self::$defaultMarkup, self::$markup);
$classes = array_merge(self::$defaultClasses, self::$classes);
foreach($children as $inputfield) {
$collapsed = (int) $inputfield->getSetting('collapsed');
if($collapsed == Inputfield::collapsedHidden) continue;
if($renderValueMode) {
$ffOut = $inputfield->renderValue();
if(!strlen($ffOut)) $ffOut = ' ';
} else {
$ffOut = $inputfield->render();
}
if(!strlen($ffOut)) continue;
if(!$inputfield instanceof InputfieldWrapper) {
$errors = $inputfield->getErrors(true);
if(count($errors)) $collapsed = Inputfield::collapsedNo;
foreach($errors as $error) $ffOut = str_replace('{out}', $this->entityEncode($error, true), $markup['item_error']) . $ffOut;
} else $errors = array();
if($inputfield->getSetting('description')) $ffOut = str_replace('{out}', nl2br($this->entityEncode($inputfield->getSetting('description'), true)), $markup['item_description']) . $ffOut;
if($inputfield->getSetting('head')) $ffOut = str_replace('{out}', $this->entityEncode($inputfield->getSetting('head'), true), $markup['item_head']) . $ffOut;
$ffOut = preg_replace('/(\n\s*)</', "$1\t\t\t<", $ffOut); // indent lines beginning with markup
if($inputfield->getSetting('notes')) $ffOut .= str_replace('{out}', nl2br($this->entityEncode($inputfield->notes, true)), $markup['item_notes']);
// The inputfield's classname is always used in it's LI wrapper
$ffAttrs = array(
'class' => str_replace(array('{class}', '{name}'), array($inputfield->className(), $inputfield->attr('name')), $classes['item'])
);
//if(count($errors)) $ffAttrs['class'] .= " ui-state-error InputfieldStateError";
if(count($errors)) $ffAttrs['class'] .= ' ' . $classes['item_error'];
if($inputfield->required) $ffAttrs['class'] .= ' ' . $classes['item_required'];
if($collapsed) {
$isEmpty = $inputfield->isEmpty();
if($inputfield instanceof InputfieldWrapper ||
$collapsed === Inputfield::collapsedYes ||
$collapsed === true ||
($isEmpty && $collapsed === Inputfield::collapsedBlank) ||
(!$isEmpty && $collapsed === Inputfield::collapsedPopulated)) {
$ffAttrs['class'] .= ' ' . $classes['item_collapsed'];
}
}
if($inputfield instanceof InputfieldWrapper) {
// if the child is a wrapper, then id, title and class attributes become part of the LI wrapper
foreach($inputfield->getAttributes() as $k => $v) {
if(in_array($k, array('id', 'title', 'class'))) {
$ffAttrs[$k] = isset($ffAttrs[$k]) ? $ffAttrs[$k] . " $v" : $v;
}
}
}
// if the inputfield resulted in output, wrap it in an LI
if($ffOut) {
$attrs = '';
$label = '';
if($inputfield->label && $inputfield->skipLabel !== Inputfield::skipLabelHeader) {
$for = $inputfield->skipLabel ? '' : $inputfield->attr('id');
$label = str_replace(array('{for}', '{out}'), array($for, $this->entityEncode($inputfield->label)), $markup['item_label']);
}
$columnWidth = (int) $inputfield->getSetting('columnWidth');
$columnWidthAdjusted = $columnWidth + ($columnWidthTotal ? -1 : 0);
if($columnWidth >= 9 && $columnWidth <= 100) {
$ffAttrs['class'] .= ' ' . $classes['item_column_width'];
if(!$columnWidthTotal) $ffAttrs['class'] .= ' ' . $classes['item_column_width_first'];
$ffAttrs['style'] = "width: $columnWidthAdjusted%;";
$columnWidthTotal += $columnWidth;
if($columnWidthTotal >= 100) $columnWidthTotal = 0;
} else {
$columnWidthTotal = 0;
}
if(!isset($ffAttrs['id'])) $ffAttrs['id'] = 'wrap_' . $inputfield->attr('id');
foreach($ffAttrs as $k => $v) {
$attrs .= " $k='" . $this->entityEncode(trim($v)) . "'";
}
if($inputfield->className() != 'InputfieldWrapper') $ffOut = str_replace('{out}', $ffOut, $markup['item_content']);
$out .= str_replace(array('{attrs}', '{out}'), array(trim($attrs), $label . $ffOut), $markup['item']);
$lastInputfield = $inputfield;
}
}
if($out) {
$ulClass = $classes['list'];
if($columnWidthTotal || ($lastInputfield && $lastInputfield->columnWidth >= 10 && $lastInputfield->columnWidth < 100)) $ulClass .= ' ' . $classes['list_clearfix'];
$attrs = "class='$ulClass'"; // . ($this->attr('class') ? ' ' . $this->attr('class') : '') . "'";
foreach($this->getAttributes() as $attr => $value) if(strpos($attr, 'data-') === 0) $attrs .= " $attr='" . $this->entityEncode($value) . "'";
$out = $this->attr('value') . str_replace(array('{attrs}', '{out}'), array($attrs, $out), $markup['list']);
}
return $out;
}
public function ___renderValue() {
$this->attr('class', trim($this->attr('class') .' InputfieldRenderValueMode'));
$this->set('renderValueMode', true);
$out = $this->render();
$this->set('renderValueMode', false);
return $out;
}
/**
* Pass the given array to all children to process input
*
* @param array $input
*
*/
public function ___processInput(WireInputData $input) {
if(!$this->children) return $this;
foreach($this->children as $key => $child) {
// skip over collapsedHidden inputfields, beacuse they were never drawn
if($child->collapsed === Inputfield::collapsedHidden) continue;
// call the inputfield's processInput method
$child->processInput($input);
// check if a value is required and field is empty, trigger an error if so
if($child->name && $child->required && $child->isEmpty()) $child->error($this->_('Missing required value'));
}
return $this;
}
/**
* Return an array of errors that occurred on any of the children during processInput()
*
* Should only be called after processInput()
*
* @return array
*
*/
public function getErrors($clear = false) {
$errors = parent::getErrors($clear);
foreach($this->children as $key => $child) {
foreach($child->getErrors($clear) as $e) {
$msg = $child->label ? $child->label : $child->attr('name');
$errors[] = $msg . " - $e";
}
}
return $errors;
}
/**
* Return all child Inputfields, or a blank InputfieldArray if none
*
* @param string $selector Optional selector string to filter the children by
* @return InputfieldArray
*
*/
public function children($selector = '') {
if($selector) return $this->children->find($selector);
else return $this->children;
}
/**
* Return all child Inputfields, or a blank InputfieldArray if none
*
* Alias of children()
*
* @param string $selector Optional selector string to filter the children by
* @return InputfieldArray
*
*/
public function getChildren($selector = '') {
return $this->children($selector);
}
/**
* Like children() but $selector is not optional, and the method name is more readable in instances where you are filtering.
*
* @param string $selector Required selector string to filter the children by
* @return InputfieldArray
*
*/
public function find($selector) {
return $this->children->find($selector);
}
/**
* Given a field name, return the child Inputfield or NULL if not found
*
* @param string $name
* @return Inputfield|null
*
*/
public function getChildByName($name) {
$inputfield = $this->children->find("name=$name");
if(count($inputfield)) return $inputfield->first();
return null;
}
/**
* Per the InteratorAggregate interface, make the Inputfield children iterable
*
*/
public function getIterator() {
return $this->children;
}
/**
* Get all fields recursively in a flat InputfieldWrapper, not just direct children
*
* Note that all InputfieldWrappers are removed as a result (except for the containing InputfieldWrapper)
*
* @return InputfieldWrapper
*
*/
public function getAll() {
$all = new InputfieldsArray();
foreach($this->children as $child) {
if($child instanceof InputfieldWrapper) {
foreach($child->getAll() as $c) {
$all->add($c);
}
} else {
$all->add($child);
}
}
return $all;
}
/**
* Start or stop tracking changes, applying the same to any children
*
*/
public function setTrackChanges($trackChanges = true) {
if(count($this->children)) foreach($this->children as $child) $child->setTrackChanges($trackChanges);
return parent::setTrackChanges($trackChanges);
}
/**
* Start or stop tracking changes after clearing out any existing tracked changes, applying the same to any children
*
*/
public function resetTrackChanges($trackChanges = true) {
if(count($this->children)) foreach($this->children as $child) $child->resetTrackChanges($trackChanges);
return parent::resetTrackChanges();
}
/**
* Get any configuration Inputfields common to all InputfieldWrappers
*
*/
public function ___getConfigInputfields() {
$inputfields = parent::___getConfigInputfields();
// remove all options for 'collapsed' except collapsedYes and collapsedNo
foreach($inputfields as $f) {
if($f->attr('name') != 'collapsed') continue;
foreach($f->getOptions() as $value => $label) {
if(!in_array($value, array(Inputfield::collapsedNo, Inputfield::collapsedYes))) $f->removeOption($value);
}
}
return $inputfields;
}
/**
* Set custom markup for render, see self::$markup at top for reference.
*
* @param array $markup
*
*/
public static function setMarkup(array $markup) { self::$markup = array_merge(self::$markup, $markup); }
public static function getMarkup() { return array_merge(self::$defaultMarkup, self::$markup); }
/**
* Set custom classes for render, see self::$classes at top for reference.
*
*/
public static function setClasses(array $classes) { self::$classes = array_merge(self::$classes, $classes); }
public static function getClasses() { return array_merge(self::$defaultClasses, self::$classes); }
}