AbstractBuildForm.php 42 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
99
     * Builds complete form. Depending of Formspecification, the layout will plain / table / bootstrap.
     *
100
     * @return string The whole form as HTML
101
102
     * @throws CodeException
     * @throws DbException
103
104
105
106
107
     */
    public function process() {

        $html = $this->head();

108
        $filter = $this->getProcessFilter();
109

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

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

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

124

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

127
128
129
        return $html;
    }

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

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

        return $html;
    }

    /**
145
146
     * Wrap's $this->wrap[$item][WRAP_SETUP_START] around $value. If $flagOmitEmpty==true && $value=='': return ''.
     *
147
148
149
150
151
152
153
154
155
156
157
158
     * @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];
    }

    /**
159
     * Rreturns complete '<form ...>'-tag
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
     *
     * @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.
     *
190
191
     * Notice: the SIP will be transferred as POST Parameter.
     *
192
193
194
195
     * @return string
     * @throws DbException
     */
    public function getActionUrl() {
196
        $queryStringArray = array();
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212

        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() {

213
        $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"');
214
215
216
        return (count($result) === 1) ? 'multipart/form-data' : 'application/x-www-form-urlencoded';

    }
217

218
    abstract public function getProcessFilter();
219
220
221

    /**
     * @param $recordId
222
     * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD
223
     * @param int $feIdContainer
224
     * @return string
225
226
     * @throws CodeException
     * @throws DbException
227
     * @throws \qfq\UserException
228
     */
229
    public function elements($recordId, $filter = FORM_ELEMENTS_NATIVE, $feIdContainer = 0) {
230
231
232
        $html = '';

        // get current data record
233
        if ($recordId > 0 && $this->store->getVar('id', STORE_RECORD) === false) {
234
            $row = $this->db->sql("SELECT * FROM " . $this->formSpec['tableName'] . " WHERE id = ?", ROW_REGULAR, array($recordId));
235
236
            $this->store->setVarArray($row[0], STORE_RECORD);
        }
237
238
239

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

241
242
            if (($filter === FORM_ELEMENTS_NATIVE && $fe['type'] === 'subrecord') ||
                ($filter === FORM_ELEMENTS_SUBRECORD && $fe['type'] !== 'subrecord')
243
244
245
246
            ) {
                continue; // skip this FE
            }

247
248
249
250
            // Log / Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, $fe['name'] . ' / ' . $fe['id'], STORE_SYSTEM);

            // evaluate current FormElement
251
252
253
254
255
            $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);
            }
256

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

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

262
263
264
265
266
267
268
269
270
271
            // 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);
272
        }
273

274
275
276
        // Log / Debug: Last FormElement has been processed.
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

277
278
279
        return $html;
    }

280
281
282
    abstract public function tail();

    abstract public function doSubrecords();
283

284
285
286
287
288
289
290
291
    abstract public function buildRowNative($formElement, $elementHtml);

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

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

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

292
    /**
293
294
     * Extract Tag from $tag (might contain further attributes) and wrap it around $value. If $flagOmitEmpty==true && $value=='': return ''.
     *
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
     * @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;
    }

311
    /**
312
313
     * Builds a label, typically for an html-'<input>'-element.
     *
314
315
     * @param array $htmlFormElementId
     * @param $label
316
317
     * @return string
     */
318
319
320
321
    public function buildLabel($htmlFormElementId, $label) {
        $html = '<label for="' . $htmlFormElementId . '">' . $label . '</label>';

        return $html;
322
323
    }

324
325
326
327
328
329
330
331
332
333
334
335
336
    /**
     * 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
     */
337
    public function buildInput(array $formElement, $htmlFormElementId, $value) {
338
        $textarea = '';
339

Carsten  Rose's avatar
Carsten Rose committed
340
        $attribute = $this->getAttribute('name', $htmlFormElementId);
341
342
        $htmlTag = '<input';

343
344
345
346
347
348
349
350
351
352
353
354
        // 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;
            }
        }

355
        // Check for input type 'textarea'
356
        $colsRows = explode(',', $formElement['size'], 2);
357
        if (count($colsRows) === 2) {
358
            // <textarea>
359
360
            $htmlTag = '<textarea';

Carsten  Rose's avatar
Carsten Rose committed
361
362
            $attribute .= $this->getAttribute('cols', $colsRows[0]);
            $attribute .= $this->getAttribute('rows', $colsRows[1]);
363
            $textarea = htmlentities($value) . '</textarea>';
364
365

        } else {
366
367
368
            // <input>
            if ($formElement['maxLength'] > 0) {
                $value = substr($value, 0, $formElement['maxLength']);
369
370
371

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

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

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

382
        return "$htmlTag $attribute>$textarea";
383

384
385
386
    }

    /**
387
388
     * Format's an attribute: $type=$value. If $flagOmitEmpty==true && $value=='': return ''.
     *
389
390
391
392
393
     * @param $type
     * @param $value
     * @param bool|false $flagOmitEmpty
     * @return string
     */
Carsten  Rose's avatar
Carsten Rose committed
394
    private function getAttribute($type, $value, $flagOmitEmpty = true) {
395
396
        if ($flagOmitEmpty && $value === "")
            return '';
Carsten  Rose's avatar
Carsten Rose committed
397

398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
        return $type . '="' . trim($value) . '" ';
    }

    /**
     * @param $column
     * @return bool|int|string
     */
    private function getColumnSize($column) {
        $matches = array();

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

        if (1 === preg_match('/\((.+)\)/', $typeSpec, $matches)) {
            if (is_numeric($matches[1]))
                return $matches[1];
        }

        return false;
416
417
418
419
    }

    /**
     * Builds a HTML attribute list, based on  $attributeList.
420
     *
421
422
423
424
425
426
427
     * 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
428
    private function getAttributeList(array $formElement, array $attributeList) {
429
430
431
        $attribute = '';
        foreach ($attributeList as $item) {
            if (isset($formElement[$item]))
Carsten  Rose's avatar
Carsten Rose committed
432
                $attribute .= $this->getAttribute(strtolower($item), $formElement[$item]);
433
434
435
436
437
438
        }
        return $attribute;
    }

    /**
     * Construct HTML Input attribute for Client Validation:
439
     *
440
441
442
443
444
445
446
447
448
449
450
451
     *   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
452
     * @throws \qfq\UserException
453
     */
Carsten  Rose's avatar
Carsten Rose committed
454
    private function getInputCheckPattern($type, $data) {
455
456
        if ($type === '') {
            return '';
457
        }
458
459
460

        $attribute = '';

461
        $arrAttr = explode("|", $this->inputCheckPattern[$type]);
462
463
464
        $arrData = explode("|", $data);

        for ($ii = 0; $ii < count($arrAttr); $ii++) {
465
466
467
468
469
            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]) . ' ';
            }
470
471
472
473
        }
        return $attribute;
    }

474

475
    /**
476
477
     * Set corresponding html attributes readonly/required/disabled, based on $formElement['mode'].
     *
478
479
480
481
     * @param array $formElement
     * @return string
     * @throws UserException
     */
Carsten  Rose's avatar
Carsten Rose committed
482
    private function getAttributeMode(array $formElement) {
483
484
485
486
487
488
        $attribute = '';

        switch ($formElement['mode']) {
            case 'show':
                break;
            case 'readonly':
Carsten  Rose's avatar
Carsten Rose committed
489
                $attribute .= $this->getAttribute('readonly', 'readonly');
490
491
                break;
            case 'required':
Carsten  Rose's avatar
Carsten Rose committed
492
                $attribute .= $this->getAttribute('required', 'required');
493
494
495
496
                break;
            case 'lock':
                break;
            case 'disabled':
Carsten  Rose's avatar
Carsten Rose committed
497
                $attribute .= $this->getAttribute('disabled', 'disabled');
498
499
500
501
                break;
            default:
                $this->store->setVar(SYSTEM_FORM_ELEMENT, $formElement['name'] . ' / ' . $formElement['id'], STORE_SYSTEM);
                $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, 'mode', STORE_SYSTEM);
502
                throw new UserException("Unknown mode '" . $formElement['mode'] . "'", ERROR_UNKNOWN_MODE);
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
                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
     */
523
    public function buildCheckbox(array $formElement, $htmlFormElementId, $value) {
524
525
526
527
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
528
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
529
530
531

        // Get fallback, if 'checkBoxMode' is not defined:
        if (!isset($formElement['checkBoxMode'])) {
532
            // This fallback is problematic if 'set' or 'enum' has 2 : defaults to single but maybe multi is meant.
533
534
535
536
537
538
539
540
541
542
            $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
543
544
545
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('name', $htmlFormElementId);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
546
547
548
549
550
551
552
553
554
555
556
557

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

558
559
560
        return $html;
    }

561
    /**
562
563
564
565
566
     * Look for key/value list (in this order, first match counts) in
     *  a) `sql1`
     *  b) `parameter:itemList`
     *  c) table.column definition
     *
567
     * Copies the found keys to &$itemKey and the values to &$itemValue
568
     * If there are no &$itemKey, copy &$itemValue to &$itemKey.
569
570
571
572
     *
     * @param array $formElement
     * @param $itemKey
     * @param $itemValue
573
574
     * @throws CodeException
     * @throws \qfq\UserException
575
     */
576
    public function getKeyValueListFromSqlEnumSpec(array $formElement, &$itemKey, &$itemValue) {
577
578
579
580
        $fieldType = '';
        $itemKey = array();
        $itemValue = array();

581
582
583
        if (count($formElement) < 20)
            throw new CodeException("Invalid (none or to small) Formelement", ERROR_MISSING_FORMELEMENT);

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

        if (is_array($formElement['sql1'])) {
587
588
589
            if (count($formElement['sql1']) > 0) {
                $keys = array_keys($formElement['sql1'][0]);
                $itemKey = array_column($formElement['sql1'], 'id');
590

591
592
593
594
                // 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]);
                }
595

596
597
598
599
600
601
                $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]);
                }
602
            }
603
604
605
606
        } elseif (isset($formElement['itemList']) && strlen($formElement['itemList']) > 0) {
            $arr = KeyValueStringParser::parse($formElement['itemList'], ':', ',', IF_VALUE_EMPTY_COPY_KEY);
            $itemValue = array_values($arr);
            $itemKey = array_keys($arr);
607
        } elseif ($fieldType === 'enum' || $fieldType === 'set') {
Carsten  Rose's avatar
Carsten Rose committed
608
            // already done at the beginning with '$this->getItemsForEnumOrSet($formElement['name'], $fieldType);'
609
        } else {
610
            throw new UserException("Missing definition (- nothing found in 'sql1', 'parameter:itemValues', 'enum-' or 'set-definition'", ERROR_MISSING_ITEM_VALUES);
611
612
613
614
615
        }

        if (count($itemKey) === 0) {
            $itemKey = $itemValue;
        }
616
617
618
619
620
621
622
623
624
625

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

        if (isset($formElement['emptyItemAtEnd'])) {
            $itemValue[] = '';
            $itemKey[] = '';
        }
626
627
628
    }

    /**
629
630
     * Get the attribute definition list of an enum or set column. For strings, get the default value. Return elements as an array.
     *
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
     * @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:
670
     *
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
     *    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);
        }

    }

    /**
706
707
     * Build a Checkbox based on two values.
     *
708
709
710
711
712
713
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attribute
     * @param $value
     * @return string
     */
714
    public function buildCheckboxSingle(array $formElement, $htmlFormElementId, $attribute, $value) {
715
        $html = '';
716

Carsten  Rose's avatar
Carsten Rose committed
717
718
        $attribute .= $this->getAttribute('name', $htmlFormElementId);
        $attribute .= $this->getAttribute('value', $formElement['checked'], false);
719
        if ($formElement['checked'] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
720
            $attribute .= $this->getAttribute('checked', 'checked');
721
722
        }

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

725
        $html = $this->buildNativeHidden($htmlFormElementId, $formElement['unchecked']);
726
727
728
729
730
731
732
733
734
735

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

        return $html;
    }

    /**
736
737
738
739
740
741
742
743
744
745
746
747
     * Builds a real HTML hidden form element. Usefull for Checkboxes, Multiple-Select and Radios.
     *
     * @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
748
749
750
751
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attributeBase
     * @param $value
752
753
     * @param array $itemKey
     * @param array $itemValue
754
755
     * @return string
     */
756
    public function buildCheckboxMulti(array $formElement, $htmlFormElementId, $attributeBase, $value, array $itemKey, array $itemValue) {
757
758
759
        // Defines which of the checkboxes will be checked.
        $values = explode($value, ',');

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

762
        $html = $this->buildNativeHidden($htmlFormElementId, $value);
763
764
765
766
767
768
769
770
771
772
773

        $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
774
                    $attribute .= $this->getAttribute('autofocus', $formElement['autofocus']);
775
            }
Carsten  Rose's avatar
Carsten Rose committed
776
            $attribute .= $this->getAttribute('value', $item);
777
            if ($item === $values[$jj]) {
Carsten  Rose's avatar
Carsten Rose committed
778
                $attribute .= $this->getAttribute('checked', 'checked');
779
780
781
782
783
784
785
786
787
788
789
            }
            $html .= '<input ' . $attribute . '>';
            $html .= $itemValue[$ii];
            if ($ii === $formElement['maxLength']) {
                $ii = 0;
                $html .= '<br>';
            }
        }
        return $html;
    }

790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
    /**
     * 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);
    }

806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
    /**
     * 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
     */
821
    public function buildRadio(array $formElement, $htmlFormElementId, $value) {
822
823
824
825
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
826
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
827

Carsten  Rose's avatar
Carsten Rose committed
828
829
830
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('name', $htmlFormElementId);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
831
832
833
834

        $jj = 0;
        $flagFirst = true;

835
        $html = $this->buildNativeHidden($htmlFormElementId, $value);
836
837
838
839
840
841
        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
842
                    $attribute .= $this->getAttribute('autofocus', $formElement['autofocus']);
843
844
            }

Carsten  Rose's avatar
Carsten Rose committed
845
            $attribute .= $this->getAttribute('value', $itemKey[$ii]);
846
            if ($itemKey[$ii] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
847
                $attribute .= $this->getAttribute('checked', 'checked');
848
849
850
851
852
853
854
855
856
857
858
            }
            $html .= '<input ' . $attribute . '>';
            $html .= $itemValue[$ii];
            if ($jj === $formElement['maxLength']) {
                $jj = 0;
                $html .= '<br>';
            }
        }
        return $html;
    }

Carsten  Rose's avatar
Carsten Rose committed
859
    /**
860
861
     * Builds a Selct (Dropdown) Box.
     *
Carsten  Rose's avatar
Carsten Rose committed
862
863
864
865
866
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
867
    public function buildSelect(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
868
869
870
871
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
872
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
Carsten  Rose's avatar
Carsten Rose committed
873
874
875
876
877
878
879
880
881
882
883

        $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 = '';
884
        $selected = 'selected';
Carsten  Rose's avatar
Carsten Rose committed
885
886
887
888
889
        for ($ii = 0; $ii < count($itemValue); $ii++) {
            $option .= '<option ';

            $option .= $this->getAttribute('value', $itemKey[$ii]);
            if ($itemKey[$ii] === $value) {
890
891
                $option .= $selected;
                $selected = '';
Carsten  Rose's avatar
Carsten Rose committed
892
893
894
895
896
897
            }

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

        return '<select ' . $attribute . '>' . $option . '</select>';
898
899
    }

Carsten  Rose's avatar
Carsten Rose committed
900
901
902
903
904
905
906
907
908
909
    /**
     * 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
     */
910
    public function buildSubrecord(array $formElement, $htmlFormElementId, $value) {
911
912
        $html = '';

913
914
915
916
917
918
        $primaryRecord = $this->store->getStore(STORE_RECORD);

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

Carsten  Rose's avatar
Carsten Rose committed
919
920
921
922
        if (!is_array($formElement['sql1'])) {
            throw new UserException('Missing \'sql1\' Query', ERROR_MISSING_SQL1);
        }

923
924
925
926
927
928
929
930
931
        // 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
932
933
        // construct column attributes
        $control = $this->getSubrecordColumnControl(array_keys($formElement['sql1'][0]));
934

935
936
//        $html .= '<b>' . $formElement['label'] . '</b>';
        $html .= '<table border="1">';
937
        $html .= '<tr><th></th><th>' . implode('</th><th>', $control['title']) . '</th></tr>';
Carsten  Rose's avatar
Carsten Rose committed
938
        foreach ($formElement['sql1'] as $row) {
939

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

943
            foreach ($row as $columnName => $value) {
944
                $html .= '<td>' . $this->renderCell($control, $columnName, $value) . '</td>';
Carsten  Rose's avatar
Carsten Rose committed
945
946
947
948
949
            }
            $html .= '</tr>';
        }
        $html .= '</table>';

950
        return $html;
951
952
    }

Carsten  Rose's avatar
Carsten Rose committed
953
    /**
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
     * 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
969
970
971
972
     * @param $titleRaw
     * @return array
     * @throws UserException
     */
973
    private function getSubrecordColumnControl(array $titleRaw) {
Carsten  Rose's avatar
Carsten Rose committed
974
975
        $control = array();

976
977
978
        foreach ($titleRaw AS $columnName) {
            $flagWidthLimit = true;
            $control['width'][$columnName] = SUBRECORD_COLUMN_WIDTH;
Carsten  Rose's avatar
Carsten Rose committed
979
980

            // a) 'City@width=40', b) 'Status@icon', c) 'Mailto@width=80@nostrip'
981
            $arr = KeyValueStringParser::parse($columnName, '=', '|', IF_VALUE_EMPTY_COPY_KEY);
982
983
            foreach ($arr as $attribute => $value) {
                switch ($attribute) {
Carsten  Rose's avatar
Carsten Rose committed
984
985
                    case 'width':
                    case 'nostrip':
986
                    case 'title':
987
                        break;
Carsten  Rose's avatar
Carsten Rose committed
988
                    case 'icon':
989
990
991
                    case 'url':
                    case 'mailto':
                        $flagWidthLimit = false;
Carsten  Rose's avatar
Carsten Rose committed
992
993
                        break;
                    default:
994
                        $attribute = is_numeric($value) ? 'width' : 'title';
Carsten  Rose's avatar
Carsten Rose committed
995
996
                        break;
                }
997
                $control[$attribute][$columnName] = $value;
Carsten  Rose's avatar
Carsten Rose committed
998
            }
999

1000
            if (!isset($control['title'][$columnName]))