AbstractBuildForm.php 30.4 KB
Newer Older
1
<?php
Carsten  Rose's avatar
Carsten Rose committed
2
3
4
5
6
7
/**
 * Created by PhpStorm.
 * User: crose
 * Date: 1/6/16
 * Time: 8:02 PM
 */
8
9
10
namespace qfq;

use qfq;
11
use qfq\Store;
12
use qfq\exceptions\UserException;
13
use qfq\OnArray;
14
15
16
17

require_once(__DIR__ . '/../qfq/store/Store.php');
require_once(__DIR__ . '/../qfq/Constants.php');
require_once(__DIR__ . '/../qfq/exceptions/DbException.php');
18
require_once(__DIR__ . '/../qfq/exceptions/UserException.php');
19
require_once(__DIR__ . '/../qfq/Database.php');
20
21
require_once(__DIR__ . '/../qfq/helper/HelperFormElement.php');

22
23

/**
Carsten  Rose's avatar
Carsten Rose committed
24
25
 * Class AbstractBuildForm
 * @package qfq
26
 */
27
abstract class AbstractBuildForm {
28
29
30
    protected $formSpec = array();  // copy of the loaded form
    protected $feSpecAction = array(); // copy of all formElement.class='action' of the loaded form
    protected $feSpecNative = array(); // copy of all formElement.class='native' of the loaded form
31
    protected $store = null;
Carsten  Rose's avatar
Carsten Rose committed
32
    protected $evaluate = null;
33
34
    protected $buildElementFunctionName = array();
    protected $pattern = array();
35
    protected $wrap = array();
36

37
38
39
40
41
    public function __construct(array $formSpec, array $feSpecAction, array $feSpecNative) {
        $this->formSpec = $formSpec;
        $this->feSpecAction = $feSpecAction;
        $this->feSpecNative = $feSpecNative;
        $this->store = Store::getInstance();
42
        $this->db = new Database();
Carsten  Rose's avatar
Carsten Rose committed
43
        $this->evaluate = new Evaluate($this->store, $this->db);
44
45
//        $sip = $this->store->getVar(CLIENT_SIP, STORE_CLIENT);

46
        // render mode specific
47
        $this->fillWrap();
48
49
50

        $this->buildElementFunctionName = [
            'checkbox' => 'Checkbox',
51
52
            'dateJQW' => 'DateJQW',
            'datetimeJQW' => 'DateJQW',
53
54
55
56
57
58
59
60
            'email' => 'Input',
            'gridJQW' => 'GridJQW',
            'hidden' => 'Hidden',
            'input' => 'Input',
            'note' => 'Note',
            'password' => 'Input',
            'radio' => 'Radio',
            'select' => 'Select',
61
            'subrecord' => 'Subrecord',
Carsten  Rose's avatar
Carsten Rose committed
62
            'upload' => 'File',
63
64
            'fieldset' => 'Fieldset',
            'pill' => 'Pill'
65
66
        ];

67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
        $this->buildRowName = [
            'checkbox' => 'Native',
            'dateJQW' => 'Native',
            'datetimeJQW' => 'Native',
            'email' => 'Native',
            'gridJQW' => 'Native',
            'hidden' => 'Native',
            'input' => 'Native',
            'note' => 'Native',
            'password' => 'Native',
            'radio' => 'Native',
            'select' => 'Native',
            'subrecord' => 'Subrecord',
            'upload' => 'Native',
            'fieldset' => 'Fieldset',
            'pill' => 'Pill'
        ];

85
86
87
88
89
90
        $this->inputCheckPattern = [
            'min|max' => 'min="%s"|max="%s"',
            'pattern' => 'pattern="%s"',
            'number' => 'pattern="^[0-9]*$"',
            'email' => 'pattern="^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\.[a-z]{2,4})$"'
        ];
Carsten  Rose's avatar
Carsten Rose committed
91

92
93
    }

94
95
    abstract public function fillWrap();

96
97
98
99
100
101
102
103
104
    /**
     * @return string The whole form as HTML
     * @throws exceptions\CodeException
     * @throws exceptions\DbException
     */
    public function process() {

        $html = $this->head();

105
        $filter = $this->getProcessFilter();
106

107
        if ($this->formSpec['multiMode'] !== 'none') {
108

109
110
111
            $parentRecords = $this->db->sql($this->formSpec['multiSql']);
            foreach ($parentRecords as $row) {
                $this->store->setVarArray($row, STORE_PARENT_RECORD);
112
                $html .= $this->elements($row['_id'], $filter);
113
114
            }
        } else {
115
            $html .= $this->elements($this->store->getVar(SIP_RECORD_ID, STORE_SIP), $filter);
116
117
        }

118
119
//        $html .= $this->wrapItem(WRAP_SETUP_OUTER, $elementsHtml);

120
        // close the form
121
122
        $html .= $this->tail();

123
        $html .= $this->doSubrecords();
124

125
126
127
        return $html;
    }

128
    abstract public function head();
129

130
    abstract public function getProcessFilter();
131
132
133

    /**
     * @param $recordId
134
     * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD
135
136
137
138
     * @return string
     * @throws exceptions\CodeException
     * @throws exceptions\DbException
     */
139
    public function elements($recordId, $filter = FORM_ELEMENTS_NATIVE, $feIdContainer = 0) {
140
141
142
        $html = '';

        // get current data record
143
        if ($recordId > 0 && $this->store->getVar('id', STORE_RECORD) === false) {
144
            $row = $this->db->sql("SELECT * FROM " . $this->formSpec['tableName'] . " WHERE id = ?", ROW_REGULAR, array($recordId));
145
146
            $this->store->setVarArray($row[0], STORE_RECORD);
        }
147
148
149

        // Iterate over all FormElements
        foreach ($this->feSpecNative as $fe) {
150

151
152
            if (($filter === FORM_ELEMENTS_NATIVE && $fe['type'] === 'subrecord') ||
                ($filter === FORM_ELEMENTS_SUBRECORD && $fe['type'] !== 'subrecord')
153
154
155
156
            ) {
                continue; // skip this FE
            }

157
158
159
160
161
162
            // Log / Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, $fe['name'] . ' / ' . $fe['id'], STORE_SYSTEM);

            // evaluate current FormElement
            $formElement = $this->evaluate->parseArray($fe);

163
            // Get default value
164
            $value = $formElement['value'] === '' ? $this->store->getVar($formElement['name']) : $value = $formElement['value'];
Carsten  Rose's avatar
Carsten Rose committed
165

166
            $htmlFormElementId = $formElement['name'] . ':' . $recordId;
167

168
169
170
171
172
173
174
175
176
177
            // Construct Marshaller Name
            $buildElementFunctionName = 'build' . $this->buildElementFunctionName[$formElement['type']];

            // Render pure element
            $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementId, $value);

            // Construct Marshaller Name
            $buildRowName = 'buildRow' . $this->buildRowName[$formElement['type']];

            $html .= $this->$buildRowName($formElement, $elementHtml);
178
        }
179

180
181
182
        return $html;
    }

183
184
185
    abstract public function tail();

    abstract public function doSubrecords();
186

187
188
189
190
191
192
193
194
    abstract public function buildRowNative($formElement, $elementHtml);

    abstract public function buildRowPill($formElement, $elementHtml);

    abstract public function buildRowFieldset($formElement, $elementHtml);

    abstract public function buildRowSubrecord($formElement, $elementHtml);

195
    /**
196
197
198
     * @param $item
     * @param $value
     * @param bool|false $flagOmitEmpty
199
200
     * @return string
     */
201
202
203
204
    public function wrapItem($item, $value, $flagOmitEmpty = false) {
        if ($flagOmitEmpty && $value === "")
            return '';
        return $this->wrap[$item][WRAP_SETUP_START] . $value . $this->wrap[$item][WRAP_SETUP_END];
205
206
    }

207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
    /**
     * @param $tag
     * @param $value
     * @param bool|false $flagOmitEmpty
     * @return string
     */
    public function wrapTag($tag, $value, $flagOmitEmpty = false) {
        if ($flagOmitEmpty && $value === "")
            return '';

        // <div class="container-fluid"> >> </div>
        $arr = explode(' ', $tag);
        $closing = '</' . substr($arr[0], 1) . '>';

        return $tag . $value . $closing;
    }

224
    /**
225
226
     * @param array $htmlFormElementId
     * @param $label
227
228
     * @return string
     */
229
230
231
232
    public function buildLabel($htmlFormElementId, $label) {
        $html = '<label for="' . $htmlFormElementId . '">' . $label . '</label>';

        return $html;
233
234
    }

235
236
237
238
239
240
241
242
243
244
245
246
247
    /**
     * Builds HTML 'input' element.
     * Format: <input name="$htmlFormElementId" <type="email|input|password|url" [autocomplete="autocomplete"] [autofocus="autofocus"]
     *           [maxlength="$maxLength"] [placeholder="$placeholder"] [size="$size"] [min="$min"] [max="$max"]
     *           [pattern="$pattern"] [readonly="readonly"] [required="required"] [disabled="disabled"] value="$value">
     *
     *
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return string
     * @throws UserException
     */
248
    public function buildInput(array $formElement, $htmlFormElementId, $value) {
249

Carsten  Rose's avatar
Carsten Rose committed
250
        $attribute = $this->getAttribute('name', $htmlFormElementId);
251
252
253
254
255
256
257
258
259
        $htmlTag = '<input';
        $htmlTagClosing = '';

        // Check for input type 'textarea'
        $colsRows = explode(',', $formElement['size']);
        if (count($colsRows) === 2) {
            $htmlTag = '<textarea';
            $htmlTagClosing = '</textarea>';

Carsten  Rose's avatar
Carsten Rose committed
260
261
            $attribute .= $this->getAttribute('cols', $colsRows[0]);
            $attribute .= $this->getAttribute('rows', $colsRows[1]);
262
263

        } else {
264
            $attribute .= $this->getAttributeList($formElement, ['type', 'size', 'maxLength']);
Carsten  Rose's avatar
Carsten Rose committed
265
        }
266
        // 'maxLength' needs an upper 'L': naming convention for DB tables!
267
        $attribute .= $this->getAttributeList($formElement, ['autocomplete', 'autofocus', 'placeholder']);
268
269
270
271

        if ($formElement['type'] === 'email' && $formElement['checkType'] === '')
            $formElement['checkType'] = 'email';

Carsten  Rose's avatar
Carsten Rose committed
272
        $attribute .= $this->getInputCheckPattern($formElement['checkType'], $formElement['checkPattern']);
273

Carsten  Rose's avatar
Carsten Rose committed
274
        $attribute .= $this->getAttributeMode($formElement);
275

276
        $attribute .= $this->getAttribute('value', htmlentities($value), false);
277
278
279
280
281
282
283
284
285
286

        return "$htmlTag $attribute>$htmlTagClosing";
    }

    /**
     * @param $type
     * @param $value
     * @param bool|false $flagOmitEmpty
     * @return string
     */
Carsten  Rose's avatar
Carsten Rose committed
287
    private function getAttribute($type, $value, $flagOmitEmpty = true) {
288
289
        if ($flagOmitEmpty && $value === "")
            return '';
Carsten  Rose's avatar
Carsten Rose committed
290

291
292
293
294
295
296
297
298
299
300
301
302
        return "$type=\"$value\" ";
    }

    /**
     * Builds a HTML attribute list, based on  $attributeList.
     * E.g.: attributeList: [ 'type', 'autofocus' ]
     *       generates: 'type="$formElement['type']" autofocus="$formElement['autofocus']" '
     *
     * @param array $formElement
     * @param array $attributeList
     * @return string
     */
Carsten  Rose's avatar
Carsten Rose committed
303
    private function getAttributeList(array $formElement, array $attributeList) {
304
305
306
        $attribute = '';
        foreach ($attributeList as $item) {
            if (isset($formElement[$item]))
Carsten  Rose's avatar
Carsten Rose committed
307
                $attribute .= $this->getAttribute(strtolower($item), $formElement[$item]);
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
        }
        return $attribute;
    }

    /**
     * Construct HTML Input attribute for Client Validation:
     *   type     data                      predefined
     *   -------  -----------------------   -------------------------------------------------------------------------------
     *   min|max  <min value>|<max value>   min="%s"|max="%s"
     *   pattern  <regexp>                  pattern="%s"
     *   number   -                         pattern="^[0-9]*$"
     *   email    -                         pattern="^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\.[a-z]{2,4})$"
     *
     * For 'min|max' and 'pattern' the 'data' will be injected in the attribute string vai '%s'.
     *
     * @param $type
     * @param $data
     * @return string
     */
Carsten  Rose's avatar
Carsten Rose committed
327
    private function getInputCheckPattern($type, $data) {
328
329
        if ($type === '') {
            return '';
330
        }
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348

        $attribute = '';

        $arrAttr = explode("|", $type);
        $arrData = explode("|", $data);

        for ($ii = 0; $ii < count($arrAttr); $ii++) {
            if ($arrAttr[$ii])
                $attribute .= str_replace('%s', $arrData[$ii], $arrAttr[$ii]) . ' ';
        }
        return $attribute;
    }

    /**
     * @param array $formElement
     * @return string
     * @throws UserException
     */
Carsten  Rose's avatar
Carsten Rose committed
349
    private function getAttributeMode(array $formElement) {
350
351
352
353
354
355
        $attribute = '';

        switch ($formElement['mode']) {
            case 'show':
                break;
            case 'readonly':
Carsten  Rose's avatar
Carsten Rose committed
356
                $attribute .= $this->getAttribute('readonly', 'readonly');
357
358
                break;
            case 'required':
Carsten  Rose's avatar
Carsten Rose committed
359
                $attribute .= $this->getAttribute('required', 'required');
360
361
362
363
                break;
            case 'lock':
                break;
            case 'disabled':
Carsten  Rose's avatar
Carsten Rose committed
364
                $attribute .= $this->getAttribute('disabled', 'disabled');
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
                break;
            default:
                $this->store->setVar(SYSTEM_FORM_ELEMENT, $formElement['name'] . ' / ' . $formElement['id'], STORE_SYSTEM);
                $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, 'mode', STORE_SYSTEM);
                throw new UserException("Unexpected mode '" . $formElement['mode'] . "'");
                break;
        }
        return $attribute;
    }

    /**
     * Builds HTML 'checkbox' element.
     *
     * Checkboxes will only be submitted, if they are checked. Therefore, a hidden element with the unchecked value will be transfered first.
     *
     * Format: <input type="hidden" name="$htmlFormElementId" value="$valueUnChecked">
     *         <input name="$htmlFormElementId" type="checkbox" [autofocus="autofocus"]
     *            [readonly="readonly"] [required="required"] [disabled="disabled"] value="<value>" [checked="checked"] >
     *
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return string
     * @throws UserException
     */
390
    public function buildCheckbox(array $formElement, $htmlFormElementId, $value) {
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
        $this->extractKeyValueList($formElement, $itemKey, $itemValue);

        // Get fallback, if 'checkBoxMode' is not defined:
        if (!isset($formElement['checkBoxMode'])) {
            // This fallback is problematic if 'set' or 'enum' has 2 elements: defaults to single but maybe multi is meant.
            $formElement['checkBoxMode'] = (count($itemKey) > 2) ? 'multi' : 'single';
        }

        if ($formElement['checkBoxMode'] === 'multi') {
            $htmlFormElementId .= '[]';
        } else {
            // Fill meaningfull defaults to parameter:checked|unchecked
            $this->prepareCheckboxCheckedUncheckedValue($itemKey, $formElement);
        }

Carsten  Rose's avatar
Carsten Rose committed
410
411
412
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('name', $htmlFormElementId);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
413
414
415
416
417
418
419
420
421
422
423
424

        switch ($formElement['checkBoxMode']) {
            case 'single':
                $html = $this->buildCheckboxSingle($formElement, $htmlFormElementId, $attributeBase, $value);
                break;
            case 'multi';
                $html = $this->buildCheckboxMulti($formElement, $htmlFormElementId, $attributeBase, $value, $itemKey, $itemValue);
                break;
            default:
                throw new UserException('checkBoxMode: \'' . $formElement['checkBoxMode'] . '\' is unknown.', ERROR_CHECKBOXMODE_UNKNOWN);
        }

425
426
427
        return $html;
    }

428
    /**
Carsten  Rose's avatar
Carsten Rose committed
429
     * Look for key/value list in `sql1`, `parameter:itemList`, column definition (in this order, first match counts)
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
     * Copies the found keys to &$itemKey and the values to &$itemValue
     *
     * @param array $formElement
     * @param $itemKey
     * @param $itemValue
     * @throws UserException
     */
    private function extractKeyValueList(array $formElement, &$itemKey, &$itemValue) {
        $fieldType = '';
        $itemKey = array();
        $itemValue = array();

        $itemValue = $this->getItemsForEnumOrSet($formElement['name'], $fieldType);

        if (is_array($formElement['sql1'])) {
445
            $keys = array_keys($formElement['sql1'][0]);
446
447
            $itemKey = array_column($formElement['sql1'], 'id');

448
449
450
451
452
453
454
455
456
457
458
459
            // If there is no column 'id' and at least two columns in total
            if (count($itemKey) === 0 && count($keys) >= 2) {
                $itemKey = array_column($formElement['sql1'], $keys[0]);
            }

            $itemValue = array_column($formElement['sql1'], 'label');
            // If there is no column 'label' (e.g.: SHOW tables)
            if (count($itemValue) === 0) {
                $idx = count($keys) == 1 ? 0 : 1;
                $itemValue = array_column($formElement['sql1'], $keys[$idx]);
            }

460
        } elseif (isset($formElement['itemList'])) {
461
            $arr = KeyValueStringParser::parse($formElement['itemList'], ':', ',', IF_VALUE_EMPTY_COPY_KEY);
462
463
464
            $itemValue = array_values($arr);
            $itemKey = array_keys($arr);
        } elseif ($fieldType === 'enum' || $fieldType === 'set') {
Carsten  Rose's avatar
Carsten Rose committed
465
            // already done at the beginning with '$this->getItemsForEnumOrSet($formElement['name'], $fieldType);'
466
        } else {
467
            throw new UserException("Missing definition (- nothing found in 'sql1', 'parameter:itemValues', 'enum-' or 'set-definition'", ERROR_MISSING_ITEM_VALUES);
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
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
        }

        if (count($itemKey) === 0) {
            $itemKey = $itemValue;
        }
    }

    /**
     * @param $column
     * @param $fieldType
     * @return array
     * @throws UserException
     */
    private function getItemsForEnumOrSet($column, &$fieldType) {

        // Get column definition
        $fieldTypeDefinition = $this->store->getVar($column, STORE_TABLE_COLUMN_TYPES);

        if ($fieldTypeDefinition === false) {
            throw new UserException("Column '$column' unknown in table '" . $this->formSpec['tableName'] . "'", ERROR_UNKNOWN_COLUMN);
        }

        $length = strlen($fieldTypeDefinition);

        // enum('...   set('
        switch (substr($fieldTypeDefinition, 0, 4)) {
            case 'enum':
                $startPosition = 5;
                break;
            case 'set(':
                $startPosition = 4;
                break;
            default:
                $fieldType = 'string';
                return array();
        }

        // enum('a','b','c', ...)   >> [ 'a', 'b', 'c', ... ]
        // set('a','b','c', ...)   >> [ 'a', 'b', 'c', ... ]
        $items = OnArray::trimArray(explode(',', substr($fieldTypeDefinition, $startPosition, $length - $startPosition - 1)), "'");
        $fieldType = substr($fieldTypeDefinition, 0, $startPosition - 1);

        return $items;
    }

    /**
     * For CheckBox's with only one checkbox: if no parameter:checked|unchecked is defined, take defaults:
     *    checked: first Element in $itemKey
     *  unchecked: ''
     *
     * @param array $itemKey
     * @param array $formElement
     * @throws UserException
     */
    private function prepareCheckboxCheckedUncheckedValue(array $itemKey, array &$formElement) {

        if (!isset($formElement['checked'])) {
            if (isset($itemKey[0])) {
                // First element in $itemKey list
                $formElement['checked'] = $itemKey[0];
            } else {
                // Take column default value
                $formElement['checked'] = $this->store->getVar($formElement['name'], STORE_TABLE_DEFAULT);
            }
        }

        // unchecked
        if (!isset($formElement['unchecked'])) {
            if (isset($itemKey[1])) {
                $formElement['unchecked'] = ($itemKey[0] === $formElement['checked']) ? $itemKey[1] : $itemKey[0];
            } else {
                $formElement['unchecked'] = '';
            }
        }

        if ($formElement['checked'] === $formElement['unchecked']) {
            throw new UserException('FormElement: type=checkbox - checked and unchecked can\'t be the same: ' . $formElement['checked'], ERROR_CHECKBOX_EQUAL);
        }

    }

    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attribute
     * @param $value
     * @return string
     */
556
    public function buildCheckboxSingle(array $formElement, $htmlFormElementId, $attribute, $value) {
557

Carsten  Rose's avatar
Carsten Rose committed
558
559
        $attribute .= $this->getAttribute('name', $htmlFormElementId);
        $attribute .= $this->getAttribute('value', $formElement['checked'], false);
560
        if ($formElement['checked'] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
561
            $attribute .= $this->getAttribute('checked', 'checked');
562
563
        }

Carsten  Rose's avatar
Carsten Rose committed
564
        $attribute .= $this->getAttributeList($formElement, ['autofocus']);
565

Carsten  Rose's avatar
Carsten Rose committed
566
        $html = $this->buildHidden($formElement, $htmlFormElementId, $formElement['unchecked']);
567
568
569
570
571
572
573
574
575

        $html .= '<input ' . $attribute . '>';
        if (isset($formElement['label2'])) {
            $html .= $formElement['label2'];
        }

        return $html;
    }

576
577
578
579
580
581
582
583
584
585
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return string
     */
    public function buildHidden(array $formElement, $htmlFormElementId, $value) {
        return '<input type="hidden" name="' . $htmlFormElementId . '" value="' . htmlentities($value) . '">';
    }

586
587
588
589
590
591
592
593
594
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attributeBase
     * @param $value
     * @param $itemKey
     * @param $itemValue
     * @return string
     */
595
    public function buildCheckboxMulti(array $formElement, $htmlFormElementId, $attributeBase, $value, $itemKey, $itemValue) {
596
597
598
        // Defines which of the checkboxes will be checked.
        $values = explode($value, ',');

Carsten  Rose's avatar
Carsten Rose committed
599
        $attributeBase .= $this->getAttribute('name', $htmlFormElementId);
600

Carsten  Rose's avatar
Carsten Rose committed
601
        $html = $this->buildHidden($formElement, $htmlFormElementId, $value);
602
603
604
605
606
607
608
609
610
611
612

        $flagFirst = true;
        $ii = 0;
        $jj = 0;
        foreach ($itemKey as $item) {
            $ii++;
            $jj++;
            $attribute = $attributeBase;
            if ($flagFirst) {
                $flagFirst = false;
                if (isset($formElement['autofocus']))
Carsten  Rose's avatar
Carsten Rose committed
613
                    $attribute .= $this->getAttribute('autofocus', $formElement['autofocus']);
614
            }
Carsten  Rose's avatar
Carsten Rose committed
615
            $attribute .= $this->getAttribute('value', $item);
616
            if ($item === $values[$jj]) {
Carsten  Rose's avatar
Carsten Rose committed
617
                $attribute .= $this->getAttribute('checked', 'checked');
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
            }
            $html .= '<input ' . $attribute . '>';
            $html .= $itemValue[$ii];
            if ($ii === $formElement['maxLength']) {
                $ii = 0;
                $html .= '<br>';
            }
        }
        return $html;
    }

    /**
     * Build HTML 'radio' element.
     *
     * Checkboxes will only be submitted, if they are checked. Therefore, a hidden element with the unchecked value will be transfered first.
     *
     * Format: <input type="hidden" name="$htmlFormElementId" value="$valueUnChecked">
     *         <input name="$htmlFormElementId" type="radio" [autofocus="autofocus"]
     *            [readonly="readonly"] [required="required"] [disabled="disabled"] value="<value>" [checked="checked"] >
     *
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return string
     * @throws UserException
     */
644
    public function buildRadio(array $formElement, $htmlFormElementId, $value) {
645
646
647
648
649
650
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
        $this->extractKeyValueList($formElement, $itemKey, $itemValue);

Carsten  Rose's avatar
Carsten Rose committed
651
652
653
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('name', $htmlFormElementId);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
654
655
656
657

        $jj = 0;
        $flagFirst = true;

Carsten  Rose's avatar
Carsten Rose committed
658
        $html = $this->buildHidden($formElement, $htmlFormElementId, $value);
659
660
661
662
663
664
        for ($ii = 0; $ii < count($itemValue); $ii++) {
            $jj++;
            $attribute = $attributeBase;
            if ($flagFirst) {
                $flagFirst = false;
                if (isset($formElement['autofocus']))
Carsten  Rose's avatar
Carsten Rose committed
665
                    $attribute .= $this->getAttribute('autofocus', $formElement['autofocus']);
666
667
            }

Carsten  Rose's avatar
Carsten Rose committed
668
            $attribute .= $this->getAttribute('value', $itemKey[$ii]);
669
            if ($itemKey[$ii] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
670
                $attribute .= $this->getAttribute('checked', 'checked');
671
672
673
674
675
676
677
678
679
680
681
            }
            $html .= '<input ' . $attribute . '>';
            $html .= $itemValue[$ii];
            if ($jj === $formElement['maxLength']) {
                $jj = 0;
                $html .= '<br>';
            }
        }
        return $html;
    }

Carsten  Rose's avatar
Carsten Rose committed
682
683
684
685
686
687
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
688
    public function buildSelect(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
        $this->extractKeyValueList($formElement, $itemKey, $itemValue);

        $attribute = $this->getAttributeMode($formElement);
        $attribute .= $this->getAttribute('name', $htmlFormElementId);
        $attribute .= $this->getAttributeList($formElement, ['type', 'autofocus']);

        if (isset($formElement['size']) && $formElement['size'] > 1) {
            $attribute .= $this->getAttribute('size', $formElement['size']);
            $attribute .= $this->getAttribute('multiple', 'multiple');
        }

        $option = '';

        if (isset($formElement['emptyItemAtStart']))
            $option = '<option></option>';

        for ($ii = 0; $ii < count($itemValue); $ii++) {
            $option .= '<option ';

            $option .= $this->getAttribute('value', $itemKey[$ii]);
            if ($itemKey[$ii] === $value) {
                $attribute .= 'selected ';
            }

            $option .= '>' . $itemValue[$ii] . '</option>';
        }

        if (isset($formElement['emptyItemAtEnd']))
            $option = '<option></option>';

        return '<select ' . $attribute . '>' . $option . '</select>';
724
725
    }

Carsten  Rose's avatar
Carsten Rose committed
726
727
728
729
730
731
732
733
734
735
    /**
     * Constuct a HTML table of the subrecord data.
     * Column syntax definition: https://wikiit.math.uzh.ch/it/projekt/qfq/qfq-jqwidgets/Documentation#Type:_subrecord
     *
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return string
     * @throws UserException
     */
736
    public function buildSubrecord(array $formElement, $htmlFormElementId, $value) {
737
738
        $html = '';

Carsten  Rose's avatar
Carsten Rose committed
739
740
741
742
743
744
        if (!is_array($formElement['sql1'])) {
            throw new UserException('Missing \'sql1\' Query', ERROR_MISSING_SQL1);
        }

        // construct column attributes
        $control = $this->getSubrecordColumnControl(array_keys($formElement['sql1'][0]));
745
746
//        $html .= '<b>' . $formElement['label'] . '</b>';
        $html .= '<table border="1">';
Carsten  Rose's avatar
Carsten Rose committed
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
        $html .= '<tr><th>' . implode('</th><th>', $control['title']) . '</th></tr>';
        foreach ($formElement['sql1'] as $row) {
            $html .= '<tr>';
            foreach ($row as $col => $value) {
                if (isset($control['icon'][$col])) {
                    $cell = ($value === '') ? '' : "<image src='fileadmin/icons/$value'>";
                } else {
                    $cell = isset($control['nostrip'][$col]) ? $value : strip_tags($value);
                    $cell = substr($cell, 0, $control['width'][$col]);
                }
                $html .= "<td>$cell</td>";
            }
            $html .= '</tr>';
        }
        $html .= '</table>';

763
        return $html;
764
765
    }

Carsten  Rose's avatar
Carsten Rose committed
766
767
768
769
770
771
772
773
    /**
     * @param $titleRaw
     * @return array
     * @throws UserException
     */
    private function getSubrecordColumnControl($titleRaw) {
        $control = array();

774
        foreach ($titleRaw AS $col) {
Carsten  Rose's avatar
Carsten Rose committed
775
776
777
            $control['width'][$col] = SUBRECORD_COLUMN_WIDTH;

            // a) 'City@width=40', b) 'Status@icon', c) 'Mailto@width=80@nostrip'
778
            $arr = KeyValueStringParser::parse($col, '=', '@', IF_VALUE_EMPTY_COPY_KEY);
779
780
            foreach ($arr as $attribute => $value) {
                switch ($attribute) {
Carsten  Rose's avatar
Carsten Rose committed
781
782
783
784
785
                    case 'width':
                    case 'nostrip':
                    case 'icon':
                        break;
                    default:
786
                        $attribute = 'title';
Carsten  Rose's avatar
Carsten Rose committed
787
788
                        break;
                }
789
                $control[$attribute][$col] = $value;
Carsten  Rose's avatar
Carsten Rose committed
790
            }
791
792
            // Limit title length
            $control['title'][$col] = substr($control['title'][$col], 0, $control['width'][$col]);
Carsten  Rose's avatar
Carsten Rose committed
793
794
        }
        return $control;
795
796
    }

Carsten  Rose's avatar
Carsten Rose committed
797
798
799
800
801
802
803
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return string
     * @throws UserException
     */
804
    public function buildFile(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819

        $attribute = $this->getAttributeMode($formElement);
        $attribute .= $this->getAttribute('type', 'file');
        $attribute .= $this->getAttribute('name', $htmlFormElementId);
        $attribute .= $this->getAttributeList($formElement, ['autofocus', 'accept']);

        return '<input ' . $attribute . '>';
    }

    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @throws UserException
     */
820
    public function buildDateJQW(array $formElement, $htmlFormElementId, $value) {
821
822
823
824
        // TODO: implement
        throw new UserException("Not implemented yet: buildDateJQW()");
    }

Carsten  Rose's avatar
Carsten Rose committed
825
826
827
828
829
830
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @throws UserException
     */
831
    public function buildGridJQW(array $formElement, $htmlFormElementId, $value) {
832
833
834
        // TODO: implement
        throw new UserException("Not implemented yet: buildGridJQW()");
    }
Carsten  Rose's avatar
Carsten Rose committed
835
836
837
838
839
840
841

    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
842
    public function buildNote(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
843
844
845
        return $value;
    }

846
847
848
849
850
851
852
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
    public function buildPill(array $formElement, $htmlFormElementId, $value) {
853
        return $value;
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
    }

    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
    public function buildFieldset(array $formElement, $htmlFormElementId, $value) {

        // save parent processed FE's
        $tmpStore = $this->feSpecNative;

        // <fieldset>
        $html = '<fieldset ' . $this->getAttribute('name', $htmlFormElementId) . '>';
869
        if ($formElement['label'] !== '') {
870
871
872
873
874
875
876
            $html .= '<legend>' . $formElement['label'] . '</legend>';
        }

        $html .= $this->wrap[WRAP_SETUP_IN_FIELDSET][WRAP_SETUP_START];

        // child FE's
        $sql = SQL_FORM_ELEMENT;
877
        $this->feSpecNative = $this->db->sql($sql, ROW_REGULAR, ['yes', $this->formSpec["id"], 'native,container', $formElement['id']]);
878
879
880
881
882
883
884
885
886
887
888
        HelperFormElement::explodeParameter($this->feSpecNative);
        $html .= $this->elements($this->store->getVar(SIP_RECORD_ID, STORE_SIP), FORM_ELEMENTS_NATIVE_SUBRECORD);


        $html .= $this->wrap[WRAP_SETUP_IN_FIELDSET][WRAP_SETUP_END];

        $html .= '</fieldset>';

        // restore parent processed FE's
        $this->feSpecNative = $tmpStore;

889
        return $html;
890
891
892
    }


893
}