AbstractBuildForm.php 42.9 KB
Newer Older
1
<?php
Carsten  Rose's avatar
Carsten Rose committed
2
3
4
5
6
7
/**
 * Created by PhpStorm.
 * User: crose
 * Date: 1/6/16
 * Time: 8:02 PM
 */
8
9
10
namespace qfq;

use qfq;
11
use qfq\Store;
12
use qfq\UserException;
13
use qfq\OnArray;
14
15
16
17

require_once(__DIR__ . '/../qfq/store/Store.php');
require_once(__DIR__ . '/../qfq/Constants.php');
require_once(__DIR__ . '/../qfq/exceptions/DbException.php');
18
require_once(__DIR__ . '/../qfq/exceptions/UserException.php');
19
require_once(__DIR__ . '/../qfq/Database.php');
20
require_once(__DIR__ . '/../qfq/helper/HelperFormElement.php');
21
require_once(__DIR__ . '/../qfq/helper/Support.php');
22
require_once(__DIR__ . '/../qfq/helper/OnArray.php');
23

24
25

/**
Carsten  Rose's avatar
Carsten Rose committed
26
27
 * Class AbstractBuildForm
 * @package qfq
28
 */
29
abstract class AbstractBuildForm {
30
31
32
    protected $formSpec = array();  // copy of the loaded form
    protected $feSpecAction = array(); // copy of all formElement.class='action' of the loaded form
    protected $feSpecNative = array(); // copy of all formElement.class='native' of the loaded form
33
    protected $store = null;
Carsten  Rose's avatar
Carsten Rose committed
34
    protected $evaluate = null;
35
36
    protected $buildElementFunctionName = array();
    protected $pattern = array();
37
    protected $wrap = array();
38
//    protected $feDivClass = array(); // Wrap FormElements in <div class="$feDivClass[type]">
39

40
41
    private $formId = null;

42
43
44
45
46
    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
    /**
     * Builds the head area of the form.
     *
     * @return string
     */
135
136
137
    public function head() {
        $html = '';

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

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

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

        return $html;
    }

    /**
148
149
     * Wrap's $this->wrap[$item][WRAP_SETUP_START] around $value. If $flagOmitEmpty==true && $value=='': return ''.
     *
150
151
152
153
154
155
156
157
158
159
160
161
     * @param $item
     * @param $value
     * @param bool|false $flagOmitEmpty
     * @return string
     */
    public function wrapItem($item, $value, $flagOmitEmpty = false) {
        if ($flagOmitEmpty && $value === "")
            return '';
        return $this->wrap[$item][WRAP_SETUP_START] . $value . $this->wrap[$item][WRAP_SETUP_END];
    }

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

        $attribute = $this->getFormTagAtrributes();

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

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

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

        return $attribute;
    }

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

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

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

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

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

    }
235

236
    abstract public function getProcessFilter();
237
238
239

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

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

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

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

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

            // evaluate current FormElement
270
            $evaluate = new Evaluate($this->store, $this->db);
271
            $formElement = $evaluate->parseArray($fe, $debugStack);
272

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

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

278
279
280
281
            // Construct Marshaller Name
            $buildElementFunctionName = 'build' . $this->buildElementFunctionName[$formElement['type']];

            // Render pure element
282
283
284
285
286
287
288
289
290
291
292
293
            $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementId, $value, $debugStack);

            // debugStack as Tooltip
            if( $this->formSpec['showDebugInfo'] === 'yes' && count($debugStack)>0) {
//                $elementHtml = Support::wrapWithTooltip($elementHtml,  addslashes(implode("\n", Support::htmlentitiesOnArray($debugStack))));
                $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);
//            }
294
295
296
297
298

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

            $html .= $this->$buildRowName($formElement, $elementHtml);
299
        }
300

301
302
303
        // Log / Debug: Last FormElement has been processed.
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

304
305
306
        return $html;
    }

307
308
309
    abstract public function tail();

    abstract public function doSubrecords();
310

311
312
313
314
315
316
317
318
    abstract public function buildRowNative($formElement, $elementHtml);

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

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

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

319
    /**
320
321
     * Builds a label, typically for an html-'<input>'-element.
     *
322
323
     * @param array $htmlFormElementId
     * @param $label
324
325
     * @return string
     */
326
327
328
329
    public function buildLabel($htmlFormElementId, $label) {
        $html = '<label for="' . $htmlFormElementId . '">' . $label . '</label>';

        return $html;
330
331
    }

332
333
334
335
336
337
338
339
340
341
342
343
344
    /**
     * 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
     */
345
    public function buildInput(array $formElement, $htmlFormElementId, $value) {
346
        $textarea = '';
347

Carsten  Rose's avatar
Carsten Rose committed
348
        $attribute = $this->getAttribute('name', $htmlFormElementId);
349
350
        $htmlTag = '<input';

351
352
353
354
355
356
357
358
359
360
361
362
        // 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;
            }
        }

363
        // Check for input type 'textarea'
364
        $colsRows = explode(',', $formElement['size'], 2);
365
        if (count($colsRows) === 2) {
366
            // <textarea>
367
368
            $htmlTag = '<textarea';

Carsten  Rose's avatar
Carsten Rose committed
369
370
            $attribute .= $this->getAttribute('cols', $colsRows[0]);
            $attribute .= $this->getAttribute('rows', $colsRows[1]);
371
            $textarea = htmlentities($value) . '</textarea>';
372
373

        } else {
374
375
376
            // <input>
            if ($formElement['maxLength'] > 0) {
                $value = substr($value, 0, $formElement['maxLength']);
377
378
379

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

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

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

390
        return "$htmlTag $attribute>$textarea";
391

392
393
394
    }

    /**
395
396
     * Format's an attribute: $type=$value. If $flagOmitEmpty==true && $value=='': return ''.
     *
397
398
399
400
401
     * @param $type
     * @param $value
     * @param bool|false $flagOmitEmpty
     * @return string
     */
402
    public function getAttribute($type, $value, $flagOmitEmpty = true) {
403
404
        if ($flagOmitEmpty && $value === "")
            return '';
Carsten  Rose's avatar
Carsten Rose committed
405

406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
        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;
424
425
426
427
    }

    /**
     * Builds a HTML attribute list, based on  $attributeList.
428
     *
429
430
431
432
433
434
435
     * 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
436
    private function getAttributeList(array $formElement, array $attributeList) {
437
438
439
        $attribute = '';
        foreach ($attributeList as $item) {
            if (isset($formElement[$item]))
Carsten  Rose's avatar
Carsten Rose committed
440
                $attribute .= $this->getAttribute(strtolower($item), $formElement[$item]);
441
442
443
444
445
446
        }
        return $attribute;
    }

    /**
     * Construct HTML Input attribute for Client Validation:
447
     *
448
449
450
451
452
453
454
455
456
457
458
459
     *   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
460
     * @throws \qfq\UserException
461
     */
Carsten  Rose's avatar
Carsten Rose committed
462
    private function getInputCheckPattern($type, $data) {
463
464
        if ($type === '') {
            return '';
465
        }
466
467
468

        $attribute = '';

469
        $arrAttr = explode("|", $this->inputCheckPattern[$type]);
470
471
472
        $arrData = explode("|", $data);

        for ($ii = 0; $ii < count($arrAttr); $ii++) {
473
474
475
476
477
            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]) . ' ';
            }
478
479
480
481
        }
        return $attribute;
    }

482

483
    /**
484
485
     * Set corresponding html attributes readonly/required/disabled, based on $formElement['mode'].
     *
486
487
488
489
     * @param array $formElement
     * @return string
     * @throws UserException
     */
Carsten  Rose's avatar
Carsten Rose committed
490
    private function getAttributeMode(array $formElement) {
491
492
493
494
495
496
        $attribute = '';

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

        // Fill $itemKey & $itemValue
536
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
537
538
539

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

        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);
        }
564
565
566
        return $html;
    }

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

587
588
589
        if (count($formElement) < 20)
            throw new CodeException("Invalid (none or to small) Formelement", ERROR_MISSING_FORMELEMENT);

590
591
592
        $itemValue = $this->getItemsForEnumOrSet($formElement['name'], $fieldType);

        if (is_array($formElement['sql1'])) {
593
594
595
            if (count($formElement['sql1']) > 0) {
                $keys = array_keys($formElement['sql1'][0]);
                $itemKey = array_column($formElement['sql1'], 'id');
596

597
598
599
600
                // 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]);
                }
601

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

        if (count($itemKey) === 0) {
            $itemKey = $itemValue;
        }
622
623
624
625
626
627
628
629
630
631

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

        if (isset($formElement['emptyItemAtEnd'])) {
            $itemValue[] = '';
            $itemKey[] = '';
        }
632
633
634
    }

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

        $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:
676
     *
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
     *    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);
        }

    }

    /**
712
713
     * Build a Checkbox based on two values.
     *
714
715
716
717
718
719
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attribute
     * @param $value
     * @return string
     */
720
    public function buildCheckboxSingle(array $formElement, $htmlFormElementId, $attribute, $value) {
721
        $html = '';
722

Carsten  Rose's avatar
Carsten Rose committed
723
724
        $attribute .= $this->getAttribute('name', $htmlFormElementId);
        $attribute .= $this->getAttribute('value', $formElement['checked'], false);
725
        if ($formElement['checked'] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
726
            $attribute .= $this->getAttribute('checked', 'checked');
727
728
        }

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

731
        $html = $this->buildNativeHidden($htmlFormElementId, $formElement['unchecked']);
732
733
734
735
736
737
738
739
740
741

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

        return $html;
    }

    /**
742
743
744
745
746
747
748
749
750
751
752
753
     * 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
754
755
756
757
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attributeBase
     * @param $value
758
759
     * @param array $itemKey
     * @param array $itemValue
760
761
     * @return string
     */
762
    public function buildCheckboxMulti(array $formElement, $htmlFormElementId, $attributeBase, $value, array $itemKey, array $itemValue) {
763
764
765
        // Defines which of the checkboxes will be checked.
        $values = explode($value, ',');

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

768
        $html = $this->buildNativeHidden($htmlFormElementId, $value);
769
770
771
772
773
774
775
776
777
778
779

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

796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
    /**
     * 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);
    }

812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
    /**
     * 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
     */
827
    public function buildRadio(array $formElement, $htmlFormElementId, $value) {
828
829
830
831
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
832
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
833

Carsten  Rose's avatar
Carsten Rose committed
834
835
836
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('name', $htmlFormElementId);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
837
838
839
840

        $jj = 0;
        $flagFirst = true;

841
        $html = $this->buildNativeHidden($htmlFormElementId, $value);
842
843
844
845
846
847
        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
848
                    $attribute .= $this->getAttribute('autofocus', $formElement['autofocus']);
849
850
            }

Carsten  Rose's avatar
Carsten Rose committed
851
            $attribute .= $this->getAttribute('value', $itemKey[$ii]);
852
            if ($itemKey[$ii] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
853
                $attribute .= $this->getAttribute('checked', 'checked');
854
            }
855
856
857
858
859
860
861
862
863
864
865

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

866
867
868
869
870
871
872
873
            if ($jj === $formElement['maxLength']) {
                $jj = 0;
                $html .= '<br>';
            }
        }
        return $html;
    }

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

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

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

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

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

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

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

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

Carsten  Rose's avatar
Carsten Rose committed
915
916
917
918
919
920
921
922
923
924
    /**
     * Constuct a HTML table of the subrecord data.
     * Column syntax definition: https://wikiit.math.uzh.ch/it/projekt/qfq/qfq-jqwidgets/Documentation#Type:_subrecord
     *
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return string
     * @throws UserException
     */
925
    public function buildSubrecord(array $formElement, $htmlFormElementId, $value) {
926
927
        $html = '';

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

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

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

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

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

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

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

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

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

966
        return $html;
967
968
    }

Carsten  Rose's avatar
Carsten Rose committed
969
    /**
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
     * Get various column format information based on the 'raw' column title. The attributes are separated by '|' and specified as 'key' or 'key=value'.
     *
     * - Return all parsed values as an assoc array.
     * - For regular columns: If there is no 'width' specified, take the default 'SUBRECORD_COLUMN_WIDTH'
     * - For 'icon /  url / mailto': no width limit.
     *
     * Returned assoc array:
     *  title      Only key. Element is non numeric, which is not a keyword 'width/nostrip/icon/url/mailto'
     *  width      Key/Value Pair. Not provided for 'icon/url/mailto'.
     *  nostrip    Only key. Do not strip HTML Tags from the content.
     *  icon       Only key. Value will rendered (later) as an image.
     *  url        Only key. Value will rendered (later) as a 'href'
     *  mailto     Only key. Value will rendered (later) as a 'href mailto'
     *
     *
Carsten  Rose's avatar
Carsten Rose committed
985
986
987
988
     * @param $titleRaw
     * @return array
     * @throws UserException
     */
989
    private function getSubrecordColumnControl(array $titleRaw) {
Carsten  Rose's avatar
Carsten Rose committed
990
991
        $control = array();

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

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

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

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

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

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

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

        $queryStringArray = [
            'form' => $formElement['form'],
1054
            'r' => $targetRecordId
1055
1056
1057
1058
1059
1060
        ];

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

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

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

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

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

    }

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

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

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

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

        return $cell;
    }

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

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

Carsten  Rose's avatar
Carsten Rose committed
1160
1161
1162
1163
1164
1165
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @throws UserException
     */
1166
    public function buildGridJQW(array $formElement, $htmlFormElementId, $value) {