AbstractBuildForm.php 71 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
323
324
325
     * @param array $json
     * @param string $modeCollectFe
     * @param bool $htmlElementNameIdZero
     * @param string $storeUse
326
     * @return string
327
328
     * @throws CodeException
     * @throws DbException
329
     * @throws \qfq\UserFormException
330
     */
331
    public function elements($recordId, $filter = FORM_ELEMENTS_NATIVE, $feIdContainer = 0, array &$json,
332
                             $modeCollectFe = FLAG_DYNAMIC_UPDATE, $htmlElementNameIdZero = false, $storeUse = STORE_USE_DEFAULT) {
333
334
335
        $html = '';

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

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

350
351
            $debugStack = array();

352
353
            // Preparation for Log, Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($fe), STORE_SYSTEM);
354
355

            // evaluate current FormElement
356
            $evaluate = new Evaluate($this->store, $this->db);
357
            $formElement = $evaluate->parseArray($fe, $debugStack);
358

359
360
361
            // Some Defaults
            $formElement = Support::setFeDefaults($formElement);

362
363
364
            Support::setIfNotSet($formElement, F_BS_LABEL_COLUMNS);
            Support::setIfNotSet($formElement, F_BS_INPUT_COLUMNS);
            Support::setIfNotSet($formElement, F_BS_NOTE_COLUMNS);
365
366
367
368
369
            $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);

370
            // Get default value
371
            $value = ($formElement['value'] === '') ? $this->store->getVar($formElement['name'], $storeUse,
372
                $formElement['checkType']) : $formElement['value'];
Carsten  Rose's avatar
Carsten Rose committed
373

374
375
376
            // 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);
377

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

Carsten  Rose's avatar
Carsten Rose committed
381
            $jsonElement = array();
382
            // Render pure element
Carsten  Rose's avatar
Carsten Rose committed
383
384
            $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementId, $value, $jsonElement);

385
386
//            $fake0 = $fe['dynamicUpdate'];
//            $fake1 = $formElement['dynamicUpdate'];
Carsten  Rose's avatar
Carsten Rose committed
387
388
389
390
391
392
393
394

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

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

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

409
            $html .= $this->$buildRowName($formElement, $elementHtml, $htmlFormElementId);
Carsten  Rose's avatar
Carsten Rose committed
410
//            break;
411
        }
412

413
414
415
        // Log / Debug: Last FormElement has been processed.
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

416
417
418
        return $html;
    }

419
420
    abstract public function fillWrapLabelInputNote($label, $input, $note);

421
422
423
    /**
     * Create a hidden sip, based on latest STORE_SIP Values. Return complete HTML 'hidden' element.
     *
424
     * @param array $json
425
426
427
428
     * @return string  <input type='hidden' name='s' value='<sip>'>
     * @throws CodeException
     * @throws \qfq\UserFormException
     */
429
    public function buildHiddenSip(array &$json) {
430
431
432
433
434
435
436
437
438
        $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);

439
        $json[] = $this->getJsonElementUpdate(CLIENT_SIP, $sipValue, FE_MODE_SHOW);
440
441
442
443
444
445
446

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

    /**
     * @param $htmlFormElementId
     * @param string|array $value
447
     * @param string $feMode disabled|readonly|''
448
449
     * @return array
     */
450
    private function getJsonElementUpdate($htmlFormElementId, $value, $feMode) {
451

452
        $json = $this->getJsonFeMode($feMode);
453
454
455
456
457
458
459

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

        return $json;
    }

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

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

Carsten  Rose's avatar
Carsten Rose committed
525
526
        unset($urlParam[SIP_SIP]);
        unset($urlParam[SIP_URLPARAM]);
527
528

        Support::appendTypo3ParameterToArray($urlParam);
Carsten  Rose's avatar
Carsten Rose committed
529
530
531
532
533

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

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

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

        return $url;
    }

542
    abstract public function buildRowNative(array $formElement, $htmlElement, $htmlFormElementId);
543

544
    abstract public function buildRowPill(array $formElement, $elementHtml);
545

546
    abstract public function buildRowFieldset(array $formElement, $elementHtml);
547

548
    abstract public function buildRowSubrecord(array $formElement, $elementHtml);
549

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

        $html = Support::wrapTag("<label $attributes>", $label);
562
563

        return $html;
564
565
    }

566
567
568
569
    /**
     * 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
570
     *           [pattern="$pattern"] [required="required"] [disabled="disabled"] value="$value">
571
572
573
574
575
     *
     *
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
576
     * @param array $json
577
     * @return string
578
     * @throws \qfq\UserFormException
579
     */
580
    public function buildInput(array $formElement, $htmlFormElementId, $value, array &$json) {
581
        $textarea = '';
582

583
        $attribute = Support::doAttribute('name', $htmlFormElementId);
584
        $attribute .= Support::doAttribute('class', 'form-control');
585

586
        // Check for input type 'textarea'
587
        $colsRows = explode(',', $formElement['size'], 2);
588
        if (count($colsRows) === 2) {
589
            // <textarea>
590
591
            $htmlTag = '<textarea';

592
593
            $attribute .= Support::doAttribute('cols', $colsRows[0]);
            $attribute .= Support::doAttribute('rows', $colsRows[1]);
594
            $textarea = htmlentities($value) . '</textarea>';
595
596

        } else {
Carsten  Rose's avatar
Carsten Rose committed
597
598
599
600
            $htmlTag = '<input';

            $this->adjustMaxLength($formElement);

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

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

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

618
        $attribute .= $this->getAttributeFeMode($formElement[FE_MODE]);
619

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

622
        return "$htmlTag $attribute>$textarea" . $this->getHelpBlock();
623

624
625
    }

Carsten  Rose's avatar
Carsten Rose committed
626
627
628
629
630
631
632
633
    /**
     * @param array $formElement
     */
    private function adjustMaxLength(array &$formElement) {

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

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

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

        $typeSpec = $this->store->getVar($column, STORE_TABLE_COLUMN_TYPES);
676
677
678
679
680
681
682
683
684
685
686
        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;
        }
687

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

        return false;
695
696
697
698
    }

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

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

737
738
        if ($type === '') {
            return '';
739
        }
740

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

748
749
750
                $attribute = 'min="' . $arrData[0] . '" ';
                $attribute .= 'max="' . $arrData[1] . '" ';
                break;
751

752
753
754
755
756
757
758
759
760
761
            case SANITIZE_ALLOW_PATTERN:
                $attribute = 'pattern="' . $data . '" ';
                break;

            case SANITIZE_ALLOW_ALL:
                break;

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

764
765
766
767
        return $attribute;
    }

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

777
778
779
780
781
        $this->getFeMode($feMode, $hidden, $disabled, $required);

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

792
        // Attributes: data-...
793
        $attribute .= Support::doAttribute(DATA_HIDDEN, $hidden);
794
        $attribute .= Support::doAttribute(DATA_DISABLED, $disabled);
795
796
        $attribute .= Support::doAttribute(DATA_REQUIRED, $required);

797
798
799
        return $attribute;
    }

800
801
802
803
804
805
806
    /**
     * @return string
     */
    private function getHelpBlock() {
        return '<div class="help-block with-errors"></div>';
    }

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

        // Fill $itemKey & $itemValue
829
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
830
831
832

        // Get fallback, if 'checkBoxMode' is not defined:
        if (!isset($formElement['checkBoxMode'])) {
833
            // This fallback is problematic if 'set' or 'enum' has 2 : defaults to single but maybe multi is meant.
834
835
836
837
838
839
            $formElement['checkBoxMode'] = (count($itemKey) > 2) ? 'multi' : 'single';
        }

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

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

        switch ($formElement['checkBoxMode']) {
            case 'single':
849
                $html = $this->buildCheckboxSingle($formElement, $htmlFormElementId, $attributeBase, $value, $json);
850
851
                break;
            case 'multi';
852
                $html = $this->buildCheckboxMulti($formElement, $htmlFormElementId, $attributeBase, $value, $itemKey, $itemValue, $json);
853
854
                break;
            default:
855
                throw new UserFormException('checkBoxMode: \'' . $formElement['checkBoxMode'] . '\' is unknown.', ERROR_CHECKBOXMODE_UNKNOWN);
856
        }
857

858
859
860
        return $html;
    }

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

881
882
883
        if (count($formElement) < 20)
            throw new CodeException("Invalid (none or to small) Formelement", ERROR_MISSING_FORMELEMENT);

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

        if (is_array($formElement['sql1'])) {
890
891
892
            if (count($formElement['sql1']) > 0) {
                $keys = array_keys($formElement['sql1'][0]);
                $itemKey = array_column($formElement['sql1'], 'id');
893

894
895
896
897
                // 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]);
                }
898

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

        if (count($itemKey) === 0) {
            $itemKey = $itemValue;
        }
919
920
921
922
923
924
925
926
927
928

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

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

Carsten  Rose's avatar
Carsten Rose committed
930
931
        if (isset($formElement['emptyHide'])) {
            if (isset($itemValue['']))
932
                unset($itemValue['']);
Carsten  Rose's avatar
Carsten Rose committed
933
            if (isset($itemKey['']))
934
935
936
                unset($itemKey['']);

        }
937
938
939
    }

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

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

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

        $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:
981
     *