AbstractBuildForm.php 27.1 KB
Newer Older
1
2
3
4
5
<?php

namespace qfq;

use qfq;
6
7
8
use qfq\store\Store;
use qfq\exceptions\UserException;
use qfq\helper\OnArray;
9
10
11
12

require_once(__DIR__ . '/../qfq/store/Store.php');
require_once(__DIR__ . '/../qfq/Constants.php');
require_once(__DIR__ . '/../qfq/exceptions/DbException.php');
13
require_once(__DIR__ . '/../qfq/exceptions/UserException.php');
14
15
16
17
18
19
20
21
require_once(__DIR__ . '/../qfq/Database.php');

/**
 * Created by PhpStorm.
 * User: crose
 * Date: 1/6/16
 * Time: 8:02 PM
 */
22
abstract class AbstractBuildForm {
23
24
25
    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
26
    protected $store = null;
Carsten  Rose's avatar
Carsten Rose committed
27
    protected $evaluate = null;
28
29
    protected $buildElementFunctionName = array();
    protected $pattern = array();
30
    protected $wrap = array();
31

32
33
34
35
36
    public function __construct(array $formSpec, array $feSpecAction, array $feSpecNative) {
        $this->formSpec = $formSpec;
        $this->feSpecAction = $feSpecAction;
        $this->feSpecNative = $feSpecNative;
        $this->store = Store::getInstance();
37
        $this->db = new Database();
Carsten  Rose's avatar
Carsten Rose committed
38
        $this->evaluate = new Evaluate($this->store, $this->db);
39
40
//        $sip = $this->store->getVar(CLIENT_SIP, STORE_CLIENT);

41
        $this->fillWrap();
42
43
44

        $this->buildElementFunctionName = [
            'checkbox' => 'Checkbox',
45
46
            'dateJQW' => 'DateJQW',
            'datetimeJQW' => 'DateJQW',
47
48
49
50
51
52
53
54
            'email' => 'Input',
            'gridJQW' => 'GridJQW',
            'hidden' => 'Hidden',
            'input' => 'Input',
            'note' => 'Note',
            'password' => 'Input',
            'radio' => 'Radio',
            'select' => 'Select',
55
            'subrecord' => 'Subrecord',
Carsten  Rose's avatar
Carsten Rose committed
56
            'upload' => 'File',
57
58
59
60
61
62
63
64
65
            'url' => 'Input'
        ];

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

67
68
    }

69
70
    abstract public function fillWrap();

71
72
73
74
75
76
77
78
79
    /**
     * @return string The whole form as HTML
     * @throws exceptions\CodeException
     * @throws exceptions\DbException
     */
    public function process() {

        $html = $this->head();

80
        $filter = $this->getProcessFilter();
81

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

84
85
86
            $parentRecords = $this->db->sql($this->formSpec['multiSql']);
            foreach ($parentRecords as $row) {
                $this->store->setVarArray($row, STORE_PARENT_RECORD);
87
                $html .= $this->elements($row['_id'], $filter);
88
89
            }
        } else {
90
            $html .= $this->elements($this->store->getVar(SIP_RECORD_ID, STORE_SIP), $filter);
91
92
        }

93
        // close the form
94
95
        $html .= $this->tail();

96
        $html .= $this->doSubrecords();
97

98
99
100
        return $html;
    }

101
    abstract public function head();
102

103
    abstract public function getProcessFilter();
104
105
106

    /**
     * @param $recordId
107
     * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD
108
109
110
111
     * @return string
     * @throws exceptions\CodeException
     * @throws exceptions\DbException
     */
112
    public function elements($recordId, $filter = FORM_ELEMENTS_NATIVE) {
113
114
115
        $html = '';

        // get current data record
116
        if ($recordId > 0 && $this->store->getVar('id', STORE_RECORD) === false) {
117
            $row = $this->db->sql("SELECT * FROM " . $this->formSpec['tableName'] . " WHERE id = ?", ROW_REGULAR, array($recordId));
118
119
            $this->store->setVarArray($row[0], STORE_RECORD);
        }
120
121
122

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

124
125
            if (($filter === FORM_ELEMENTS_NATIVE && $fe['type'] === 'subrecord') ||
                ($filter === FORM_ELEMENTS_SUBRECORD && $fe['type'] !== 'subrecord')
126
127
128
129
            ) {
                continue; // skip this FE
            }

130
131
132
133
134
135
            // Log / Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, $fe['name'] . ' / ' . $fe['id'], STORE_SYSTEM);

            // evaluate current FormElement
            $formElement = $this->evaluate->parseArray($fe);

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

139
            $htmlFormElementId = $formElement['name'] . ':' . $recordId;
140

141
            $html .= $this->wrapElement($htmlFormElementId, $formElement, $value);
142
        }
143

144
145
146
        return $html;
    }

147
    abstract public function wrapElement($htmlFormElementId, $formElement, $value);
148

149
150
151
    abstract public function tail();

    abstract public function doSubrecords();
152

153
    /**
154
155
156
     * @param $item
     * @param $value
     * @param bool|false $flagOmitEmpty
157
158
     * @return string
     */
159
160
161
162
    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];
163
164
    }

165
    /**
166
167
     * @param array $htmlFormElementId
     * @param $label
168
169
     * @return string
     */
170
171
172
173
    public function buildLabel($htmlFormElementId, $label) {
        $html = '<label for="' . $htmlFormElementId . '">' . $label . '</label>';

        return $html;
174
175
    }

176
177
178
179
180
181
182
183
184
185
186
187
188
    /**
     * 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
     */
189
    public function buildInput(array $formElement, $htmlFormElementId, $value) {
190

Carsten  Rose's avatar
Carsten Rose committed
191
        $attribute = $this->getAttribute('name', $htmlFormElementId);
192
193
194
195
196
197
198
199
200
        $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
201
202
            $attribute .= $this->getAttribute('cols', $colsRows[0]);
            $attribute .= $this->getAttribute('rows', $colsRows[1]);
203
204

        } else {
205
            $attribute .= $this->getAttributeList($formElement, ['type', 'size', 'maxLength']);
Carsten  Rose's avatar
Carsten Rose committed
206
        }
207
        // 'maxLength' needs an upper 'L': naming convention for DB tables!
208
        $attribute .= $this->getAttributeList($formElement, ['autocomplete', 'autofocus', 'placeholder']);
209
210
211
212

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

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

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

217
        $attribute .= $this->getAttribute('value', htmlentities($value), false);
218
219
220
221
222
223
224
225
226
227

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

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

232
233
234
235
236
237
238
239
240
241
242
243
        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
244
    private function getAttributeList(array $formElement, array $attributeList) {
245
246
247
        $attribute = '';
        foreach ($attributeList as $item) {
            if (isset($formElement[$item]))
Carsten  Rose's avatar
Carsten Rose committed
248
                $attribute .= $this->getAttribute(strtolower($item), $formElement[$item]);
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
        }
        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
268
    private function getInputCheckPattern($type, $data) {
269
270
        if ($type === '') {
            return '';
271
        }
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289

        $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
290
    private function getAttributeMode(array $formElement) {
291
292
293
294
295
296
        $attribute = '';

        switch ($formElement['mode']) {
            case 'show':
                break;
            case 'readonly':
Carsten  Rose's avatar
Carsten Rose committed
297
                $attribute .= $this->getAttribute('readonly', 'readonly');
298
299
                break;
            case 'required':
Carsten  Rose's avatar
Carsten Rose committed
300
                $attribute .= $this->getAttribute('required', 'required');
301
302
303
304
                break;
            case 'lock':
                break;
            case 'disabled':
Carsten  Rose's avatar
Carsten Rose committed
305
                $attribute .= $this->getAttribute('disabled', 'disabled');
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
                break;
            default:
                $this->store->setVar(SYSTEM_FORM_ELEMENT, $formElement['name'] . ' / ' . $formElement['id'], STORE_SYSTEM);
                $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, 'mode', STORE_SYSTEM);
                throw new UserException("Unexpected mode '" . $formElement['mode'] . "'");
                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
     */
331
    public function buildCheckbox(array $formElement, $htmlFormElementId, $value) {
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
        $itemKey = array();
        $itemValue = array();

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

        // Get fallback, if 'checkBoxMode' is not defined:
        if (!isset($formElement['checkBoxMode'])) {
            // This fallback is problematic if 'set' or 'enum' has 2 elements: defaults to single but maybe multi is meant.
            $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
351
352
353
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('name', $htmlFormElementId);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
354
355
356
357
358
359
360
361
362
363
364
365

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

366
367
368
        return $html;
    }

369
    /**
Carsten  Rose's avatar
Carsten Rose committed
370
     * Look for key/value list in `sql1`, `parameter:itemList`, column definition (in this order, first match counts)
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
     * Copies the found keys to &$itemKey and the values to &$itemValue
     *
     * @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'])) {
386
            $keys = array_keys($formElement['sql1'][0]);
387
388
            $itemKey = array_column($formElement['sql1'], 'id');

389
390
391
392
393
394
395
396
397
398
399
400
            // 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]);
            }

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

401
        } elseif (isset($formElement['itemList'])) {
Carsten  Rose's avatar
Carsten Rose committed
402
            $arr = qfq\helper\KeyValueStringParser::parse($formElement['itemList'], ':', ',', IF_VALUE_EMPTY_COPY_KEY);
403
404
405
            $itemValue = array_values($arr);
            $itemKey = array_keys($arr);
        } elseif ($fieldType === 'enum' || $fieldType === 'set') {
Carsten  Rose's avatar
Carsten Rose committed
406
            // already done at the beginning with '$this->getItemsForEnumOrSet($formElement['name'], $fieldType);'
407
        } else {
408
            throw new UserException("Missing definition (- nothing found in 'sql1', 'parameter:itemValues', 'enum-' or 'set-definition'", ERROR_MISSING_ITEM_VALUES);
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
        }

        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
     */
497
    public function buildCheckboxSingle(array $formElement, $htmlFormElementId, $attribute, $value) {
498

Carsten  Rose's avatar
Carsten Rose committed
499
500
        $attribute .= $this->getAttribute('name', $htmlFormElementId);
        $attribute .= $this->getAttribute('value', $formElement['checked'], false);
501
        if ($formElement['checked'] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
502
            $attribute .= $this->getAttribute('checked', 'checked');
503
504
        }

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

Carsten  Rose's avatar
Carsten Rose committed
507
        $html = $this->buildHidden($formElement, $htmlFormElementId, $formElement['unchecked']);
508
509
510
511
512
513
514
515
516

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

        return $html;
    }

517
518
519
520
521
522
523
524
525
526
    /**
     * @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) . '">';
    }

527
528
529
530
531
532
533
534
535
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attributeBase
     * @param $value
     * @param $itemKey
     * @param $itemValue
     * @return string
     */
536
    public function buildCheckboxMulti(array $formElement, $htmlFormElementId, $attributeBase, $value, $itemKey, $itemValue) {
537
538
539
        // Defines which of the checkboxes will be checked.
        $values = explode($value, ',');

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

Carsten  Rose's avatar
Carsten Rose committed
542
        $html = $this->buildHidden($formElement, $htmlFormElementId, $value);
543
544
545
546
547
548
549
550
551
552
553

        $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
554
                    $attribute .= $this->getAttribute('autofocus', $formElement['autofocus']);
555
            }
Carsten  Rose's avatar
Carsten Rose committed
556
            $attribute .= $this->getAttribute('value', $item);
557
            if ($item === $values[$jj]) {
Carsten  Rose's avatar
Carsten Rose committed
558
                $attribute .= $this->getAttribute('checked', 'checked');
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
            }
            $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
     */
585
    public function buildRadio(array $formElement, $htmlFormElementId, $value) {
586
587
588
589
590
591
        $itemKey = array();
        $itemValue = array();

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

Carsten  Rose's avatar
Carsten Rose committed
592
593
594
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('name', $htmlFormElementId);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
595
596
597
598

        $jj = 0;
        $flagFirst = true;

Carsten  Rose's avatar
Carsten Rose committed
599
        $html = $this->buildHidden($formElement, $htmlFormElementId, $value);
600
601
602
603
604
605
        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
606
                    $attribute .= $this->getAttribute('autofocus', $formElement['autofocus']);
607
608
            }

Carsten  Rose's avatar
Carsten Rose committed
609
            $attribute .= $this->getAttribute('value', $itemKey[$ii]);
610
            if ($itemKey[$ii] === $value) {
Carsten  Rose's avatar
Carsten Rose committed
611
                $attribute .= $this->getAttribute('checked', 'checked');
612
613
614
615
616
617
618
619
620
621
622
            }
            $html .= '<input ' . $attribute . '>';
            $html .= $itemValue[$ii];
            if ($jj === $formElement['maxLength']) {
                $jj = 0;
                $html .= '<br>';
            }
        }
        return $html;
    }

Carsten  Rose's avatar
Carsten Rose committed
623
624
625
626
627
628
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
629
    public function buildSelect(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
630
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
657
658
659
660
661
662
663
664
        $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 = '';

        if (isset($formElement['emptyItemAtStart']))
            $option = '<option></option>';

        for ($ii = 0; $ii < count($itemValue); $ii++) {
            $option .= '<option ';

            $option .= $this->getAttribute('value', $itemKey[$ii]);
            if ($itemKey[$ii] === $value) {
                $attribute .= 'selected ';
            }

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

        if (isset($formElement['emptyItemAtEnd']))
            $option = '<option></option>';

        return '<select ' . $attribute . '>' . $option . '</select>';
665
666
    }

Carsten  Rose's avatar
Carsten Rose committed
667
668
669
670
671
672
673
674
675
676
    /**
     * 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
     */
677
    public function buildSubrecord(array $formElement, $htmlFormElementId, $value) {
678
679
        $html = '';

Carsten  Rose's avatar
Carsten Rose committed
680
681
682
683
684
685
        if (!is_array($formElement['sql1'])) {
            throw new UserException('Missing \'sql1\' Query', ERROR_MISSING_SQL1);
        }

        // construct column attributes
        $control = $this->getSubrecordColumnControl(array_keys($formElement['sql1'][0]));
686
687
//        $html .= '<b>' . $formElement['label'] . '</b>';
        $html .= '<table border="1">';
Carsten  Rose's avatar
Carsten Rose committed
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
        $html .= '<tr><th>' . implode('</th><th>', $control['title']) . '</th></tr>';
        foreach ($formElement['sql1'] as $row) {
            $html .= '<tr>';
            foreach ($row as $col => $value) {
                if (isset($control['icon'][$col])) {
                    $cell = ($value === '') ? '' : "<image src='fileadmin/icons/$value'>";
                } else {
                    $cell = isset($control['nostrip'][$col]) ? $value : strip_tags($value);
                    $cell = substr($cell, 0, $control['width'][$col]);
                }
                $html .= "<td>$cell</td>";
            }
            $html .= '</tr>';
        }
        $html .= '</table>';

704
        return $html;
705
706
    }

Carsten  Rose's avatar
Carsten Rose committed
707
708
709
710
711
712
713
714
    /**
     * @param $titleRaw
     * @return array
     * @throws UserException
     */
    private function getSubrecordColumnControl($titleRaw) {
        $control = array();

715
        foreach ($titleRaw AS $col) {
Carsten  Rose's avatar
Carsten Rose committed
716
717
718
            $control['width'][$col] = SUBRECORD_COLUMN_WIDTH;

            // a) 'City@width=40', b) 'Status@icon', c) 'Mailto@width=80@nostrip'
719
720
721
            $arr = qfq\helper\KeyValueStringParser::parse($col, '=', '@', IF_VALUE_EMPTY_COPY_KEY);
            foreach ($arr as $attribute => $value) {
                switch ($attribute) {
Carsten  Rose's avatar
Carsten Rose committed
722
723
724
725
726
                    case 'width':
                    case 'nostrip':
                    case 'icon':
                        break;
                    default:
727
                        $attribute = 'title';
Carsten  Rose's avatar
Carsten Rose committed
728
729
                        break;
                }
730
                $control[$attribute][$col] = $value;
Carsten  Rose's avatar
Carsten Rose committed
731
            }
732
733
            // Limit title length
            $control['title'][$col] = substr($control['title'][$col], 0, $control['width'][$col]);
Carsten  Rose's avatar
Carsten Rose committed
734
735
        }
        return $control;
736
737
    }

Carsten  Rose's avatar
Carsten Rose committed
738
739
740
741
742
743
744
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return string
     * @throws UserException
     */
745
    public function buildFile(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760

        $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
     */
761
    public function buildDateJQW(array $formElement, $htmlFormElementId, $value) {
762
763
764
765
        // TODO: implement
        throw new UserException("Not implemented yet: buildDateJQW()");
    }

Carsten  Rose's avatar
Carsten Rose committed
766
767
768
769
770
771
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @throws UserException
     */
772
    public function buildGridJQW(array $formElement, $htmlFormElementId, $value) {
773
774
775
        // TODO: implement
        throw new UserException("Not implemented yet: buildGridJQW()");
    }
Carsten  Rose's avatar
Carsten Rose committed
776
777
778
779
780
781
782

    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
783
    public function buildNote(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
784
785
786
        return $value;
    }

787
}