AbstractBuildForm.php 82.4 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
 */
Carsten  Rose's avatar
Carsten Rose committed
8

9
10
11
namespace qfq;

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

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

26
27

/**
Carsten  Rose's avatar
Carsten Rose committed
28
29
 * Class AbstractBuildForm
 * @package qfq
30
 */
31
abstract class AbstractBuildForm {
32
33
34
35
36
    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
    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
46
47
48
49
50
51
    /**
     * @var Store
     */
    protected $store = null;
    /**
     * @var Evaluate
     */
    protected $evaluate = null;
52
53
54
    /**
     * @var string
     */
55
    private $formId = null;
56
57
58
59
60
    /**
     * @var Sip
     */
    private $sip = null;

61
62
63
64
65
66
67
    /**
     * AbstractBuildForm constructor.
     *
     * @param array $formSpec
     * @param array $feSpecAction
     * @param array $feSpecNative
     */
68
69
70
71
72
    public function __construct(array $formSpec, array $feSpecAction, array $feSpecNative) {
        $this->formSpec = $formSpec;
        $this->feSpecAction = $feSpecAction;
        $this->feSpecNative = $feSpecNative;
        $this->store = Store::getInstance();
73
        $this->db = new Database();
Carsten  Rose's avatar
Carsten Rose committed
74
        $this->evaluate = new Evaluate($this->store, $this->db);
Carsten  Rose's avatar
Carsten Rose committed
75
        $this->showDebugInfo = ($this->store->getVar(SYSTEM_SHOW_DEBUG_INFO, STORE_SYSTEM) === 'yes');
76

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

79
        // render mode specific
80
        $this->fillWrap();
81
82
83

        $this->buildElementFunctionName = [
            'checkbox' => 'Checkbox',
84
85
            'date' => 'DateTime',
            'datetime' => 'DateTime',
86
87
            'dateJQW' => 'DateJQW',
            'datetimeJQW' => 'DateJQW',
88
89
            'email' => 'Input',
            'gridJQW' => 'GridJQW',
90
            FE_TYPE_EXTRA => 'Extra',
91
            'text' => 'Input',
Carsten  Rose's avatar
Carsten Rose committed
92
            'editor' => 'Editor',
93
            'time' => 'DateTime',
94
95
96
97
            'note' => 'Note',
            'password' => 'Input',
            'radio' => 'Radio',
            'select' => 'Select',
98
            'subrecord' => 'Subrecord',
Carsten  Rose's avatar
Carsten Rose committed
99
            'upload' => 'File',
100
101
            'fieldset' => 'Fieldset',
            'pill' => 'Pill'
102
103
        ];

104
105
        $this->buildRowName = [
            'checkbox' => 'Native',
106
107
            'date' => 'Native',
            'datetime' => 'Native',
108
109
110
111
            'dateJQW' => 'Native',
            'datetimeJQW' => 'Native',
            'email' => 'Native',
            'gridJQW' => 'Native',
112
            FE_TYPE_EXTRA => 'Native',
113
            'text' => 'Native',
Carsten  Rose's avatar
Carsten Rose committed
114
            'editor' => 'Native',
115
            'time' => 'Native',
116
117
118
119
120
121
122
123
124
125
            'note' => 'Native',
            'password' => 'Native',
            'radio' => 'Native',
            'select' => 'Native',
            'subrecord' => 'Subrecord',
            'upload' => 'Native',
            'fieldset' => 'Fieldset',
            'pill' => 'Pill'
        ];

126
127
128
        $this->symbol[SYMBOL_EDIT] = "<span class='glyphicon " . GLYPH_ICON_EDIT . "'></span>";
        $this->symbol[SYMBOL_NEW] = "<span class='glyphicon " . GLYPH_ICON_NEW . "'></span>";
        $this->symbol[SYMBOL_DELETE] = "<span class='glyphicon " . GLYPH_ICON_DELETE . "'></span>";
129

130
        $this->inputCheckPattern = Sanitize::inputCheckPatternArray();
131
132
    }

133
134
    abstract public function fillWrap();

135
    /**
136
     * Builds complete form. Depending of form specification, the layout will be 'plain' / 'table' / 'bootstrap'.
137
     *
138
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE
Carsten  Rose's avatar
Carsten Rose committed
139
     * @return string|array   $mode=LOAD_FORM: The whole form as HTML, $mode=FORM_UPDATE: array of all formElement.dynamicUpdate-yes  values/states
140
141
     * @throws CodeException
     * @throws DbException
142
     * @throws \qfq\UserFormException
143
     */
144
    public function process($mode, $htmlElementNameIdZero = false) {
Carsten  Rose's avatar
Carsten Rose committed
145
146
147
148
149
        $htmlHead = '';
        $htmlTail = '';
        $htmlSubrecords = '';
        $htmlElements = '';
        $json = array();
150
151
152
153
154
155
156
157

        $modeCollectFe = FLAG_DYNAMIC_UPDATE;
        $storeUse = STORE_USE_DEFAULT;

        if ($mode === FORM_SAVE) {
            $modeCollectFe = FLAG_ALL;
            $storeUse = STORE_RECORD . STORE_TABLE_DEFAULT;
        }
158

159
        // <form>
Carsten  Rose's avatar
Carsten Rose committed
160
161
162
163
164
        if ($mode === FORM_LOAD) {
            $htmlHead = $this->head();
            $htmlTail = $this->tail();
            $htmlSubrecords = $this->doSubrecords();
        }
165

166
        $filter = $this->getProcessFilter();
167

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

170
171
            $parentRecords = $this->db->sql($this->formSpec['multiSql']);
            foreach ($parentRecords as $row) {
172
                $this->store->setVarArray($row, STORE_PARENT_RECORD, true);
Carsten  Rose's avatar
Carsten Rose committed
173
                $jsonTmp = array();
174
                $htmlElements = $this->elements($row['_id'], $filter, 0, $jsonTmp, $modeCollectFe);
Carsten  Rose's avatar
Carsten Rose committed
175
                $json[] = $jsonTmp;
176
177
            }
        } else {
178
            $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);
179
            $htmlElements = $this->elements($recordId, $filter, 0, $json, $modeCollectFe, $htmlElementNameIdZero, $storeUse, $mode);
180
        }
181
182
183
        $htmlSip = $this->buildHiddenSip($json);

        return ($mode === FORM_LOAD) ? $htmlHead . $htmlElements . $htmlSip . $htmlTail . $htmlSubrecords : $json;
184
185
    }

186
    /**
187
     * Builds the head area of the form.
188
     *
189
     * @return string
190
     */
191
192
    public function head() {
        $html = '';
193

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

196
197
198
        // Logged in BE User will see a FormEdit Link
        $sipParamString = OnArray::toString($this->store->getStore(STORE_SIP), ':', ', ', "'");
        $formEditUrl = $this->createFormEditUrl();
199

200
        $html .= "<p><a " . Support::doAttribute('href', $formEditUrl) . ">Edit</a> <small>[$sipParamString]</small></p>";
201

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

204
205
206
        $html .= $this->getFormTag();

        return $html;
207
208
    }

209
    /**
210
     * If SHOW_DEBUG_INFO=yes: create a link (incl. SIP) to edit the current form. Show also the hidden content of the SIP.
211
     *
212
     * @return string String: <a href="?pageId&sip=....">Edit</a> <small>[sip:..., r:..., urlparam:..., ...]</small>
213
     */
214
    public function createFormEditUrl() {
215

Carsten  Rose's avatar
Carsten Rose committed
216
        if (!$this->showDebugInfo) {
217
218
            return '';
        }
219

220
221
222
223
224
        $queryStringArray = [
            'id' => $this->store->getVar(TYPO3_PAGE_ID, STORE_TYPO3),
            'form' => 'form',
            'r' => $this->formSpec['id']
        ];
225

226
        $queryString = Support::arrayToQueryString($queryStringArray);
227

228
229
        $sip = $this->store->getSipInstance();
        $url = $sip->queryStringToSip($queryString);
230

231
        return $url;
232
233
234
    }

    /**
235
236
     * Wrap's $this->wrap[$item][WRAP_SETUP_START] around $value. If $flagOmitEmpty==true && $value=='': return ''.
     *
237
238
239
240
241
242
243
244
245
246
247
248
     * @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];
    }

    /**
249
     * Returns '<form ...>'-tag with various attributes.
250
251
252
253
254
255
256
257
258
259
260
261
262
     *
     * @return string
     */
    public function getFormTag() {

        $attribute = $this->getFormTagAtrributes();

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

    /**
     * Build an assoc array with standard form attributes.
     *
263
     * @return array
264
265
266
     */
    public function getFormTagAtrributes() {

267
        $attribute['id'] = $this->getFormId();
268
269
270
271
272
273
274
275
276
277
        $attribute['method'] = 'post';
        $attribute['action'] = $this->getActionUrl();
        $attribute['target'] = '_top';
        $attribute['accept-charset'] = 'UTF-8';
        $attribute['autocomplete'] = 'on';
        $attribute['enctype'] = $this->getEncType();

        return $attribute;
    }

278
279
280
281
282
283
284
285
286
287
    /**
     * @return string
     */
    public function getFormId() {
        if ($this->formId === null) {
            $this->formId = uniqid('qfq-form-');
        }
        return $this->formId;
    }

288
289
290
    /**
     * Builds the HTML 'form'-tag inlcuding all attributes and target.
     *
291
292
     * Notice: the SIP will be transferred as POST Parameter.
     *
293
294
295
296
297
     * @return string
     * @throws DbException
     */
    public function getActionUrl() {

298
        return API_DIR . '/save.php';
299
300
301
302
303
304
305
306
307
308
309
310
    }

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

311
        $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"');
312
313
314
        return (count($result) === 1) ? 'multipart/form-data' : 'application/x-www-form-urlencoded';

    }
315

Carsten  Rose's avatar
Carsten Rose committed
316
317
318
319
    abstract public function tail();

    abstract public function doSubrecords();

320
    abstract public function getProcessFilter();
321
322

    /**
323
324
     * Process all FormElements: build corresponding HTML code. Collect and return all HTML code.
     *
325
     * @param $recordId
326
     * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD
327
     * @param int $feIdContainer
328
329
330
331
     * @param array $json
     * @param string $modeCollectFe
     * @param bool $htmlElementNameIdZero
     * @param string $storeUse
332
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE
333
     * @return string
334
335
     * @throws CodeException
     * @throws DbException
336
     * @throws \qfq\UserFormException
337
     */
338
    public function elements($recordId, $filter = FORM_ELEMENTS_NATIVE, $feIdContainer = 0, array &$json,
339
                             $modeCollectFe = FLAG_DYNAMIC_UPDATE, $htmlElementNameIdZero = false, $storeUse = STORE_USE_DEFAULT, $mode = FORM_LOAD) {
340
        $html = '';
341
        $flagOutput = false;
342
343

        // get current data record
344
        if ($recordId > 0 && $this->store->getVar('id', STORE_RECORD) === false) {
345
            $row = $this->db->sql("SELECT * FROM " . $this->formSpec[F_TABLE_NAME] . " WHERE id = ?", ROW_EXPECT_1, array($recordId));
346
            $this->store->setVarArray($row, STORE_RECORD);
347
        }
348
349
350

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

352
353
            if (($filter === FORM_ELEMENTS_NATIVE && $fe[FE_TYPE] === 'subrecord')
                || ($filter === FORM_ELEMENTS_SUBRECORD && $fe[FE_TYPE] !== 'subrecord')
Carsten  Rose's avatar
Carsten Rose committed
354
//                || ($filter === FORM_ELEMENTS_DYNAMIC_UPDATE && $fe['dynamicUpdate'] === 'no')
355
356
357
358
            ) {
                continue; // skip this FE
            }

359
360
            $flagOutput = ($fe[FE_TYPE] !== FE_TYPE_EXTRA);

361
362
            $debugStack = array();

363
364
            // Preparation for Log, Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($fe), STORE_SYSTEM);
365
366

            // evaluate current FormElement
367
            $formElement = $this->evaluate->parseArray($fe, $debugStack);
368

369
370
371
            // Some Defaults
            $formElement = Support::setFeDefaults($formElement);

372
373
374
375
376
377
378
379
380
            if ($flagOutput === true) {
                Support::setIfNotSet($formElement, F_BS_LABEL_COLUMNS);
                Support::setIfNotSet($formElement, F_BS_INPUT_COLUMNS);
                Support::setIfNotSet($formElement, F_BS_NOTE_COLUMNS);
                $label = ($formElement[F_BS_LABEL_COLUMNS] == '') ? $this->formSpec[F_BS_LABEL_COLUMNS] : $formElement[F_BS_LABEL_COLUMNS];
                $input = ($formElement[F_BS_INPUT_COLUMNS] == '') ? $this->formSpec[F_BS_INPUT_COLUMNS] : $formElement[F_BS_INPUT_COLUMNS];
                $note = ($formElement[F_BS_NOTE_COLUMNS] == '') ? $this->formSpec[F_BS_NOTE_COLUMNS] : $formElement[F_BS_NOTE_COLUMNS];
                $this->fillWrapLabelInputNote($label, $input, $note);
            }
381

382
            // Get default value
383
            $value = ($formElement['value'] === '') ? $this->store->getVar($formElement['name'], $storeUse,
384
                $formElement['checkType']) : $formElement['value'];
Carsten  Rose's avatar
Carsten Rose committed
385

386
387
            // Typically: $htmlElementNameIdZero = true
            // After Saving a record, staying on the form, the FormElements on the Client are still known as '<feName>:0'.
388
            $htmlFormElementId = HelperFormElement::buildFormElementName($formElement['name'], ($htmlElementNameIdZero) ? 0 : $recordId);
389

Carsten  Rose's avatar
Carsten Rose committed
390
            // Construct Marshaller Name: buildElement
391
            $buildElementFunctionName = 'build' . $this->buildElementFunctionName[$formElement[FE_TYPE]];
392

Carsten  Rose's avatar
Carsten Rose committed
393
            $jsonElement = array();
394
            // Render pure element
395
            $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementId, $value, $jsonElement, $mode);
Carsten  Rose's avatar
Carsten Rose committed
396

397
398
//            $fake0 = $fe['dynamicUpdate'];
//            $fake1 = $formElement['dynamicUpdate'];
Carsten  Rose's avatar
Carsten Rose committed
399
400
401
402
403
404
405
406

            // 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
407
                if ($modeCollectFe === FLAG_ALL || ($modeCollectFe == FLAG_DYNAMIC_UPDATE && $fe['dynamicUpdate'] == 'yes')) {
Carsten  Rose's avatar
Carsten Rose committed
408
409
410
411
412
413
                    if (isset($jsonElement[0]) && is_array($jsonElement[0])) {
                        // Checkboxes are delivered as array of arrays: unnest them and append them to the existing json array.
                        $json = array_merge($json, $jsonElement);
                    } else {
                        $json[] = $jsonElement;
                    }
Carsten  Rose's avatar
Carsten Rose committed
414
415
                }
            }
416

417
418
419
420
421
            if ($flagOutput) {
                // debugStack as Tooltip
                if ($this->showDebugInfo && count($debugStack) > 0) {
                    $elementHtml = Support::appendTooltip($elementHtml, implode("\n", $debugStack));
                }
422

423
424
                // Construct Marshaller Name: buildRow
                $buildRowName = 'buildRow' . $this->buildRowName[$formElement[FE_TYPE]];
425

426
427
                $html .= $this->$buildRowName($formElement, $elementHtml, $htmlFormElementId);
            }
428
        }
429

430
431
432
        // Log / Debug: Last FormElement has been processed.
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

433
434
435
        return $html;
    }

436
437
    abstract public function fillWrapLabelInputNote($label, $input, $note);

438
439
440
    /**
     * Create a hidden sip, based on latest STORE_SIP Values. Return complete HTML 'hidden' element.
     *
441
     * @param array $json
442
443
444
445
     * @return string  <input type='hidden' name='s' value='<sip>'>
     * @throws CodeException
     * @throws \qfq\UserFormException
     */
446
    public function buildHiddenSip(array &$json) {
447

448
        $sipArray = $this->store->getStore(STORE_SIP);
449
450

        // do not include system vars
451
452
453
454
455
456
457
458
        unset($sipArray[SIP_SIP]);
        unset($sipArray[SIP_URLPARAM]);

        $queryString = Support::arrayToQueryString($sipArray);
        $sip = $this->store->getSipInstance();

        $sipValue = $sip->queryStringToSip($queryString, RETURN_SIP);

459
        $json[] = $this->getJsonElementUpdate(CLIENT_SIP, $sipValue, FE_MODE_SHOW);
460
461
462
463
464
465
466

        return $this->buildNativeHidden(CLIENT_SIP, $sipValue);
    }

    /**
     * @param $htmlFormElementId
     * @param string|array $value
467
     * @param string $feMode disabled|readonly|''
468
469
     * @return array
     */
470
    private function getJsonElementUpdate($htmlFormElementId, $value, $feMode) {
471

472
        $json = $this->getJsonFeMode($feMode);
473
474
475
476
477
478
479

        $json['form-element'] = $htmlFormElementId;
        $json['value'] = $value;

        return $json;
    }

480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
    /**
     * Set corresponding JSON attributes readonly/required/disabled, based on $formElement[FE_MODE].
     *
     * @param array $feMode
     * @return array
     * @throws UserFormException
     */
    private function getJsonFeMode($feMode) {

        $this->getFeMode($feMode, $hidden, $disabled, $required);

        return [API_JSON_HIDDEN => $hidden === 'yes', API_JSON_DISABLED => $disabled === 'yes', API_JSON_REQUIRED => $required === 'yes'];
    }

    /**
     * @param $feMode
     * @param $hidden
     * @param $disabled
     * @param $required
     * @throws \qfq\UserFormException
     */
    private function getFeMode($feMode, &$hidden, &$disabled, &$required) {
        $hidden = 'no';
        $disabled = 'no';
        $required = 'no';

        switch ($feMode) {
            case FE_MODE_SHOW:
                break;
            case FE_MODE_REQUIRED:
                $required = 'yes';
                break;
            case FE_MODE_READONLY:
513
                $disabled = 'yes';  // convert the UI status 'readonly' to the HTML/CSS status 'disabled'.
514
515
516
517
518
519
520
521
522
523
                break;
            case FE_MODE_HIDDEN:
                $hidden = 'yes';
                break;
            default:
                throw new UserFormException("Unknown mode '$feMode'", ERROR_UNKNOWN_MODE);
                break;
        }
    }

524
525
526
527
528
529
530
531
532
533
534
    /**
     * Builds a real HTML hidden form element. Useful for checkboxes, Multiple-Select and Radios.
     *
     * @param $htmlFormElementId
     * @param $value
     * @return string
     */
    public function buildNativeHidden($htmlFormElementId, $value) {
        return '<input type="hidden" name="' . $htmlFormElementId . '" value="' . htmlentities($value) . '">';
    }

Carsten  Rose's avatar
Carsten Rose committed
535
536
537
538
    /**
     * Takes the current SIP ('form' and additional parameter), set SIP_RECORD_ID=0 and create a new 'NewRecordUrl'.
     *
     * @throws CodeException
539
     * @throws \qfq\UserFormException
Carsten  Rose's avatar
Carsten Rose committed
540
541
542
543
     */
    public function deriveNewRecordUrlFromExistingSip(&$toolTipNew) {
        $urlParam = $this->store->getStore(STORE_SIP);
        $urlParam[SIP_RECORD_ID] = 0;
544

Carsten  Rose's avatar
Carsten Rose committed
545
546
        unset($urlParam[SIP_SIP]);
        unset($urlParam[SIP_URLPARAM]);
547
548

        Support::appendTypo3ParameterToArray($urlParam);
Carsten  Rose's avatar
Carsten Rose committed
549
550
551
552
553

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

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

554
        if ($this->showDebugInfo) {
555
            //TODO: missing decoding of SIP
556
557
            $toolTipNew .= PHP_EOL . PHP_EOL . OnArray::toString($urlParam, ' = ', PHP_EOL, "'");
        }
Carsten  Rose's avatar
Carsten Rose committed
558
559
560
561

        return $url;
    }

562
    abstract public function buildRowNative(array $formElement, $htmlElement, $htmlFormElementId);
563

564
    abstract public function buildRowPill(array $formElement, $elementHtml);
565

566
    abstract public function buildRowFieldset(array $formElement, $elementHtml);
567

568
    abstract public function buildRowSubrecord(array $formElement, $elementHtml);
569

570
    /**
571
572
     * Builds a label, typically for an html-'<input>'-element.
     *
573
574
     * @param string $htmlFormElementId
     * @param string $label
575
576
     * @return string
     */
577
    public function buildLabel($htmlFormElementId, $label) {
578
579
580
581
        $attributes = Support::doAttribute('for', $htmlFormElementId);
        $attributes .= Support::doAttribute('class', 'control-label');

        $html = Support::wrapTag("<label $attributes>", $label);
582
583

        return $html;
584
585
    }

586
587
588
589
    /**
     * 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"]
Carsten  Rose's avatar
Carsten Rose committed
590
     *           [pattern="$pattern"] [required="required"] [disabled="disabled"] value="$value">
591
592
593
594
595
     *
     *
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
596
     * @param array $json
597
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE
598
     * @return string
599
     * @throws \qfq\UserFormException
600
     */
601
    public function buildInput(array $formElement, $htmlFormElementId, $value, array &$json, $mode = FORM_LOAD) {
602
        $textarea = '';
603

604
        $attribute = Support::doAttribute('name', $htmlFormElementId);
605
        $attribute .= Support::doAttribute('class', 'form-control');
606

607
        // Check for input type 'textarea'
608
        $colsRows = explode(',', $formElement['size'], 2);
609
        if (count($colsRows) === 2) {
610
            // <textarea>
611
612
            $htmlTag = '<textarea';

613
614
            $attribute .= Support::doAttribute('cols', $colsRows[0]);
            $attribute .= Support::doAttribute('rows', $colsRows[1]);
615
            $textarea = htmlentities($value) . '</textarea>';
616
617

        } else {
Carsten  Rose's avatar
Carsten Rose committed
618
619
620
621
            $htmlTag = '<input';

            $this->adjustMaxLength($formElement);

622
            if ($formElement['maxLength'] > 0 && $value !== '') {
Carsten  Rose's avatar
Carsten Rose committed
623
                // crop string only if it's not empty (substr returns false on empty strings)
624
                $value = substr($value, 0, $formElement['maxLength']);
625
            }
626
627
628
629

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

632
        $attribute .= $this->getAttributeList($formElement, ['autocomplete', 'autofocus', 'placeholder']);
633
634
        $attribute .= Support::doAttribute('data-load', ($formElement['dynamicUpdate'] === 'yes') ? 'data-load' : '');
        $attribute .= Support::doAttribute('title', $formElement['tooltip']);
Carsten  Rose's avatar
Carsten Rose committed
635
        $attribute .= $this->getInputCheckPattern($formElement['checkType'], $formElement['checkPattern']);
636

637
        $attribute .= $this->getAttributeFeMode($formElement[FE_MODE]);
638

639
        $json = $this->getJsonElementUpdate($htmlFormElementId, $value, $formElement[FE_MODE]);
Carsten  Rose's avatar
Carsten Rose committed
640

641
        return "$htmlTag $attribute>$textarea" . $this->getHelpBlock();
642

643
644
    }

Carsten  Rose's avatar
Carsten Rose committed
645
646
647
648
649
650
651
652
    /**
     * @param array $formElement
     */
    private function adjustMaxLength(array &$formElement) {

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

653
        switch ($formElement[FE_TYPE]) {
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
            case 'date':
                $feMaxLength = 10;
                break;
            case 'datetime':
                $feMaxLength = 19;
                break;
            case 'time':
                $feMaxLength = 8;
                break;
            default:
                $feMaxLength = false;
                break;
        }

        // In case the underlying tablecolumn is not of type date/time, the $maxLength might be to high: correct
        if ($feMaxLength !== false && $maxLength !== false && $feMaxLength < $maxLength) {
            $maxLength = $feMaxLength;
        }

        // date/datetime
Carsten  Rose's avatar
Carsten Rose committed
674
        if ($maxLength !== false) {
675
            if (is_numeric($formElement['maxLength']) && $formElement['maxLength'] != 0) {
Carsten  Rose's avatar
Carsten Rose committed
676
677
678
679
680
681
682
683
684
                if ($formElement['maxLength'] > $maxLength) {
                    $formElement['maxLength'] = $maxLength;
                }
            } else {
                $formElement['maxLength'] = $maxLength;
            }
        }
    }

685
    /**
686
687
     * Get column spec from tabledefinition and parse size of it. If nothing defined, return false.
     *
688
     * @param $column
689
     * @return bool|int  a) 'false' if there is no length definition, b) length definition, c) date|time|datetime|timestamp use hardcoded length
690
691
692
693
694
     */
    private function getColumnSize($column) {
        $matches = array();

        $typeSpec = $this->store->getVar($column, STORE_TABLE_COLUMN_TYPES);
695
696
697
698
699
700
701
702
703
        switch ($typeSpec) {
            case 'date': // yyyy-mm-dd
                return 10;
            case 'datetime': // yyyy-mm-dd hh:mm:ss
            case 'timestamp': // yyyy-mm-dd hh:mm:ss
                return 19;
            case 'time': // hh:mm:ss
                return 8;
            default:
704
705
706
                if (substr($typeSpec, 0, 4) === 'set(' || substr($typeSpec, 0, 5) === 'enum(') {
                    return $this->maxLengthSetEnum($typeSpec);
                }
707
708
                break;
        }
709

710
        // e.g.: string(64) >> 64, enum('yes','no') >> false
711
712
713
714
715
716
        if (1 === preg_match('/\((.+)\)/', $typeSpec, $matches)) {
            if (is_numeric($matches[1]))
                return $matches[1];
        }

        return false;
717
718
    }

719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
    /**
     * Get the strlen of the longest element in enum('val1','val2',...,'valn') or set('val1','val2',...,'valn')
     *
     * @param string $typeSpec
     * @return int
     */
    private function maxLengthSetEnum($typeSpec) {
        $startPos = (substr($typeSpec, 0, 4) === 'set(') ? 4 : 5;
        $max = 0;

        $valueList = substr($typeSpec, $startPos, strlen($typeSpec) - $startPos - 1);
        $valueArr = explode(',', $valueList);
        foreach ($valueArr as $value) {
            $value = trim($value, "'");
            $len = strlen($value);
            if ($len > $max) {
                $max = $len;
            }
        }

        return $max;
    }

742
743
    /**
     * Builds a HTML attribute list, based on  $attributeList.
744
     *
745
     * E.g.: attributeList: [ 'type', 'autofocus' ]
746
     *       generates: 'type="$formElement[FE_TYPE]" autofocus="$formElement['autofocus']" '
747
748
749
750
751
     *
     * @param array $formElement
     * @param array $attributeList
     * @return string
     */
Carsten  Rose's avatar
Carsten Rose committed
752
    private function getAttributeList(array $formElement, array $attributeList) {
753
754
755
        $attribute = '';
        foreach ($attributeList as $item) {
            if (isset($formElement[$item]))
756
                $attribute .= Support::doAttribute(strtolower($item), $formElement[$item]);
757
758
759
760
761
762
        }
        return $attribute;
    }

    /**
     * Construct HTML Input attribute for Client Validation:
763
     *
764
     *   type     data                      result
765
     *   -------  -----------------------   -------------------------------------------------------------------------------
766
767
     *   min|max  <min value>|<max value>   min="$attrData[0]"|max="$attrData[1]"
     *   pattern  <regexp>                  pattern="$data"
Carsten  Rose's avatar
Carsten Rose committed
768
     *   digit    -                         pattern="^[0-9]*$"
769
     *   email    -                         pattern="^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\.[a-z]{2,4})$"
770
     *   alnumx   -
771
     *
772
     * For 'min/max' and 'pattern' the 'data' will be injected in the attribute string via '%s'.
773
774
775
776
     *
     * @param $type
     * @param $data
     * @return string
777
     * @throws \qfq\UserFormException
778
     */
Carsten  Rose's avatar
Carsten Rose committed
779
    private function getInputCheckPattern($type, $data) {
780
781
        $attribute = '';

782
783
        if ($type === '') {
            return '';
784
        }
785

786
787
788
789
790
        switch ($type) {
            case SANITIZE_ALLOW_MIN_MAX:
            case SANITIZE_ALLOW_MIN_MAX_DATE:
                $arrData = explode("|", $data);
                if (count($arrData) != 2 || $arrData[0] == '' || $arrData[1] == '')
791
                    throw new UserFormException("Missing MIN|MAX values", ERROR_MISSING_MIN_MAX);
792

793
794
795
                $attribute = 'min="' . $arrData[0] . '" ';
                $attribute .= 'max="' . $arrData[1] . '" ';
                break;
796

797
798
799
800
801
802
803
804
805
806
            case SANITIZE_ALLOW_PATTERN:
                $attribute = 'pattern="' . $data . '" ';
                break;

            case SANITIZE_ALLOW_ALL:
                break;

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

809
810
811
812
        return $attribute;
    }

    /**
813
     * Set corresponding html attributes readonly/required/disabled, based on $formElement[FE_MODE].
814
     *
815
     * @param string $feMode
816
     * @return string
817
     * @throws UserFormException
818
     */
819
    private function getAttributeFeMode($feMode) {
820
821
        $attribute = '';

822
823
824
825
826
        $this->getFeMode($feMode, $hidden, $disabled, $required);

        switch ($feMode) {
            case FE_MODE_HIDDEN:
            case FE_MODE_SHOW:
827
                break;
828
829
830
            case FE_MODE_REQUIRED:
            case FE_MODE_READONLY:
                $attribute .= Support::doAttribute($feMode, $feMode);
831
832
                break;
            default:
833
                throw new UserFormException("Unknown mode '$feMode'", ERROR_UNKNOWN_MODE);
834
835
                break;
        }
836

837
        // Attributes: data-...
838
        $attribute .= Support::doAttribute(DATA_HIDDEN, $hidden);
839
        $attribute .= Support::doAttribute(DATA_DISABLED, $disabled);
840
841
        $attribute .= Support::doAttribute(DATA_REQUIRED, $required);

842
843
844
        return $attribute;
    }

845
846
847
848
849
850
851
    /**
     * @return string
     */
    private function getHelpBlock() {
        return '<div class="help-block with-errors"></div>';
    }

852
853
854
    /**
     * Builds HTML 'checkbox' element.
     *
855
     * Checkboxes will only be submitted, if they are checked. Therefore, a hidden element with the unchecked value will be transferred first.
856
857
858
     *
     * Format: <input type="hidden" name="$htmlFormElementId" value="$valueUnChecked">
     *         <input name="$htmlFormElementId" type="checkbox" [autofocus="autofocus"]
Carsten  Rose's avatar
Carsten Rose committed
859
     *            [required="required"] [disabled="disabled"] value="<value>" [checked="checked"] >
860
861
862
863
     *
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
864
     * @param array $json
865
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE*
866
     * @return string
867
868
     * @throws CodeException
     * @throws \qfq\UserFormException
869
     */
870
    public function buildCheckbox(array $formElement, $htmlFormElementId, $value, array &$json, $mode = FORM_LOAD) {
871
872
873
874
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
875
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
876
877
878

        // Get fallback, if 'checkBoxMode' is not defined:
        if (!isset($formElement['checkBoxMode'])) {
879
            // This fallback is problematic if 'set' or 'enum' has 2 : defaults to single but maybe multi is meant.
880
881
882
883
            $formElement['checkBoxMode'] = (count($itemKey) > 2) ? 'multi' : 'single';
        }

        if ($formElement['checkBoxMode'] === 'multi') {
884
//            $htmlFormElementId .= '[]';
885
        } else {
886
            // Fill meaningfull defaults to parameter: checked|unchecked  (CHECKBOX_VALUE_CHECKED|CHECKBOX_VALUE_UNCHECKED)
887
888
889
            $this->prepareCheckboxCheckedUncheckedValue($itemKey, $formElement);
        }

890
        $attributeBase = $this->getAttributeFeMode($formElement[FE_MODE]);
891
        $attributeBase .= Support::doAttribute('type', $formElement[FE_TYPE]);
892
893
894

        switch ($formElement['checkBoxMode']) {
            case 'single':
895
                $html = $this->buildCheckboxSingle($formElement, $htmlFormElementId, $attributeBase, $value, $json);
896
897
                break;
            case 'multi';
898
                $html = $this->buildCheckboxMulti($formElement, $htmlFormElementId, $attributeBase, $value, $itemKey, $itemValue, $json);
899
900
                break;
            default:
901
                throw new UserFormException('checkBoxMode: \'' . $formElement['checkBoxMode'] . '\' is unknown.', ERROR_CHECKBOXMODE_UNKNOWN);
902
        }
903

904
905
906
        return $html;
    }

907
    /**
908
909
910
911
912
     * Look for key/value list (in this order, first match counts) in
     *  a) `sql1`
     *  b) `parameter:itemList`
     *  c) table.column definition
     *
913
     * Copies the found keys to &$itemKey and the values to &$itemValue
914
     * If there are no &$itemKey, copy &$itemValue to &$itemKey.
915
916
917
918
     *
     * @param array $formElement
     * @param $itemKey
     * @param $itemValue
919
     * @throws CodeException
920
     * @throws \qfq\UserFormException
921
     */
922
    public function getKeyValueListFromSqlEnumSpec(array $formElement, &$itemKey, &$itemValue) {
923
924
925
926
        $fieldType = '';
        $itemKey = array();
        $itemValue = array();

927
928
929
        if (count($formElement) < 20)
            throw new CodeException("Invalid (none or to small) Formelement", ERROR_MISSING_FORMELEMENT);

930
        // Call getItemsForEnumOrSet() only if there a corresponding column really exist.
931
        if (false !== $this->store->getVar($formElement['name'], STORE_TABLE_COLUMN_TYPES)) {
932
933
            $itemValue = $this->getItemsForEnumOrSet($formElement['name'], $fieldType);
        }
934
935

        if (is_array($formElement['sql1'])) {
936
937
938
            if (count($formElement['sql1']) > 0) {
                $keys = array_keys($formElement['sql1'][0]);
                $itemKey = array_column($formElement['sql1'], 'id');
939

940
941
942
943
                // 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]);
                }
944

945
946
947
948
949
950
                $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]);
                }
951
            }
952
        } elseif (isset($formElement['itemList']) && strlen($formElement['itemList']) > 0) {
953
            $arr = KeyValueStringParser::parse($formElement['itemList'], ':', ',', KVP_IF_VALUE_EMPTY_COPY_KEY);
954
955
            $itemValue = array_values($arr);
            $itemKey = array_keys($arr);
956
        } elseif ($fieldType === 'enum' || $fieldType === 'set') {
Carsten  Rose's avatar
Carsten Rose committed
957
            // already done at the beginning with '$this->getItemsForEnumOrSet($formElement['name'], $fieldType);'
958
        } else {
959
            throw new UserFormException("Missing definition (- nothing found in 'sql1', 'parameter:itemValues', 'enum-' or 'set-definition'", ERROR_MISSING_ITEM_VALUES);