AbstractBuildForm.php 55.1 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 form specification, 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
        $modeCollectFe = ($mode === FORM_SAVE) ? FLAG_ALL : FLAG_DYNAMIC_UPDATE;
128

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

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

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

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

151
        // </form>
152

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

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

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

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

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

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

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

        return $html;
177
178
    }

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

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

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

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

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

201
        return $url;
202
203
204
    }

    /**
205
206
     * Wrap's $this->wrap[$item][WRAP_SETUP_START] around $value. If $flagOmitEmpty==true && $value=='': return ''.
     *
207
208
209
210
211
212
213
214
215
216
217
218
     * @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];
    }

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

        $attribute = $this->getFormTagAtrributes();

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

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

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

        return $attribute;
    }

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

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

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

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

281
        $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"');
282
283
284
        return (count($result) === 1) ? 'multipart/form-data' : 'application/x-www-form-urlencoded';

    }
285

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

    abstract public function doSubrecords();

290
    abstract public function getProcessFilter();
291
292

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

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

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

321
322
            $debugStack = array();

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

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

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

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

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

Carsten  Rose's avatar
Carsten Rose committed
338
            $jsonElement = array();
339
            // Render pure element
Carsten  Rose's avatar
Carsten Rose committed
340
341
            $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementId, $value, $jsonElement);

342
343
//            $fake0 = $fe['dynamicUpdate'];
//            $fake1 = $formElement['dynamicUpdate'];
Carsten  Rose's avatar
Carsten Rose committed
344
345
346
347
348
349
350
351

            // 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
352
                if ($modeCollectFe === FLAG_ALL || ($modeCollectFe == FLAG_DYNAMIC_UPDATE && $fe['dynamicUpdate'] == 'yes')) {
Carsten  Rose's avatar
Carsten Rose committed
353
354
355
                    $json[] = $jsonElement;
                }
            }
356
357

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

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

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

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

373
374
375
        return $html;
    }

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

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

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

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

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

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

        return $url;
    }

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

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

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

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

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

        return $html;
422
423
    }

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

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

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

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

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

            $this->adjustMaxLength($formElement);

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

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

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

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

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

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

480
481
    }

Carsten  Rose's avatar
Carsten Rose committed
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
    /**
     * @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;
            }
        }
    }

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

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

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

        return false;
519
520
521
522
    }

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

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

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

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

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

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

            case SANITIZE_ALLOW_ALL:
                break;

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

588
589
590
591
        return $attribute;
    }

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

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

Carsten  Rose's avatar
Carsten Rose committed
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
    /**
     * @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;
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        }
768
769
770
    }

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

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

        if ($fieldTypeDefinition === false) {
784
            throw new UserFormException("Column '$column' unknown in table '" . $this->formSpec['tableName'] . "'", ERROR_DB_UNKNOWN_COLUMN);
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
811
        }

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

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

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

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

    }

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

859
860
861
        $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
862

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

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

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

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

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

879
880
881
882
        return $html;
    }

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

    /**
894
895
896
897
898
     * 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.
     *
899
900
901
902
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attributeBase
     * @param $value
903
904
     * @param array $itemKey
     * @param array $itemValue
905
906
     * @return string
     */
907
    public function buildCheckboxMulti(array $formElement, $htmlFormElementId, $attributeBase, $value, array $itemKey, array $itemValue) {
908
        // Defines which of the checkboxes will be checked.
909
        $values = explode(',', $value);
910

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

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

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

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

921
            $attribute = $attributeBase;
922
923

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

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

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

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

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

            $html .= $htmlCheckbox;
945
        }
946

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

950
951
952
        return $html;
    }

953
954
955
956
957
958
959
960
961
962
963
    /**
     * 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
964
    public function buildHidden(array $formElement, $htmlFormElementId, $value, &$json) {
965
966
967
968

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

969
970
971
972
973
974