FormBuildPlain.php 27.4 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
22
require_once(__DIR__ . '/../qfq/Database.php');

/**
 * Created by PhpStorm.
 * User: crose
 * Date: 1/6/16
 * Time: 8:02 PM
 */
class FormBuildPlain {
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

31
32
33
34
35
    public function __construct(array $formSpec, array $feSpecAction, array $feSpecNative) {
        $this->formSpec = $formSpec;
        $this->feSpecAction = $feSpecAction;
        $this->feSpecNative = $feSpecNative;
        $this->store = Store::getInstance();
36
        $this->db = new Database();
Carsten  Rose's avatar
Carsten Rose committed
37
        $this->evaluate = new Evaluate($this->store, $this->db);
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
//        $sip = $this->store->getVar(CLIENT_SIP, STORE_CLIENT);

        $this->wrap[WRAP_SETUP_TITLE][WRAP_SETUP_START] = '<h3>';
        $this->wrap[WRAP_SETUP_TITLE][WRAP_SETUP_END] = '</h3>';
        $this->wrap[WRAP_SETUP_ELEMENT][WRAP_SETUP_START] = '<p>';
        $this->wrap[WRAP_SETUP_ELEMENT][WRAP_SETUP_END] = '</p>';
        $this->wrap[WRAP_SETUP_LABEL][WRAP_SETUP_START] = '';
        $this->wrap[WRAP_SETUP_LABEL][WRAP_SETUP_END] = '';
        $this->wrap[WRAP_SETUP_INPUT][WRAP_SETUP_START] = '';
        $this->wrap[WRAP_SETUP_INPUT][WRAP_SETUP_END] = '';
        $this->wrap[WRAP_SETUP_NOTE][WRAP_SETUP_START] = '';
        $this->wrap[WRAP_SETUP_NOTE][WRAP_SETUP_END] = '';

        $this->buildElementFunctionName = [
            'checkbox' => 'Checkbox',
            'dateJQW' => 'dateJQW',
            'datetimeJQW' => 'dateJQW',
            'email' => 'Input',
            'gridJQW' => 'GridJQW',
            'hidden' => 'Hidden',
            'input' => 'Input',
            'note' => 'Note',
            'password' => 'Input',
            'radio' => 'Radio',
            'select' => 'Select',
            'subrecord' => 'subrecord',
Carsten  Rose's avatar
Carsten Rose committed
64
            'upload' => 'File',
65
66
67
68
69
70
71
72
73
            '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
74

75
76
    }

77
78
79
80
81
82
83
84
85
86
    /**
     * @return string The whole form as HTML
     * @throws exceptions\CodeException
     * @throws exceptions\DbException
     */
    public function process() {

        $html = $this->head();

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

88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
            $parentRecords = $this->db->sql($this->formSpec['multiSql']);
            foreach ($parentRecords as $row) {
                $this->store->setVarArray($row, STORE_PARENT_RECORD);
                $html .= $this->elements($row['_id']);
            }
        } else {
            $html .= $this->elements($this->store->getVar(SIP_RECORD_ID, STORE_SIP));
        }

        $html .= $this->tail();

        return $html;
    }

    /**
     * @return string
     */
105
    public function head() {
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
        $html = $this->wrapItem(WRAP_SETUP_TITLE, $this->formSpec['title'], true);
        $html .= '<form action="?" method="post" target="_top" accept-charset="UTF-8">';

        return $html;
    }

    /**
     * @param $item
     * @param $value
     * @param bool|false $flagOmitEmpty
     * @return string
     */
    private function wrapItem($item, $value, $flagOmitEmpty = false) {
        if ($flagOmitEmpty && $value === "")
            return '';
        return $this->wrap[$item][WRAP_SETUP_START] . $value . $this->wrap[$item][WRAP_SETUP_END];
    }

    /**
     * @param $recordId
     * @return string
     * @throws exceptions\CodeException
     * @throws exceptions\DbException
     */
    public function elements($recordId) {
        $html = '';

        // get current data record
        $row = $this->db->sql("SELECT * FROM `" . $this->formSpec['tableName'] . "` WHERE id = ?", ROW_REGULAR, array($recordId));
        $this->store->setVarArray($row, STORE_RECORD);

        // Iterate over all FormElements
        foreach ($this->feSpecNative as $fe) {
            // Log / Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, $fe['name'] . ' / ' . $fe['id'], STORE_SYSTEM);

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

            // Default Value
            $value = $formElement['value'] === '' ? $this->store->getVar($formElement['name']) : $value = $formElement['value'];
Carsten  Rose's avatar
Carsten Rose committed
147

148
            $htmlFormElementId = $formElement['name'] . ':' . $recordId;
149

150
151
152
153
154
155
156
157
158
159
160
            // Construct Marshaller Name
            $buildElementFunctionName = 'build' . $this->buildElementFunctionName[$formElement['type']];

            $html .= $this->wrap[WRAP_SETUP_ELEMENT][WRAP_SETUP_START];
            $html .= $this->wrapItem(WRAP_SETUP_LABEL, $this->buildLabel($htmlFormElementId, $formElement['label']));
            // Call Marschaller
            $html .= $this->wrapItem(WRAP_SETUP_INPUT, $this->$buildElementFunctionName($formElement, $htmlFormElementId, $value));
            $html .= $this->wrapItem(WRAP_SETUP_NOTE, $formElement['note']);
            $html .= $this->wrap[WRAP_SETUP_ELEMENT][WRAP_SETUP_END];

        }
161
162
163
        return $html;
    }

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

        return $html;
    }

175
176
177
178
    /**
     * @return string
     */
    public function tail() {
179
180
        $html = '';

181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
        $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);
        $sip = $this->store->getVar(CLIENT_SIP, STORE_CLIENT);
        $sipName = CLIENT_SIP . ':' . $recordId;
        $html .= '<input type="hidden" name="' . $sipName . '" value="' . $sip . '">';

        $html .= '<input type="submit" value="Submit"></form>';

        return $html;
    }

    /**
     * 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
     */
    private function buildInput(array $formElement, $htmlFormElementId, $value) {

Carsten  Rose's avatar
Carsten Rose committed
206
        $attribute = $this->getAttribute('name', $htmlFormElementId);
207
208
209
210
211
212
213
214
215
        $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
216
217
            $attribute .= $this->getAttribute('cols', $colsRows[0]);
            $attribute .= $this->getAttribute('rows', $colsRows[1]);
218
219

        } else {
Carsten  Rose's avatar
Carsten Rose committed
220
221
            $attribute .= $this->getAttribute('type', $formElement['type']);
            $attribute .= $this->getAttribute('size', $formElement['size']);
Carsten  Rose's avatar
Carsten Rose committed
222
        }
223
        // 'maxLength' needs an upper 'L': naming convention for DB tables!
Carsten  Rose's avatar
Carsten Rose committed
224
        $attribute .= $this->getAttributeList($formElement, ['autocomplete', 'autofocus', 'maxLength', 'placeholder']);
225
226
227
228

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

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

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

Carsten  Rose's avatar
Carsten Rose committed
233
        $attribute .= $this->getAttribute('value', addslashes($value), false);
234
235
236
237
238
239
240
241
242
243

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

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

248
249
250
251
252
253
254
255
256
257
258
259
        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
260
    private function getAttributeList(array $formElement, array $attributeList) {
261
262
263
        $attribute = '';
        foreach ($attributeList as $item) {
            if (isset($formElement[$item]))
Carsten  Rose's avatar
Carsten Rose committed
264
                $attribute .= $this->getAttribute(strtolower($item), $formElement[$item]);
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
        }
        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
284
    private function getInputCheckPattern($type, $data) {
285
286
        if ($type === '') {
            return '';
287
        }
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305

        $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
306
    private function getAttributeMode(array $formElement) {
307
308
309
310
311
312
        $attribute = '';

        switch ($formElement['mode']) {
            case 'show':
                break;
            case 'readonly':
Carsten  Rose's avatar
Carsten Rose committed
313
                $attribute .= $this->getAttribute('readonly', 'readonly');
314
315
                break;
            case 'required':
Carsten  Rose's avatar
Carsten Rose committed
316
                $attribute .= $this->getAttribute('required', 'required');
317
318
319
320
                break;
            case 'lock':
                break;
            case 'disabled':
Carsten  Rose's avatar
Carsten Rose committed
321
                $attribute .= $this->getAttribute('disabled', 'disabled');
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
                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
     */
    private function buildCheckbox(array $formElement, $htmlFormElementId, $value) {
        $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
367
368
369
        $attributeBase = $this->getAttributeMode($formElement);
        $attributeBase .= $this->getAttribute('name', $htmlFormElementId);
        $attributeBase .= $this->getAttribute('type', $formElement['type']);
370
371
372
373
374
375
376
377
378
379
380
381

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

382
383
384
        return $html;
    }

385
    /**
Carsten  Rose's avatar
Carsten Rose committed
386
     * Look for key/value list in `sql1`, `parameter:itemList`, column definition (in this order, first match counts)
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
     * 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'])) {
            $itemValue = array_column($formElement['sql1'], 'label');
            $itemKey = array_column($formElement['sql1'], 'id');

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

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

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

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

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

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

        return $html;
    }

    /**
Carsten  Rose's avatar
Carsten Rose committed
522
     * @param array $formElement
523
524
525
526
     * @param $htmlFormElementId
     * @param $value
     * @return string
     */
Carsten  Rose's avatar
Carsten Rose committed
527
    private function buildHidden(array $formElement, $htmlFormElementId, $value) {
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
        return '<input type="hidden" name="' . $htmlFormElementId . '" value="' . addslashes($value) . '">';
    }

    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attributeBase
     * @param $value
     * @param $itemKey
     * @param $itemValue
     * @return string
     */
    private function buildCheckboxMulti(array $formElement, $htmlFormElementId, $attributeBase, $value, $itemKey, $itemValue) {
        // Defines which of the checkboxes will be checked.
        $values = explode($value, ',');

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

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

        $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
558
                    $attribute .= $this->getAttribute('autofocus', $formElement['autofocus']);
559
            }
Carsten  Rose's avatar
Carsten Rose committed
560
            $attribute .= $this->getAttribute('value', $item);
561
            if ($item === $values[$jj]) {
Carsten  Rose's avatar
Carsten Rose committed
562
                $attribute .= $this->getAttribute('checked', 'checked');
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
588
589
590
591
592
593
594
595
            }
            $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
     */
    private function buildRadio(array $formElement, $htmlFormElementId, $value) {
        $itemKey = array();
        $itemValue = array();

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

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

        $jj = 0;
        $flagFirst = true;

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

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

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

Carsten  Rose's avatar
Carsten Rose committed
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
    /**
     * 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
     */
    private function buildSubrecord(array $formElement, $htmlFormElementId, $value) {
        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]));
        $html = '<b>' . $formElement['label'] . '</b>';
        $html .= '<table>';
        $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>';

        return "<p>$html</p>";
707
708
    }

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

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

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

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

        $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
     */
    private 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
772
    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @throws UserException
     */
    private 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
783
784
785
786

    /**
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return mixed
     */
    private function buildNote(array $formElement, $htmlFormElementId, $value) {
        return $value;
    }

787
}