AbstractBuildForm.php 42.3 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
    private $formId = null;

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

48
49
//        $sip = $this->store->getVar(CLIENT_SIP, STORE_CLIENT);

50
        // render mode specific
51
        $this->fillWrap();
52
53
54

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

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

89
90
91
92
93
94
        $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
95

96
97
    }

98
99
    abstract public function fillWrap();

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

        $html = $this->head();

111
        $filter = $this->getProcessFilter();
112

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

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

124
        // close the form
125
126
        $html .= $this->tail();

127

128
        $html .= $this->doSubrecords();
129

130
131
132
        return $html;
    }

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

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

        return $html;
    }

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

    /**
162
     * Rreturns complete '<form ...>'-tag
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
     *
     * @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() {

Carsten  Rose's avatar
Carsten Rose committed
180
181
        //TODO: ttconetn id eintragen
//        $attribute['id'] = $this->store->getVar(STORE_TYPO3,'1234');
182
        $attribute['id'] = $this->getFormId();
183
184
185
186
187
188
189
190
191
192
        $attribute['method'] = 'post';
        $attribute['action'] = $this->getActionUrl();
        $attribute['target'] = '_top';
        $attribute['accept-charset'] = 'UTF-8';
        $attribute['autocomplete'] = 'on';
        $attribute['enctype'] = $this->getEncType();

        return $attribute;
    }

193
194
195
196
197
198
199
200
201
202
    /**
     * @return string
     */
    public function getFormId() {
        if ($this->formId === null) {
            $this->formId = uniqid('qfq-form-');
        }
        return $this->formId;
    }

203
204
205
    /**
     * Builds the HTML 'form'-tag inlcuding all attributes and target.
     *
206
207
     * Notice: the SIP will be transferred as POST Parameter.
     *
208
209
210
211
     * @return string
     * @throws DbException
     */
    public function getActionUrl() {
212
        $queryStringArray = array();
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228

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

229
        $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"');
230
231
232
        return (count($result) === 1) ? 'multipart/form-data' : 'application/x-www-form-urlencoded';

    }
233

234
    abstract public function getProcessFilter();
235
236
237

    /**
     * @param $recordId
238
     * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD
239
     * @param int $feIdContainer
240
     * @return string
241
242
     * @throws CodeException
     * @throws DbException
243
     * @throws \qfq\UserException
244
     */
245
    public function elements($recordId, $filter = FORM_ELEMENTS_NATIVE, $feIdContainer = 0) {
246
247
248
        $html = '';

        // get current data record
249
        if ($recordId > 0 && $this->store->getVar('id', STORE_RECORD) === false) {
250
            $row = $this->db->sql("SELECT * FROM " . $this->formSpec['tableName'] . " WHERE id = ?", ROW_REGULAR, array($recordId));
251
252
            $this->store->setVarArray($row[0], STORE_RECORD);
        }
253
254
255

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

257
258
            if (($filter === FORM_ELEMENTS_NATIVE && $fe['type'] === 'subrecord') ||
                ($filter === FORM_ELEMENTS_SUBRECORD && $fe['type'] !== 'subrecord')
259
260
261
262
            ) {
                continue; // skip this FE
            }

263
264
265
266
            // Log / Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, $fe['name'] . ' / ' . $fe['id'], STORE_SYSTEM);

            // evaluate current FormElement
267
268
269
270
271
            $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);
            }
272

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

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

278
279
280
281
282
283
284
285
286
287
            // 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);
288
        }
289

290
291
292
        // Log / Debug: Last FormElement has been processed.
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

293
294
295
        return $html;
    }

296
297
298
    abstract public function tail();

    abstract public function doSubrecords();
299

300
301
302
303
304
305
306
307
    abstract public function buildRowNative($formElement, $elementHtml);

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

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

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

308
    /**
309
310
     * Extract Tag from $tag (might contain further attributes) and wrap it around $value. If $flagOmitEmpty==true && $value=='': return ''.
     *
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
     * @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;
    }

327
    /**
328
329
     * Builds a label, typically for an html-'<input>'-element.
     *
330
331
     * @param array $htmlFormElementId
     * @param $label
332
333
     * @return string
     */
334
335
336
337
    public function buildLabel($htmlFormElementId, $label) {
        $html = '<label for="' . $htmlFormElementId . '">' . $label . '</label>';

        return $html;
338
339
    }

340
341
342
343
344
345
346
347
348
349
350
351
352
    /**
     * 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
     */
353
    public function buildInput(array $formElement, $htmlFormElementId, $value) {
354
        $textarea = '';
355

Carsten  Rose's avatar
Carsten Rose committed
356
        $attribute = $this->getAttribute('name', $htmlFormElementId);
357
358
        $htmlTag = '<input';

359
360
361
362
363
364
365
366
367
368
369
370
        // 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;
            }
        }

371
        // Check for input type 'textarea'
372
        $colsRows = explode(',', $formElement['size'], 2);
373
        if (count($colsRows) === 2) {
374
            // <textarea>
375
376
            $htmlTag = '<textarea';

Carsten  Rose's avatar
Carsten Rose committed
377
378
            $attribute .= $this->getAttribute('cols', $colsRows[0]);
            $attribute .= $this->getAttribute('rows', $colsRows[1]);
379
            $textarea = htmlentities($value) . '</textarea>';
380
381

        } else {
382
383
384
            // <input>
            if ($formElement['maxLength'] > 0) {
                $value = substr($value, 0, $formElement['maxLength']);
385
386
387

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

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

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

398
        return "$htmlTag $attribute>$textarea";
399

400
401
402
    }

    /**
403
404
     * Format's an attribute: $type=$value. If $flagOmitEmpty==true && $value=='': return ''.
     *
405
406
407
408
409
     * @param $type
     * @param $value
     * @param bool|false $flagOmitEmpty
     * @return string
     */
Carsten  Rose's avatar
Carsten Rose committed
410
    private function getAttribute($type, $value, $flagOmitEmpty = true) {
411
412
        if ($flagOmitEmpty && $value === "")
            return '';
Carsten  Rose's avatar
Carsten Rose committed
413

414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
        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;
432
433
434
435
    }

    /**
     * Builds a HTML attribute list, based on  $attributeList.
436
     *
437
438
439
440
441
442
443
     * 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
444
    private function getAttributeList(array $formElement, array $attributeList) {
445
446
447
        $attribute = '';
        foreach ($attributeList as $item) {
            if (isset($formElement[$item]))
Carsten  Rose's avatar
Carsten Rose committed
448
                $attribute .= $this->getAttribute(strtolower($item), $formElement[$item]);
449
450
451
452
453
454
        }
        return $attribute;
    }

    /**
     * Construct HTML Input attribute for Client Validation:
455
     *
456
457
458
459
460
461
462
463
464
465
466
467
     *   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
468
     * @throws \qfq\UserException
469
     */
Carsten  Rose's avatar
Carsten Rose committed
470
    private function getInputCheckPattern($type, $data) {
471
472
        if ($type === '') {
            return '';
473
        }
474
475
476

        $attribute = '';

477
        $arrAttr = explode("|", $this->inputCheckPattern[$type]);
478
479
480
        $arrData = explode("|", $data);

        for ($ii = 0; $ii < count($arrAttr); $ii++) {
481
482
483
484
485
            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]) . ' ';
            }
486
487
488
489
        }
        return $attribute;
    }

490

491
    /**
492
493
     * Set corresponding html attributes readonly/required/disabled, based on $formElement['mode'].
     *
494
495
496
497
     * @param array $formElement
     * @return string
     * @throws UserException
     */
Carsten  Rose's avatar
Carsten Rose committed
498
    private function getAttributeMode(array $formElement) {
499
500
501
502
503
504
        $attribute = '';

        switch ($formElement['mode']) {
            case 'show':
                break;
            case 'readonly':
Carsten  Rose's avatar
Carsten Rose committed
505
                $attribute .= $this->getAttribute('readonly', 'readonly');
506
507
                break;
            case 'required':
Carsten  Rose's avatar
Carsten Rose committed
508
                $attribute .= $this->getAttribute('required', 'required');
509
510
511
512
                break;
            case 'lock':
                break;
            case 'disabled':
Carsten  Rose's avatar
Carsten Rose committed
513
                $attribute .= $this->getAttribute('disabled', 'disabled');
514
515
516
517
                break;
            default:
                $this->store->setVar(SYSTEM_FORM_ELEMENT, $formElement['name'] . ' / ' . $formElement['id'], STORE_SYSTEM);
                $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, 'mode', STORE_SYSTEM);
518
                throw new UserException("Unknown mode '" . $formElement['mode'] . "'", ERROR_UNKNOWN_MODE);
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
                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
     */
539
    public function buildCheckbox(array $formElement, $htmlFormElementId, $value) {
540
541
542
543
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
544
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
545
546
547

        // Get fallback, if 'checkBoxMode' is not defined:
        if (!isset($formElement['checkBoxMode'])) {
548
            // This fallback is problematic if 'set' or 'enum' has 2 : defaults to single but maybe multi is meant.
549
550
551
552
553
554
555
556
557
558
            $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
559
560
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
561
562
563
564
565
566
567
568
569
570
571
572

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

573
574
575
        return $html;
    }

576
    /**
577
578
579
580
581
     * Look for key/value list (in this order, first match counts) in
     *  a) `sql1`
     *  b) `parameter:itemList`
     *  c) table.column definition
     *
582
     * Copies the found keys to &$itemKey and the values to &$itemValue
583
     * If there are no &$itemKey, copy &$itemValue to &$itemKey.
584
585
586
587
     *
     * @param array $formElement
     * @param $itemKey
     * @param $itemValue
588
589
     * @throws CodeException
     * @throws \qfq\UserException
590
     */
591
    public function getKeyValueListFromSqlEnumSpec(array $formElement, &$itemKey, &$itemValue) {
592
593
594
595
        $fieldType = '';
        $itemKey = array();
        $itemValue = array();

596
597
598
        if (count($formElement) < 20)
            throw new CodeException("Invalid (none or to small) Formelement", ERROR_MISSING_FORMELEMENT);

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

        if (is_array($formElement['sql1'])) {
602
603
604
            if (count($formElement['sql1']) > 0) {
                $keys = array_keys($formElement['sql1'][0]);
                $itemKey = array_column($formElement['sql1'], 'id');
605

606
607
608
609
                // 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]);
                }
610

611
612
613
614
615
616
                $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]);
                }
617
            }
618
619
620
621
        } 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);
622
        } elseif ($fieldType === 'enum' || $fieldType === 'set') {
Carsten  Rose's avatar
Carsten Rose committed
623
            // already done at the beginning with '$this->getItemsForEnumOrSet($formElement['name'], $fieldType);'
624
        } else {
625
            throw new UserException("Missing definition (- nothing found in 'sql1', 'parameter:itemValues', 'enum-' or 'set-definition'", ERROR_MISSING_ITEM_VALUES);
626
627
628
629
630
        }

        if (count($itemKey) === 0) {
            $itemKey = $itemValue;
        }
631
632
633
634
635
636
637
638
639
640

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

        if (isset($formElement['emptyItemAtEnd'])) {
            $itemValue[] = '';
            $itemKey[] = '';
        }
641
642
643
    }

    /**
644
645
     * Get the attribute definition list of an enum or set column. For strings, get the default value. Return elements as an array.
     *
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
     * @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:
685
     *
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
     *    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);
        }

    }

    /**
721
722
     * Build a Checkbox based on two values.
     *
723
724
725
726
727
728
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attribute
     * @param $value
     * @return string
     */
729
    public function buildCheckboxSingle(array $formElement, $htmlFormElementId, $attribute, $value) {
730
        $html = '';
731

Carsten  Rose's avatar
Carsten Rose committed
732
733
        $attribute .= $this->getAttribute('name', $htmlFormElementId);
        $attribute .= $this->getAttribute('value', $formElement['checked'], false);
734
        if ($formElement['checked'] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
735
            $attribute .= $this->getAttribute('checked', 'checked');
736
737
        }

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

740
        $html = $this->buildNativeHidden($htmlFormElementId, $formElement['unchecked']);
741
742
743
744
745
746
747
748
749
750

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

        return $html;
    }

    /**
751
752
753
754
755
756
757
758
759
760
761
762
     * 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
763
764
765
766
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attributeBase
     * @param $value
767
768
     * @param array $itemKey
     * @param array $itemValue
769
770
     * @return string
     */
771
    public function buildCheckboxMulti(array $formElement, $htmlFormElementId, $attributeBase, $value, array $itemKey, array $itemValue) {
772
773
774
        // Defines which of the checkboxes will be checked.
        $values = explode($value, ',');

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

777
        $html = $this->buildNativeHidden($htmlFormElementId, $value);
778
779
780
781
782
783
784
785
786
787
788

        $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
789
                    $attribute .= $this->getAttribute('autofocus', $formElement['autofocus']);
790
            }
Carsten  Rose's avatar
Carsten Rose committed
791
            $attribute .= $this->getAttribute('value', $item);
792
            if ($item === $values[$jj]) {
Carsten  Rose's avatar
Carsten Rose committed
793
                $attribute .= $this->getAttribute('checked', 'checked');
794
795
796
797
798
799
800
801
802
803
804
            }
            $html .= '<input ' . $attribute . '>';
            $html .= $itemValue[$ii];
            if ($ii === $formElement['maxLength']) {
                $ii = 0;
                $html .= '<br>';
            }
        }
        return $html;
    }

805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
    /**
     * 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);
    }

821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
    /**
     * 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
     */
836
    public function buildRadio(array $formElement, $htmlFormElementId, $value) {
837
838
839
840
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
841
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
842

Carsten  Rose's avatar
Carsten Rose committed
843
844
845
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('name', $htmlFormElementId);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
846
847
848
849

        $jj = 0;
        $flagFirst = true;

850
        $html = $this->buildNativeHidden($htmlFormElementId, $value);
851
852
853
854
855
856
        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
857
                    $attribute .= $this->getAttribute('autofocus', $formElement['autofocus']);
858
859
            }

Carsten  Rose's avatar
Carsten Rose committed
860
            $attribute .= $this->getAttribute('value', $itemKey[$ii]);
861
            if ($itemKey[$ii] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
862
                $attribute .= $this->getAttribute('checked', 'checked');
863
864
865
866
867
868
869
870
871
872
873
            }
            $html .= '<input ' . $attribute . '>';
            $html .= $itemValue[$ii];
            if ($jj === $formElement['maxLength']) {
                $jj = 0;
                $html .= '<br>';
            }
        }
        return $html;
    }

Carsten  Rose's avatar
Carsten Rose committed
874
    /**
875
876
     * Builds a Selct (Dropdown) Box.
     *
Carsten  Rose's avatar
Carsten Rose committed
877
878
879
880
881
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
882
    public function buildSelect(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
883
884
885
886
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
887
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
Carsten  Rose's avatar
Carsten Rose committed
888
889
890

        $attribute = $this->getAttributeMode($formElement);
        $attribute .= $this->getAttribute('name', $htmlFormElementId);
891
        $attribute .= $this->getAttributeList($formElement, ['autofocus']);
Carsten  Rose's avatar
Carsten Rose committed
892
893
894
895
896
897
898

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

        $option = '';
899
        $selected = 'selected';
Carsten  Rose's avatar
Carsten Rose committed
900
901
902
903
904
        for ($ii = 0; $ii < count($itemValue); $ii++) {
            $option .= '<option ';

            $option .= $this->getAttribute('value', $itemKey[$ii]);
            if ($itemKey[$ii] === $value) {
905
906
                $option .= $selected;
                $selected = '';
Carsten  Rose's avatar
Carsten Rose committed
907
908
909
910
911
912
            }

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

        return '<select ' . $attribute . '>' . $option . '</select>';
913
914
    }

Carsten  Rose's avatar
Carsten Rose committed
915
916
917
918
919
920
921
922
923
924
    /**
     * 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
     */
925
    public function buildSubrecord(array $formElement, $htmlFormElementId, $value) {
926
927
        $html = '';

928
929
930
931
932
933
        $primaryRecord = $this->store->getStore(STORE_RECORD);

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

Carsten  Rose's avatar
Carsten Rose committed
934
935
936
937
        if (!is_array($formElement['sql1'])) {
            throw new UserException('Missing \'sql1\' Query', ERROR_MISSING_SQL1);
        }

938
939
940
941
942
943
944
945
946
        // 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
947
948
        // construct column attributes
        $control = $this->getSubrecordColumnControl(array_keys($formElement['sql1'][0]));
949

950
//        $html .= '<b>' . $formElement['label'] . '</b>';
951
952
//        $html .= '<table border="1">';
        $html .= '<table class="table">';
953
        $html .= '<tr><th></th><th>' . implode('</th><th>', $control['title']) . '</th></tr>';
Carsten  Rose's avatar
Carsten Rose committed
954
        foreach ($formElement['sql1'] as $row) {
955

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

959
            foreach ($row as $columnName => $value) {
960
                $html .= '<td>' . $this->renderCell($control, $columnName, $value) . '</td>';
Carsten  Rose's avatar
Carsten Rose committed
961
962
963
964
965
            }
            $html .= '</tr>';
        }
        $html .= '</table>';

966
        return $html;
967
968
    }

Carsten  Rose's avatar
Carsten Rose committed
969
    /**
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
     * 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
985
986
987
988
     * @param $titleRaw
     * @return array
     * @throws UserException
     */
989
    private function getSubrecordColumnControl(array $titleRaw) {
Carsten  Rose's avatar
Carsten Rose committed
990
991
        $control = array();

992
993
994
        foreach ($titleRaw AS $columnName) {
            $flagWidthLimit = true;
            $control['width'][$columnName] = SUBRECORD_COLUMN_WIDTH;
Carsten  Rose's avatar
Carsten Rose committed
995
996

            // a) 'City@width=40', b) 'Status@icon', c) 'Mailto@width=80@nostrip'
997
            $arr = KeyValueStringParser::parse($columnName, '=', '|', IF_VALUE_EMPTY_COPY_KEY);
998
999
            foreach ($arr as $attribute => $value) {
                switch ($attribute) {
Carsten  Rose's avatar
Carsten Rose committed
1000
1001
                    case 'width':
                    case 'nostrip':
1002
                    case 'title':
1003
                        break;
Carsten  Rose's avatar
Carsten Rose committed
1004
                    case 'icon':
1005
1006
1007
                    case 'url':
                    case 'mailto':
                        $flagWidthLimit = false;
Carsten  Rose's avatar
Carsten Rose committed
1008
1009
                        break;
                    default:
1010
                        $attribute = is_numeric($value) ? 'width' : 'title';
Carsten  Rose's avatar
Carsten Rose committed
1011
1012
                        break;
                }
1013
                $control[$attribute][$columnName] = $value;
Carsten  Rose's avatar
Carsten Rose committed
1014
            }
1015

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

1019
            // Limit title length
1020
1021
1022
1023
1024
1025
            $control['title'][$columnName] = substr($control['title'][$columnName], 0, $control['width'][$columnName]);

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

Carsten  Rose's avatar
Carsten Rose committed
1026
1027
        }
        return $control;
1028
1029
    }

1030
    /**
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
     * Renders an Link with a symbol (edit) and register a new SIP to grant permission to the link..
     *
     * Returns <a href="<Link>"><span ...></span></a>
     *
     * 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)
     *
     *
1044
1045
1046
1047
1048
1049
     * @param $formElement
     * @param $targetRecordId
     * @param $record
     * @return string
     * @throws UserException
     */
1050
    private function editLink($formElement, $targetRecordId, $record) {
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072

        $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];
                }
            }
        }

1073

1074
        Support::appendTypo3ParameterToArray($queryStringArray);
1075
1076
1077
1078
        // If there is a specific targetpage defined, take it.
        if (isset($formElement['page']) && $formElement['page'] !== '') {
            $queryStringArray['id'] = $formElement['page'];
        }
1079
1080
1081
1082

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

1083
        $sip = $this->store->getSipInstance();
1084
        $url = $sip->queryStringToSip($queryString);
1085
1086
1087
1088
1089

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

    }

1090
    /**
1091
1092
1093
1094
1095
1096
1097
1098
1099
     * Renders $value as specified in array $control
     *
     * nostrip: by default, HTML tags are removed. With this attribute, the value will be delivered as it is.
     * width: if there is a size limit - apply it.
     * icon: The cell will be rendered as an image. $value should contain the name of an image in 'fileadmin/icons/'
     * mailto: The cell will be rendered as an <a> tag with the 'mailto' attribute.
     * url:  The cell will be rendered as an <a> tag. The value will be exploded by '|'. $value[0] = href, value[1] = text.
     *  E.g. $value = 'www.math.uzh.ch/?id=45&v=234|Show details for Modul 123' >> <a href="www.math.uzh.ch/?id=45&v=234">Show details for Modul 123</a>
     *
1100
1101
1102
1103
1104
     * @param array $control
     * @param $columnName
     * @param $value
     * @return string
     */
1105
1106
1107
1108
1109
    private function renderCell(array $control, $columnName, $value) {

        $arr = explode('|', $value);
        if (count($arr) == 1)
            $arr[1] = $arr[0];
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120

        $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])) {
1121
            $cell = "<a href='mailto:$arr[0]'>$arr[1]</a>";
1122
1123
1124
        }

        if (isset($control['url'][$columnName])) {
1125
            $cell = "<a href='$arr[0]'>$arr[1]</a>";
1126
1127
1128
1129
1130
        }

        return $cell;
    }

Carsten  Rose's avatar
Carsten Rose committed
1131
    /**
1132
1133
     * Builts an Upload (File) Button.
     *
Carsten  Rose's avatar
Carsten Rose committed
1134
1135
1136
1137
1138
1139
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return string
     * @throws UserException
     */
1140
    public function buildFile(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155

        $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
     */
1156
    public function buildDateJQW(array $formElement, $htmlFormElementId, $value) {
1157
        // TODO: implement
1158
        throw new UserException("Not implemented yet: buildDateJQW()", ERROR_NOT_IMPLEMENTED);
1159
1160
    }

Carsten  Rose's avatar
Carsten Rose committed
1161
1162
1163
1164
1165
1166
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @throws UserException
     */
1167
    public function buildGridJQW(array $formElement, $htmlFormElementId, $value) {
1168
        // TODO: implement
1169
        throw new UserException("Not implemented yet: buildGridJQW()", ERROR_NOT_IMPLEMENTED);
1170
    }
Carsten  Rose's avatar
Carsten Rose committed
1171
1172
1173
1174
1175
1176
1177

    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
1178
    public function buildNote(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
1179
1180
1181
        return $value;
    }

1182
1183
1184
1185
1186
1187
1188
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
    public function buildPill(array $formElement, $htmlFormElementId, $value) {
1189
        return $value;
1190
1191
1192
    }

    /**
1193
1194
     * Build a HTML fieldset. Renders all assigned FormElements inside the fieldset.
     *
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
     * @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) . '>';
1207
        if ($formElement['label'] !== '') {
1208
1209
1210
1211
1212
1213
            $html .= '<legend>' . $formElement['label'] . '</legend>';
        }

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

        // child FE's