AbstractBuildForm.php 70.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
 */
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

25
26

/**
Carsten  Rose's avatar
Carsten Rose committed
27
28
 * Class AbstractBuildForm
 * @package qfq
29
 */
30
abstract class AbstractBuildForm {
31
32
33
    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
34
    protected $store = null;
Carsten  Rose's avatar
Carsten Rose committed
35
    protected $evaluate = null;
36
37
    protected $buildElementFunctionName = array();
    protected $pattern = array();
38
    protected $wrap = array();
39
    protected $symbol = array();
Carsten  Rose's avatar
Carsten Rose committed
40
    protected $showDebugInfo = false;
41
    protected $inputCheckPattern = array();
Carsten  Rose's avatar
Carsten Rose committed
42

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

45
46
47
    /**
     * @var string
     */
48
49
    private $formId = null;

50
51
52
53
54
    /**
     * @var Sip
     */
    private $sip = null;

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

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

73
        // render mode specific
74
        $this->fillWrap();
75
76
77

        $this->buildElementFunctionName = [
            'checkbox' => 'Checkbox',
78
79
            'date' => 'DateTime',
            'datetime' => 'DateTime',
80
81
            'dateJQW' => 'DateJQW',
            'datetimeJQW' => 'DateJQW',
82
83
84
            'email' => 'Input',
            'gridJQW' => 'GridJQW',
            'hidden' => 'Hidden',
85
            'text' => 'Input',
86
            'time' => 'DateTime',
87
88
89
90
            'note' => 'Note',
            'password' => 'Input',
            'radio' => 'Radio',
            'select' => 'Select',
91
            'subrecord' => 'Subrecord',
Carsten  Rose's avatar
Carsten Rose committed
92
            'upload' => 'File',
93
94
            'fieldset' => 'Fieldset',
            'pill' => 'Pill'
95
96
        ];

97
98
        $this->buildRowName = [
            'checkbox' => 'Native',
99
100
            'date' => 'Native',
            'datetime' => 'Native',
101
102
103
104
105
            'dateJQW' => 'Native',
            'datetimeJQW' => 'Native',
            'email' => 'Native',
            'gridJQW' => 'Native',
            'hidden' => 'Native',
106
            'text' => 'Native',
107
            'time' => 'Native',
108
109
110
111
112
113
114
115
116
117
            'note' => 'Native',
            'password' => 'Native',
            'radio' => 'Native',
            'select' => 'Native',
            'subrecord' => 'Subrecord',
            'upload' => 'Native',
            'fieldset' => 'Fieldset',
            'pill' => 'Pill'
        ];

118
119
120
        $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>";
121

122
        $this->inputCheckPattern = Sanitize::inputCheckPatternArray();
123
124
    }

125
126
    abstract public function fillWrap();

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

        $modeCollectFe = FLAG_DYNAMIC_UPDATE;
        $storeUse = STORE_USE_DEFAULT;

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

151
        // <form>
Carsten  Rose's avatar
Carsten Rose committed
152
153
154
155
156
        if ($mode === FORM_LOAD) {
            $htmlHead = $this->head();
            $htmlTail = $this->tail();
            $htmlSubrecords = $this->doSubrecords();
        }
157

158
        $filter = $this->getProcessFilter();
159

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

162
163
            $parentRecords = $this->db->sql($this->formSpec['multiSql']);
            foreach ($parentRecords as $row) {
164
                $this->store->setVarArray($row, STORE_PARENT_RECORD, true);
Carsten  Rose's avatar
Carsten Rose committed
165
                $jsonTmp = array();
166
                $htmlElements = $this->elements($row['_id'], $filter, 0, $jsonTmp, $modeCollectFe);
Carsten  Rose's avatar
Carsten Rose committed
167
                $json[] = $jsonTmp;
168
169
            }
        } else {
170
            $htmlElements = $this->elements($this->store->getVar(SIP_RECORD_ID, STORE_SIP), $filter, 0, $json, $modeCollectFe, $htmlElementNameIdZero, $storeUse);
171
172
        }

173
174
        $htmlSip = $this->buildHiddenSip($json);

175
        // </form>
176

177
        return ($mode === FORM_LOAD) ? $htmlHead . $htmlElements . $htmlSip . $htmlTail . $htmlSubrecords : $json;
178
179
    }

180
    /**
181
     * Builds the head area of the form.
182
     *
183
     * @return string
184
     */
185
186
    public function head() {
        $html = '';
187

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

190
191
192
        // Logged in BE User will see a FormEdit Link
        $sipParamString = OnArray::toString($this->store->getStore(STORE_SIP), ':', ', ', "'");
        $formEditUrl = $this->createFormEditUrl();
193

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

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

198
199
200
        $html .= $this->getFormTag();

        return $html;
201
202
    }

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

Carsten  Rose's avatar
Carsten Rose committed
210
        if (!$this->showDebugInfo) {
211
212
            return '';
        }
213

214
215
216
217
218
        $queryStringArray = [
            'id' => $this->store->getVar(TYPO3_PAGE_ID, STORE_TYPO3),
            'form' => 'form',
            'r' => $this->formSpec['id']
        ];
219

220
        $queryString = Support::arrayToQueryString($queryStringArray);
221

222
223
        $sip = $this->store->getSipInstance();
        $url = $sip->queryStringToSip($queryString);
224

225
        return $url;
226
227
228
    }

    /**
229
230
     * Wrap's $this->wrap[$item][WRAP_SETUP_START] around $value. If $flagOmitEmpty==true && $value=='': return ''.
     *
231
232
233
234
235
236
237
238
239
240
241
242
     * @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];
    }

    /**
243
     * Returns '<form ...>'-tag with various attributes.
244
245
246
247
248
249
250
251
252
253
254
255
256
     *
     * @return string
     */
    public function getFormTag() {

        $attribute = $this->getFormTagAtrributes();

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

    /**
     * Build an assoc array with standard form attributes.
     *
257
     * @return array
258
259
260
     */
    public function getFormTagAtrributes() {

261
        $attribute['id'] = $this->getFormId();
262
263
264
265
266
267
268
269
270
271
        $attribute['method'] = 'post';
        $attribute['action'] = $this->getActionUrl();
        $attribute['target'] = '_top';
        $attribute['accept-charset'] = 'UTF-8';
        $attribute['autocomplete'] = 'on';
        $attribute['enctype'] = $this->getEncType();

        return $attribute;
    }

272
273
274
275
276
277
278
279
280
281
    /**
     * @return string
     */
    public function getFormId() {
        if ($this->formId === null) {
            $this->formId = uniqid('qfq-form-');
        }
        return $this->formId;
    }

282
283
284
    /**
     * Builds the HTML 'form'-tag inlcuding all attributes and target.
     *
285
286
     * Notice: the SIP will be transferred as POST Parameter.
     *
287
288
289
290
291
     * @return string
     * @throws DbException
     */
    public function getActionUrl() {

292
        return API_DIR . '/save.php';
293
294
295
296
297
298
299
300
301
302
303
304
    }

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

305
        $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"');
306
307
308
        return (count($result) === 1) ? 'multipart/form-data' : 'application/x-www-form-urlencoded';

    }
309

Carsten  Rose's avatar
Carsten Rose committed
310
311
312
313
    abstract public function tail();

    abstract public function doSubrecords();

314
    abstract public function getProcessFilter();
315
316

    /**
317
318
     * Process all FormElements: build corresponding HTML code. Collect and return all HTML code.
     *
319
     * @param $recordId
320
     * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD
321
     * @param int $feIdContainer
322
     * @return string
323
324
     * @throws CodeException
     * @throws DbException
325
     * @throws \qfq\UserFormException
326
     */
327
    public function elements($recordId, $filter = FORM_ELEMENTS_NATIVE, $feIdContainer = 0, &$json,
328
                             $modeCollectFe = FLAG_DYNAMIC_UPDATE, $htmlElementNameIdZero = false, $storeUse = STORE_USE_DEFAULT) {
329
330
331
        $html = '';

        // get current data record
332
        if ($recordId > 0 && $this->store->getVar('id', STORE_RECORD) === false) {
333
334
            $row = $this->db->sql("SELECT * FROM " . $this->formSpec['tableName'] . " WHERE id = ?", ROW_EXPECT_1, array($recordId));
            $this->store->setVarArray($row, STORE_RECORD);
335
        }
336
337
338

        // Iterate over all FormElements
        foreach ($this->feSpecNative as $fe) {
339
340
            if (($filter === FORM_ELEMENTS_NATIVE && $fe[FE_TYPE] === 'subrecord')
                || ($filter === FORM_ELEMENTS_SUBRECORD && $fe[FE_TYPE] !== 'subrecord')
Carsten  Rose's avatar
Carsten Rose committed
341
//                || ($filter === FORM_ELEMENTS_DYNAMIC_UPDATE && $fe['dynamicUpdate'] === 'no')
342
343
344
345
            ) {
                continue; // skip this FE
            }

346
347
            $debugStack = array();

348
349
            // Preparation for Log, Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($fe), STORE_SYSTEM);
350
351

            // evaluate current FormElement
352
            $evaluate = new Evaluate($this->store, $this->db);
353
            $formElement = $evaluate->parseArray($fe, $debugStack);
354

355
356
357
            // Some Defaults
            $formElement = Support::setFeDefaults($formElement);

358
359
360
            Support::setIfNotSet($formElement, F_BS_LABEL_COLUMNS);
            Support::setIfNotSet($formElement, F_BS_INPUT_COLUMNS);
            Support::setIfNotSet($formElement, F_BS_NOTE_COLUMNS);
361
362
363
364
365
            $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);

366
            // Get default value
367
            $value = ($formElement['value'] === '') ? $this->store->getVar($formElement['name'], $storeUse,
368
                $formElement['checkType']) : $formElement['value'];
Carsten  Rose's avatar
Carsten Rose committed
369

370
371
372
            // Typically: $htmlElementNameIdZero = true
            // After Saving a record, staying on the form, the FormElements on the Client are still known as '<feName>:0'.
            $htmlFormElementId = HelperFormElement::buildFormElementId($formElement['name'], ($htmlElementNameIdZero) ? 0 : $recordId);
373

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

Carsten  Rose's avatar
Carsten Rose committed
377
            $jsonElement = array();
378
            // Render pure element
Carsten  Rose's avatar
Carsten Rose committed
379
380
            $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementId, $value, $jsonElement);

381
382
//            $fake0 = $fe['dynamicUpdate'];
//            $fake1 = $formElement['dynamicUpdate'];
Carsten  Rose's avatar
Carsten Rose committed
383
384
385
386
387
388
389
390

            // 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
391
                if ($modeCollectFe === FLAG_ALL || ($modeCollectFe == FLAG_DYNAMIC_UPDATE && $fe['dynamicUpdate'] == 'yes')) {
Carsten  Rose's avatar
Carsten Rose committed
392
393
394
                    $json[] = $jsonElement;
                }
            }
395
396

            // debugStack as Tooltip
Carsten  Rose's avatar
Carsten Rose committed
397
            if ($this->showDebugInfo && count($debugStack) > 0) {
398
399
//                $elementHtml = Support::appendTooltip($elementHtml, implode("\n", OnArray::htmlentitiesOnArray($debugStack)));
                $elementHtml = Support::appendTooltip($elementHtml, implode("\n", $debugStack));
400
401
            }

Carsten  Rose's avatar
Carsten Rose committed
402
            // Construct Marshaller Name: buildRow
403
            $buildRowName = 'buildRow' . $this->buildRowName[$formElement[FE_TYPE]];
404

405
            $html .= $this->$buildRowName($formElement, $elementHtml, $htmlFormElementId);
Carsten  Rose's avatar
Carsten Rose committed
406
//            break;
407
        }
408

409
410
411
        // Log / Debug: Last FormElement has been processed.
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

412
413
414
        return $html;
    }

415
416
    abstract public function fillWrapLabelInputNote($label, $input, $note);

417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
    /**
     * Create a hidden sip, based on latest STORE_SIP Values. Return complete HTML 'hidden' element.
     *
     * @param $json
     * @return string  <input type='hidden' name='s' value='<sip>'>
     * @throws CodeException
     * @throws \qfq\UserFormException
     */
    public function buildHiddenSip(&$json) {
        $sipArray = $this->store->getStore(STORE_SIP);
        unset($sipArray[SIP_SIP]);
        unset($sipArray[SIP_URLPARAM]);

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

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

435
        $json[] = $this->getJsonElementUpdate(CLIENT_SIP, $sipValue, FE_MODE_SHOW);
436
437
438
439
440
441
442

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

    /**
     * @param $htmlFormElementId
     * @param string|array $value
443
     * @param string $feMode disabled|readonly|''
444
445
     * @return array
     */
446
447
    private function getJsonElementUpdate($htmlFormElementId, $value, $feMode) {
        $json = $this->getJsonFeMode($feMode);
448
449
450

        $json['form-element'] = $htmlFormElementId;
        $json['value'] = $value;
451
452
//        $json['disabled'] = ($feMode === 'disabled');
//        $json['readonly'] = ($feMode === 'readonly');
453
454
455
456

        return $json;
    }

457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
    /**
     * 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:
490
                $disabled = 'yes';  // convert the UI status 'readonly' to the HTML/CSS status 'disabled'.
491
492
493
494
495
496
497
498
499
500
                break;
            case FE_MODE_HIDDEN:
                $hidden = 'yes';
                break;
            default:
                throw new UserFormException("Unknown mode '$feMode'", ERROR_UNKNOWN_MODE);
                break;
        }
    }

501
502
503
504
505
506
507
508
509
510
511
    /**
     * 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
512
513
514
515
    /**
     * Takes the current SIP ('form' and additional parameter), set SIP_RECORD_ID=0 and create a new 'NewRecordUrl'.
     *
     * @throws CodeException
516
     * @throws \qfq\UserFormException
Carsten  Rose's avatar
Carsten Rose committed
517
518
519
520
     */
    public function deriveNewRecordUrlFromExistingSip(&$toolTipNew) {
        $urlParam = $this->store->getStore(STORE_SIP);
        $urlParam[SIP_RECORD_ID] = 0;
521

Carsten  Rose's avatar
Carsten Rose committed
522
523
        unset($urlParam[SIP_SIP]);
        unset($urlParam[SIP_URLPARAM]);
524
525

        Support::appendTypo3ParameterToArray($urlParam);
Carsten  Rose's avatar
Carsten Rose committed
526
527
528
529
530

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

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

531
        if ($this->showDebugInfo) {
532
            //TODO: missing decoding of SIP
533
534
            $toolTipNew .= PHP_EOL . PHP_EOL . OnArray::toString($urlParam, ' = ', PHP_EOL, "'");
        }
Carsten  Rose's avatar
Carsten Rose committed
535
536
537
538

        return $url;
    }

539
    abstract public function buildRowNative(array $formElement, $htmlElement, $htmlFormElementId);
540

541
    abstract public function buildRowPill(array $formElement, $elementHtml);
542

543
    abstract public function buildRowFieldset(array $formElement, $elementHtml);
544

545
    abstract public function buildRowSubrecord(array $formElement, $elementHtml);
546

547
    /**
548
549
     * Builds a label, typically for an html-'<input>'-element.
     *
550
551
     * @param string $htmlFormElementId
     * @param string $label
552
553
     * @return string
     */
554
    public function buildLabel($htmlFormElementId, $label) {
555
556
557
558
        $attributes = Support::doAttribute('for', $htmlFormElementId);
        $attributes .= Support::doAttribute('class', 'control-label');

        $html = Support::wrapTag("<label $attributes>", $label);
559
560

        return $html;
561
562
    }

563
564
565
566
    /**
     * 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
567
     *           [pattern="$pattern"] [required="required"] [disabled="disabled"] value="$value">
568
569
570
571
572
573
     *
     *
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return string
574
     * @throws UserFormException
575
     */
Carsten  Rose's avatar
Carsten Rose committed
576
    public function buildInput(array $formElement, $htmlFormElementId, $value, &$json) {
577
        $textarea = '';
578

579
        $attribute = Support::doAttribute('name', $htmlFormElementId);
580
        $attribute .= Support::doAttribute('class', 'form-control');
581

582
        // Check for input type 'textarea'
583
        $colsRows = explode(',', $formElement['size'], 2);
584
        if (count($colsRows) === 2) {
585
            // <textarea>
586
587
            $htmlTag = '<textarea';

588
589
            $attribute .= Support::doAttribute('cols', $colsRows[0]);
            $attribute .= Support::doAttribute('rows', $colsRows[1]);
590
            $textarea = htmlentities($value) . '</textarea>';
591
592

        } else {
Carsten  Rose's avatar
Carsten Rose committed
593
594
595
596
            $htmlTag = '<input';

            $this->adjustMaxLength($formElement);

597
598
            // <input>
            if ($formElement['maxLength'] > 0) {
Carsten  Rose's avatar
Carsten Rose committed
599
600
601
                // crop string only if it's not empty (substr returns false on empty strings)
                if ($value !== '')
                    $value = substr($value, 0, $formElement['maxLength']);
602

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

609
        $attribute .= $this->getAttributeList($formElement, ['autocomplete', 'autofocus', 'placeholder']);
610
611
        $attribute .= Support::doAttribute('data-load', ($formElement['dynamicUpdate'] === 'yes') ? 'data-load' : '');
        $attribute .= Support::doAttribute('title', $formElement['tooltip']);
Carsten  Rose's avatar
Carsten Rose committed
612
        $attribute .= $this->getInputCheckPattern($formElement['checkType'], $formElement['checkPattern']);
613

614
        $attribute .= $this->getAttributeFeMode($formElement[FE_MODE]);
615

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

618
        return "$htmlTag $attribute>$textarea" . $this->getHelpBlock();
619

620
621
    }

Carsten  Rose's avatar
Carsten Rose committed
622
623
624
625
626
627
628
629
    /**
     * @param array $formElement
     */
    private function adjustMaxLength(array &$formElement) {

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

630
        switch ($formElement[FE_TYPE]) {
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
            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
651
652
653
654
655
656
657
658
659
660
661
        if ($maxLength !== false) {
            if (is_numeric($formElement['maxLength'])) {
                if ($formElement['maxLength'] > $maxLength) {
                    $formElement['maxLength'] = $maxLength;
                }
            } else {
                $formElement['maxLength'] = $maxLength;
            }
        }
    }

662
    /**
663
664
     * Get column spec from tabledefinition and parse size of it. If nothing defined, return false.
     *
665
     * @param $column
666
     * @return bool|int  a) 'false' if there is no length definition, b) length definition, c) date|time|datetime|timestamp use hardcoded length
667
668
669
670
671
     */
    private function getColumnSize($column) {
        $matches = array();

        $typeSpec = $this->store->getVar($column, STORE_TABLE_COLUMN_TYPES);
672
673
674
675
676
677
678
679
680
681
682
        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:
                break;
        }
683

684
        // e.g.: string(64) >> 64, enum('yes','no') >> false
685
686
687
688
689
690
        if (1 === preg_match('/\((.+)\)/', $typeSpec, $matches)) {
            if (is_numeric($matches[1]))
                return $matches[1];
        }

        return false;
691
692
693
694
    }

    /**
     * Builds a HTML attribute list, based on  $attributeList.
695
     *
696
     * E.g.: attributeList: [ 'type', 'autofocus' ]
697
     *       generates: 'type="$formElement[FE_TYPE]" autofocus="$formElement['autofocus']" '
698
699
700
701
702
     *
     * @param array $formElement
     * @param array $attributeList
     * @return string
     */
Carsten  Rose's avatar
Carsten Rose committed
703
    private function getAttributeList(array $formElement, array $attributeList) {
704
705
706
        $attribute = '';
        foreach ($attributeList as $item) {
            if (isset($formElement[$item]))
707
                $attribute .= Support::doAttribute(strtolower($item), $formElement[$item]);
708
709
710
711
712
713
        }
        return $attribute;
    }

    /**
     * Construct HTML Input attribute for Client Validation:
714
     *
715
     *   type     data                      result
716
     *   -------  -----------------------   -------------------------------------------------------------------------------
717
718
     *   min|max  <min value>|<max value>   min="$attrData[0]"|max="$attrData[1]"
     *   pattern  <regexp>                  pattern="$data"
Carsten  Rose's avatar
Carsten Rose committed
719
     *   digit    -                         pattern="^[0-9]*$"
720
     *   email    -                         pattern="^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\.[a-z]{2,4})$"
721
     *   alnumx   -
722
     *
723
     * For 'min/max' and 'pattern' the 'data' will be injected in the attribute string via '%s'.
724
725
726
727
     *
     * @param $type
     * @param $data
     * @return string
728
     * @throws \qfq\UserFormException
729
     */
Carsten  Rose's avatar
Carsten Rose committed
730
    private function getInputCheckPattern($type, $data) {
731
732
        $attribute = '';

733
734
        if ($type === '') {
            return '';
735
        }
736

737
738
739
740
741
        switch ($type) {
            case SANITIZE_ALLOW_MIN_MAX:
            case SANITIZE_ALLOW_MIN_MAX_DATE:
                $arrData = explode("|", $data);
                if (count($arrData) != 2 || $arrData[0] == '' || $arrData[1] == '')
742
                    throw new UserFormException("Missing MIN|MAX values", ERROR_MISSING_MIN_MAX);
743

744
745
746
                $attribute = 'min="' . $arrData[0] . '" ';
                $attribute .= 'max="' . $arrData[1] . '" ';
                break;
747

748
749
750
751
752
753
754
755
756
757
            case SANITIZE_ALLOW_PATTERN:
                $attribute = 'pattern="' . $data . '" ';
                break;

            case SANITIZE_ALLOW_ALL:
                break;

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

760
761
762
763
        return $attribute;
    }

    /**
764
     * Set corresponding html attributes readonly/required/disabled, based on $formElement[FE_MODE].
765
     *
766
     * @param string $feMode
767
     * @return string
768
     * @throws UserFormException
769
     */
770
    private function getAttributeFeMode($feMode) {
771
772
        $attribute = '';

773
774
775
776
777
        $this->getFeMode($feMode, $hidden, $disabled, $required);

        switch ($feMode) {
            case FE_MODE_HIDDEN:
            case FE_MODE_SHOW:
778
                break;
779
780
781
            case FE_MODE_REQUIRED:
            case FE_MODE_READONLY:
                $attribute .= Support::doAttribute($feMode, $feMode);
782
783
                break;
            default:
784
                throw new UserFormException("Unknown mode '$feMode'", ERROR_UNKNOWN_MODE);
785
786
                break;
        }
787

788
        // Attributes: data-...
789
        $attribute .= Support::doAttribute(DATA_HIDDEN, $hidden);
790
        $attribute .= Support::doAttribute(DATA_DISABLED, $disabled);
791
792
        $attribute .= Support::doAttribute(DATA_REQUIRED, $required);

793
794
795
        return $attribute;
    }

796
797
798
799
800
801
802
    /**
     * @return string
     */
    private function getHelpBlock() {
        return '<div class="help-block with-errors"></div>';
    }

803
804
805
    /**
     * Builds HTML 'checkbox' element.
     *
806
     * Checkboxes will only be submitted, if they are checked. Therefore, a hidden element with the unchecked value will be transferred first.
807
808
809
     *
     * Format: <input type="hidden" name="$htmlFormElementId" value="$valueUnChecked">
     *         <input name="$htmlFormElementId" type="checkbox" [autofocus="autofocus"]
Carsten  Rose's avatar
Carsten Rose committed
810
     *            [required="required"] [disabled="disabled"] value="<value>" [checked="checked"] >
811
812
813
814
815
     *
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return string
816
     * @throws UserFormException
817
     */
Carsten  Rose's avatar
Carsten Rose committed
818
    public function buildCheckbox(array $formElement, $htmlFormElementId, $value, &$json) {
819
820
821
822
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
823
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
824
825
826

        // Get fallback, if 'checkBoxMode' is not defined:
        if (!isset($formElement['checkBoxMode'])) {
827
            // This fallback is problematic if 'set' or 'enum' has 2 : defaults to single but maybe multi is meant.
828
829
830
831
832
833
            $formElement['checkBoxMode'] = (count($itemKey) > 2) ? 'multi' : 'single';
        }

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

838
        $attributeBase = $this->getAttributeFeMode($formElement[FE_MODE]);
839
        $attributeBase .= Support::doAttribute('type', $formElement[FE_TYPE]);
840
841
842
843
844
845
846
847
848

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

852
        $json = $this->getJsonElementUpdate($htmlFormElementId, $value, $formElement[FE_MODE]);
853
//        return Support::wrapTag('<div class="checkbox">', $html, true);
854
855
856
        return $html;
    }

857
    /**
858
859
860
861
862
     * Look for key/value list (in this order, first match counts) in
     *  a) `sql1`
     *  b) `parameter:itemList`
     *  c) table.column definition
     *
863
     * Copies the found keys to &$itemKey and the values to &$itemValue
864
     * If there are no &$itemKey, copy &$itemValue to &$itemKey.
865
866
867
868
     *
     * @param array $formElement
     * @param $itemKey
     * @param $itemValue
869
     * @throws CodeException
870
     * @throws \qfq\UserFormException
871
     */
872
    public function getKeyValueListFromSqlEnumSpec(array $formElement, &$itemKey, &$itemValue) {
873
874
875
876
        $fieldType = '';
        $itemKey = array();
        $itemValue = array();

877
878
879
        if (count($formElement) < 20)
            throw new CodeException("Invalid (none or to small) Formelement", ERROR_MISSING_FORMELEMENT);

880
        // Call getItemsForEnumOrSet() only if there a corresponding column really exist.
881
        if (false !== $this->store->getVar($formElement['name'], STORE_TABLE_COLUMN_TYPES)) {
882
883
            $itemValue = $this->getItemsForEnumOrSet($formElement['name'], $fieldType);
        }
884
885

        if (is_array($formElement['sql1'])) {
886
887
888
            if (count($formElement['sql1']) > 0) {
                $keys = array_keys($formElement['sql1'][0]);
                $itemKey = array_column($formElement['sql1'], 'id');
889

890
891
892
893
                // 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]);
                }
894

895
896
897
898
899
900
                $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]);
                }
901
            }
902
        } elseif (isset($formElement['itemList']) && strlen($formElement['itemList']) > 0) {
903
            $arr = KeyValueStringParser::parse($formElement['itemList'], ':', ',', KVP_IF_VALUE_EMPTY_COPY_KEY);
904
905
            $itemValue = array_values($arr);
            $itemKey = array_keys($arr);
906
        } elseif ($fieldType === 'enum' || $fieldType === 'set') {
Carsten  Rose's avatar
Carsten Rose committed
907
            // already done at the beginning with '$this->getItemsForEnumOrSet($formElement['name'], $fieldType);'
908
        } else {
909
            throw new UserFormException("Missing definition (- nothing found in 'sql1', 'parameter:itemValues', 'enum-' or 'set-definition'", ERROR_MISSING_ITEM_VALUES);
910
911
912
913
914
        }

        if (count($itemKey) === 0) {
            $itemKey = $itemValue;
        }
915
916
917
918
919
920
921
922
923
924

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

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

Carsten  Rose's avatar
Carsten Rose committed
926
927
        if (isset($formElement['emptyHide'])) {
            if (isset($itemValue['']))
928
                unset($itemValue['']);
Carsten  Rose's avatar
Carsten Rose committed
929
            if (isset($itemKey['']))
930
931
932
                unset($itemKey['']);

        }
933
934
935
    }

    /**
936
937
     * Get the attribute definition list of an enum or set column. For strings, get the default value. Return elements as an array.
     *
938
939
940
     * @param $column
     * @param $fieldType
     * @return array
941
     * @throws UserFormException
942
943
944
945
946
947
948
     */
    private function getItemsForEnumOrSet($column, &$fieldType) {

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

        if ($fieldTypeDefinition === false) {
949
            throw new UserFormException("Column '$column' unknown in table '" . $this->formSpec['tableName'] . "'", ERROR_DB_UNKNOWN_COLUMN);
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
        }

        $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:
977
     *
978
979
980
981
982
     *    checked: first Element in $itemKey
     *  unchecked: ''
     *
     * @param array $itemKey
     * @param array $formElement
983
     * @throws UserFormException
984
985
986
     */
    private function prepareCheckboxCheckedUncheckedValue(array $itemKey, array &$formElement) {

987
        if (!isset($formElement[CHECKBOX_VALUE_CHECKED])) {
988
989
            if (isset($itemKey[0])) {
                // First element in $itemKey list
990
                $formElement[CHECKBOX_VALUE_CHECKED] = $itemKey[0];
991
992
            } else {
                // Take column default value
993
                $formElement[CHECKBOX_VALUE_CHECKED] = $this->store->getVar($formElement['name'], STORE_TABLE_DEFAULT);