AbstractBuildForm.php 43.9 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();
Carsten  Rose's avatar
Carsten Rose committed
99

100
101
    }

102
103
    abstract public function fillWrap();

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

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

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

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

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

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

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

134
135
136
        return $html;
    }

137
    /**
138
139
140
     * If SHOW_DEBUG_INFO=yes: create a link (incl. SIP) to edit the current form. Show also the hidden content of the SIP.
     *
     * @return string String: <a href="?pageId&sip=....">Edit</a> <small>[sip:..., r:..., urlparam:..., ...]</small>
141
142
143
144
145
146
147
148
     */
    public function formEditLink() {

        if($this->store->getVar('SHOW_DEBUG_INFO', STORE_SYSTEM) !== 'yes') {
            return '';
        }

        $queryStringArray = [
149
            'id' => $this->store->getVar(CLIENT_PAGE_ID, STORE_CLIENT),
150
151
152
153
154
155
156
157
158
159
160
161
162
163
            'form' => 'form',
            'r' => $this->formSpec['id']
        ];

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

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

        $sipParamString = OnArray::toString($this->store->getStore(STORE_SIP),':', ', ',"'");

        return "<p></p><a href='$url'>Edit</a> <small>[$sipParamString]</small></p>";
    }

164
165
166
167
168
    /**
     * Builds the head area of the form.
     *
     * @return string
     */
169
170
171
    public function head() {
        $html = '';

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

174
175
176
        // Logged in BE User will see a FormEdit Link
        $html .= $this->formEditLink();

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

179
180
181
182
183
184
        $html .= $this->getFormTag();

        return $html;
    }

    /**
185
186
     * Wrap's $this->wrap[$item][WRAP_SETUP_START] around $value. If $flagOmitEmpty==true && $value=='': return ''.
     *
187
188
189
190
191
192
193
194
195
196
197
198
     * @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];
    }

    /**
199
     * Returns '<form ...>'-tag with various attributes.
200
201
202
203
204
205
206
207
208
209
210
211
212
     *
     * @return string
     */
    public function getFormTag() {

        $attribute = $this->getFormTagAtrributes();

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

    /**
     * Build an assoc array with standard form attributes.
     *
213
     * @return array
214
215
216
     */
    public function getFormTagAtrributes() {

217
        //TODO: ttcontent id eintragen
Carsten  Rose's avatar
Carsten Rose committed
218
//        $attribute['id'] = $this->store->getVar(STORE_TYPO3,'1234');
219
        $attribute['id'] = $this->getFormId();
220
221
222
223
224
225
226
227
228
229
        $attribute['method'] = 'post';
        $attribute['action'] = $this->getActionUrl();
        $attribute['target'] = '_top';
        $attribute['accept-charset'] = 'UTF-8';
        $attribute['autocomplete'] = 'on';
        $attribute['enctype'] = $this->getEncType();

        return $attribute;
    }

230
231
232
233
234
235
236
237
238
239
    /**
     * @return string
     */
    public function getFormId() {
        if ($this->formId === null) {
            $this->formId = uniqid('qfq-form-');
        }
        return $this->formId;
    }

240
241
242
    /**
     * Builds the HTML 'form'-tag inlcuding all attributes and target.
     *
243
244
     * Notice: the SIP will be transferred as POST Parameter.
     *
245
246
247
248
249
     * @return string
     * @throws DbException
     */
    public function getActionUrl() {

250
        return 'typo3conf/ext/qfq/qfq/api/save.php';
251
252
253
254
255
256
257
258
259
260
261
262
    }

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

263
        $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"');
264
265
266
        return (count($result) === 1) ? 'multipart/form-data' : 'application/x-www-form-urlencoded';

    }
267

268
    abstract public function getProcessFilter();
269
270

    /**
271
272
     * Process all FormElements: build corresponding HTML code. Collect and return all HTML code.
     *
273
     * @param $recordId
274
     * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD
275
     * @param int $feIdContainer
276
     * @return string
277
278
     * @throws CodeException
     * @throws DbException
279
     * @throws \qfq\UserException
280
     */
281
    public function elements($recordId, $filter = FORM_ELEMENTS_NATIVE, $feIdContainer = 0) {
282
283
284
        $html = '';

        // get current data record
285
        if ($recordId > 0 && $this->store->getVar('id', STORE_RECORD) === false) {
286
            $row = $this->db->sql("SELECT * FROM " . $this->formSpec['tableName'] . " WHERE id = ?", ROW_REGULAR, array($recordId));
287
288
            $this->store->setVarArray($row[0], STORE_RECORD);
        }
289
290
291

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

294
295
            if (($filter === FORM_ELEMENTS_NATIVE && $fe['type'] === 'subrecord') ||
                ($filter === FORM_ELEMENTS_SUBRECORD && $fe['type'] !== 'subrecord')
296
297
298
299
            ) {
                continue; // skip this FE
            }

300
301
302
303
            // Log / Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, $fe['name'] . ' / ' . $fe['id'], STORE_SYSTEM);

            // evaluate current FormElement
304
            $evaluate = new Evaluate($this->store, $this->db);
305
            $formElement = $evaluate->parseArray($fe, $debugStack);
306

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

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

312
313
314
315
            // Construct Marshaller Name
            $buildElementFunctionName = 'build' . $this->buildElementFunctionName[$formElement['type']];

            // Render pure element
316
317
318
            $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementId, $value, $debugStack);

            // debugStack as Tooltip
319
            if( $this->store->getVar('SHOW_DEBUG_INFO', STORE_SYSTEM) === 'yes' && count($debugStack)>0) {
320
321
322
                $elementHtml = Support::appendTooltip($elementHtml,  implode("\n", OnArray::htmlentitiesOnArray($debugStack)));
            }

323
324
325
326
            // Construct Marshaller Name
            $buildRowName = 'buildRow' . $this->buildRowName[$formElement['type']];

            $html .= $this->$buildRowName($formElement, $elementHtml);
327
        }
328

329
330
331
        // Log / Debug: Last FormElement has been processed.
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

332
333
334
        return $html;
    }

335
336
337
    abstract public function tail();

    abstract public function doSubrecords();
338

339
340
341
342
343
344
345
346
    abstract public function buildRowNative($formElement, $elementHtml);

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

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

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

347
    /**
348
349
     * Builds a label, typically for an html-'<input>'-element.
     *
350
351
     * @param array $htmlFormElementId
     * @param $label
352
353
     * @return string
     */
354
355
356
357
    public function buildLabel($htmlFormElementId, $label) {
        $html = '<label for="' . $htmlFormElementId . '">' . $label . '</label>';

        return $html;
358
359
    }

360
361
362
363
364
365
366
367
368
369
370
371
372
    /**
     * 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
     */
373
    public function buildInput(array $formElement, $htmlFormElementId, $value) {
374
        $textarea = '';
375

Carsten  Rose's avatar
Carsten Rose committed
376
        $attribute = $this->getAttribute('name', $htmlFormElementId);
377
378
        $htmlTag = '<input';

379
380
381
382
383
384
385
386
387
388
389
390
        // 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;
            }
        }

391
        // Check for input type 'textarea'
392
        $colsRows = explode(',', $formElement['size'], 2);
393
        if (count($colsRows) === 2) {
394
            // <textarea>
395
396
            $htmlTag = '<textarea';

Carsten  Rose's avatar
Carsten Rose committed
397
398
            $attribute .= $this->getAttribute('cols', $colsRows[0]);
            $attribute .= $this->getAttribute('rows', $colsRows[1]);
399
            $textarea = htmlentities($value) . '</textarea>';
400
401

        } else {
402
403
404
            // <input>
            if ($formElement['maxLength'] > 0) {
                $value = substr($value, 0, $formElement['maxLength']);
405
406
407

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

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

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

418
        return "$htmlTag $attribute>$textarea";
419

420
421
422
    }

    /**
423
424
     * Format's an attribute: $type=$value. If $flagOmitEmpty==true && $value=='': return ''.
     *
425
426
427
428
429
     * @param $type
     * @param $value
     * @param bool|false $flagOmitEmpty
     * @return string
     */
430
    public function getAttribute($type, $value, $flagOmitEmpty = true) {
431
432
        if ($flagOmitEmpty && $value === "")
            return '';
Carsten  Rose's avatar
Carsten Rose committed
433

434
435
436
437
        return $type . '="' . trim($value) . '" ';
    }

    /**
438
439
     * Get column spec from tabledefinition and parse size of it. If nothing defined, return false.
     *
440
     * @param $column
441
     * @return bool|int
442
443
444
445
446
447
     */
    private function getColumnSize($column) {
        $matches = array();

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

448
        // e.g.: string(64), enum('yes','no')
449
450
451
452
453
454
        if (1 === preg_match('/\((.+)\)/', $typeSpec, $matches)) {
            if (is_numeric($matches[1]))
                return $matches[1];
        }

        return false;
455
456
457
458
    }

    /**
     * Builds a HTML attribute list, based on  $attributeList.
459
     *
460
461
462
463
464
465
466
     * 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
467
    private function getAttributeList(array $formElement, array $attributeList) {
468
469
470
        $attribute = '';
        foreach ($attributeList as $item) {
            if (isset($formElement[$item]))
Carsten  Rose's avatar
Carsten Rose committed
471
                $attribute .= $this->getAttribute(strtolower($item), $formElement[$item]);
472
473
474
475
476
477
        }
        return $attribute;
    }

    /**
     * Construct HTML Input attribute for Client Validation:
478
     *
479
480
481
482
483
484
485
486
487
488
489
490
     *   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
491
     * @throws \qfq\UserException
492
     */
Carsten  Rose's avatar
Carsten Rose committed
493
    private function getInputCheckPattern($type, $data) {
494
495
        if ($type === '') {
            return '';
496
        }
497
498
499

        $attribute = '';

500
        $arrAttr = explode("|", $this->inputCheckPattern[$type]);
501
502
503
        $arrData = explode("|", $data);

        for ($ii = 0; $ii < count($arrAttr); $ii++) {
504
505
506
507
508
            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]) . ' ';
            }
509
510
511
512
        }
        return $attribute;
    }

513

514
    /**
515
516
     * Set corresponding html attributes readonly/required/disabled, based on $formElement['mode'].
     *
517
518
519
520
     * @param array $formElement
     * @return string
     * @throws UserException
     */
Carsten  Rose's avatar
Carsten Rose committed
521
    private function getAttributeMode(array $formElement) {
522
523
524
525
526
527
        $attribute = '';

        switch ($formElement['mode']) {
            case 'show':
                break;
            case 'readonly':
Carsten  Rose's avatar
Carsten Rose committed
528
                $attribute .= $this->getAttribute('readonly', 'readonly');
529
530
                break;
            case 'required':
Carsten  Rose's avatar
Carsten Rose committed
531
                $attribute .= $this->getAttribute('required', 'required');
532
533
534
535
                break;
            case 'lock':
                break;
            case 'disabled':
Carsten  Rose's avatar
Carsten Rose committed
536
                $attribute .= $this->getAttribute('disabled', 'disabled');
537
538
539
540
                break;
            default:
                $this->store->setVar(SYSTEM_FORM_ELEMENT, $formElement['name'] . ' / ' . $formElement['id'], STORE_SYSTEM);
                $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, 'mode', STORE_SYSTEM);
541
                throw new UserException("Unknown mode '" . $formElement['mode'] . "'", ERROR_UNKNOWN_MODE);
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
                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
     */
562
    public function buildCheckbox(array $formElement, $htmlFormElementId, $value) {
563
564
565
566
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
567
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
568
569
570

        // Get fallback, if 'checkBoxMode' is not defined:
        if (!isset($formElement['checkBoxMode'])) {
571
            // This fallback is problematic if 'set' or 'enum' has 2 : defaults to single but maybe multi is meant.
572
573
574
575
576
577
578
579
580
581
            $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
582
583
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
584
585
586
587
588
589
590
591
592
593
594

        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);
        }
595
596
597
        return $html;
    }

598
    /**
599
600
601
602
603
     * Look for key/value list (in this order, first match counts) in
     *  a) `sql1`
     *  b) `parameter:itemList`
     *  c) table.column definition
     *
604
     * Copies the found keys to &$itemKey and the values to &$itemValue
605
     * If there are no &$itemKey, copy &$itemValue to &$itemKey.
606
607
608
609
     *
     * @param array $formElement
     * @param $itemKey
     * @param $itemValue
610
611
     * @throws CodeException
     * @throws \qfq\UserException
612
     */
613
    public function getKeyValueListFromSqlEnumSpec(array $formElement, &$itemKey, &$itemValue) {
614
615
616
617
        $fieldType = '';
        $itemKey = array();
        $itemValue = array();

618
619
620
        if (count($formElement) < 20)
            throw new CodeException("Invalid (none or to small) Formelement", ERROR_MISSING_FORMELEMENT);

621
622
623
        $itemValue = $this->getItemsForEnumOrSet($formElement['name'], $fieldType);

        if (is_array($formElement['sql1'])) {
624
625
626
            if (count($formElement['sql1']) > 0) {
                $keys = array_keys($formElement['sql1'][0]);
                $itemKey = array_column($formElement['sql1'], 'id');
627

628
629
630
631
                // 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]);
                }
632

633
634
635
636
637
638
                $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]);
                }
639
            }
640
        } elseif (isset($formElement['itemList']) && strlen($formElement['itemList']) > 0) {
641
            $arr = KeyValueStringParser::parse($formElement['itemList'], ':', ',', KVP_IF_VALUE_EMPTY_COPY_KEY);
642
643
            $itemValue = array_values($arr);
            $itemKey = array_keys($arr);
644
        } elseif ($fieldType === 'enum' || $fieldType === 'set') {
Carsten  Rose's avatar
Carsten Rose committed
645
            // already done at the beginning with '$this->getItemsForEnumOrSet($formElement['name'], $fieldType);'
646
        } else {
647
            throw new UserException("Missing definition (- nothing found in 'sql1', 'parameter:itemValues', 'enum-' or 'set-definition'", ERROR_MISSING_ITEM_VALUES);
648
649
650
651
652
        }

        if (count($itemKey) === 0) {
            $itemKey = $itemValue;
        }
653
654
655
656
657
658
659
660
661
662

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

        if (isset($formElement['emptyItemAtEnd'])) {
            $itemValue[] = '';
            $itemKey[] = '';
        }
663
664
665
    }

    /**
666
667
     * Get the attribute definition list of an enum or set column. For strings, get the default value. Return elements as an array.
     *
668
669
670
671
672
673
674
675
676
677
678
     * @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) {
679
            throw new UserException("Column '$column' unknown in table '" . $this->formSpec['tableName'] . "'", ERROR_DB_UNKNOWN_COLUMN);
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
706
        }

        $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:
707
     *
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
     *    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);
        }

    }

    /**
743
744
     * Build a Checkbox based on two values.
     *
745
746
747
748
749
750
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attribute
     * @param $value
     * @return string
     */
751
    public function buildCheckboxSingle(array $formElement, $htmlFormElementId, $attribute, $value) {
752
        $html = '';
753

Carsten  Rose's avatar
Carsten Rose committed
754
755
        $attribute .= $this->getAttribute('name', $htmlFormElementId);
        $attribute .= $this->getAttribute('value', $formElement['checked'], false);
756
        if ($formElement['checked'] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
757
            $attribute .= $this->getAttribute('checked', 'checked');
758
759
        }

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

762
        $html = $this->buildNativeHidden($htmlFormElementId, $formElement['unchecked']);
763
764
765
766
767
768
769
770
771
772

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

        return $html;
    }

    /**
773
     * Builds a real HTML hidden form element. Useful for checkboxes, Multiple-Select and Radios.
774
775
776
777
778
779
780
781
782
783
784
     *
     * @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
785
786
787
788
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attributeBase
     * @param $value
789
790
     * @param array $itemKey
     * @param array $itemValue
791
792
     * @return string
     */
793
    public function buildCheckboxMulti(array $formElement, $htmlFormElementId, $attributeBase, $value, array $itemKey, array $itemValue) {
794
795
796
        // Defines which of the checkboxes will be checked.
        $values = explode($value, ',');

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

799
        $html = $this->buildNativeHidden($htmlFormElementId, $value);
800
801
802
803
804
805
806
807
808
809
810

        $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
811
                    $attribute .= $this->getAttribute('autofocus', $formElement['autofocus']);
812
            }
Carsten  Rose's avatar
Carsten Rose committed
813
            $attribute .= $this->getAttribute('value', $item);
814
            if ($item === $values[$jj]) {
Carsten  Rose's avatar
Carsten Rose committed
815
                $attribute .= $this->getAttribute('checked', 'checked');
816
817
818
819
820
821
822
823
824
825
826
            }
            $html .= '<input ' . $attribute . '>';
            $html .= $itemValue[$ii];
            if ($ii === $formElement['maxLength']) {
                $ii = 0;
                $html .= '<br>';
            }
        }
        return $html;
    }

827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
    /**
     * 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);
    }

843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
    /**
     * 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
     */
858
    public function buildRadio(array $formElement, $htmlFormElementId, $value) {
859
860
861
862
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
863
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
864

Carsten  Rose's avatar
Carsten Rose committed
865
866
867
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('name', $htmlFormElementId);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
868
869
870
871

        $jj = 0;
        $flagFirst = true;

872
        $html = $this->buildNativeHidden($htmlFormElementId, $value);
873
874
875
876
877
878
        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
879
                    $attribute .= $this->getAttribute('autofocus', $formElement['autofocus']);
880
881
            }

Carsten  Rose's avatar
Carsten Rose committed
882
            $attribute .= $this->getAttribute('value', $itemKey[$ii]);
883
            if ($itemKey[$ii] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
884
                $attribute .= $this->getAttribute('checked', 'checked');
885
            }
886
887
888
889
890
891
892
893
894
895
896

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

897
898
899
900
901
902
903
904
            if ($jj === $formElement['maxLength']) {
                $jj = 0;
                $html .= '<br>';
            }
        }
        return $html;
    }

Carsten  Rose's avatar
Carsten Rose committed
905
    /**
906
907
     * Builds a Selct (Dropdown) Box.
     *
Carsten  Rose's avatar
Carsten Rose committed
908
909
910
911
912
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
913
    public function buildSelect(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
914
915
916
917
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
918
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
Carsten  Rose's avatar
Carsten Rose committed
919
920
921

        $attribute = $this->getAttributeMode($formElement);
        $attribute .= $this->getAttribute('name', $htmlFormElementId);
922
        $attribute .= $this->getAttributeList($formElement, ['autofocus']);
Carsten  Rose's avatar
Carsten Rose committed
923
924
925
926
927
928
929

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

        $option = '';
930
        $selected = 'selected';
Carsten  Rose's avatar
Carsten Rose committed
931
932
933
934
935
        for ($ii = 0; $ii < count($itemValue); $ii++) {
            $option .= '<option ';

            $option .= $this->getAttribute('value', $itemKey[$ii]);
            if ($itemKey[$ii] === $value) {
936
937
                $option .= $selected;
                $selected = '';
Carsten  Rose's avatar
Carsten Rose committed
938
939
940
941
942
943
            }

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

        return '<select ' . $attribute . '>' . $option . '</select>';
944
945
    }

Carsten  Rose's avatar
Carsten Rose committed
946
947
948
949
950
951
952
953
954
955
    /**
     * 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
     */
956
    public function buildSubrecord(array $formElement, $htmlFormElementId, $value) {
957
958
        $html = '';

959
960
961
962
963
964
        $primaryRecord = $this->store->getStore(STORE_RECORD);

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

Carsten  Rose's avatar
Carsten Rose committed
965
966
967
968
        if (!is_array($formElement['sql1'])) {
            throw new UserException('Missing \'sql1\' Query', ERROR_MISSING_SQL1);
        }

969
970
971
972
973
974
        // No records?
        if (count($formElement['sql1']) == 0) {
            return '';
        }

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

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

981
//        $html .= '<b>' . $formElement['label'] . '</b>';
982
983
//        $html .= '<table border="1">';
        $html .= '<table class="table">';
984
        $html .= '<tr><th></th><th>' . implode('</th><th>', $control['title']) . '</th></tr>';
Carsten  Rose's avatar
Carsten Rose committed
985
        foreach ($formElement['sql1'] as $row) {
986

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

990
            foreach ($row as $columnName => $value) {
991
                $html .= '<td>' . $this->renderCell($control, $columnName, $value) . '</td>';
Carsten  Rose's avatar
Carsten Rose committed
992
993
994
995
996
            }
            $html .= '</tr>';
        }
        $html .= '</table>';

997
        return $html;
998
999
    }

Carsten  Rose's avatar
Carsten Rose committed
1000
    /**
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
     * 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
1016
1017
1018
1019
     * @param $titleRaw
     * @return array
     * @throws UserException
     */
1020
    private function getSubrecordColumnControl(array $titleRaw) {
Carsten  Rose's avatar
Carsten Rose committed
1021
1022
        $control = array();

1023
1024
1025
        foreach ($titleRaw AS $columnName) {
            $flagWidthLimit = true;
            $control['width'][$columnName] = SUBRECORD_COLUMN_WIDTH;
Carsten  Rose's avatar
Carsten Rose committed
1026
1027

            // a) 'City@width=40', b) 'Status@icon', c) 'Mailto@width=80@nostrip'
1028
            $arr = KeyValueStringParser::parse($columnName, '=', '|', KVP_IF_VALUE_EMPTY_COPY_KEY);
1029
1030
            foreach ($arr as $attribute => $value) {
                switch ($attribute) {
Carsten  Rose's avatar
Carsten Rose committed
1031
1032
                    case 'width':
                    case 'nostrip':
1033
                    case 'title':
1034
                        break;
Carsten  Rose's avatar
Carsten Rose committed
1035
                    case 'icon':
1036
1037
1038
                    case 'url':
                    case 'mailto':
                        $flagWidthLimit = false;
Carsten  Rose's avatar
Carsten Rose committed
1039
1040
                        break;
                    default:
1041
                        $attribute = is_numeric($value) ? 'width' : 'title';
Carsten  Rose's avatar
Carsten Rose committed
1042
1043
                        break;
                }
1044
                $control[$attribute][$columnName] = $value;
Carsten  Rose's avatar
Carsten Rose committed
1045
            }
1046

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

1050
            // Limit title length
1051
1052
1053
1054
1055
1056
            $control['title'][$columnName] = substr($control['title'][$columnName], 0, $control['width'][$columnName]);

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

Carsten  Rose's avatar
Carsten Rose committed
1057
1058
        }
        return $control;
1059
1060
    }

1061
    /**
1062
1063
     * Renders an Link with a symbol (edit) and register a new SIP to grant permission to the link..
     *
1064
     * Returns <a href="<Link>">[icon]</a>
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
     *
     * 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)
     *
     *
1075
1076
1077
1078
1079
1080
     * @param $formElement
     * @param $targetRecordId
     * @param $record
     * @return string
     * @throws UserException
     */
1081
    private function editLink($formElement, $targetRecordId, $record) {
1082
1083
1084

        $queryStringArray = [
            'form' => $formElement['form'],
1085
            'r' => $targetRecordId
1086
1087
1088
1089
1090
1091
        ];

        // Add custom query parameter
        if (isset($formElement['detail'])) {
            $detailParam = KeyValueStringParser::parse($formElement['detail']);
            foreach ($detailParam as $src => $dest) {
1092
                // Constants
1093
1094
1095
1096
                if ($src[0] == '#') {
                    $queryStringArray[$dest] = substr($src, 1);
                    continue;
                }
1097
                // Form record values or parameter
1098
1099
1100
1101
1102
1103
1104
                if (isset($record[$src])) {
                    $queryStringArray[$dest] = $record[$src];
                }
            }
        }

        Support::appendTypo3ParameterToArray($queryStringArray);
1105
1106
1107
1108
        // If there is a specific targetpage defined, take it.
        if (isset($formElement['page']) && $formElement['page'] !== '') {
            $queryStringArray['id'] = $formElement['page'];
        }
1109
1110
1111
1112

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

1113
        $sip = $this->store->getSipInstance();
1114
        $url = $sip->queryStringToSip($queryString);
1115
1116
1117
1118

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

1119
    /**
1120
1121
1122
1123
1124
1125
1126
1127
1128
     * 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>
     *
1129
1130
1131
1132
1133
     * @param array $control
     * @param $columnName
     * @param $value
     * @return string
     */
1134
1135
1136
1137
1138
    private function renderCell(array $control, $columnName, $value) {

        $arr = explode('|', $value);
        if (count($arr) == 1)
            $arr[1] = $arr[0];