AbstractBuildForm.php 27.2 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
12
13
use qfq\store\Store;
use qfq\exceptions\UserException;
use qfq\helper\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
20
21
require_once(__DIR__ . '/../qfq/Database.php');

/**
Carsten  Rose's avatar
Carsten Rose committed
22
23
 * Class AbstractBuildForm
 * @package qfq
24
 */
25
abstract class AbstractBuildForm {
26
27
28
    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
29
    protected $store = null;
Carsten  Rose's avatar
Carsten Rose committed
30
    protected $evaluate = null;
31
32
    protected $buildElementFunctionName = array();
    protected $pattern = array();
33
    protected $wrap = array();
34

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

44
        $this->fillWrap();
45
46
47

        $this->buildElementFunctionName = [
            'checkbox' => 'Checkbox',
48
49
            'dateJQW' => 'DateJQW',
            'datetimeJQW' => 'DateJQW',
50
51
52
53
54
55
56
57
            'email' => 'Input',
            'gridJQW' => 'GridJQW',
            'hidden' => 'Hidden',
            'input' => 'Input',
            'note' => 'Note',
            'password' => 'Input',
            'radio' => 'Radio',
            'select' => 'Select',
58
            'subrecord' => 'Subrecord',
Carsten  Rose's avatar
Carsten Rose committed
59
            'upload' => 'File',
60
61
62
63
64
65
66
67
68
            '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
69

70
71
    }

72
73
    abstract public function fillWrap();

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

        $html = $this->head();

83
        $filter = $this->getProcessFilter();
84

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

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

96
        // close the form
97
98
        $html .= $this->tail();

99
        $html .= $this->doSubrecords();
100

101
102
103
        return $html;
    }

104
    abstract public function head();
105

106
    abstract public function getProcessFilter();
107
108
109

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

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

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

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

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

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

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

142
            $htmlFormElementId = $formElement['name'] . ':' . $recordId;
143

144
            $html .= $this->wrapElement($htmlFormElementId, $formElement, $value);
145
        }
146

147
148
149
        return $html;
    }

150
    abstract public function wrapElement($htmlFormElementId, $formElement, $value);
151

152
153
154
    abstract public function tail();

    abstract public function doSubrecords();
155

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

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

        return $html;
177
178
    }

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

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

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

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

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

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

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

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

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

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

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

        switch ($formElement['mode']) {
            case 'show':
                break;
            case 'readonly':
Carsten  Rose's avatar
Carsten Rose committed
300
                $attribute .= $this->getAttribute('readonly', 'readonly');
301
302
                break;
            case 'required':
Carsten  Rose's avatar
Carsten Rose committed
303
                $attribute .= $this->getAttribute('required', 'required');
304
305
306
307
                break;
            case 'lock':
                break;
            case 'disabled':
Carsten  Rose's avatar
Carsten Rose committed
308
                $attribute .= $this->getAttribute('disabled', 'disabled');
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
                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
     */
334
    public function buildCheckbox(array $formElement, $htmlFormElementId, $value) {
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
        $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
354
355
356
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('name', $htmlFormElementId);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
357
358
359
360
361
362
363
364
365
366
367
368

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

369
370
371
        return $html;
    }

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

392
393
394
395
396
397
398
399
400
401
402
403
            // 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]);
            }

404
        } elseif (isset($formElement['itemList'])) {
Carsten  Rose's avatar
Carsten Rose committed
405
            $arr = qfq\helper\KeyValueStringParser::parse($formElement['itemList'], ':', ',', IF_VALUE_EMPTY_COPY_KEY);
406
407
408
            $itemValue = array_values($arr);
            $itemKey = array_keys($arr);
        } elseif ($fieldType === 'enum' || $fieldType === 'set') {
Carsten  Rose's avatar
Carsten Rose committed
409
            // already done at the beginning with '$this->getItemsForEnumOrSet($formElement['name'], $fieldType);'
410
        } else {
411
            throw new UserException("Missing definition (- nothing found in 'sql1', 'parameter:itemValues', 'enum-' or 'set-definition'", ERROR_MISSING_ITEM_VALUES);
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
497
498
499
        }

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

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

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

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

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

        return $html;
    }

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

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

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

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

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

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

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

        $jj = 0;
        $flagFirst = true;

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

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

Carsten  Rose's avatar
Carsten Rose committed
626
627
628
629
630
631
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
632
    public function buildSelect(array $formElement, $htmlFormElementId, $value) {
Carsten  Rose's avatar
Carsten Rose committed
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
665
666
667
        $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>';
668
669
    }

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

Carsten  Rose's avatar
Carsten Rose committed
683
684
685
686
687
688
        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]));
689
690
//        $html .= '<b>' . $formElement['label'] . '</b>';
        $html .= '<table border="1">';
Carsten  Rose's avatar
Carsten Rose committed
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
        $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>';

707
        return $html;
708
709
    }

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

718
        foreach ($titleRaw AS $col) {
Carsten  Rose's avatar
Carsten Rose committed
719
720
721
            $control['width'][$col] = SUBRECORD_COLUMN_WIDTH;

            // a) 'City@width=40', b) 'Status@icon', c) 'Mailto@width=80@nostrip'
722
723
724
            $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
725
726
727
728
729
                    case 'width':
                    case 'nostrip':
                    case 'icon':
                        break;
                    default:
730
                        $attribute = 'title';
Carsten  Rose's avatar
Carsten Rose committed
731
732
                        break;
                }
733
                $control[$attribute][$col] = $value;
Carsten  Rose's avatar
Carsten Rose committed
734
            }
735
736
            // Limit title length
            $control['title'][$col] = substr($control['title'][$col], 0, $control['width'][$col]);
Carsten  Rose's avatar
Carsten Rose committed
737
738
        }
        return $control;
739
740
    }

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

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

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

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

790
}