AbstractBuildForm.php 43.6 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
    public function __construct(array $formSpec, array $feSpecAction, array $feSpecNative) {
        $this->formSpec = $formSpec;
        $this->feSpecAction = $feSpecAction;
        $this->feSpecNative = $feSpecNative;
        $this->store = Store::getInstance();
47
        $this->db = new Database();
Carsten  Rose's avatar
Carsten Rose committed
48
        $this->evaluate = new Evaluate($this->store, $this->db);
49

50
51
//        $sip = $this->store->getVar(CLIENT_SIP, STORE_CLIENT);

52
        // render mode specific
53
        $this->fillWrap();
54
55
56

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

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

91
        $this->inputCheckPattern = OnArray::inputCheckPatternArray();
Carsten  Rose's avatar
Carsten Rose committed
92

93
94
    }

95
96
    abstract public function fillWrap();

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

        $html = $this->head();

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

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

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

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

124

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

127
128
129
        return $html;
    }

130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
    /**
     * @return string
     */
    public function formEditLink() {

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

        $queryStringArray = [
            '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>";
    }

154
155
156
157
158
    /**
     * Builds the head area of the form.
     *
     * @return string
     */
159
160
161
    public function head() {
        $html = '';

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

164
165
166
167
        // Logged in BE User will see a FormEdit Link
        $html .= $this->formEditLink();
//        $html .= $this->showSipParam();

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

170
171
172
173
174
175
        $html .= $this->getFormTag();

        return $html;
    }

    /**
176
177
     * Wrap's $this->wrap[$item][WRAP_SETUP_START] around $value. If $flagOmitEmpty==true && $value=='': return ''.
     *
178
179
180
181
182
183
184
185
186
187
188
189
     * @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];
    }

    /**
190
     * Returns complete '<form ...>'-tag
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
     *
     * @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() {

208
        //TODO: ttcontent id eintragen
Carsten  Rose's avatar
Carsten Rose committed
209
//        $attribute['id'] = $this->store->getVar(STORE_TYPO3,'1234');
210
        $attribute['id'] = $this->getFormId();
211
212
213
214
215
216
217
218
219
220
        $attribute['method'] = 'post';
        $attribute['action'] = $this->getActionUrl();
        $attribute['target'] = '_top';
        $attribute['accept-charset'] = 'UTF-8';
        $attribute['autocomplete'] = 'on';
        $attribute['enctype'] = $this->getEncType();

        return $attribute;
    }

221
222
223
224
225
226
227
228
229
230
    /**
     * @return string
     */
    public function getFormId() {
        if ($this->formId === null) {
            $this->formId = uniqid('qfq-form-');
        }
        return $this->formId;
    }

231
232
233
    /**
     * Builds the HTML 'form'-tag inlcuding all attributes and target.
     *
234
235
     * Notice: the SIP will be transferred as POST Parameter.
     *
236
237
238
239
     * @return string
     * @throws DbException
     */
    public function getActionUrl() {
240
241
        return 'typo3conf/ext/qfq/qfq/api/save.php';

242
        $queryStringArray = array();
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258

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

259
        $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"');
260
261
262
        return (count($result) === 1) ? 'multipart/form-data' : 'application/x-www-form-urlencoded';

    }
263

264
    abstract public function getProcessFilter();
265
266
267

    /**
     * @param $recordId
268
     * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD
269
     * @param int $feIdContainer
270
     * @return string
271
272
     * @throws CodeException
     * @throws DbException
273
     * @throws \qfq\UserException
274
     */
275
    public function elements($recordId, $filter = FORM_ELEMENTS_NATIVE, $feIdContainer = 0) {
276
277
278
        $html = '';

        // get current data record
279
        if ($recordId > 0 && $this->store->getVar('id', STORE_RECORD) === false) {
280
            $row = $this->db->sql("SELECT * FROM " . $this->formSpec['tableName'] . " WHERE id = ?", ROW_REGULAR, array($recordId));
281
282
            $this->store->setVarArray($row[0], STORE_RECORD);
        }
283
284
285

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

288
289
            if (($filter === FORM_ELEMENTS_NATIVE && $fe['type'] === 'subrecord') ||
                ($filter === FORM_ELEMENTS_SUBRECORD && $fe['type'] !== 'subrecord')
290
291
292
293
            ) {
                continue; // skip this FE
            }

294
295
296
297
            // Log / Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, $fe['name'] . ' / ' . $fe['id'], STORE_SYSTEM);

            // evaluate current FormElement
298
            $evaluate = new Evaluate($this->store, $this->db);
299
            $formElement = $evaluate->parseArray($fe, $debugStack);
300

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

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

306
307
308
309
            // Construct Marshaller Name
            $buildElementFunctionName = 'build' . $this->buildElementFunctionName[$formElement['type']];

            // Render pure element
310
311
312
            $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementId, $value, $debugStack);

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

            // e.g.: <div class="radio">
//            if(isset($this->feDivClass[$formElement['type']]) && $this->feDivClass[$formElement['type']] != '') {
//                $elementHtml = Support::wrapTag('<div class="' . $this->feDivClass[$formElement['type']] .'">',  $elementHtml);
//            }
321
322
323
324
325

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

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

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

331
332
333
        return $html;
    }

334
335
336
    abstract public function tail();

    abstract public function doSubrecords();
337

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

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

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

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

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

        return $html;
357
358
    }

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

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

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

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

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

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

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

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

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

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

419
420
421
    }

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

433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
        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;
451
452
453
454
    }

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

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

        $attribute = '';

496
        $arrAttr = explode("|", $this->inputCheckPattern[$type]);
497
498
499
        $arrData = explode("|", $data);

        for ($ii = 0; $ii < count($arrAttr); $ii++) {
500
501
502
503
504
            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]) . ' ';
            }
505
506
507
508
        }
        return $attribute;
    }

509

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

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

        // Fill $itemKey & $itemValue
563
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
564
565
566

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

        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);
        }
591
592
593
        return $html;
    }

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

614
615
616
        if (count($formElement) < 20)
            throw new CodeException("Invalid (none or to small) Formelement", ERROR_MISSING_FORMELEMENT);

617
618
619
        $itemValue = $this->getItemsForEnumOrSet($formElement['name'], $fieldType);

        if (is_array($formElement['sql1'])) {
620
621
622
            if (count($formElement['sql1']) > 0) {
                $keys = array_keys($formElement['sql1'][0]);
                $itemKey = array_column($formElement['sql1'], 'id');
623

624
625
626
627
                // 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]);
                }
628

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

        if (count($itemKey) === 0) {
            $itemKey = $itemValue;
        }
649
650
651
652
653
654
655
656
657
658

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

        if (isset($formElement['emptyItemAtEnd'])) {
            $itemValue[] = '';
            $itemKey[] = '';
        }
659
660
661
    }

    /**
662
663
     * Get the attribute definition list of an enum or set column. For strings, get the default value. Return elements as an array.
     *
664
665
666
667
668
669
670
671
672
673
674
     * @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) {
675
            throw new UserException("Column '$column' unknown in table '" . $this->formSpec['tableName'] . "'", ERROR_DB_UNKNOWN_COLUMN);
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
        }

        $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:
703
     *
704
705
706
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
     *    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);
        }

    }

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

Carsten  Rose's avatar
Carsten Rose committed
750
751
        $attribute .= $this->getAttribute('name', $htmlFormElementId);
        $attribute .= $this->getAttribute('value', $formElement['checked'], false);
752
        if ($formElement['checked'] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
753
            $attribute .= $this->getAttribute('checked', 'checked');
754
755
        }

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

758
        $html = $this->buildNativeHidden($htmlFormElementId, $formElement['unchecked']);
759
760
761
762
763
764
765
766
767
768

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

        return $html;
    }

    /**
769
770
771
772
773
774
775
776
777
778
779
780
     * 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
781
782
783
784
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attributeBase
     * @param $value
785
786
     * @param array $itemKey
     * @param array $itemValue
787
788
     * @return string
     */
789
    public function buildCheckboxMulti(array $formElement, $htmlFormElementId, $attributeBase, $value, array $itemKey, array $itemValue) {
790
791
792
        // Defines which of the checkboxes will be checked.
        $values = explode($value, ',');

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

795
        $html = $this->buildNativeHidden($htmlFormElementId, $value);
796
797
798
799
800
801
802
803
804
805
806

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

823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
    /**
     * 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);
    }

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

        // Fill $itemKey & $itemValue
859
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
860

Carsten  Rose's avatar
Carsten Rose committed
861
862
863
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('name', $htmlFormElementId);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
864
865
866
867

        $jj = 0;
        $flagFirst = true;

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

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

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

893
894
895
896
897
898
899
900
            if ($jj === $formElement['maxLength']) {
                $jj = 0;
                $html .= '<br>';
            }
        }
        return $html;
    }

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

        // Fill $itemKey & $itemValue
914
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
Carsten  Rose's avatar
Carsten Rose committed
915
916
917

        $attribute = $this->getAttributeMode($formElement);
        $attribute .= $this->getAttribute('name', $htmlFormElementId);
918
        $attribute .= $this->getAttributeList($formElement, ['autofocus']);
Carsten  Rose's avatar
Carsten Rose committed
919
920
921
922
923
924
925

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

        $option = '';
926
        $selected = 'selected';
Carsten  Rose's avatar
Carsten Rose committed
927
928
929
930
931
        for ($ii = 0; $ii < count($itemValue); $ii++) {
            $option .= '<option ';

            $option .= $this->getAttribute('value', $itemKey[$ii]);
            if ($itemKey[$ii] === $value) {
932
933
                $option .= $selected;
                $selected = '';
Carsten  Rose's avatar
Carsten Rose committed
934
935
936
937
938
939
            }

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

        return '<select ' . $attribute . '>' . $option . '</select>';
940
941
    }

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

955
956
957
958
959
960
        $primaryRecord = $this->store->getStore(STORE_RECORD);

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

Carsten  Rose's avatar
Carsten Rose committed
961
962
963
964
        if (!is_array($formElement['sql1'])) {
            throw new UserException('Missing \'sql1\' Query', ERROR_MISSING_SQL1);
        }

965
966
967
968
969
970
        // No records?
        if (count($formElement['sql1']) == 0) {
            return '';
        }

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

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

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

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

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

993
        return $html;
994
995
    }

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

1019
1020
1021
        foreach ($titleRaw AS $columnName) {
            $flagWidthLimit = true;
            $control['width'][$columnName] = SUBRECORD_COLUMN_WIDTH;
Carsten  Rose's avatar
Carsten Rose committed
1022
1023

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

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

1046
            // Limit title length
1047
1048
1049
1050
1051
1052
            $control['title'][$columnName] = substr($control['title'][$columnName], 0, $control['width'][$columnName]);

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

Carsten  Rose's avatar
Carsten Rose committed
1053
1054
        }
        return $control;
1055
1056
    }

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

        $queryStringArray = [
            'form' => $formElement['form'],
1081
            'r' => $targetRecordId
1082
1083
1084
1085
1086
1087
        ];

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

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

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

1109
        $sip = $this->store->getSipInstance();
1110
        $url = $sip->queryStringToSip($queryString);
1111
1112
1113
1114
1115

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

    }

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

        $arr = explode('|', $value);
        if (count($arr) == 1)
            $arr[1] = $arr[0];
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146

        $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])) {
1147
            $cell = "<a href='mailto:$arr[0]'>$arr[1]</a>";
1148
1149
1150
        }

        if (isset($control['url'][$columnName])) {
1151
            $cell = "<a href='$arr[0]'>$arr[1]</a>";
1152
1153
1154
1155
1156
        }

        return $cell;
    }

Carsten  Rose's avatar
Carsten Rose committed
1157
    /**
1158
1159
     * Builts an Upload (File) Button.
     *
Carsten  Rose's avatar
Carsten Rose committed
1160
1161
1162
1163
1164
1165
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return string
     * @throws UserException
     */
1166
    public function buildFile(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
1167
1168
1169
1170
1171
1172
1173
1174
1175