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

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

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

23
24

/**
Carsten  Rose's avatar
Carsten Rose committed
25
26
 * Class AbstractBuildForm
 * @package qfq
27
 */
28
abstract class AbstractBuildForm {
29
30
31
    protected $formSpec = array();  // copy of the loaded form
    protected $feSpecAction = array(); // copy of all formElement.class='action' of the loaded form
    protected $feSpecNative = array(); // copy of all formElement.class='native' of the loaded form
32
    protected $store = null;
Carsten  Rose's avatar
Carsten Rose committed
33
    protected $evaluate = null;
34
35
    protected $buildElementFunctionName = array();
    protected $pattern = array();
36
    protected $wrap = array();
37

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

47
        // render mode specific
48
        $this->fillWrap();
49
50
51

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

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

86
87
88
89
90
91
        $this->inputCheckPattern = [
            'min|max' => 'min="%s"|max="%s"',
            'pattern' => 'pattern="%s"',
            'number' => 'pattern="^[0-9]*$"',
            'email' => 'pattern="^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\.[a-z]{2,4})$"'
        ];
Carsten  Rose's avatar
Carsten Rose committed
92

93
94
    }

95
96
    abstract public function fillWrap();

97
98
    /**
     * @return string The whole form as HTML
99
100
     * @throws CodeException
     * @throws DbException
101
102
103
104
105
     */
    public function process() {

        $html = $this->head();

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

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

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

119
120
//        $html .= $this->wrapItem(WRAP_SETUP_OUTER, $elementsHtml);

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

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

126
127
128
        return $html;
    }

129
    abstract public function head();
130

131
    abstract public function getProcessFilter();
132
133
134

    /**
     * @param $recordId
135
     * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD
136
     * @return string
137
138
     * @throws CodeException
     * @throws DbException
139
     */
140
    public function elements($recordId, $filter = FORM_ELEMENTS_NATIVE, $feIdContainer = 0) {
141
142
143
        $html = '';

        // get current data record
144
        if ($recordId > 0 && $this->store->getVar('id', STORE_RECORD) === false) {
145
            $row = $this->db->sql("SELECT * FROM " . $this->formSpec['tableName'] . " WHERE id = ?", ROW_REGULAR, array($recordId));
146
147
            $this->store->setVarArray($row[0], STORE_RECORD);
        }
148
149
150

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

152
153
            if (($filter === FORM_ELEMENTS_NATIVE && $fe['type'] === 'subrecord') ||
                ($filter === FORM_ELEMENTS_SUBRECORD && $fe['type'] !== 'subrecord')
154
155
156
157
            ) {
                continue; // skip this FE
            }

158
159
160
161
            // Log / Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, $fe['name'] . ' / ' . $fe['id'], STORE_SYSTEM);

            // evaluate current FormElement
162
163
164
165
166
            $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);
            }
167

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

171
            $htmlFormElementId = $formElement['name'] . ':' . $recordId;
172

173
174
175
176
177
178
179
180
181
182
            // 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);
183
        }
184

185
186
187
        return $html;
    }

188
189
190
    abstract public function tail();

    abstract public function doSubrecords();
191

192
193
194
195
196
197
198
199
    abstract public function buildRowNative($formElement, $elementHtml);

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

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

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

200
    /**
201
202
203
     * @param $item
     * @param $value
     * @param bool|false $flagOmitEmpty
204
205
     * @return string
     */
206
207
208
209
    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];
210
211
    }

212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
    /**
     * @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;
    }

229
    /**
230
231
     * @param array $htmlFormElementId
     * @param $label
232
233
     * @return string
     */
234
235
236
237
    public function buildLabel($htmlFormElementId, $label) {
        $html = '<label for="' . $htmlFormElementId . '">' . $label . '</label>';

        return $html;
238
239
    }

240
241
242
243
244
245
246
247
248
249
250
251
252
    /**
     * 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
     */
253
    public function buildInput(array $formElement, $htmlFormElementId, $value) {
254

Carsten  Rose's avatar
Carsten Rose committed
255
        $attribute = $this->getAttribute('name', $htmlFormElementId);
256
257
258
259
260
261
262
263
264
        $htmlTag = '<input';
        $htmlTagClosing = '';

        // Check for input type 'textarea'
        $colsRows = explode(',', $formElement['size']);
        if (count($colsRows) === 2) {
            $htmlTag = '<textarea';
            $htmlTagClosing = '</textarea>';

Carsten  Rose's avatar
Carsten Rose committed
265
266
            $attribute .= $this->getAttribute('cols', $colsRows[0]);
            $attribute .= $this->getAttribute('rows', $colsRows[1]);
267
268

        } else {
269
            $attribute .= $this->getAttributeList($formElement, ['type', 'size', 'maxLength']);
Carsten  Rose's avatar
Carsten Rose committed
270
        }
271
        // 'maxLength' needs an upper 'L': naming convention for DB tables!
272
        $attribute .= $this->getAttributeList($formElement, ['autocomplete', 'autofocus', 'placeholder']);
273
274
275
276

        if ($formElement['type'] === 'email' && $formElement['checkType'] === '')
            $formElement['checkType'] = 'email';

Carsten  Rose's avatar
Carsten Rose committed
277
        $attribute .= $this->getInputCheckPattern($formElement['checkType'], $formElement['checkPattern']);
278

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

281
        $attribute .= $this->getAttribute('value', htmlentities($value), false);
282
283
284
285
286
287
288
289
290
291

        return "$htmlTag $attribute>$htmlTagClosing";
    }

    /**
     * @param $type
     * @param $value
     * @param bool|false $flagOmitEmpty
     * @return string
     */
Carsten  Rose's avatar
Carsten Rose committed
292
    private function getAttribute($type, $value, $flagOmitEmpty = true) {
293
294
        if ($flagOmitEmpty && $value === "")
            return '';
Carsten  Rose's avatar
Carsten Rose committed
295

296
297
298
299
300
301
302
303
304
305
306
307
        return "$type=\"$value\" ";
    }

    /**
     * Builds a HTML attribute list, based on  $attributeList.
     * 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
308
    private function getAttributeList(array $formElement, array $attributeList) {
309
310
311
        $attribute = '';
        foreach ($attributeList as $item) {
            if (isset($formElement[$item]))
Carsten  Rose's avatar
Carsten Rose committed
312
                $attribute .= $this->getAttribute(strtolower($item), $formElement[$item]);
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
        }
        return $attribute;
    }

    /**
     * Construct HTML Input attribute for Client Validation:
     *   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
     */
Carsten  Rose's avatar
Carsten Rose committed
332
    private function getInputCheckPattern($type, $data) {
333
334
        if ($type === '') {
            return '';
335
        }
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353

        $attribute = '';

        $arrAttr = explode("|", $type);
        $arrData = explode("|", $data);

        for ($ii = 0; $ii < count($arrAttr); $ii++) {
            if ($arrAttr[$ii])
                $attribute .= str_replace('%s', $arrData[$ii], $arrAttr[$ii]) . ' ';
        }
        return $attribute;
    }

    /**
     * @param array $formElement
     * @return string
     * @throws UserException
     */
Carsten  Rose's avatar
Carsten Rose committed
354
    private function getAttributeMode(array $formElement) {
355
356
357
358
359
360
        $attribute = '';

        switch ($formElement['mode']) {
            case 'show':
                break;
            case 'readonly':
Carsten  Rose's avatar
Carsten Rose committed
361
                $attribute .= $this->getAttribute('readonly', 'readonly');
362
363
                break;
            case 'required':
Carsten  Rose's avatar
Carsten Rose committed
364
                $attribute .= $this->getAttribute('required', 'required');
365
366
367
368
                break;
            case 'lock':
                break;
            case 'disabled':
Carsten  Rose's avatar
Carsten Rose committed
369
                $attribute .= $this->getAttribute('disabled', 'disabled');
370
371
372
373
                break;
            default:
                $this->store->setVar(SYSTEM_FORM_ELEMENT, $formElement['name'] . ' / ' . $formElement['id'], STORE_SYSTEM);
                $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, 'mode', STORE_SYSTEM);
374
                throw new UserException("Unknown mode '" . $formElement['mode'] . "'", ERROR_UNKNOWN_MODE);
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
                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
     */
395
    public function buildCheckbox(array $formElement, $htmlFormElementId, $value) {
396
397
398
399
400
401
402
403
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
        $this->extractKeyValueList($formElement, $itemKey, $itemValue);

        // Get fallback, if 'checkBoxMode' is not defined:
        if (!isset($formElement['checkBoxMode'])) {
404
            // This fallback is problematic if 'set' or 'enum' has 2 : defaults to single but maybe multi is meant.
405
406
407
408
409
410
411
412
413
414
            $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
415
416
417
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('name', $htmlFormElementId);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
418
419
420
421
422
423
424
425
426
427
428
429

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

430
431
432
        return $html;
    }

433
    /**
434
435
436
437
438
     * Look for key/value list (in this order, first match counts) in
     *  a) `sql1`
     *  b) `parameter:itemList`
     *  c) table.column definition
     *
439
     * Copies the found keys to &$itemKey and the values to &$itemValue
440
     * If there are no &$itemKey, copy &$itemValue to &$itemKey.
441
442
443
444
445
446
447
448
449
450
451
452
453
454
     *
     * @param array $formElement
     * @param $itemKey
     * @param $itemValue
     * @throws UserException
     */
    private function extractKeyValueList(array $formElement, &$itemKey, &$itemValue) {
        $fieldType = '';
        $itemKey = array();
        $itemValue = array();

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

        if (is_array($formElement['sql1'])) {
455
456
457
            if (count($formElement['sql1']) > 0) {
                $keys = array_keys($formElement['sql1'][0]);
                $itemKey = array_column($formElement['sql1'], 'id');
458

459
460
461
462
                // 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]);
                }
463

464
465
466
467
468
469
                $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]);
                }
470
            }
471
        } elseif (isset($formElement['itemList'])) {
472
473
474
475
476
            if (count($formElement['itemList']) > 0) {
                $arr = KeyValueStringParser::parse($formElement['itemList'], ':', ',', IF_VALUE_EMPTY_COPY_KEY);
                $itemValue = array_values($arr);
                $itemKey = array_keys($arr);
            }
477
        } elseif ($fieldType === 'enum' || $fieldType === 'set') {
Carsten  Rose's avatar
Carsten Rose committed
478
            // already done at the beginning with '$this->getItemsForEnumOrSet($formElement['name'], $fieldType);'
479
        } else {
480
            throw new UserException("Missing definition (- nothing found in 'sql1', 'parameter:itemValues', 'enum-' or 'set-definition'", ERROR_MISSING_ITEM_VALUES);
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
        }

        if (count($itemKey) === 0) {
            $itemKey = $itemValue;
        }
    }

    /**
     * @param $column
     * @param $fieldType
     * @return array
     * @throws UserException
     */
    private function getItemsForEnumOrSet($column, &$fieldType) {

        // Get column definition
        $fieldTypeDefinition = $this->store->getVar($column, STORE_TABLE_COLUMN_TYPES);

        if ($fieldTypeDefinition === false) {
            throw new UserException("Column '$column' unknown in table '" . $this->formSpec['tableName'] . "'", ERROR_UNKNOWN_COLUMN);
        }

        $length = strlen($fieldTypeDefinition);

        // enum('...   set('
        switch (substr($fieldTypeDefinition, 0, 4)) {
            case 'enum':
                $startPosition = 5;
                break;
            case 'set(':
                $startPosition = 4;
                break;
            default:
                $fieldType = 'string';
                return array();
        }

        // enum('a','b','c', ...)   >> [ 'a', 'b', 'c', ... ]
        // set('a','b','c', ...)   >> [ 'a', 'b', 'c', ... ]
        $items = OnArray::trimArray(explode(',', substr($fieldTypeDefinition, $startPosition, $length - $startPosition - 1)), "'");
        $fieldType = substr($fieldTypeDefinition, 0, $startPosition - 1);

        return $items;
    }

    /**
     * For CheckBox's with only one checkbox: if no parameter:checked|unchecked is defined, take defaults:
     *    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);
        }

    }

    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attribute
     * @param $value
     * @return string
     */
569
    public function buildCheckboxSingle(array $formElement, $htmlFormElementId, $attribute, $value) {
570

Carsten  Rose's avatar
Carsten Rose committed
571
572
        $attribute .= $this->getAttribute('name', $htmlFormElementId);
        $attribute .= $this->getAttribute('value', $formElement['checked'], false);
573
        if ($formElement['checked'] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
574
            $attribute .= $this->getAttribute('checked', 'checked');
575
576
        }

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

Carsten  Rose's avatar
Carsten Rose committed
579
        $html = $this->buildHidden($formElement, $htmlFormElementId, $formElement['unchecked']);
580
581
582
583
584
585
586
587
588

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

        return $html;
    }

589
590
591
592
593
594
595
596
597
598
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return string
     */
    public function buildHidden(array $formElement, $htmlFormElementId, $value) {
        return '<input type="hidden" name="' . $htmlFormElementId . '" value="' . htmlentities($value) . '">';
    }

599
600
601
602
603
604
605
606
607
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attributeBase
     * @param $value
     * @param $itemKey
     * @param $itemValue
     * @return string
     */
608
    public function buildCheckboxMulti(array $formElement, $htmlFormElementId, $attributeBase, $value, $itemKey, $itemValue) {
609
610
611
        // Defines which of the checkboxes will be checked.
        $values = explode($value, ',');

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

Carsten  Rose's avatar
Carsten Rose committed
614
        $html = $this->buildHidden($formElement, $htmlFormElementId, $value);
615
616
617
618
619
620
621
622
623
624
625

        $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
626
                    $attribute .= $this->getAttribute('autofocus', $formElement['autofocus']);
627
            }
Carsten  Rose's avatar
Carsten Rose committed
628
            $attribute .= $this->getAttribute('value', $item);
629
            if ($item === $values[$jj]) {
Carsten  Rose's avatar
Carsten Rose committed
630
                $attribute .= $this->getAttribute('checked', 'checked');
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
            }
            $html .= '<input ' . $attribute . '>';
            $html .= $itemValue[$ii];
            if ($ii === $formElement['maxLength']) {
                $ii = 0;
                $html .= '<br>';
            }
        }
        return $html;
    }

    /**
     * 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
     */
657
    public function buildRadio(array $formElement, $htmlFormElementId, $value) {
658
659
660
661
662
663
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
        $this->extractKeyValueList($formElement, $itemKey, $itemValue);

Carsten  Rose's avatar
Carsten Rose committed
664
665
666
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('name', $htmlFormElementId);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
667
668
669
670

        $jj = 0;
        $flagFirst = true;

Carsten  Rose's avatar
Carsten Rose committed
671
        $html = $this->buildHidden($formElement, $htmlFormElementId, $value);
672
673
674
675
676
677
        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
678
                    $attribute .= $this->getAttribute('autofocus', $formElement['autofocus']);
679
680
            }

Carsten  Rose's avatar
Carsten Rose committed
681
            $attribute .= $this->getAttribute('value', $itemKey[$ii]);
682
            if ($itemKey[$ii] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
683
                $attribute .= $this->getAttribute('checked', 'checked');
684
685
686
687
688
689
690
691
692
693
694
            }
            $html .= '<input ' . $attribute . '>';
            $html .= $itemValue[$ii];
            if ($jj === $formElement['maxLength']) {
                $jj = 0;
                $html .= '<br>';
            }
        }
        return $html;
    }

Carsten  Rose's avatar
Carsten Rose committed
695
696
697
698
699
700
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
701
    public function buildSelect(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
        $this->extractKeyValueList($formElement, $itemKey, $itemValue);

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

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

        $option = '';
718
        $selected = 'selected';
Carsten  Rose's avatar
Carsten Rose committed
719
720
721
722
723
        for ($ii = 0; $ii < count($itemValue); $ii++) {
            $option .= '<option ';

            $option .= $this->getAttribute('value', $itemKey[$ii]);
            if ($itemKey[$ii] === $value) {
724
725
                $option .= $selected;
                $selected = '';
Carsten  Rose's avatar
Carsten Rose committed
726
727
728
729
730
            }

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

731
732
733
734
735
        if (isset($formElement['emptyItemAtStart'])) {
            $option = "<option $selected></option>";
            $selected = '';
        }

Carsten  Rose's avatar
Carsten Rose committed
736
        if (isset($formElement['emptyItemAtEnd']))
737
            $option = "<option $selected></option>";
Carsten  Rose's avatar
Carsten Rose committed
738
739

        return '<select ' . $attribute . '>' . $option . '</select>';
740
741
    }

Carsten  Rose's avatar
Carsten Rose committed
742
743
744
745
746
747
748
749
750
751
    /**
     * 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
     */
752
    public function buildSubrecord(array $formElement, $htmlFormElementId, $value) {
753
754
        $html = '';

755
756
757
758
759
760
761
762
763

        $primaryRecord = $this->store->getStore(STORE_RECORD);

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

        $page = Support::getCurrentPage();

Carsten  Rose's avatar
Carsten Rose committed
764
765
766
767
        if (!is_array($formElement['sql1'])) {
            throw new UserException('Missing \'sql1\' Query', ERROR_MISSING_SQL1);
        }

768
769
770
771
772
773
774
775
776
        // No records?
        if (count($formElement['sql1']) == 0) {
            return '';
        }

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

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

780
781
//        $html .= '<b>' . $formElement['label'] . '</b>';
        $html .= '<table border="1">';
782
        $html .= '<tr><th></th><th>' . implode('</th><th>', $control['title']) . '</th></tr>';
Carsten  Rose's avatar
Carsten Rose committed
783
        foreach ($formElement['sql1'] as $row) {
784

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

788
789
            foreach ($row as $columnName => $value) {
                $html .= '<td>' . $this->formatColumn($control, $columnName, $value) . '</td>';
Carsten  Rose's avatar
Carsten Rose committed
790
791
792
793
794
            }
            $html .= '</tr>';
        }
        $html .= '</table>';

795
        return $html;
796
797
    }

Carsten  Rose's avatar
Carsten Rose committed
798
799
800
801
802
    /**
     * @param $titleRaw
     * @return array
     * @throws UserException
     */
803
    private function getSubrecordColumnControl(array $titleRaw) {
Carsten  Rose's avatar
Carsten Rose committed
804
805
        $control = array();

806
807
808
        foreach ($titleRaw AS $columnName) {
            $flagWidthLimit = true;
            $control['width'][$columnName] = SUBRECORD_COLUMN_WIDTH;
Carsten  Rose's avatar
Carsten Rose committed
809
810

            // a) 'City@width=40', b) 'Status@icon', c) 'Mailto@width=80@nostrip'
811
            $arr = KeyValueStringParser::parse($columnName, '=', '@', IF_VALUE_EMPTY_COPY_KEY);
812
813
            foreach ($arr as $attribute => $value) {
                switch ($attribute) {
Carsten  Rose's avatar
Carsten Rose committed
814
815
                    case 'width':
                    case 'nostrip':
816
                        break;
Carsten  Rose's avatar
Carsten Rose committed
817
                    case 'icon':
818
819
820
                    case 'url':
                    case 'mailto':
                        $flagWidthLimit = false;
Carsten  Rose's avatar
Carsten Rose committed
821
822
                        break;
                    default:
823
                        $attribute = is_numeric($value) ? 'width' : 'title';
Carsten  Rose's avatar
Carsten Rose committed
824
825
                        break;
                }
826
                $control[$attribute][$columnName] = $value;
Carsten  Rose's avatar
Carsten Rose committed
827
            }
828

829
            // Limit title length
830
831
832
833
834
835
            $control['title'][$columnName] = substr($control['title'][$columnName], 0, $control['width'][$columnName]);

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

Carsten  Rose's avatar
Carsten Rose committed
836
837
        }
        return $control;
838
839
    }

840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
    /**
     * @param $formElement
     * @param $page
     * @param $targetRecordId
     * @param $record
     * @return string
     * @throws UserException
     */
    private function editLink($formElement, $page, $targetRecordId, $record) {

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

        ];

        // Add custom query parameter
        if (isset($formElement['detail'])) {
            $detailParam = KeyValueStringParser::parse($formElement['detail']);
            foreach ($detailParam as $src => $dest) {
                if ($src[0] == '#') {
                    $queryStringArray[$dest] = substr($src, 1);
                    continue;
                }

                if (isset($record[$src])) {
                    $queryStringArray[$dest] = $record[$src];
                }
            }
        }

        Support::appendTypo3ParameterToArray($queryStringArray);

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

        $sip = $this->store->getSip();
        $url = $formElement['page'] . $sip->queryStringToSip($queryString);

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

    }

884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
    /**
     * @param array $control
     * @param $columnName
     * @param $value
     * @return string
     */
    private function formatColumn(array $control, $columnName, $value) {

        $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])) {
            $cell = "<a href='mailto:$cell'>$cell</a>";
        }

        if (isset($control['url'][$columnName])) {
            $cell = "<a href='$cell'>$cell</a>";
        }

        return $cell;
    }

Carsten  Rose's avatar
Carsten Rose committed
912
913
914
915
916
917
918
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return string
     * @throws UserException
     */
919
    public function buildFile(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934

        $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
     */
935
    public function buildDateJQW(array $formElement, $htmlFormElementId, $value) {
936
        // TODO: implement
937
        throw new UserException("Not implemented yet: buildDateJQW()", ERROR_NOT_IMPLEMENTED);
938
939
    }

Carsten  Rose's avatar
Carsten Rose committed
940
941
942
943
944
945
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @throws UserException
     */
946
    public function buildGridJQW(array $formElement, $htmlFormElementId, $value) {
947
        // TODO: implement
948
        throw new UserException("Not implemented yet: buildGridJQW()", ERROR_NOT_IMPLEMENTED);
949
    }
Carsten  Rose's avatar
Carsten Rose committed
950
951
952
953
954
955
956

    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
957
    public function buildNote(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
958
959
960
        return $value;
    }

961
962
963
964
965
966
967
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
    public function buildPill(array $formElement, $htmlFormElementId, $value) {
968
        return $value;
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
    }

    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
    public function buildFieldset(array $formElement, $htmlFormElementId, $value) {

        // save parent processed FE's
        $tmpStore = $this->feSpecNative;

        // <fieldset>
        $html = '<fieldset ' . $this->getAttribute('name', $htmlFormElementId) . '>';
984
        if ($formElement['label'] !== '') {
985
986
987
988
989
990
991
            $html .= '<legend>' . $formElement['label'] . '</legend>';
        }

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

        // child FE's
        $sql = SQL_FORM_ELEMENT;
992
        $this->feSpecNative = $this->db->sql($sql, ROW_REGULAR, ['yes', $this->formSpec["id"], 'native,container', $formElement['id']]);
993
        HelperFormElement::explodeFieldParameter($this->feSpecNative);
994
995
996
997
998
999
1000
1001
1002
1003
        $html .= $this->elements($this->store->getVar(SIP_RECORD_ID, STORE_SIP), FORM_ELEMENTS_NATIVE_SUBRECORD);


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

        $html .= '</fieldset>';

        // restore parent processed FE's
        $this->feSpecNative = $tmpStore;

1004
        return $html;
1005
1006
1007
    }


1008
}