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

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

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

24
25

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

42
//    protected $feDivClass = array(); // Wrap FormElements in <div class="$feDivClass[type]">
43

44
45
    private $formId = null;

46
47
48
49
50
51
52
    /**
     * AbstractBuildForm constructor.
     *
     * @param array $formSpec
     * @param array $feSpecAction
     * @param array $feSpecNative
     */
53
54
55
56
57
    public function __construct(array $formSpec, array $feSpecAction, array $feSpecNative) {
        $this->formSpec = $formSpec;
        $this->feSpecAction = $feSpecAction;
        $this->feSpecNative = $feSpecNative;
        $this->store = Store::getInstance();
58
        $this->db = new Database();
Carsten  Rose's avatar
Carsten Rose committed
59
        $this->evaluate = new Evaluate($this->store, $this->db);
Carsten  Rose's avatar
Carsten Rose committed
60
        $this->showDebugInfo = ($this->store->getVar(SYSTEM_SHOW_DEBUG_INFO, STORE_SYSTEM) === 'yes');
61

62
63
//        $sip = $this->store->getVar(CLIENT_SIP, STORE_CLIENT);

64
        // render mode specific
65
        $this->fillWrap();
66
67
68

        $this->buildElementFunctionName = [
            'checkbox' => 'Checkbox',
69
70
            'dateJQW' => 'DateJQW',
            'datetimeJQW' => 'DateJQW',
71
72
73
            'email' => 'Input',
            'gridJQW' => 'GridJQW',
            'hidden' => 'Hidden',
74
            'text' => 'Input',
75
76
77
78
            'note' => 'Note',
            'password' => 'Input',
            'radio' => 'Radio',
            'select' => 'Select',
79
            'subrecord' => 'Subrecord',
Carsten  Rose's avatar
Carsten Rose committed
80
            'upload' => 'File',
81
82
            'fieldset' => 'Fieldset',
            'pill' => 'Pill'
83
84
        ];

85
86
87
88
89
90
91
        $this->buildRowName = [
            'checkbox' => 'Native',
            'dateJQW' => 'Native',
            'datetimeJQW' => 'Native',
            'email' => 'Native',
            'gridJQW' => 'Native',
            'hidden' => 'Native',
92
            'text' => 'Native',
93
94
95
96
97
98
99
100
101
102
            'note' => 'Native',
            'password' => 'Native',
            'radio' => 'Native',
            'select' => 'Native',
            'subrecord' => 'Subrecord',
            'upload' => 'Native',
            'fieldset' => 'Fieldset',
            'pill' => 'Pill'
        ];

103
104
105
        $this->symbol[SYMBOL_EDIT] = "<span class='glyphicon glyphicon-pencil'></span>";
        $this->symbol[SYMBOL_NEW] = "<span class='glyphicon glyphicon-plus'></span>";
        $this->symbol[SYMBOL_DELETE] = "<span class='glyphicon glyphicon-trash'></span>";
106

107
        $this->inputCheckPattern = Sanitize::inputCheckPatternArray();
108
109
    }

110
111
    abstract public function fillWrap();

112
    /**
113
     * Builds complete form. Depending of Formspecification, the layout will be 'plain' / 'table' / 'bootstrap'.
114
     *
Carsten  Rose's avatar
Carsten Rose committed
115
116
     * @param $mode
     * @return string|array   $mode=LOAD_FORM: The whole form as HTML, $mode=FORM_UPDATE: array of all formElement.dynamicUpdate-yes  values/states
117
118
     * @throws CodeException
     * @throws DbException
119
     * @throws \qfq\UserFormException
120
     */
Carsten  Rose's avatar
Carsten Rose committed
121
122
123
124
125
126
    public function process($mode) {
        $htmlHead = '';
        $htmlTail = '';
        $htmlSubrecords = '';
        $htmlElements = '';
        $json = array();
127

128
        // <form>
Carsten  Rose's avatar
Carsten Rose committed
129
130
131
132
133
        if ($mode === FORM_LOAD) {
            $htmlHead = $this->head();
            $htmlTail = $this->tail();
            $htmlSubrecords = $this->doSubrecords();
        }
134

135
        $filter = $this->getProcessFilter();
136

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

139
140
            $parentRecords = $this->db->sql($this->formSpec['multiSql']);
            foreach ($parentRecords as $row) {
141
                $this->store->setVarArray($row, STORE_PARENT_RECORD, true);
Carsten  Rose's avatar
Carsten Rose committed
142
143
144
                $jsonTmp = array();
                $htmlElements = $this->elements($row['_id'], $filter, 0, $jsonTmp);
                $json[] = $jsonTmp;
145
146
            }
        } else {
Carsten  Rose's avatar
Carsten Rose committed
147
            $htmlElements = $this->elements($this->store->getVar(SIP_RECORD_ID, STORE_SIP), $filter, 0, $json);
148
149
        }

150
        // </form>
151

Carsten  Rose's avatar
Carsten Rose committed
152
        return ($mode === FORM_LOAD) ? $htmlHead . $htmlElements . $htmlTail . $htmlSubrecords : $json;
153
154
    }

155
    /**
156
     * Builds the head area of the form.
157
     *
158
     * @return string
159
     */
160
161
    public function head() {
        $html = '';
162

163
        $html .= '<div ' . Support::doAttribute('class', $this->formSpec['class'], TRUE) . '>'; // main <div class=...> around everything
164

165
166
167
        // Logged in BE User will see a FormEdit Link
        $sipParamString = OnArray::toString($this->store->getStore(STORE_SIP), ':', ', ', "'");
        $formEditUrl = $this->createFormEditUrl();
168

169
        $html .= "<p><a href='$formEditUrl'>Edit</a> <small>[$sipParamString]</small></p>";
170

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

173
174
175
        $html .= $this->getFormTag();

        return $html;
176
177
    }

178
    /**
179
     * If SHOW_DEBUG_INFO=yes: create a link (incl. SIP) to edit the current form. Show also the hidden content of the SIP.
180
     *
181
     * @return string String: <a href="?pageId&sip=....">Edit</a> <small>[sip:..., r:..., urlparam:..., ...]</small>
182
     */
183
    public function createFormEditUrl() {
184

Carsten  Rose's avatar
Carsten Rose committed
185
        if (!$this->showDebugInfo) {
186
187
            return '';
        }
188

189
190
191
192
193
        $queryStringArray = [
            'id' => $this->store->getVar(TYPO3_PAGE_ID, STORE_TYPO3),
            'form' => 'form',
            'r' => $this->formSpec['id']
        ];
194

195
        $queryString = Support::arrayToQueryString($queryStringArray);
196

197
198
        $sip = $this->store->getSipInstance();
        $url = $sip->queryStringToSip($queryString);
199

200
        return $url;
201
202
203
    }

    /**
204
205
     * Wrap's $this->wrap[$item][WRAP_SETUP_START] around $value. If $flagOmitEmpty==true && $value=='': return ''.
     *
206
207
208
209
210
211
212
213
214
215
216
217
     * @param $item
     * @param $value
     * @param bool|false $flagOmitEmpty
     * @return string
     */
    public function wrapItem($item, $value, $flagOmitEmpty = false) {
        if ($flagOmitEmpty && $value === "")
            return '';
        return $this->wrap[$item][WRAP_SETUP_START] . $value . $this->wrap[$item][WRAP_SETUP_END];
    }

    /**
218
     * Returns '<form ...>'-tag with various attributes.
219
220
221
222
223
224
225
226
227
228
229
230
231
     *
     * @return string
     */
    public function getFormTag() {

        $attribute = $this->getFormTagAtrributes();

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

    /**
     * Build an assoc array with standard form attributes.
     *
232
     * @return array
233
234
235
     */
    public function getFormTagAtrributes() {

236
        $attribute['id'] = $this->getFormId();
237
238
239
240
241
242
243
244
245
246
        $attribute['method'] = 'post';
        $attribute['action'] = $this->getActionUrl();
        $attribute['target'] = '_top';
        $attribute['accept-charset'] = 'UTF-8';
        $attribute['autocomplete'] = 'on';
        $attribute['enctype'] = $this->getEncType();

        return $attribute;
    }

247
248
249
250
251
252
253
254
255
256
    /**
     * @return string
     */
    public function getFormId() {
        if ($this->formId === null) {
            $this->formId = uniqid('qfq-form-');
        }
        return $this->formId;
    }

257
258
259
    /**
     * Builds the HTML 'form'-tag inlcuding all attributes and target.
     *
260
261
     * Notice: the SIP will be transferred as POST Parameter.
     *
262
263
264
265
266
     * @return string
     * @throws DbException
     */
    public function getActionUrl() {

267
        return API_DIR . '/save.php';
268
269
270
271
272
273
274
275
276
277
278
279
    }

    /**
     * Determines the enctype.
     *
     * See: https://www.w3.org/wiki/HTML/Elements/form#HTML_Attributes
     *
     * @return string
     * @throws DbException
     */
    public function getEncType() {

280
        $result = $this->db->sql("SELECT id FROM FormElement AS fe WHERE fe.formId=? AND fe.type='upload' LIMIT 1", ROW_REGULAR, [$this->formSpec['id']], 'Look for Formelement.type="upload"');
281
282
283
        return (count($result) === 1) ? 'multipart/form-data' : 'application/x-www-form-urlencoded';

    }
284

Carsten  Rose's avatar
Carsten Rose committed
285
286
287
288
    abstract public function tail();

    abstract public function doSubrecords();

289
    abstract public function getProcessFilter();
290
291

    /**
292
293
     * Process all FormElements: build corresponding HTML code. Collect and return all HTML code.
     *
294
     * @param $recordId
295
     * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD
296
     * @param int $feIdContainer
297
     * @return string
298
299
     * @throws CodeException
     * @throws DbException
300
     * @throws \qfq\UserFormException
301
     */
Carsten  Rose's avatar
Carsten Rose committed
302
    public function elements($recordId, $filter = FORM_ELEMENTS_NATIVE, $feIdContainer = 0, &$json) {
303
304
305
        $html = '';

        // get current data record
306
        if ($recordId > 0 && $this->store->getVar('id', STORE_RECORD) === false) {
307
308
            $row = $this->db->sql("SELECT * FROM " . $this->formSpec['tableName'] . " WHERE id = ?", ROW_EXPECT_1, array($recordId));
            $this->store->setVarArray($row, STORE_RECORD);
309
        }
310
311
312

        // Iterate over all FormElements
        foreach ($this->feSpecNative as $fe) {
Carsten  Rose's avatar
Carsten Rose committed
313
314
315
            if (($filter === FORM_ELEMENTS_NATIVE && $fe['type'] === 'subrecord')
                || ($filter === FORM_ELEMENTS_SUBRECORD && $fe['type'] !== 'subrecord')
//                || ($filter === FORM_ELEMENTS_DYNAMIC_UPDATE && $fe['dynamicUpdate'] === 'no')
316
317
318
319
            ) {
                continue; // skip this FE
            }

320
321
            $debugStack = array();

322
323
324
325
            // Log / Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, $fe['name'] . ' / ' . $fe['id'], STORE_SYSTEM);

            // evaluate current FormElement
326
            $evaluate = new Evaluate($this->store, $this->db);
327
            $formElement = $evaluate->parseArray($fe, $debugStack);
328

329
            // Get default value
330
            $value = ($formElement['value'] === '') ? $this->store->getVar($formElement['name'], STORE_USE_DEFAULT, $formElement['checkType']) : $formElement['value'];
Carsten  Rose's avatar
Carsten Rose committed
331

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

Carsten  Rose's avatar
Carsten Rose committed
334
            // Construct Marshaller Name: buildElement
335
336
            $buildElementFunctionName = 'build' . $this->buildElementFunctionName[$formElement['type']];

Carsten  Rose's avatar
Carsten Rose committed
337
            $jsonElement = array();
338
            // Render pure element
Carsten  Rose's avatar
Carsten Rose committed
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
            $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementId, $value, $jsonElement);

            $fake0 = $fe['dynamicUpdate'];
            $fake1 = $formElement['dynamicUpdate'];

            // container elements do not have dynamicUpdate='yes'. Instead they deliver nested elements.
            if ($formElement['class'] == 'container') {
                if (count($jsonElement) > 0) {
                    $json = array_merge($json, $jsonElement);
                }
            } else {
                // for non container elements: just add the current json status
                if ($fe['dynamicUpdate'] == 'yes') {
                    $json[] = $jsonElement;
                }
            }
355
356

            // debugStack as Tooltip
Carsten  Rose's avatar
Carsten Rose committed
357
            if ($this->showDebugInfo && count($debugStack) > 0) {
358
359
//                $elementHtml = Support::appendTooltip($elementHtml, implode("\n", OnArray::htmlentitiesOnArray($debugStack)));
                $elementHtml = Support::appendTooltip($elementHtml, implode("\n", $debugStack));
360
361
            }

Carsten  Rose's avatar
Carsten Rose committed
362
            // Construct Marshaller Name: buildRow
363
364
365
            $buildRowName = 'buildRow' . $this->buildRowName[$formElement['type']];

            $html .= $this->$buildRowName($formElement, $elementHtml);
Carsten  Rose's avatar
Carsten Rose committed
366
//            break;
367
        }
368

369
370
371
        // Log / Debug: Last FormElement has been processed.
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

372
373
374
        return $html;
    }

Carsten  Rose's avatar
Carsten Rose committed
375
376
377
378
    /**
     * Takes the current SIP ('form' and additional parameter), set SIP_RECORD_ID=0 and create a new 'NewRecordUrl'.
     *
     * @throws CodeException
379
     * @throws \qfq\UserFormException
Carsten  Rose's avatar
Carsten Rose committed
380
381
382
383
     */
    public function deriveNewRecordUrlFromExistingSip(&$toolTipNew) {
        $urlParam = $this->store->getStore(STORE_SIP);
        $urlParam[SIP_RECORD_ID] = 0;
384

Carsten  Rose's avatar
Carsten Rose committed
385
386
        unset($urlParam[SIP_SIP]);
        unset($urlParam[SIP_URLPARAM]);
387
388

        Support::appendTypo3ParameterToArray($urlParam);
Carsten  Rose's avatar
Carsten Rose committed
389
390
391
392
393

        $sip = $this->store->getSipInstance();

        $url = $sip->queryStringToSip(OnArray::toString($urlParam));

394
        if ($this->showDebugInfo) {
395
            //TODO: missing decoding of SIP
396
397
            $toolTipNew .= PHP_EOL . PHP_EOL . OnArray::toString($urlParam, ' = ', PHP_EOL, "'");
        }
Carsten  Rose's avatar
Carsten Rose committed
398
399
400
401

        return $url;
    }

402
403
404
405
406
407
408
409
    abstract public function buildRowNative($formElement, $elementHtml);

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

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

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

410
    /**
411
412
     * Builds a label, typically for an html-'<input>'-element.
     *
413
414
     * @param array $htmlFormElementId
     * @param $label
415
416
     * @return string
     */
417
418
419
420
    public function buildLabel($htmlFormElementId, $label) {
        $html = '<label for="' . $htmlFormElementId . '">' . $label . '</label>';

        return $html;
421
422
    }

423
424
425
426
427
428
429
430
431
432
433
    /**
     * 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
434
     * @throws UserFormException
435
     */
Carsten  Rose's avatar
Carsten Rose committed
436
    public function buildInput(array $formElement, $htmlFormElementId, $value, &$json) {
437
        $textarea = '';
438

439
        $attribute = Support::doAttribute('name', $htmlFormElementId);
440

441
        // Check for input type 'textarea'
442
        $colsRows = explode(',', $formElement['size'], 2);
443
        if (count($colsRows) === 2) {
444
            // <textarea>
445
446
            $htmlTag = '<textarea';

447
448
            $attribute .= Support::doAttribute('cols', $colsRows[0]);
            $attribute .= Support::doAttribute('rows', $colsRows[1]);
449
            $textarea = htmlentities($value) . '</textarea>';
450
451

        } else {
Carsten  Rose's avatar
Carsten Rose committed
452
453
454
455
            $htmlTag = '<input';

            $this->adjustMaxLength($formElement);

456
457
            // <input>
            if ($formElement['maxLength'] > 0) {
Carsten  Rose's avatar
Carsten Rose committed
458
459
460
                // crop string only if it's not empty (substr returns false on empty strings)
                if ($value !== '')
                    $value = substr($value, 0, $formElement['maxLength']);
461

Carsten  Rose's avatar
Carsten Rose committed
462
                // 'maxLength' needs an upper 'L': naming convention for DB tables!
463
                $attribute .= $this->getAttributeList($formElement, ['type', 'size', 'maxLength']);
464
                $attribute .= Support::doAttribute('value', htmlentities($value), false);
465
            }
Carsten  Rose's avatar
Carsten Rose committed
466
        }
467

468
        $attribute .= $this->getAttributeList($formElement, ['autocomplete', 'autofocus', 'placeholder']);
469
470
        $attribute .= Support::doAttribute('data-load', ($formElement['dynamicUpdate'] === 'yes') ? 'data-load' : '');
        $attribute .= Support::doAttribute('title', $formElement['tooltip']);
Carsten  Rose's avatar
Carsten Rose committed
471
        $attribute .= $this->getInputCheckPattern($formElement['checkType'], $formElement['checkPattern']);
472

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

Carsten  Rose's avatar
Carsten Rose committed
475
476
        $json = $this->getJsonElementUpdate($htmlFormElementId, $value, $formElement['mode']);

477
        return "$htmlTag $attribute>$textarea";
478

479
480
    }

Carsten  Rose's avatar
Carsten Rose committed
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
    /**
     * @param array $formElement
     */
    private function adjustMaxLength(array &$formElement) {

        // MIN( $formElement['maxLength'], tabledefinition)
        $maxLength = $this->getColumnSize($formElement['name']);

        if ($maxLength !== false) {
            if (is_numeric($formElement['maxLength'])) {
                if ($formElement['maxLength'] > $maxLength) {
                    $formElement['maxLength'] = $maxLength;
                }
            } else {
                $formElement['maxLength'] = $maxLength;
            }
        }
    }

500
    /**
501
502
     * Get column spec from tabledefinition and parse size of it. If nothing defined, return false.
     *
503
     * @param $column
504
     * @return bool|int
505
506
507
508
509
510
     */
    private function getColumnSize($column) {
        $matches = array();

        $typeSpec = $this->store->getVar($column, STORE_TABLE_COLUMN_TYPES);

511
        // e.g.: string(64), enum('yes','no')
512
513
514
515
516
517
        if (1 === preg_match('/\((.+)\)/', $typeSpec, $matches)) {
            if (is_numeric($matches[1]))
                return $matches[1];
        }

        return false;
518
519
520
521
    }

    /**
     * Builds a HTML attribute list, based on  $attributeList.
522
     *
523
524
525
526
527
528
529
     * 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
530
    private function getAttributeList(array $formElement, array $attributeList) {
531
532
533
        $attribute = '';
        foreach ($attributeList as $item) {
            if (isset($formElement[$item]))
534
                $attribute .= Support::doAttribute(strtolower($item), $formElement[$item]);
535
536
537
538
539
540
        }
        return $attribute;
    }

    /**
     * Construct HTML Input attribute for Client Validation:
541
     *
542
     *   type     data                      result
543
     *   -------  -----------------------   -------------------------------------------------------------------------------
544
545
     *   min|max  <min value>|<max value>   min="$attrData[0]"|max="$attrData[1]"
     *   pattern  <regexp>                  pattern="$data"
Carsten  Rose's avatar
Carsten Rose committed
546
     *   digit    -                         pattern="^[0-9]*$"
547
     *   email    -                         pattern="^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\.[a-z]{2,4})$"
548
     *   alnumx   -
549
     *
550
     * For 'min/max' and 'pattern' the 'data' will be injected in the attribute string via '%s'.
551
552
553
554
     *
     * @param $type
     * @param $data
     * @return string
555
     * @throws \qfq\UserFormException
556
     */
Carsten  Rose's avatar
Carsten Rose committed
557
    private function getInputCheckPattern($type, $data) {
558
559
        $attribute = '';

560
561
        if ($type === '') {
            return '';
562
        }
563

564
565
566
567
568
        switch ($type) {
            case SANITIZE_ALLOW_MIN_MAX:
            case SANITIZE_ALLOW_MIN_MAX_DATE:
                $arrData = explode("|", $data);
                if (count($arrData) != 2 || $arrData[0] == '' || $arrData[1] == '')
569
                    throw new UserFormException("Missing MIN|MAX values", ERROR_MISSING_MIN_MAX);
570

571
572
573
                $attribute = 'min="' . $arrData[0] . '" ';
                $attribute .= 'max="' . $arrData[1] . '" ';
                break;
574

575
576
577
578
579
580
581
582
583
584
            case SANITIZE_ALLOW_PATTERN:
                $attribute = 'pattern="' . $data . '" ';
                break;

            case SANITIZE_ALLOW_ALL:
                break;

            default:
                $attribute = 'pattern="' . $this->inputCheckPattern[$type] . '" ';
                break;
585
        }
586

587
588
589
590
        return $attribute;
    }

    /**
591
592
     * Set corresponding html attributes readonly/required/disabled, based on $formElement['mode'].
     *
593
594
     * @param array $formElement
     * @return string
595
     * @throws UserFormException
596
     */
Carsten  Rose's avatar
Carsten Rose committed
597
    private function getAttributeMode(array $formElement) {
598
599
600
601
602
603
        $attribute = '';

        switch ($formElement['mode']) {
            case 'show':
                break;
            case 'readonly':
604
                $attribute .= Support::doAttribute('readonly', 'readonly');
605
606
                break;
            case 'required':
607
                $attribute .= Support::doAttribute('required', 'required');
608
609
610
611
                break;
            case 'lock':
                break;
            case 'disabled':
612
                $attribute .= Support::doAttribute('disabled', 'disabled');
613
614
615
616
                break;
            default:
                $this->store->setVar(SYSTEM_FORM_ELEMENT, $formElement['name'] . ' / ' . $formElement['id'], STORE_SYSTEM);
                $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, 'mode', STORE_SYSTEM);
617
                throw new UserFormException("Unknown mode '" . $formElement['mode'] . "'", ERROR_UNKNOWN_MODE);
618
619
620
621
622
                break;
        }
        return $attribute;
    }

Carsten  Rose's avatar
Carsten Rose committed
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
    /**
     * @param $htmlFormElementId
     * @param string|array $value
     * @param $mode
     * @return array
     */
    private function getJsonElementUpdate($htmlFormElementId, $value, $mode) {
        $json = array();

        $json['form-element'] = $htmlFormElementId;
        $json['value'] = $value;
        $json['disabled'] = ($mode === 'disabled');
        $json['readonly'] = ($mode === 'readonly');

        return $json;
    }

640
641
642
    /**
     * Builds HTML 'checkbox' element.
     *
643
     * Checkboxes will only be submitted, if they are checked. Therefore, a hidden element with the unchecked value will be transferred first.
644
645
646
647
648
649
650
651
652
     *
     * 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
653
     * @throws UserFormException
654
     */
Carsten  Rose's avatar
Carsten Rose committed
655
    public function buildCheckbox(array $formElement, $htmlFormElementId, $value, &$json) {
656
657
658
659
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
660
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
661
662
663

        // Get fallback, if 'checkBoxMode' is not defined:
        if (!isset($formElement['checkBoxMode'])) {
664
            // This fallback is problematic if 'set' or 'enum' has 2 : defaults to single but maybe multi is meant.
665
666
667
668
669
670
            $formElement['checkBoxMode'] = (count($itemKey) > 2) ? 'multi' : 'single';
        }

        if ($formElement['checkBoxMode'] === 'multi') {
            $htmlFormElementId .= '[]';
        } else {
671
            // Fill meaningfull defaults to parameter: checked|unchecked  (CHECKBOX_VALUE_CHECKED|CHECKBOX_VALUE_UNCHECKED)
672
673
674
            $this->prepareCheckboxCheckedUncheckedValue($itemKey, $formElement);
        }

Carsten  Rose's avatar
Carsten Rose committed
675
        $attributeBase = $this->getAttributeMode($formElement);
676
        $attributeBase .= Support::doAttribute('type', $formElement['type']);
677
678
679
680
681
682
683
684
685

        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:
686
                throw new UserFormException('checkBoxMode: \'' . $formElement['checkBoxMode'] . '\' is unknown.', ERROR_CHECKBOXMODE_UNKNOWN);
687
        }
688

Carsten  Rose's avatar
Carsten Rose committed
689
        $json = $this->getJsonElementUpdate($htmlFormElementId, $value, $formElement['mode']);
690
//        return Support::wrapTag('<div class="checkbox">', $html, true);
691
692
693
        return $html;
    }

694
    /**
695
696
697
698
699
     * Look for key/value list (in this order, first match counts) in
     *  a) `sql1`
     *  b) `parameter:itemList`
     *  c) table.column definition
     *
700
     * Copies the found keys to &$itemKey and the values to &$itemValue
701
     * If there are no &$itemKey, copy &$itemValue to &$itemKey.
702
703
704
705
     *
     * @param array $formElement
     * @param $itemKey
     * @param $itemValue
706
     * @throws CodeException
707
     * @throws \qfq\UserFormException
708
     */
709
    public function getKeyValueListFromSqlEnumSpec(array $formElement, &$itemKey, &$itemValue) {
710
711
712
713
        $fieldType = '';
        $itemKey = array();
        $itemValue = array();

714
715
716
        if (count($formElement) < 20)
            throw new CodeException("Invalid (none or to small) Formelement", ERROR_MISSING_FORMELEMENT);

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

        if (is_array($formElement['sql1'])) {
720
721
722
            if (count($formElement['sql1']) > 0) {
                $keys = array_keys($formElement['sql1'][0]);
                $itemKey = array_column($formElement['sql1'], 'id');
723

724
725
726
727
                // 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]);
                }
728

729
730
731
732
733
734
                $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]);
                }
735
            }
736
        } elseif (isset($formElement['itemList']) && strlen($formElement['itemList']) > 0) {
737
            $arr = KeyValueStringParser::parse($formElement['itemList'], ':', ',', KVP_IF_VALUE_EMPTY_COPY_KEY);
738
739
            $itemValue = array_values($arr);
            $itemKey = array_keys($arr);
740
        } elseif ($fieldType === 'enum' || $fieldType === 'set') {
Carsten  Rose's avatar
Carsten Rose committed
741
            // already done at the beginning with '$this->getItemsForEnumOrSet($formElement['name'], $fieldType);'
742
        } else {
743
            throw new UserFormException("Missing definition (- nothing found in 'sql1', 'parameter:itemValues', 'enum-' or 'set-definition'", ERROR_MISSING_ITEM_VALUES);
744
745
746
747
748
        }

        if (count($itemKey) === 0) {
            $itemKey = $itemValue;
        }
749
750
751
752
753
754
755
756
757
758

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

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

Carsten  Rose's avatar
Carsten Rose committed
760
761
        if (isset($formElement['emptyHide'])) {
            if (isset($itemValue['']))
762
                unset($itemValue['']);
Carsten  Rose's avatar
Carsten Rose committed
763
            if (isset($itemKey['']))
764
765
766
                unset($itemKey['']);

        }
767
768
769
    }

    /**
770
771
     * Get the attribute definition list of an enum or set column. For strings, get the default value. Return elements as an array.
     *
772
773
774
     * @param $column
     * @param $fieldType
     * @return array
775
     * @throws UserFormException
776
777
778
779
780
781
782
     */
    private function getItemsForEnumOrSet($column, &$fieldType) {

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

        if ($fieldTypeDefinition === false) {
783
            throw new UserFormException("Column '$column' unknown in table '" . $this->formSpec['tableName'] . "'", ERROR_DB_UNKNOWN_COLUMN);
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
        }

        $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:
811
     *
812
813
814
815
816
     *    checked: first Element in $itemKey
     *  unchecked: ''
     *
     * @param array $itemKey
     * @param array $formElement
817
     * @throws UserFormException
818
819
820
     */
    private function prepareCheckboxCheckedUncheckedValue(array $itemKey, array &$formElement) {

821
        if (!isset($formElement[CHECKBOX_VALUE_CHECKED])) {
822
823
            if (isset($itemKey[0])) {
                // First element in $itemKey list
824
                $formElement[CHECKBOX_VALUE_CHECKED] = $itemKey[0];
825
826
            } else {
                // Take column default value
827
                $formElement[CHECKBOX_VALUE_CHECKED] = $this->store->getVar($formElement['name'], STORE_TABLE_DEFAULT);
828
829
830
831
            }
        }

        // unchecked
832
        if (!isset($formElement[CHECKBOX_VALUE_UNCHECKED])) {
833
            if (isset($itemKey[1])) {
834
                $formElement[CHECKBOX_VALUE_UNCHECKED] = ($itemKey[0] === $formElement['checked']) ? $itemKey[1] : $itemKey[0];
835
            } else {
836
                $formElement[CHECKBOX_VALUE_UNCHECKED] = '';
837
838
839
            }
        }

840
        if ($formElement[CHECKBOX_VALUE_CHECKED] === $formElement[CHECKBOX_VALUE_UNCHECKED]) {
841
            throw new UserFormException('FormElement: type=checkbox - checked and unchecked can\'t be the same: ' . $formElement[CHECKBOX_VALUE_CHECKED], ERROR_CHECKBOX_EQUAL);
842
843
844
845
846
        }

    }

    /**
847
848
     * Build a Checkbox based on two values.
     *
849
850
851
852
853
854
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attribute
     * @param $value
     * @return string
     */
855
    public function buildCheckboxSingle(array $formElement, $htmlFormElementId, $attribute, $value) {
856
        $html = '';
857

858
859
860
        $attribute .= Support::doAttribute('name', $htmlFormElementId);
        $attribute .= Support::doAttribute('value', $formElement['checked'], false);
        $attribute .= Support::doAttribute('data-load', ($formElement['dynamicUpdate'] === 'yes') ? 'data-load' : '');
Carsten  Rose's avatar
Carsten Rose committed
861

862
        if ($formElement['checked'] === $value) {
863
            $attribute .= Support::doAttribute('checked', 'checked');
864
865
        }

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

868
        $html = $this->buildNativeHidden($htmlFormElementId, $formElement['unchecked']);
869
870
871
872
873
874

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

875
876
877
        $html = Support::wrapTag("<label>", $html, true);
        $html = Support::wrapTag("<div class='checkbox'>", $html, true);

878
879
880
881
        return $html;
    }

    /**
882
     * Builds a real HTML hidden form element. Useful for checkboxes, Multiple-Select and Radios.
883
884
885
886
887
888
889
890
891
892
     *
     * @param $htmlFormElementId
     * @param $value
     * @return string
     */
    public function buildNativeHidden($htmlFormElementId, $value) {
        return '<input type="hidden" name="' . $htmlFormElementId . '" value="' . htmlentities($value) . '">';
    }

    /**
893
894
895
896
897
     * Build as many Checkboxes as items.
     *
     * Layout: The Bootstrap Layout needs very special setup, the checkboxes are wrapped differently with <div class=checkbox>
     *         depending of if they aligned horizontal or vertical.
     *
898
899
900
901
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attributeBase
     * @param $value
902
903
     * @param array $itemKey
     * @param array $itemValue
904
905
     * @return string
     */
906
    public function buildCheckboxMulti(array $formElement, $htmlFormElementId, $attributeBase, $value, array $itemKey, array $itemValue) {
907
        // Defines which of the checkboxes will be checked.
908
        $values = explode(',', $value);
909

910
911
        $attributeBase .= Support::doAttribute('name', $htmlFormElementId);
        $attributeBase .= Support::doAttribute('data-load', ($formElement['dynamicUpdate'] === 'yes') ? 'data-load' : '');
912

913
        $html = $this->buildNativeHidden($htmlFormElementId, '');
914

Carsten  Rose's avatar
Carsten Rose committed
915
        $orientation = (isset($formElement[CHECKBOX_ORIENTATION]) && $formElement[CHECKBOX_ORIENTATION] === 'vertical') ? '' : 'checkbox-inline';
916

917
        $flagFirst = true;
918
919
        for ($ii = 0, $jj = 1; $ii < count($itemKey); $ii++, $jj++) {

920
            $attribute = $attributeBase;
921
922

            // Do this only the first round.
923
924
925
            if ($flagFirst) {
                $flagFirst = false;
                if (isset($formElement['autofocus']))
926
                    $attribute .= Support::doAttribute('autofocus', $formElement['autofocus']);
927
            }
928

929
            $attribute .= Support::doAttribute('value', $itemKey[$ii]);
930
931
932

            // Check if the given key is found in field.
            if (false !== array_search($itemKey[$ii], $values)) {
933
                $attribute .= Support::doAttribute('checked', 'checked');
934
            }
935

936
937
938
939
            $htmlCheckbox = '<input ' . $attribute . '>';
            $htmlCheckbox .= $itemValue[$ii];

            $htmlCheckbox = Support::wrapTag("<label class='$orientation'>", $htmlCheckbox, true);
Carsten  Rose's avatar
Carsten Rose committed
940
            if (isset($formElement[CHECKBOX_ORIENTATION]) && $formElement[CHECKBOX_ORIENTATION] === 'vertical')
941
942
943
                $htmlCheckbox = Support::wrapTag("<div class='checkbox'>", $htmlCheckbox, true);

            $html .= $htmlCheckbox;
944
        }
945

Carsten  Rose's avatar
Carsten Rose committed
946
        if (isset($formElement[CHECKBOX_ORIENTATION]) && $formElement[CHECKBOX_ORIENTATION] !== 'vertical')
947
948
            $html = Support::wrapTag("<div class='checkbox'>", $html, true);

949
950
951
        return $html;
    }

952
953
954
955
956
957
958
959
960
961
962
    /**
     * Submit hidden values by SIP.
     *
     * Sometimes, it's usefull to precalculate values during formload and to submit them as hidden fields.
     * To avoid any manipulation on those fields, the values will be transferred by SIP.
     *
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return string
     */
Carsten  Rose's avatar
Carsten Rose committed
963
    public function buildHidden(array $formElement, $htmlFormElementId, $value, &$json) {
964
965
966
967

        $this->store->setVar($htmlFormElementId, $value, STORE_SIP, false);
    }

968
969
970
971
972
973
974
975
976
977
978
979
980
    /**
     * 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
981
     * @throws UserFormException
982
     */
Carsten  Rose's avatar
Carsten Rose committed
983
    public function buildRadio(array $formElement, $htmlFormElementId, $value, &$json) {
984
985
986
987
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue