AbstractBuildForm.php 29.1 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
        ];

        $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
73

74
75
    }

76
77
    abstract public function fillWrap();

78
79
80
81
82
83
84
85
86
    /**
     * @return string The whole form as HTML
     * @throws exceptions\CodeException
     * @throws exceptions\DbException
     */
    public function process() {

        $html = $this->head();

87
        $filter = $this->getProcessFilter();
88

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

91
92
93
            $parentRecords = $this->db->sql($this->formSpec['multiSql']);
            foreach ($parentRecords as $row) {
                $this->store->setVarArray($row, STORE_PARENT_RECORD);
94
                $html .= $this->elements($row['_id'], $filter);
95
96
            }
        } else {
97
            $html .= $this->elements($this->store->getVar(SIP_RECORD_ID, STORE_SIP), $filter);
98
99
        }

100
        // close the form
101
102
        $html .= $this->tail();

103
        $html .= $this->doSubrecords();
104

105
106
107
        return $html;
    }

108
    abstract public function head();
109

110
    abstract public function getProcessFilter();
111
112
113

    /**
     * @param $recordId
114
     * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD
115
116
117
118
     * @return string
     * @throws exceptions\CodeException
     * @throws exceptions\DbException
     */
119
    public function elements($recordId, $filter = FORM_ELEMENTS_NATIVE, $feIdContainer = 0) {
120
121
122
        $html = '';

        // get current data record
123
        if ($recordId > 0 && $this->store->getVar('id', STORE_RECORD) === false) {
124
            $row = $this->db->sql("SELECT * FROM " . $this->formSpec['tableName'] . " WHERE id = ?", ROW_REGULAR, array($recordId));
125
126
            $this->store->setVarArray($row[0], STORE_RECORD);
        }
127
128
129

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

131
132
            if (($filter === FORM_ELEMENTS_NATIVE && $fe['type'] === 'subrecord') ||
                ($filter === FORM_ELEMENTS_SUBRECORD && $fe['type'] !== 'subrecord')
133
134
135
136
            ) {
                continue; // skip this FE
            }

137
138
139
140
141
142
            // Log / Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, $fe['name'] . ' / ' . $fe['id'], STORE_SYSTEM);

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

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

146
            $htmlFormElementId = $formElement['name'] . ':' . $recordId;
147

148
            $html .= $this->wrapElement($htmlFormElementId, $formElement, $value);
149
        }
150

151
152
153
        return $html;
    }

154
    abstract public function wrapElement($htmlFormElementId, $formElement, $value);
155

156
157
158
    abstract public function tail();

    abstract public function doSubrecords();
159

160
    /**
161
162
163
     * @param $item
     * @param $value
     * @param bool|false $flagOmitEmpty
164
165
     * @return string
     */
166
167
168
169
    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];
170
171
    }

172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
    /**
     * @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;
    }

189
    /**
190
191
     * @param array $htmlFormElementId
     * @param $label
192
193
     * @return string
     */
194
195
196
197
    public function buildLabel($htmlFormElementId, $label) {
        $html = '<label for="' . $htmlFormElementId . '">' . $label . '</label>';

        return $html;
198
199
    }

200
201
202
203
204
205
206
207
208
209
210
211
212
    /**
     * 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
     */
213
    public function buildInput(array $formElement, $htmlFormElementId, $value) {
214

Carsten  Rose's avatar
Carsten Rose committed
215
        $attribute = $this->getAttribute('name', $htmlFormElementId);
216
217
218
219
220
221
222
223
224
        $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
225
226
            $attribute .= $this->getAttribute('cols', $colsRows[0]);
            $attribute .= $this->getAttribute('rows', $colsRows[1]);
227
228

        } else {
229
            $attribute .= $this->getAttributeList($formElement, ['type', 'size', 'maxLength']);
Carsten  Rose's avatar
Carsten Rose committed
230
        }
231
        // 'maxLength' needs an upper 'L': naming convention for DB tables!
232
        $attribute .= $this->getAttributeList($formElement, ['autocomplete', 'autofocus', 'placeholder']);
233
234
235
236

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

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

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

241
        $attribute .= $this->getAttribute('value', htmlentities($value), false);
242
243
244
245
246
247
248
249
250
251

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

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

256
257
258
259
260
261
262
263
264
265
266
267
        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
268
    private function getAttributeList(array $formElement, array $attributeList) {
269
270
271
        $attribute = '';
        foreach ($attributeList as $item) {
            if (isset($formElement[$item]))
Carsten  Rose's avatar
Carsten Rose committed
272
                $attribute .= $this->getAttribute(strtolower($item), $formElement[$item]);
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
        }
        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
292
    private function getInputCheckPattern($type, $data) {
293
294
        if ($type === '') {
            return '';
295
        }
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313

        $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
314
    private function getAttributeMode(array $formElement) {
315
316
317
318
319
320
        $attribute = '';

        switch ($formElement['mode']) {
            case 'show':
                break;
            case 'readonly':
Carsten  Rose's avatar
Carsten Rose committed
321
                $attribute .= $this->getAttribute('readonly', 'readonly');
322
323
                break;
            case 'required':
Carsten  Rose's avatar
Carsten Rose committed
324
                $attribute .= $this->getAttribute('required', 'required');
325
326
327
328
                break;
            case 'lock':
                break;
            case 'disabled':
Carsten  Rose's avatar
Carsten Rose committed
329
                $attribute .= $this->getAttribute('disabled', 'disabled');
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
                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
     */
355
    public function buildCheckbox(array $formElement, $htmlFormElementId, $value) {
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
        $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
375
376
377
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('name', $htmlFormElementId);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
378
379
380
381
382
383
384
385
386
387
388
389

        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);
        }

390
391
392
        return $html;
    }

393
    /**
Carsten  Rose's avatar
Carsten Rose committed
394
     * Look for key/value list in `sql1`, `parameter:itemList`, column definition (in this order, first match counts)
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
     * 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'])) {
410
            $keys = array_keys($formElement['sql1'][0]);
411
412
            $itemKey = array_column($formElement['sql1'], 'id');

413
414
415
416
417
418
419
420
421
422
423
424
            // 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]);
            }

425
        } elseif (isset($formElement['itemList'])) {
426
            $arr = KeyValueStringParser::parse($formElement['itemList'], ':', ',', IF_VALUE_EMPTY_COPY_KEY);
427
428
429
            $itemValue = array_values($arr);
            $itemKey = array_keys($arr);
        } elseif ($fieldType === 'enum' || $fieldType === 'set') {
Carsten  Rose's avatar
Carsten Rose committed
430
            // already done at the beginning with '$this->getItemsForEnumOrSet($formElement['name'], $fieldType);'
431
        } else {
432
            throw new UserException("Missing definition (- nothing found in 'sql1', 'parameter:itemValues', 'enum-' or 'set-definition'", ERROR_MISSING_ITEM_VALUES);
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
        }

        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
     */
521
    public function buildCheckboxSingle(array $formElement, $htmlFormElementId, $attribute, $value) {
522

Carsten  Rose's avatar
Carsten Rose committed
523
524
        $attribute .= $this->getAttribute('name', $htmlFormElementId);
        $attribute .= $this->getAttribute('value', $formElement['checked'], false);
525
        if ($formElement['checked'] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
526
            $attribute .= $this->getAttribute('checked', 'checked');
527
528
        }

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

Carsten  Rose's avatar
Carsten Rose committed
531
        $html = $this->buildHidden($formElement, $htmlFormElementId, $formElement['unchecked']);
532
533
534
535
536
537
538
539
540

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

        return $html;
    }

541
542
543
544
545
546
547
548
549
550
    /**
     * @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) . '">';
    }

551
552
553
554
555
556
557
558
559
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attributeBase
     * @param $value
     * @param $itemKey
     * @param $itemValue
     * @return string
     */
560
    public function buildCheckboxMulti(array $formElement, $htmlFormElementId, $attributeBase, $value, $itemKey, $itemValue) {
561
562
563
        // Defines which of the checkboxes will be checked.
        $values = explode($value, ',');

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

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

        $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
578
                    $attribute .= $this->getAttribute('autofocus', $formElement['autofocus']);
579
            }
Carsten  Rose's avatar
Carsten Rose committed
580
            $attribute .= $this->getAttribute('value', $item);
581
            if ($item === $values[$jj]) {
Carsten  Rose's avatar
Carsten Rose committed
582
                $attribute .= $this->getAttribute('checked', 'checked');
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
            }
            $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
     */
609
    public function buildRadio(array $formElement, $htmlFormElementId, $value) {
610
611
612
613
614
615
        $itemKey = array();
        $itemValue = array();

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

Carsten  Rose's avatar
Carsten Rose committed
616
617
618
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('name', $htmlFormElementId);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
619
620
621
622

        $jj = 0;
        $flagFirst = true;

Carsten  Rose's avatar
Carsten Rose committed
623
        $html = $this->buildHidden($formElement, $htmlFormElementId, $value);
624
625
626
627
628
629
        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
630
                    $attribute .= $this->getAttribute('autofocus', $formElement['autofocus']);
631
632
            }

Carsten  Rose's avatar
Carsten Rose committed
633
            $attribute .= $this->getAttribute('value', $itemKey[$ii]);
634
            if ($itemKey[$ii] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
635
                $attribute .= $this->getAttribute('checked', 'checked');
636
637
638
639
640
641
642
643
644
645
646
            }
            $html .= '<input ' . $attribute . '>';
            $html .= $itemValue[$ii];
            if ($jj === $formElement['maxLength']) {
                $jj = 0;
                $html .= '<br>';
            }
        }
        return $html;
    }

Carsten  Rose's avatar
Carsten Rose committed
647
648
649
650
651
652
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
653
    public function buildSelect(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
        $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>';
689
690
    }

Carsten  Rose's avatar
Carsten Rose committed
691
692
693
694
695
696
697
698
699
700
    /**
     * 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
     */
701
    public function buildSubrecord(array $formElement, $htmlFormElementId, $value) {
702
703
        $html = '';

Carsten  Rose's avatar
Carsten Rose committed
704
705
706
707
708
709
        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]));
710
711
//        $html .= '<b>' . $formElement['label'] . '</b>';
        $html .= '<table border="1">';
Carsten  Rose's avatar
Carsten Rose committed
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
        $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>';

728
        return $html;
729
730
    }

Carsten  Rose's avatar
Carsten Rose committed
731
732
733
734
735
736
737
738
    /**
     * @param $titleRaw
     * @return array
     * @throws UserException
     */
    private function getSubrecordColumnControl($titleRaw) {
        $control = array();

739
        foreach ($titleRaw AS $col) {
Carsten  Rose's avatar
Carsten Rose committed
740
741
742
            $control['width'][$col] = SUBRECORD_COLUMN_WIDTH;

            // a) 'City@width=40', b) 'Status@icon', c) 'Mailto@width=80@nostrip'
743
            $arr = KeyValueStringParser::parse($col, '=', '@', IF_VALUE_EMPTY_COPY_KEY);
744
745
            foreach ($arr as $attribute => $value) {
                switch ($attribute) {
Carsten  Rose's avatar
Carsten Rose committed
746
747
748
749
750
                    case 'width':
                    case 'nostrip':
                    case 'icon':
                        break;
                    default:
751
                        $attribute = 'title';
Carsten  Rose's avatar
Carsten Rose committed
752
753
                        break;
                }
754
                $control[$attribute][$col] = $value;
Carsten  Rose's avatar
Carsten Rose committed
755
            }
756
757
            // Limit title length
            $control['title'][$col] = substr($control['title'][$col], 0, $control['width'][$col]);
Carsten  Rose's avatar
Carsten Rose committed
758
759
        }
        return $control;
760
761
    }

Carsten  Rose's avatar
Carsten Rose committed
762
763
764
765
766
767
768
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return string
     * @throws UserException
     */
769
    public function buildFile(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784

        $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
     */
785
    public function buildDateJQW(array $formElement, $htmlFormElementId, $value) {
786
787
788
789
        // TODO: implement
        throw new UserException("Not implemented yet: buildDateJQW()");
    }

Carsten  Rose's avatar
Carsten Rose committed
790
791
792
793
794
795
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @throws UserException
     */
796
    public function buildGridJQW(array $formElement, $htmlFormElementId, $value) {
797
798
799
        // TODO: implement
        throw new UserException("Not implemented yet: buildGridJQW()");
    }
Carsten  Rose's avatar
Carsten Rose committed
800
801
802
803
804
805
806

    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
807
    public function buildNote(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
808
809
810
        return $value;
    }

811
812
813
814
815
816
817
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
    public function buildPill(array $formElement, $htmlFormElementId, $value) {
818
        return $value;
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
    }

    /**
     * @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) . '>';
834
        if ($formElement['label'] !== '') {
835
836
837
838
839
840
841
            $html .= '<legend>' . $formElement['label'] . '</legend>';
        }

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

        // child FE's
        $sql = SQL_FORM_ELEMENT;
842
        $this->feSpecNative = $this->db->sql($sql, ROW_REGULAR, ['yes', $this->formSpec["id"], 'native,container', $formElement['id']]);
843
844
845
846
847
848
849
850
851
852
853
854
        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;


855
        return $html;
856
857
858
    }


859
}