AbstractBuildForm.php 42.5 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

39
40
    private $formId = null;

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

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

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

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

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

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

92
93
    }

94
95
    abstract public function fillWrap();

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

        $html = $this->head();

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

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

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

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

123

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

126
127
128
        return $html;
    }

129
130
131
132
133
    /**
     * Builds the head area of the form.
     *
     * @return string
     */
134
135
136
    public function head() {
        $html = '';

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

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

141
142
143
144
145
146
        $html .= $this->getFormTag();

        return $html;
    }

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

    /**
161
     * Rreturns complete '<form ...>'-tag
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
     *
     * @return string
     */
    public function getFormTag() {

        $attribute = $this->getFormTagAtrributes();

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

    /**
     * Build an assoc array with standard form attributes.
     *
     * @return mixed
     */
    public function getFormTagAtrributes() {

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

        return $attribute;
    }

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

202
203
204
    /**
     * Builds the HTML 'form'-tag inlcuding all attributes and target.
     *
205
206
     * Notice: the SIP will be transferred as POST Parameter.
     *
207
208
209
210
     * @return string
     * @throws DbException
     */
    public function getActionUrl() {
211
212
        return 'typo3conf/ext/qfq/qfq/api/save.php';

213
        $queryStringArray = array();
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229

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

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

    }
234

235
    abstract public function getProcessFilter();
236
237
238

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

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

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

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

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

            // evaluate current FormElement
268
269
270
271
272
            $evaluate = new Evaluate($this->store, $this->db);
            $formElement = $evaluate->parseArray($fe, $fe['debug'] === 'yes');
            if ($fe['debug'] === 'yes') {
                throw new UserException($evaluate->getDebug(), ERROR_DEBUG);
            }
273

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

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

279
280
281
282
283
284
285
286
287
288
            // Construct Marshaller Name
            $buildElementFunctionName = 'build' . $this->buildElementFunctionName[$formElement['type']];

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

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

            $html .= $this->$buildRowName($formElement, $elementHtml);
289
        }
290

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

294
295
296
        return $html;
    }

297
298
299
    abstract public function tail();

    abstract public function doSubrecords();
300

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

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

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

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

309
    /**
310
311
     * Extract Tag from $tag (might contain further attributes) and wrap it around $value. If $flagOmitEmpty==true && $value=='': return ''.
     *
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
     * @param $tag
     * @param $value
     * @param bool|false $flagOmitEmpty
     * @return string
     */
    public function wrapTag($tag, $value, $flagOmitEmpty = false) {
        if ($flagOmitEmpty && $value === "")
            return '';

        // <div class="container-fluid"> >> </div>
        $arr = explode(' ', $tag);
        $closing = '</' . substr($arr[0], 1) . '>';

        return $tag . $value . $closing;
    }

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

        return $html;
339
340
    }

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

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

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

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

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

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

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

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

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

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

401
402
403
    }

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

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

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

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

        $attribute = '';

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

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

491

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

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

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

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

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

574
575
576
        return $html;
    }

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

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

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

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

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

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

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

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

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

    /**
645
646
     * Get the attribute definition list of an enum or set column. For strings, get the default value. Return elements as an array.
     *
647
648
649
650
651
652
653
654
655
656
657
     * @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) {
658
            throw new UserException("Column '$column' unknown in table '" . $this->formSpec['tableName'] . "'", ERROR_DB_UNKNOWN_COLUMN);
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
        }

        $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:
686
     *
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
     *    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);
        }

    }

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

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

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

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

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

        return $html;
    }

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

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

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

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

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

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

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

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

        $jj = 0;
        $flagFirst = true;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

939
940
941
942
943
944
        // No records?
        if (count($formElement['sql1']) == 0) {
            return '';
        }

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

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

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

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

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

967
        return $html;
968
969
    }

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

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

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

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

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

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

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

1031
    /**
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
     * Renders an Link with a symbol (edit) and register a new SIP to grant permission to the link..
     *
     * Returns <a href="<Link>"><span ...></span></a>
     *
     * Link: <page>?s=<SIP>&<standard typo3 params>
     * SIP: form = $formElement['form'] (provided via formElement['parameter'])
     *      r = $targetRecordId
     *      Parse  $formElement['detail'] with possible key/value pairs. E.g.: detail=id:gr_id,#{{a}}:p_id,#12:x_id
     *        gr_id = <<primarytable.id>>
     *        p_id = <<variable defined in SIP or Client>>
     *        x_id = 12 (constant)
     *
     *
1045
1046
1047
1048
1049
1050
     * @param $formElement
     * @param $targetRecordId
     * @param $record
     * @return string
     * @throws UserException
     */
1051
    private function editLink($formElement, $targetRecordId, $record) {
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062

        $queryStringArray = [
            'form' => $formElement['form'],
            'r' => $targetRecordId,

        ];

        // Add custom query parameter
        if (isset($formElement['detail'])) {
            $detailParam = KeyValueStringParser::parse($formElement['detail']);
            foreach ($detailParam as $src => $dest) {
1063
                // Constants
1064
1065
1066
1067
                if ($src[0] == '#') {
                    $queryStringArray[$dest] = substr($src, 1);
                    continue;
                }
1068
                // Form record values or parameter
1069
1070
1071
1072
1073
1074
1075
                if (isset($record[$src])) {
                    $queryStringArray[$dest] = $record[$src];
                }
            }
        }

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

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

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

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

    }

1091
    /**
1092
1093
1094
1095
1096
1097
1098
1099
1100
     * 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>
     *
1101
1102
1103
1104
1105
     * @param array $control
     * @param $columnName
     * @param $value
     * @return string
     */
1106
1107
1108
1109
1110
    private function renderCell(array $control, $columnName, $value) {

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

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

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

        return $cell;
    }

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

        $attribute = $this->getAttributeMode($formElement);
        $attribute .= $this->getAttribute('type', 'file');
        $attribute .= $this->getAttribute('name', $htmlFormElementId);
        $attribute .= $this->getAttributeList($formElement, ['autofocus', 'accept']);

        return '<input ' . $attribute . '>';
    }

    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @throws UserException
     */
1157
    public function buildDateJQW(array $formElement, $htmlFormElementId, $value) {
1158
        // TODO: implement
1159
        throw new UserException("Not implemented yet: buildDateJQW()", ERROR_NOT_IMPLEMENTED);
1160
1161
    }

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

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