AbstractBuildForm.php 35.5 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\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
require_once(__DIR__ . '/../qfq/helper/HelperFormElement.php');
21
require_once(__DIR__ . '/../qfq/helper/Support.php');
22

23
24

/**
Carsten  Rose's avatar
Carsten Rose committed
25
26
 * Class AbstractBuildForm
 * @package qfq
27
 */
28
abstract class AbstractBuildForm {
29
30
31
    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
32
    protected $store = null;
Carsten  Rose's avatar
Carsten Rose committed
33
    protected $evaluate = null;
34
35
    protected $buildElementFunctionName = array();
    protected $pattern = array();
36
    protected $wrap = array();
37

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

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

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

68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
        $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'
        ];

86
87
88
89
90
91
        $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
92

93
94
    }

95
96
    abstract public function fillWrap();

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

        $html = $this->head();

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

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

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

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

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

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

126
127
128
        return $html;
    }

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
    public function head() {
        $html = '';

        $html .= $this->wrapItem(WRAP_SETUP_TITLE, $this->formSpec['title'], true);
        $html .= $this->getFormTag();

        return $html;
    }

    /**
     * @param $item
     * @param $value
     * @param bool|false $flagOmitEmpty
     * @return string
     */
    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];
    }

    /**
     * Rreturns complete '<form ...>'
     *
     * @return string
     */
    public function getFormTag() {

        $attribute = $this->getFormTagAtrributes();

        return '<form ' . OnArray::toString($attribute, '=', ' ', "'") . '>';
    }

    /**
     * Build an assoc array with standard form attributes.
     *
     * @return mixed
     */
    public function getFormTagAtrributes() {

        $attribute['method'] = 'post';
        $attribute['action'] = $this->getActionUrl();
        $attribute['target'] = '_top';
        $attribute['accept-charset'] = 'UTF-8';
        $attribute['autocomplete'] = 'on';
        $attribute['enctype'] = $this->getEncType();

        return $attribute;
    }

    /**
     * Builds the HTML 'form'-tag inlcuding all attributes and target.
     *
     * @return string
     * @throws DbException
     */
    public function getActionUrl() {

        $queryStringArray['s'] = $this->store->getVar(SIP_SIP, STORE_SIP);

        Support::appendTypo3ParameterToArray($queryStringArray);

        return basename($_SERVER['SCRIPT_NAME']) . "?" . Support::arrayToQueryString($queryStringArray);
    }

    /**
     * Determines the enctype.
     *
     * See: https://www.w3.org/wiki/HTML/Elements/form#HTML_Attributes
     *
     * @return string
     * @throws DbException
     */
    public function getEncType() {

        $result = $this->db->sql("SELECT id FROM FormElement AS fe WHERE fe.formId=? AND fe.type='upload' LIMIT 1", ROW_EMPTY_IS_OK, [$this->formSpec['id']], 'Look for Formelement.type="upload"');
        return (count($result) === 1) ? 'multipart/form-data' : 'application/x-www-form-urlencoded';

    }
208

209
    abstract public function getProcessFilter();
210
211
212

    /**
     * @param $recordId
213
     * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD
214
     * @return string
215
216
     * @throws CodeException
     * @throws DbException
217
     */
218
    public function elements($recordId, $filter = FORM_ELEMENTS_NATIVE, $feIdContainer = 0) {
219
220
221
        $html = '';

        // get current data record
222
        if ($recordId > 0 && $this->store->getVar('id', STORE_RECORD) === false) {
223
            $row = $this->db->sql("SELECT * FROM " . $this->formSpec['tableName'] . " WHERE id = ?", ROW_REGULAR, array($recordId));
224
225
            $this->store->setVarArray($row[0], STORE_RECORD);
        }
226
227
228

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

230
231
            if (($filter === FORM_ELEMENTS_NATIVE && $fe['type'] === 'subrecord') ||
                ($filter === FORM_ELEMENTS_SUBRECORD && $fe['type'] !== 'subrecord')
232
233
234
235
            ) {
                continue; // skip this FE
            }

236
237
238
239
            // Log / Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, $fe['name'] . ' / ' . $fe['id'], STORE_SYSTEM);

            // evaluate current FormElement
240
241
242
243
244
            $evaluate = new Evaluate($this->store, $this->db);
            $formElement = $evaluate->parseArray($fe, $fe['debug'] === 'yes');
            if ($fe['debug'] === 'yes') {
                throw new UserException($evaluate->getDebug(), ERROR_DEBUG);
            }
245

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

249
            $htmlFormElementId = $formElement['name'] . ':' . $recordId;
250

251
252
253
254
255
256
257
258
259
260
            // 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);
261
        }
262

263
264
265
        return $html;
    }

266
267
268
    abstract public function tail();

    abstract public function doSubrecords();
269

270
271
272
273
274
275
276
277
    abstract public function buildRowNative($formElement, $elementHtml);

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

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

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

278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
    /**
     * @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;
    }

295
    /**
296
297
     * @param array $htmlFormElementId
     * @param $label
298
299
     * @return string
     */
300
301
302
303
    public function buildLabel($htmlFormElementId, $label) {
        $html = '<label for="' . $htmlFormElementId . '">' . $label . '</label>';

        return $html;
304
305
    }

306
307
308
309
310
311
312
313
314
315
316
317
318
    /**
     * 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
     */
319
    public function buildInput(array $formElement, $htmlFormElementId, $value) {
320

Carsten  Rose's avatar
Carsten Rose committed
321
        $attribute = $this->getAttribute('name', $htmlFormElementId);
322
323
324
325
326
327
328
329
330
        $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
331
332
            $attribute .= $this->getAttribute('cols', $colsRows[0]);
            $attribute .= $this->getAttribute('rows', $colsRows[1]);
333
334

        } else {
335
            $attribute .= $this->getAttributeList($formElement, ['type', 'size', 'maxLength']);
Carsten  Rose's avatar
Carsten Rose committed
336
        }
337
        // 'maxLength' needs an upper 'L': naming convention for DB tables!
338
        $attribute .= $this->getAttributeList($formElement, ['autocomplete', 'autofocus', 'placeholder']);
339
340
341
342

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

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

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

347
        $attribute .= $this->getAttribute('value', htmlentities($value), false);
348
349
350
351
352
353
354
355
356
357

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

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

362
363
364
365
366
367
368
369
370
371
372
373
        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
374
    private function getAttributeList(array $formElement, array $attributeList) {
375
376
377
        $attribute = '';
        foreach ($attributeList as $item) {
            if (isset($formElement[$item]))
Carsten  Rose's avatar
Carsten Rose committed
378
                $attribute .= $this->getAttribute(strtolower($item), $formElement[$item]);
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
        }
        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
398
    private function getInputCheckPattern($type, $data) {
399
400
        if ($type === '') {
            return '';
401
        }
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419

        $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
420
    private function getAttributeMode(array $formElement) {
421
422
423
424
425
426
        $attribute = '';

        switch ($formElement['mode']) {
            case 'show':
                break;
            case 'readonly':
Carsten  Rose's avatar
Carsten Rose committed
427
                $attribute .= $this->getAttribute('readonly', 'readonly');
428
429
                break;
            case 'required':
Carsten  Rose's avatar
Carsten Rose committed
430
                $attribute .= $this->getAttribute('required', 'required');
431
432
433
434
                break;
            case 'lock':
                break;
            case 'disabled':
Carsten  Rose's avatar
Carsten Rose committed
435
                $attribute .= $this->getAttribute('disabled', 'disabled');
436
437
438
439
                break;
            default:
                $this->store->setVar(SYSTEM_FORM_ELEMENT, $formElement['name'] . ' / ' . $formElement['id'], STORE_SYSTEM);
                $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, 'mode', STORE_SYSTEM);
440
                throw new UserException("Unknown mode '" . $formElement['mode'] . "'", ERROR_UNKNOWN_MODE);
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
                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
     */
461
    public function buildCheckbox(array $formElement, $htmlFormElementId, $value) {
462
463
464
465
466
467
468
469
        $itemKey = array();
        $itemValue = array();

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

        // Get fallback, if 'checkBoxMode' is not defined:
        if (!isset($formElement['checkBoxMode'])) {
470
            // This fallback is problematic if 'set' or 'enum' has 2 : defaults to single but maybe multi is meant.
471
472
473
474
475
476
477
478
479
480
            $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
481
482
483
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('name', $htmlFormElementId);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
484
485
486
487
488
489
490
491
492
493
494
495

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

496
497
498
        return $html;
    }

499
    /**
500
501
502
503
504
     * Look for key/value list (in this order, first match counts) in
     *  a) `sql1`
     *  b) `parameter:itemList`
     *  c) table.column definition
     *
505
     * Copies the found keys to &$itemKey and the values to &$itemValue
506
     * If there are no &$itemKey, copy &$itemValue to &$itemKey.
507
508
509
510
511
512
513
514
515
516
517
518
519
520
     *
     * @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'])) {
521
522
523
            if (count($formElement['sql1']) > 0) {
                $keys = array_keys($formElement['sql1'][0]);
                $itemKey = array_column($formElement['sql1'], 'id');
524

525
526
527
528
                // 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]);
                }
529

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

        if (count($itemKey) === 0) {
            $itemKey = $itemValue;
        }
552
553
554
555
556
557
558
559
560
561

        if (isset($formElement['emptyItemAtStart'])) {
            array_unshift($itemKey, '');
            array_unshift($itemValue, '');
        }

        if (isset($formElement['emptyItemAtEnd'])) {
            $itemValue[] = '';
            $itemKey[] = '';
        }
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
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
609
610
611
612
613
614
615
616
617
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
644
    }

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

Carsten  Rose's avatar
Carsten Rose committed
647
648
        $attribute .= $this->getAttribute('name', $htmlFormElementId);
        $attribute .= $this->getAttribute('value', $formElement['checked'], false);
649
        if ($formElement['checked'] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
650
            $attribute .= $this->getAttribute('checked', 'checked');
651
652
        }

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

Carsten  Rose's avatar
Carsten Rose committed
655
        $html = $this->buildHidden($formElement, $htmlFormElementId, $formElement['unchecked']);
656
657
658
659
660
661
662
663
664

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

        return $html;
    }

665
666
667
668
669
670
671
672
673
674
    /**
     * @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) . '">';
    }

675
676
677
678
679
680
681
682
683
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attributeBase
     * @param $value
     * @param $itemKey
     * @param $itemValue
     * @return string
     */
684
    public function buildCheckboxMulti(array $formElement, $htmlFormElementId, $attributeBase, $value, $itemKey, $itemValue) {
685
686
687
        // Defines which of the checkboxes will be checked.
        $values = explode($value, ',');

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

Carsten  Rose's avatar
Carsten Rose committed
690
        $html = $this->buildHidden($formElement, $htmlFormElementId, $value);
691
692
693
694
695
696
697
698
699
700
701

        $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
702
                    $attribute .= $this->getAttribute('autofocus', $formElement['autofocus']);
703
            }
Carsten  Rose's avatar
Carsten Rose committed
704
            $attribute .= $this->getAttribute('value', $item);
705
            if ($item === $values[$jj]) {
Carsten  Rose's avatar
Carsten Rose committed
706
                $attribute .= $this->getAttribute('checked', 'checked');
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
            }
            $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
     */
733
    public function buildRadio(array $formElement, $htmlFormElementId, $value) {
734
735
736
737
738
739
        $itemKey = array();
        $itemValue = array();

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

Carsten  Rose's avatar
Carsten Rose committed
740
741
742
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('name', $htmlFormElementId);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
743
744
745
746

        $jj = 0;
        $flagFirst = true;

Carsten  Rose's avatar
Carsten Rose committed
747
        $html = $this->buildHidden($formElement, $htmlFormElementId, $value);
748
749
750
751
752
753
        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
754
                    $attribute .= $this->getAttribute('autofocus', $formElement['autofocus']);
755
756
            }

Carsten  Rose's avatar
Carsten Rose committed
757
            $attribute .= $this->getAttribute('value', $itemKey[$ii]);
758
            if ($itemKey[$ii] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
759
                $attribute .= $this->getAttribute('checked', 'checked');
760
761
762
763
764
765
766
767
768
769
770
            }
            $html .= '<input ' . $attribute . '>';
            $html .= $itemValue[$ii];
            if ($jj === $formElement['maxLength']) {
                $jj = 0;
                $html .= '<br>';
            }
        }
        return $html;
    }

Carsten  Rose's avatar
Carsten Rose committed
771
772
773
774
775
776
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
777
    public function buildSelect(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
        $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 = '';
794
        $selected = 'selected';
Carsten  Rose's avatar
Carsten Rose committed
795
796
797
798
799
        for ($ii = 0; $ii < count($itemValue); $ii++) {
            $option .= '<option ';

            $option .= $this->getAttribute('value', $itemKey[$ii]);
            if ($itemKey[$ii] === $value) {
800
801
                $option .= $selected;
                $selected = '';
Carsten  Rose's avatar
Carsten Rose committed
802
803
804
805
806
807
            }

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

        return '<select ' . $attribute . '>' . $option . '</select>';
808
809
    }

Carsten  Rose's avatar
Carsten Rose committed
810
811
812
813
814
815
816
817
818
819
    /**
     * 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
     */
820
    public function buildSubrecord(array $formElement, $htmlFormElementId, $value) {
821
822
        $html = '';

823
824
825
826
827
828
        $primaryRecord = $this->store->getStore(STORE_RECORD);

        if (!isset($primaryRecord['id'])) {
            return 'Please save main record fist.';
        }

Carsten  Rose's avatar
Carsten Rose committed
829
830
831
832
        if (!is_array($formElement['sql1'])) {
            throw new UserException('Missing \'sql1\' Query', ERROR_MISSING_SQL1);
        }

833
834
835
836
837
838
839
840
841
        // No records?
        if (count($formElement['sql1']) == 0) {
            return '';
        }

        if (!isset($formElement['sql1'][0]['id'])) {
            throw new UserException('Missing column \'id\' in  \'sql1\' Query', ERROR_MISSING_COLUMN_ID);
        }

Carsten  Rose's avatar
Carsten Rose committed
842
843
        // construct column attributes
        $control = $this->getSubrecordColumnControl(array_keys($formElement['sql1'][0]));
844

845
846
//        $html .= '<b>' . $formElement['label'] . '</b>';
        $html .= '<table border="1">';
847
        $html .= '<tr><th></th><th>' . implode('</th><th>', $control['title']) . '</th></tr>';
Carsten  Rose's avatar
Carsten Rose committed
848
        foreach ($formElement['sql1'] as $row) {
849

Carsten  Rose's avatar
Carsten Rose committed
850
            $html .= '<tr>';
851
            $html .= '<td>' . $this->editLink($formElement, $row['id'], $primaryRecord) . '</td>';
852

853
854
            foreach ($row as $columnName => $value) {
                $html .= '<td>' . $this->formatColumn($control, $columnName, $value) . '</td>';
Carsten  Rose's avatar
Carsten Rose committed
855
856
857
858
859
            }
            $html .= '</tr>';
        }
        $html .= '</table>';

860
        return $html;
861
862
    }

Carsten  Rose's avatar
Carsten Rose committed
863
864
865
866
867
    /**
     * @param $titleRaw
     * @return array
     * @throws UserException
     */
868
    private function getSubrecordColumnControl(array $titleRaw) {
Carsten  Rose's avatar
Carsten Rose committed
869
870
        $control = array();

871
872
873
        foreach ($titleRaw AS $columnName) {
            $flagWidthLimit = true;
            $control['width'][$columnName] = SUBRECORD_COLUMN_WIDTH;
Carsten  Rose's avatar
Carsten Rose committed
874
875

            // a) 'City@width=40', b) 'Status@icon', c) 'Mailto@width=80@nostrip'
876
            $arr = KeyValueStringParser::parse($columnName, '=', '@', IF_VALUE_EMPTY_COPY_KEY);
877
878
            foreach ($arr as $attribute => $value) {
                switch ($attribute) {
Carsten  Rose's avatar
Carsten Rose committed
879
880
                    case 'width':
                    case 'nostrip':
881
                        break;
Carsten  Rose's avatar
Carsten Rose committed
882
                    case 'icon':
883
884
885
                    case 'url':
                    case 'mailto':
                        $flagWidthLimit = false;
Carsten  Rose's avatar
Carsten Rose committed
886
887
                        break;
                    default:
888
                        $attribute = is_numeric($value) ? 'width' : 'title';
Carsten  Rose's avatar
Carsten Rose committed
889
890
                        break;
                }
891
                $control[$attribute][$columnName] = $value;
Carsten  Rose's avatar
Carsten Rose committed
892
            }
893

894
            // Limit title length
895
896
897
898
899
900
            $control['title'][$columnName] = substr($control['title'][$columnName], 0, $control['width'][$columnName]);

            if (!$flagWidthLimit) {
                $control['width'][$columnName] = false;
            }

Carsten  Rose's avatar
Carsten Rose committed
901
902
        }
        return $control;
903
904
    }

905
906
907
908
909
910
911
    /**
     * @param $formElement
     * @param $targetRecordId
     * @param $record
     * @return string
     * @throws UserException
     */
912
    private function editLink($formElement, $targetRecordId, $record) {
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946

        $queryStringArray = [
            'form' => $formElement['form'],
            'r' => $targetRecordId,

        ];

        // Add custom query parameter
        if (isset($formElement['detail'])) {
            $detailParam = KeyValueStringParser::parse($formElement['detail']);
            foreach ($detailParam as $src => $dest) {
                if ($src[0] == '#') {
                    $queryStringArray[$dest] = substr($src, 1);
                    continue;
                }

                if (isset($record[$src])) {
                    $queryStringArray[$dest] = $record[$src];
                }
            }
        }

        Support::appendTypo3ParameterToArray($queryStringArray);

        //-----------------
        $queryString = Support::arrayToQueryString($queryStringArray);

        $sip = $this->store->getSip();
        $url = $formElement['page'] . $sip->queryStringToSip($queryString);

        return "<a href='$url'><span class='glyphicon glyphicon-pencil'></span></a>";

    }

947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
    /**
     * @param array $control
     * @param $columnName
     * @param $value
     * @return string
     */
    private function formatColumn(array $control, $columnName, $value) {

        $cell = isset($control['nostrip'][$columnName]) ? $value : strip_tags($value);

        if ($control['width'][$columnName] !== false)
            $cell = substr($cell, 0, $control['width'][$columnName]);

        if (isset($control['icon'][$columnName])) {
            $cell = ($cell === '') ? '' : "<image src='fileadmin/icons/$cell'>";
        }

        if (isset($control['mailto'][$columnName])) {
            $cell = "<a href='mailto:$cell'>$cell</a>";
        }

        if (isset($control['url'][$columnName])) {
            $cell = "<a href='$cell'>$cell</a>";
        }

        return $cell;
    }

Carsten  Rose's avatar
Carsten Rose committed
975
976
977
978
979
980
981
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return string
     * @throws UserException
     */
982
    public function buildFile(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997

        $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
     */
998
    public function buildDateJQW(array $formElement, $htmlFormElementId, $value) {
999
        // TODO: implement
1000
        throw new UserException("Not implemented yet: buildDateJQW()", ERROR_NOT_IMPLEMENTED);
1001
1002
    }

Carsten  Rose's avatar
Carsten Rose committed
1003
1004
1005
1006
1007
1008
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @throws UserException
     */
1009
    public function buildGridJQW(array $formElement, $htmlFormElementId, $value) {
1010
        // TODO: implement
1011
        throw new UserException("Not implemented yet: buildGridJQW()", ERROR_NOT_IMPLEMENTED);
1012
    }
Carsten  Rose's avatar
Carsten Rose committed
1013
1014
1015
1016
1017
1018
1019

    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
1020
    public function buildNote(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
1021
1022
1023
        return $value;
    }

1024
1025
1026
1027
1028
1029
1030
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
    public function buildPill(array $formElement, $htmlFormElementId, $value) {
1031
        return $value;
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
    }

    /**
     * @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) . '>';
1047
        if ($formElement['label'] !== '') {
1048
1049
1050
1051
1052
1053
1054
            $html .= '<legend>' . $formElement['label'] . '</legend>';
        }

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

        // child FE's
        $sql = SQL_FORM_ELEMENT;
1055
        $this->feSpecNative = $this->db->sql($sql, ROW_REGULAR, ['yes', $this->formSpec["id"], 'native,container', $formElement['id']]);
1056
        HelperFormElement::explodeFieldParameter($this->feSpecNative);
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
        $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;

1067
        return $html;
1068
1069
1070
    }


1071
}