AbstractBuildForm.php 44.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\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
require_once(__DIR__ . '/../qfq/helper/OnArray.php');
23

24
25

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

40
41
    private $formId = null;

42
43
44
45
46
47
48
    /**
     * AbstractBuildForm constructor.
     *
     * @param array $formSpec
     * @param array $feSpecAction
     * @param array $feSpecNative
     */
49
50
51
52
53
    public function __construct(array $formSpec, array $feSpecAction, array $feSpecNative) {
        $this->formSpec = $formSpec;
        $this->feSpecAction = $feSpecAction;
        $this->feSpecNative = $feSpecNative;
        $this->store = Store::getInstance();
54
        $this->db = new Database();
Carsten  Rose's avatar
Carsten Rose committed
55
        $this->evaluate = new Evaluate($this->store, $this->db);
56

57
58
//        $sip = $this->store->getVar(CLIENT_SIP, STORE_CLIENT);

59
        // render mode specific
60
        $this->fillWrap();
61
62
63

        $this->buildElementFunctionName = [
            'checkbox' => 'Checkbox',
64
65
            'dateJQW' => 'DateJQW',
            'datetimeJQW' => 'DateJQW',
66
67
68
            'email' => 'Input',
            'gridJQW' => 'GridJQW',
            'hidden' => 'Hidden',
69
            'text' => 'Input',
70
71
72
73
            'note' => 'Note',
            'password' => 'Input',
            'radio' => 'Radio',
            'select' => 'Select',
74
            'subrecord' => 'Subrecord',
Carsten  Rose's avatar
Carsten Rose committed
75
            'upload' => 'File',
76
77
            'fieldset' => 'Fieldset',
            'pill' => 'Pill'
78
79
        ];

80
81
82
83
84
85
86
        $this->buildRowName = [
            'checkbox' => 'Native',
            'dateJQW' => 'Native',
            'datetimeJQW' => 'Native',
            'email' => 'Native',
            'gridJQW' => 'Native',
            'hidden' => 'Native',
87
            'text' => 'Native',
88
89
90
91
92
93
94
95
96
97
            'note' => 'Native',
            'password' => 'Native',
            'radio' => 'Native',
            'select' => 'Native',
            'subrecord' => 'Subrecord',
            'upload' => 'Native',
            'fieldset' => 'Fieldset',
            'pill' => 'Pill'
        ];

98
        $this->inputCheckPattern = OnArray::inputCheckPatternArray();
99
100
    }

101
102
    abstract public function fillWrap();

103
    /**
104
     * Builds complete form. Depending of Formspecification, the layout will be 'plain' / 'table' / 'bootstrap'.
105
     *
106
     * @return string The whole form as HTML
107
108
     * @throws CodeException
     * @throws DbException
109
110
111
     */
    public function process() {

112
        // <form>
113
114
        $html = $this->head();

115
        $filter = $this->getProcessFilter();
116

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

119
120
            $parentRecords = $this->db->sql($this->formSpec['multiSql']);
            foreach ($parentRecords as $row) {
121
                $this->store->setVarArray($row, STORE_PARENT_RECORD, true);
122
                $html .= $this->elements($row['_id'], $filter);
123
124
            }
        } else {
125
            $html .= $this->elements($this->store->getVar(SIP_RECORD_ID, STORE_SIP), $filter);
126
127
        }

128
        // </form>
129
130
        $html .= $this->tail();

131
        $html .= $this->doSubrecords();
132

133
134
135
        return $html;
    }

136
    /**
137
     * Builds the head area of the form.
138
     *
139
     * @return string
140
     */
141
142
    public function head() {
        $html = '';
143

144
        $html .= '<div ' . $this->getAttribute('class', $this->formSpec['class'], TRUE) . '>'; // main <div class=...> around everything
145

146
147
148
        // Logged in BE User will see a FormEdit Link
        $sipParamString = OnArray::toString($this->store->getStore(STORE_SIP), ':', ', ', "'");
        $formEditUrl = $this->createFormEditUrl();
149

150
        $html .= "<p><a href='$formEditUrl'>Edit</a> <small>[$sipParamString]</small></p>";
151

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

154
155
156
        $html .= $this->getFormTag();

        return $html;
157
158
159
    }

    /**
160
     * Format's an attribute: $type=$value. If $flagOmitEmpty==true && $value=='': return ''.
161
     *
162
163
164
165
     * @param $type
     * @param $value
     * @param bool|false $flagOmitEmpty
     * @return string
166
     */
167
168
169
    public function getAttribute($type, $value, $flagOmitEmpty = true) {
        if ($flagOmitEmpty && $value === "")
            return '';
170

171
        return $type . '="' . trim($value) . '" ';
172
173
    }

174
    /**
175
     * If SHOW_DEBUG_INFO=yes: create a link (incl. SIP) to edit the current form. Show also the hidden content of the SIP.
176
     *
177
     * @return string String: <a href="?pageId&sip=....">Edit</a> <small>[sip:..., r:..., urlparam:..., ...]</small>
178
     */
179
    public function createFormEditUrl() {
180

181
        if ($this->store->getVar(SYSTEM_SHOW_DEBUG_INFO, STORE_SYSTEM) !== 'yes') {
182
183
            return '';
        }
184

185
186
187
188
189
        $queryStringArray = [
            'id' => $this->store->getVar(TYPO3_PAGE_ID, STORE_TYPO3),
            'form' => 'form',
            'r' => $this->formSpec['id']
        ];
190

191
        $queryString = Support::arrayToQueryString($queryStringArray);
192

193
194
        $sip = $this->store->getSipInstance();
        $url = $sip->queryStringToSip($queryString);
195

196
        return $url;
197
198
199
    }

    /**
200
201
     * Wrap's $this->wrap[$item][WRAP_SETUP_START] around $value. If $flagOmitEmpty==true && $value=='': return ''.
     *
202
203
204
205
206
207
208
209
210
211
212
213
     * @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];
    }

    /**
214
     * Returns '<form ...>'-tag with various attributes.
215
216
217
218
219
220
221
222
223
224
225
226
227
     *
     * @return string
     */
    public function getFormTag() {

        $attribute = $this->getFormTagAtrributes();

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

    /**
     * Build an assoc array with standard form attributes.
     *
228
     * @return array
229
230
231
     */
    public function getFormTagAtrributes() {

232
        //TODO: ttcontent id eintragen
Carsten  Rose's avatar
Carsten Rose committed
233
//        $attribute['id'] = $this->store->getVar(STORE_TYPO3,'1234');
234
        $attribute['id'] = $this->getFormId();
235
236
237
238
239
240
241
242
243
244
        $attribute['method'] = 'post';
        $attribute['action'] = $this->getActionUrl();
        $attribute['target'] = '_top';
        $attribute['accept-charset'] = 'UTF-8';
        $attribute['autocomplete'] = 'on';
        $attribute['enctype'] = $this->getEncType();

        return $attribute;
    }

245
246
247
248
249
250
251
252
253
254
    /**
     * @return string
     */
    public function getFormId() {
        if ($this->formId === null) {
            $this->formId = uniqid('qfq-form-');
        }
        return $this->formId;
    }

255
256
257
    /**
     * Builds the HTML 'form'-tag inlcuding all attributes and target.
     *
258
259
     * Notice: the SIP will be transferred as POST Parameter.
     *
260
261
262
263
264
     * @return string
     * @throws DbException
     */
    public function getActionUrl() {

265
        return API_DIR . '/save.php';
266
267
268
269
270
271
272
273
274
275
276
277
    }

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

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

    }
282

283
    abstract public function getProcessFilter();
284
285

    /**
286
287
     * Process all FormElements: build corresponding HTML code. Collect and return all HTML code.
     *
288
     * @param $recordId
289
     * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD
290
     * @param int $feIdContainer
291
     * @return string
292
293
     * @throws CodeException
     * @throws DbException
294
     * @throws \qfq\UserException
295
     */
296
    public function elements($recordId, $filter = FORM_ELEMENTS_NATIVE, $feIdContainer = 0) {
297
298
299
        $html = '';

        // get current data record
300
        if ($recordId > 0 && $this->store->getVar('id', STORE_RECORD) === false) {
301
302
            $row = $this->db->sql("SELECT * FROM " . $this->formSpec['tableName'] . " WHERE id = ?", ROW_EXPECT_1, array($recordId));
            $this->store->setVarArray($row, STORE_RECORD);
303
        }
304
305
306

        // Iterate over all FormElements
        foreach ($this->feSpecNative as $fe) {
307
            $debugStack = array();
308

309
310
            if (($filter === FORM_ELEMENTS_NATIVE && $fe['type'] === 'subrecord') ||
                ($filter === FORM_ELEMENTS_SUBRECORD && $fe['type'] !== 'subrecord')
311
312
313
314
            ) {
                continue; // skip this FE
            }

315
316
317
318
            // Log / Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, $fe['name'] . ' / ' . $fe['id'], STORE_SYSTEM);

            // evaluate current FormElement
319
            $evaluate = new Evaluate($this->store, $this->db);
320
            $formElement = $evaluate->parseArray($fe, $debugStack);
321

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

325
            $htmlFormElementId = HelperFormElement::buildFormElementId($formElement['name'], $recordId);
326

327
328
329
330
            // Construct Marshaller Name
            $buildElementFunctionName = 'build' . $this->buildElementFunctionName[$formElement['type']];

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

            // debugStack as Tooltip
334
            if ($this->store->getVar(SYSTEM_SHOW_DEBUG_INFO, STORE_SYSTEM) === 'yes' && count($debugStack) > 0) {
335
                $elementHtml = Support::appendTooltip($elementHtml, implode("\n", OnArray::htmlentitiesOnArray($debugStack)));
336
337
            }

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

            $html .= $this->$buildRowName($formElement, $elementHtml);
342
        }
343

344
345
346
        // Log / Debug: Last FormElement has been processed.
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

347
348
349
        return $html;
    }

350
351
352
    abstract public function tail();

    abstract public function doSubrecords();
353

354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
    /**
     * Create a link (incl. SIP) to delete the current record.
     *
     * @return string String: "API_DIR/delete.php?sip=...."
     */
    public function createDeleteUrl($table, $recordId) {

        $queryStringArray = [
            SIP_TABLE => $table,
            SIP_RECORD_ID => $recordId
        ];

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

        $sip = $this->store->getSipInstance();

        return $sip->queryStringToSip($queryString, RETURN_URL, API_DIR . '/delete.php');
    }

373
374
375
376
377
378
379
380
    abstract public function buildRowNative($formElement, $elementHtml);

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

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

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

381
    /**
382
383
     * Builds a label, typically for an html-'<input>'-element.
     *
384
385
     * @param array $htmlFormElementId
     * @param $label
386
387
     * @return string
     */
388
389
390
391
    public function buildLabel($htmlFormElementId, $label) {
        $html = '<label for="' . $htmlFormElementId . '">' . $label . '</label>';

        return $html;
392
393
    }

394
395
396
397
398
399
400
401
402
403
404
405
406
    /**
     * 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
     */
407
    public function buildInput(array $formElement, $htmlFormElementId, $value) {
408
        $textarea = '';
409

Carsten  Rose's avatar
Carsten Rose committed
410
        $attribute = $this->getAttribute('name', $htmlFormElementId);
411
412
        $htmlTag = '<input';

413
414
415
416
417
418
419
420
421
422
423
424
        // MIN( $formElement['maxLength'], tabledefinition)
        $maxLength = $this->getColumnSize($formElement['name']);
        if ($maxLength !== false) {
            if (is_numeric($formElement['maxLength'])) {
                if ($formElement['maxLength'] > $maxLength) {
                    $formElement['maxLength'] = $maxLength;
                }
            } else {
                $formElement['maxLength'] = $maxLength;
            }
        }

425
        // Check for input type 'textarea'
426
        $colsRows = explode(',', $formElement['size'], 2);
427
        if (count($colsRows) === 2) {
428
            // <textarea>
429
430
            $htmlTag = '<textarea';

Carsten  Rose's avatar
Carsten Rose committed
431
432
            $attribute .= $this->getAttribute('cols', $colsRows[0]);
            $attribute .= $this->getAttribute('rows', $colsRows[1]);
433
            $textarea = htmlentities($value) . '</textarea>';
434
435

        } else {
436
437
438
            // <input>
            if ($formElement['maxLength'] > 0) {
                $value = substr($value, 0, $formElement['maxLength']);
439
440
441

                $attribute .= $this->getAttributeList($formElement, ['type', 'size', 'maxLength']);
                $attribute .= $this->getAttribute('value', htmlentities($value), false);
442
            }
Carsten  Rose's avatar
Carsten Rose committed
443
        }
444

445
        // 'maxLength' needs an upper 'L': naming convention for DB tables!
446
        $attribute .= $this->getAttributeList($formElement, ['autocomplete', 'autofocus', 'placeholder']);
447
        $attribute .= $this->getAttribute('title', $formElement['tooltip']);
Carsten  Rose's avatar
Carsten Rose committed
448
        $attribute .= $this->getInputCheckPattern($formElement['checkType'], $formElement['checkPattern']);
449

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

452
        return "$htmlTag $attribute>$textarea";
453

454
455
    }

456
    /**
457
458
     * Get column spec from tabledefinition and parse size of it. If nothing defined, return false.
     *
459
     * @param $column
460
     * @return bool|int
461
462
463
464
465
466
     */
    private function getColumnSize($column) {
        $matches = array();

        $typeSpec = $this->store->getVar($column, STORE_TABLE_COLUMN_TYPES);

467
        // e.g.: string(64), enum('yes','no')
468
469
470
471
472
473
        if (1 === preg_match('/\((.+)\)/', $typeSpec, $matches)) {
            if (is_numeric($matches[1]))
                return $matches[1];
        }

        return false;
474
475
476
477
    }

    /**
     * Builds a HTML attribute list, based on  $attributeList.
478
     *
479
480
481
482
483
484
485
     * 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
486
    private function getAttributeList(array $formElement, array $attributeList) {
487
488
489
        $attribute = '';
        foreach ($attributeList as $item) {
            if (isset($formElement[$item]))
Carsten  Rose's avatar
Carsten Rose committed
490
                $attribute .= $this->getAttribute(strtolower($item), $formElement[$item]);
491
492
493
494
495
496
        }
        return $attribute;
    }

    /**
     * Construct HTML Input attribute for Client Validation:
497
     *
498
499
500
501
502
503
504
505
506
507
508
509
     *   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
510
     * @throws \qfq\UserException
511
     */
Carsten  Rose's avatar
Carsten Rose committed
512
    private function getInputCheckPattern($type, $data) {
513
514
        if ($type === '') {
            return '';
515
        }
516
517
518

        $attribute = '';

519
        $arrAttr = explode("|", $this->inputCheckPattern[$type]);
520
521
522
        $arrData = explode("|", $data);

        for ($ii = 0; $ii < count($arrAttr); $ii++) {
523
524
525
526
527
            if ($arrAttr[$ii]) {
                if (!isset($arrData[$ii]))
                    throw new UserException("Missing MIN|MAX values", ERROR_MISSING_MIN_MAX);
                $attribute .= str_replace('%s', trim($arrData[$ii]), $arrAttr[$ii]) . ' ';
            }
528
529
530
531
        }
        return $attribute;
    }

532

533
    /**
534
535
     * Set corresponding html attributes readonly/required/disabled, based on $formElement['mode'].
     *
536
537
538
539
     * @param array $formElement
     * @return string
     * @throws UserException
     */
Carsten  Rose's avatar
Carsten Rose committed
540
    private function getAttributeMode(array $formElement) {
541
542
543
544
545
546
        $attribute = '';

        switch ($formElement['mode']) {
            case 'show':
                break;
            case 'readonly':
Carsten  Rose's avatar
Carsten Rose committed
547
                $attribute .= $this->getAttribute('readonly', 'readonly');
548
549
                break;
            case 'required':
Carsten  Rose's avatar
Carsten Rose committed
550
                $attribute .= $this->getAttribute('required', 'required');
551
552
553
554
                break;
            case 'lock':
                break;
            case 'disabled':
Carsten  Rose's avatar
Carsten Rose committed
555
                $attribute .= $this->getAttribute('disabled', 'disabled');
556
557
558
559
                break;
            default:
                $this->store->setVar(SYSTEM_FORM_ELEMENT, $formElement['name'] . ' / ' . $formElement['id'], STORE_SYSTEM);
                $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, 'mode', STORE_SYSTEM);
560
                throw new UserException("Unknown mode '" . $formElement['mode'] . "'", ERROR_UNKNOWN_MODE);
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
                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
     */
581
    public function buildCheckbox(array $formElement, $htmlFormElementId, $value) {
582
583
584
585
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
586
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
587
588
589

        // Get fallback, if 'checkBoxMode' is not defined:
        if (!isset($formElement['checkBoxMode'])) {
590
            // This fallback is problematic if 'set' or 'enum' has 2 : defaults to single but maybe multi is meant.
591
592
593
594
595
596
597
598
599
600
            $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
601
602
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
603
604
605
606
607
608
609
610
611
612
613

        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);
        }
614
615
616
        return $html;
    }

617
    /**
618
619
620
621
622
     * Look for key/value list (in this order, first match counts) in
     *  a) `sql1`
     *  b) `parameter:itemList`
     *  c) table.column definition
     *
623
     * Copies the found keys to &$itemKey and the values to &$itemValue
624
     * If there are no &$itemKey, copy &$itemValue to &$itemKey.
625
626
627
628
     *
     * @param array $formElement
     * @param $itemKey
     * @param $itemValue
629
630
     * @throws CodeException
     * @throws \qfq\UserException
631
     */
632
    public function getKeyValueListFromSqlEnumSpec(array $formElement, &$itemKey, &$itemValue) {
633
634
635
636
        $fieldType = '';
        $itemKey = array();
        $itemValue = array();

637
638
639
        if (count($formElement) < 20)
            throw new CodeException("Invalid (none or to small) Formelement", ERROR_MISSING_FORMELEMENT);

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

        if (is_array($formElement['sql1'])) {
643
644
645
            if (count($formElement['sql1']) > 0) {
                $keys = array_keys($formElement['sql1'][0]);
                $itemKey = array_column($formElement['sql1'], 'id');
646

647
648
649
650
                // 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]);
                }
651

652
653
654
655
656
657
                $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]);
                }
658
            }
659
        } elseif (isset($formElement['itemList']) && strlen($formElement['itemList']) > 0) {
660
            $arr = KeyValueStringParser::parse($formElement['itemList'], ':', ',', KVP_IF_VALUE_EMPTY_COPY_KEY);
661
662
            $itemValue = array_values($arr);
            $itemKey = array_keys($arr);
663
        } elseif ($fieldType === 'enum' || $fieldType === 'set') {
Carsten  Rose's avatar
Carsten Rose committed
664
            // already done at the beginning with '$this->getItemsForEnumOrSet($formElement['name'], $fieldType);'
665
        } else {
666
            throw new UserException("Missing definition (- nothing found in 'sql1', 'parameter:itemValues', 'enum-' or 'set-definition'", ERROR_MISSING_ITEM_VALUES);
667
668
669
670
671
        }

        if (count($itemKey) === 0) {
            $itemKey = $itemValue;
        }
672
673
674
675
676
677
678
679
680
681

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

        if (isset($formElement['emptyItemAtEnd'])) {
            $itemValue[] = '';
            $itemKey[] = '';
        }
682
683
684
    }

    /**
685
686
     * Get the attribute definition list of an enum or set column. For strings, get the default value. Return elements as an array.
     *
687
688
689
690
691
692
693
694
695
696
697
     * @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) {
698
            throw new UserException("Column '$column' unknown in table '" . $this->formSpec['tableName'] . "'", ERROR_DB_UNKNOWN_COLUMN);
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
724
725
        }

        $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:
726
     *
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
     *    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);
        }

    }

    /**
762
763
     * Build a Checkbox based on two values.
     *
764
765
766
767
768
769
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attribute
     * @param $value
     * @return string
     */
770
    public function buildCheckboxSingle(array $formElement, $htmlFormElementId, $attribute, $value) {
771
        $html = '';
772

Carsten  Rose's avatar
Carsten Rose committed
773
774
        $attribute .= $this->getAttribute('name', $htmlFormElementId);
        $attribute .= $this->getAttribute('value', $formElement['checked'], false);
775
        if ($formElement['checked'] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
776
            $attribute .= $this->getAttribute('checked', 'checked');
777
778
        }

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

781
        $html = $this->buildNativeHidden($htmlFormElementId, $formElement['unchecked']);
782
783
784
785
786
787
788
789
790
791

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

        return $html;
    }

    /**
792
     * Builds a real HTML hidden form element. Useful for checkboxes, Multiple-Select and Radios.
793
794
795
796
797
798
799
800
801
802
803
     *
     * @param $htmlFormElementId
     * @param $value
     * @return string
     */
    public function buildNativeHidden($htmlFormElementId, $value) {
        return '<input type="hidden" name="' . $htmlFormElementId . '" value="' . htmlentities($value) . '">';
    }

    /**
     * Build as many Checkboxes as items
804
805
806
807
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attributeBase
     * @param $value
808
809
     * @param array $itemKey
     * @param array $itemValue
810
811
     * @return string
     */
812
    public function buildCheckboxMulti(array $formElement, $htmlFormElementId, $attributeBase, $value, array $itemKey, array $itemValue) {
813
814
815
        // Defines which of the checkboxes will be checked.
        $values = explode($value, ',');

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

818
        $html = $this->buildNativeHidden($htmlFormElementId, $value);
819
820
821
822
823
824
825
826
827
828
829

        $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
830
                    $attribute .= $this->getAttribute('autofocus', $formElement['autofocus']);
831
            }
Carsten  Rose's avatar
Carsten Rose committed
832
            $attribute .= $this->getAttribute('value', $item);
833
            if ($item === $values[$jj]) {
Carsten  Rose's avatar
Carsten Rose committed
834
                $attribute .= $this->getAttribute('checked', 'checked');
835
836
837
838
839
840
841
842
843
844
845
            }
            $html .= '<input ' . $attribute . '>';
            $html .= $itemValue[$ii];
            if ($ii === $formElement['maxLength']) {
                $ii = 0;
                $html .= '<br>';
            }
        }
        return $html;
    }

846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
    /**
     * Submit hidden values by SIP.
     *
     * Sometimes, it's usefull to precalculate values during formload and to submit them as hidden fields.
     * To avoid any manipulation on those fields, the values will be transferred by SIP.
     *
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return string
     */
    public function buildHidden(array $formElement, $htmlFormElementId, $value) {

        $this->store->setVar($htmlFormElementId, $value, STORE_SIP, false);
    }

862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
    /**
     * 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
     */
877
    public function buildRadio(array $formElement, $htmlFormElementId, $value) {
878
879
880
881
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
882
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
883

Carsten  Rose's avatar
Carsten Rose committed
884
885
886
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('name', $htmlFormElementId);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
887
888
889
890

        $jj = 0;
        $flagFirst = true;

891
        $html = $this->buildNativeHidden($htmlFormElementId, $value);
892
893
894
895
896
897
        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
898
                    $attribute .= $this->getAttribute('autofocus', $formElement['autofocus']);
899
900
            }

Carsten  Rose's avatar
Carsten Rose committed
901
            $attribute .= $this->getAttribute('value', $itemKey[$ii]);
902
            if ($itemKey[$ii] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
903
                $attribute .= $this->getAttribute('checked', 'checked');
904
            }
905
906
907
908
909
910
911
912
913
914
915

            $element = '<input ' . $attribute . '>' . $itemValue[$ii];

//            $element = Support::wrapTag('<label>',$element);

//            if(isset($this->feDivClass[$formElement['type']]) && $this->feDivClass[$formElement['type']] != '') {
//                $element = Support::wrapTag('<div class="' . $this->feDivClass[$formElement['type']] .'">',  $element);
//            }

            $html .= $element;

916
917
918
919
920
921
922
923
            if ($jj === $formElement['maxLength']) {
                $jj = 0;
                $html .= '<br>';
            }
        }
        return $html;
    }

Carsten  Rose's avatar
Carsten Rose committed
924
    /**
925
926
     * Builds a Selct (Dropdown) Box.
     *
Carsten  Rose's avatar
Carsten Rose committed
927
928
929
930
931
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
932
    public function buildSelect(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
933
934
935
936
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
937
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
Carsten  Rose's avatar
Carsten Rose committed
938
939
940

        $attribute = $this->getAttributeMode($formElement);
        $attribute .= $this->getAttribute('name', $htmlFormElementId);
941
        $attribute .= $this->getAttributeList($formElement, ['autofocus']);
Carsten  Rose's avatar
Carsten Rose committed
942
943
944
945
946
947
948

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

        $option = '';
949
        $selected = 'selected';
Carsten  Rose's avatar
Carsten Rose committed
950
951
952
953
954
        for ($ii = 0; $ii < count($itemValue); $ii++) {
            $option .= '<option ';

            $option .= $this->getAttribute('value', $itemKey[$ii]);
            if ($itemKey[$ii] === $value) {
955
956
                $option .= $selected;
                $selected = '';
Carsten  Rose's avatar
Carsten Rose committed
957
958
959
960
961
962
            }

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

        return '<select ' . $attribute . '>' . $option . '</select>';
963
964
    }

Carsten  Rose's avatar
Carsten Rose committed
965
966
967
968
969
970
971
972
973
974
    /**
     * 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
     */
975
    public function buildSubrecord(array $formElement, $htmlFormElementId, $value) {
976
977
        $html = '';

978
979
980
981
982
983
        $primaryRecord = $this->store->getStore(STORE_RECORD);

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

Carsten  Rose's avatar
Carsten Rose committed
984
985
986
987
        if (!is_array($formElement['sql1'])) {
            throw new UserException('Missing \'sql1\' Query', ERROR_MISSING_SQL1);
        }

988
989
990
991
992
993
        // No records?
        if (count($formElement['sql1']) == 0) {
            return '';
        }

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

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

1000
//        $html .= '<b>' . $formElement['label'] . '</b>';
1001
1002
//        $html .= '<table border="1">';
        $html .= '<table class="table">';
1003
        $html .= '<tr><th></th><th>' . implode('</th><th>', $control['title']) . '</th></tr>';
Carsten  Rose's avatar
Carsten Rose committed
1004
        foreach ($formElement['sql1'] as $row) {
1005

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

1009
            foreach ($row as $columnName => $value) {
1010
                $html .= '<td>' . $this->renderCell($control, $columnName, $value) . '</td>';
Carsten  Rose's avatar
Carsten Rose committed
1011
1012
1013
1014
1015
            }
            $html .= '</tr>';
        }
        $html .= '</table>';

1016
        return $html;
1017
1018
    }

Carsten  Rose's avatar
Carsten Rose committed
1019
    /**
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
     * Get various column format information based on the 'raw' column title. The attributes are separated by '|' and specified as 'key' or 'key=value'.
     *
     * - Return all parsed values as an assoc array.
     * - For regular columns: If there is no 'width' specified, take the default 'SUBRECORD_COLUMN_WIDTH'
     * - For 'icon /  url / mailto': no width limit.
     *
     * Returned assoc array:
     *  title      Only key. Element is non numeric, which is not a keyword 'width/nostrip/icon/url/mailto'
     *  width      Key/Value Pair. Not provided for 'icon/url/mailto'.
     *  nostrip    Only key. Do not strip HTML Tags from the content.
     *  icon       Only key. Value will rendered (later) as an image.
     *  url        Only key. Value will rendered (later) as a 'href'
     *  mailto     Only key. Value will rendered (later) as a 'href mailto'
     *
     *
Carsten  Rose's avatar
Carsten Rose committed
1035
1036
1037
1038
     * @param $titleRaw
     * @return array
     * @throws UserException
     */
1039
    private function getSubrecordColumnControl(array $titleRaw) {
Carsten  Rose's avatar
Carsten Rose committed
1040
1041
        $control = array();

1042
1043
1044
        foreach ($titleRaw AS $columnName) {
            $flagWidthLimit = true;
            $control['width'][$columnName] = SUBRECORD_COLUMN_WIDTH;
Carsten  Rose's avatar
Carsten Rose committed
1045
1046

            // a) 'City@width=40', b) 'Status@icon', c) 'Mailto@width=80@nostrip'
1047
            $arr = KeyValueStringParser::parse($columnName, '=', '|', KVP_IF_VALUE_EMPTY_COPY_KEY);
1048
1049
            foreach ($arr as $attribute => $value) {
                switch ($attribute) {
Carsten  Rose's avatar
Carsten Rose committed
1050
1051
                    case 'width':
                    case 'nostrip':
1052
                    case 'title':
1053
                        break;
Carsten  Rose's avatar
Carsten Rose committed
1054
                    case 'icon':
1055
1056
1057
                    case 'url':
                    case 'mailto':
                        $flagWidthLimit = false;
Carsten  Rose's avatar
Carsten Rose committed
1058
1059
                        break;
                    default:
1060
                        $attribute = is_numeric($value) ? 'width' : 'title';
Carsten  Rose's avatar
Carsten Rose committed
1061
1062
                        break;
                }
1063
                $control[$attribute][$columnName] = $value;
Carsten  Rose's avatar
Carsten Rose committed
1064
            }
1065

1066
1067
1068
            if (!isset($control['title'][$columnName]))
                $control['title'][$columnName] = ''; // Fallback:  Might be wrong, but better than nothing.

1069
            // Limit title length
1070
1071
1072
1073
1074
1075
            $control['title'][$columnName] = substr($control['title'][$columnName], 0, $control['width'][$columnName]);

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

Carsten  Rose's avatar
Carsten Rose committed
1076
1077
        }
        return $control;
1078
1079
    }

1080
    /**
1081
1082
     * Renders an Link with a symbol (edit) and register a new SIP to grant permission to the link..
     *
1083
     * Returns <a href="<Link>">[icon]</a>
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
     *
     * Link: <page>?s=<SIP>&<standard typo3 params>
     * SIP: form = $formElement['form'] (provided via formElement['parameter'])
     *      r = $targetRecordId
     *      Parse  $formElement['detail'] with possible key/value pairs. E.g.: detail=id:gr_id,#{{a}}:p_id,#12:x_id
     *        gr_id = <<primarytable.id>>
     *        p_id = <<variable defined in SIP or Client>>
     *        x_id = 12 (constant)
     *
     *
1094
1095
1096
1097
1098
1099
     * @param $formElement
     * @param $targetRecordId
     * @param $record
     * @return string
     * @throws UserException
     */
Carsten  Rose's avatar