AbstractBuildForm.php 71.6 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
34
35
    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();
36
    protected $wrap = array();
37
    protected $symbol = array();
Carsten  Rose's avatar
Carsten Rose committed
38
    protected $showDebugInfo = false;
39
    protected $inputCheckPattern = array();
Carsten  Rose's avatar
Carsten Rose committed
40

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

43
44
45
46
47
48
49
50
    /**
     * @var Store
     */
    protected $store = null;
    /**
     * @var Evaluate
     */
    protected $evaluate = null;
51
52
53
    /**
     * @var string
     */
54
    private $formId = null;
55
56
57
58
59
    /**
     * @var Sip
     */
    private $sip = null;

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

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

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

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

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

123
124
125
        $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>";
126

127
        $this->inputCheckPattern = Sanitize::inputCheckPatternArray();
128
129
    }

130
131
    abstract public function fillWrap();

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

        $modeCollectFe = FLAG_DYNAMIC_UPDATE;
        $storeUse = STORE_USE_DEFAULT;

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

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

163
        $filter = $this->getProcessFilter();
164

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

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

180
        // </form>
181

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

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

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

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

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

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

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

        return $html;
206
207
    }

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

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

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

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

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

230
        return $url;
231
232
233
    }

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

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

        $attribute = $this->getFormTagAtrributes();

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

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

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

        return $attribute;
    }

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

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

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

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

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

    }
314

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

    abstract public function doSubrecords();

319
    abstract public function getProcessFilter();
320
321

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

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

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

355
356
            $debugStack = array();

357
358
            // Preparation for Log, Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($fe), STORE_SYSTEM);
359
360

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

363
364
365
            // Some Defaults
            $formElement = Support::setFeDefaults($formElement);

366
367
368
            Support::setIfNotSet($formElement, F_BS_LABEL_COLUMNS);
            Support::setIfNotSet($formElement, F_BS_INPUT_COLUMNS);
            Support::setIfNotSet($formElement, F_BS_NOTE_COLUMNS);
369
370
371
372
373
            $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);

374
            // Get default value
375
            $value = ($formElement['value'] === '') ? $this->store->getVar($formElement['name'], $storeUse,
376
                $formElement['checkType']) : $formElement['value'];
Carsten  Rose's avatar
Carsten Rose committed
377

378
379
380
            // 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);
381

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

Carsten  Rose's avatar
Carsten Rose committed
385
            $jsonElement = array();
386
            // Render pure element
Carsten  Rose's avatar
Carsten Rose committed
387
388
            $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementId, $value, $jsonElement);

389
390
//            $fake0 = $fe['dynamicUpdate'];
//            $fake1 = $formElement['dynamicUpdate'];
Carsten  Rose's avatar
Carsten Rose committed
391
392
393
394
395
396
397
398

            // 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
399
                if ($modeCollectFe === FLAG_ALL || ($modeCollectFe == FLAG_DYNAMIC_UPDATE && $fe['dynamicUpdate'] == 'yes')) {
Carsten  Rose's avatar
Carsten Rose committed
400
401
402
403
404
405
                    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
406
407
                }
            }
408
409

            // debugStack as Tooltip
Carsten  Rose's avatar
Carsten Rose committed
410
            if ($this->showDebugInfo && count($debugStack) > 0) {
411
412
//                $elementHtml = Support::appendTooltip($elementHtml, implode("\n", OnArray::htmlentitiesOnArray($debugStack)));
                $elementHtml = Support::appendTooltip($elementHtml, implode("\n", $debugStack));
413
414
            }

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

418
            $html .= $this->$buildRowName($formElement, $elementHtml, $htmlFormElementId);
Carsten  Rose's avatar
Carsten Rose committed
419
//            break;
420
        }
421

422
423
424
        // Log / Debug: Last FormElement has been processed.
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

425
426
427
        return $html;
    }

428
429
    abstract public function fillWrapLabelInputNote($label, $input, $note);

430
431
432
    /**
     * Create a hidden sip, based on latest STORE_SIP Values. Return complete HTML 'hidden' element.
     *
433
     * @param array $json
434
435
436
437
     * @return string  <input type='hidden' name='s' value='<sip>'>
     * @throws CodeException
     * @throws \qfq\UserFormException
     */
438
    public function buildHiddenSip(array &$json) {
439
440
441
442
443
444
445
446
447
        $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);

448
        $json[] = $this->getJsonElementUpdate(CLIENT_SIP, $sipValue, FE_MODE_SHOW);
449
450
451
452
453
454
455

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

    /**
     * @param $htmlFormElementId
     * @param string|array $value
456
     * @param string $feMode disabled|readonly|''
457
458
     * @return array
     */
459
    private function getJsonElementUpdate($htmlFormElementId, $value, $feMode) {
460

461
        $json = $this->getJsonFeMode($feMode);
462
463
464
465
466
467
468

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

        return $json;
    }

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

513
514
515
516
517
518
519
520
521
522
523
    /**
     * 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
524
525
526
527
    /**
     * Takes the current SIP ('form' and additional parameter), set SIP_RECORD_ID=0 and create a new 'NewRecordUrl'.
     *
     * @throws CodeException
528
     * @throws \qfq\UserFormException
Carsten  Rose's avatar
Carsten Rose committed
529
530
531
532
     */
    public function deriveNewRecordUrlFromExistingSip(&$toolTipNew) {
        $urlParam = $this->store->getStore(STORE_SIP);
        $urlParam[SIP_RECORD_ID] = 0;
533

Carsten  Rose's avatar
Carsten Rose committed
534
535
        unset($urlParam[SIP_SIP]);
        unset($urlParam[SIP_URLPARAM]);
536
537

        Support::appendTypo3ParameterToArray($urlParam);
Carsten  Rose's avatar
Carsten Rose committed
538
539
540
541
542

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

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

543
        if ($this->showDebugInfo) {
544
            //TODO: missing decoding of SIP
545
546
            $toolTipNew .= PHP_EOL . PHP_EOL . OnArray::toString($urlParam, ' = ', PHP_EOL, "'");
        }
Carsten  Rose's avatar
Carsten Rose committed
547
548
549
550

        return $url;
    }

551
    abstract public function buildRowNative(array $formElement, $htmlElement, $htmlFormElementId);
552

553
    abstract public function buildRowPill(array $formElement, $elementHtml);
554

555
    abstract public function buildRowFieldset(array $formElement, $elementHtml);
556

557
    abstract public function buildRowSubrecord(array $formElement, $elementHtml);
558

559
    /**
560
561
     * Builds a label, typically for an html-'<input>'-element.
     *
562
563
     * @param string $htmlFormElementId
     * @param string $label
564
565
     * @return string
     */
566
    public function buildLabel($htmlFormElementId, $label) {
567
568
569
570
        $attributes = Support::doAttribute('for', $htmlFormElementId);
        $attributes .= Support::doAttribute('class', 'control-label');

        $html = Support::wrapTag("<label $attributes>", $label);
571
572

        return $html;
573
574
    }

575
576
577
578
    /**
     * 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
579
     *           [pattern="$pattern"] [required="required"] [disabled="disabled"] value="$value">
580
581
582
583
584
     *
     *
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
585
     * @param array $json
586
     * @return string
587
     * @throws \qfq\UserFormException
588
     */
589
    public function buildInput(array $formElement, $htmlFormElementId, $value, array &$json) {
590
        $textarea = '';
591

592
        $attribute = Support::doAttribute('name', $htmlFormElementId);
593
        $attribute .= Support::doAttribute('class', 'form-control');
594

595
        // Check for input type 'textarea'
596
        $colsRows = explode(',', $formElement['size'], 2);
597
        if (count($colsRows) === 2) {
598
            // <textarea>
599
600
            $htmlTag = '<textarea';

601
602
            $attribute .= Support::doAttribute('cols', $colsRows[0]);
            $attribute .= Support::doAttribute('rows', $colsRows[1]);
603
            $textarea = htmlentities($value) . '</textarea>';
604
605

        } else {
Carsten  Rose's avatar
Carsten Rose committed
606
607
608
609
            $htmlTag = '<input';

            $this->adjustMaxLength($formElement);

610
611
            // <input>
            if ($formElement['maxLength'] > 0) {
Carsten  Rose's avatar
Carsten Rose committed
612
613
614
                // crop string only if it's not empty (substr returns false on empty strings)
                if ($value !== '')
                    $value = substr($value, 0, $formElement['maxLength']);
615

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

622
        $attribute .= $this->getAttributeList($formElement, ['autocomplete', 'autofocus', 'placeholder']);
623
624
        $attribute .= Support::doAttribute('data-load', ($formElement['dynamicUpdate'] === 'yes') ? 'data-load' : '');
        $attribute .= Support::doAttribute('title', $formElement['tooltip']);
Carsten  Rose's avatar
Carsten Rose committed
625
        $attribute .= $this->getInputCheckPattern($formElement['checkType'], $formElement['checkPattern']);
626

627
        $attribute .= $this->getAttributeFeMode($formElement[FE_MODE]);
628

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

631
        return "$htmlTag $attribute>$textarea" . $this->getHelpBlock();
632

633
634
    }

Carsten  Rose's avatar
Carsten Rose committed
635
636
637
638
639
640
641
642
    /**
     * @param array $formElement
     */
    private function adjustMaxLength(array &$formElement) {

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

643
        switch ($formElement[FE_TYPE]) {
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
            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
664
665
666
667
668
669
670
671
672
673
674
        if ($maxLength !== false) {
            if (is_numeric($formElement['maxLength'])) {
                if ($formElement['maxLength'] > $maxLength) {
                    $formElement['maxLength'] = $maxLength;
                }
            } else {
                $formElement['maxLength'] = $maxLength;
            }
        }
    }

675
    /**
676
677
     * Get column spec from tabledefinition and parse size of it. If nothing defined, return false.
     *
678
     * @param $column
679
     * @return bool|int  a) 'false' if there is no length definition, b) length definition, c) date|time|datetime|timestamp use hardcoded length
680
681
682
683
684
     */
    private function getColumnSize($column) {
        $matches = array();

        $typeSpec = $this->store->getVar($column, STORE_TABLE_COLUMN_TYPES);
685
686
687
688
689
690
691
692
693
694
695
        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;
        }
696

697
        // e.g.: string(64) >> 64, enum('yes','no') >> false
698
699
700
701
702
703
        if (1 === preg_match('/\((.+)\)/', $typeSpec, $matches)) {
            if (is_numeric($matches[1]))
                return $matches[1];
        }

        return false;
704
705
706
707
    }

    /**
     * Builds a HTML attribute list, based on  $attributeList.
708
     *
709
     * E.g.: attributeList: [ 'type', 'autofocus' ]
710
     *       generates: 'type="$formElement[FE_TYPE]" autofocus="$formElement['autofocus']" '
711
712
713
714
715
     *
     * @param array $formElement
     * @param array $attributeList
     * @return string
     */
Carsten  Rose's avatar
Carsten Rose committed
716
    private function getAttributeList(array $formElement, array $attributeList) {
717
718
719
        $attribute = '';
        foreach ($attributeList as $item) {
            if (isset($formElement[$item]))
720
                $attribute .= Support::doAttribute(strtolower($item), $formElement[$item]);
721
722
723
724
725
726
        }
        return $attribute;
    }

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

746
747
        if ($type === '') {
            return '';
748
        }
749

750
751
752
753
754
        switch ($type) {
            case SANITIZE_ALLOW_MIN_MAX:
            case SANITIZE_ALLOW_MIN_MAX_DATE:
                $arrData = explode("|", $data);
                if (count($arrData) != 2 || $arrData[0] == '' || $arrData[1] == '')
755
                    throw new UserFormException("Missing MIN|MAX values", ERROR_MISSING_MIN_MAX);
756

757
758
759
                $attribute = 'min="' . $arrData[0] . '" ';
                $attribute .= 'max="' . $arrData[1] . '" ';
                break;
760

761
762
763
764
765
766
767
768
769
770
            case SANITIZE_ALLOW_PATTERN:
                $attribute = 'pattern="' . $data . '" ';
                break;

            case SANITIZE_ALLOW_ALL:
                break;

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

773
774
775
776
        return $attribute;
    }

    /**
777
     * Set corresponding html attributes readonly/required/disabled, based on $formElement[FE_MODE].
778
     *
779
     * @param string $feMode
780
     * @return string
781
     * @throws UserFormException
782
     */
783
    private function getAttributeFeMode($feMode) {
784
785
        $attribute = '';

786
787
788
789
790
        $this->getFeMode($feMode, $hidden, $disabled, $required);

        switch ($feMode) {
            case FE_MODE_HIDDEN:
            case FE_MODE_SHOW:
791
                break;
792
793
794
            case FE_MODE_REQUIRED:
            case FE_MODE_READONLY:
                $attribute .= Support::doAttribute($feMode, $feMode);
795
796
                break;
            default:
797
                throw new UserFormException("Unknown mode '$feMode'", ERROR_UNKNOWN_MODE);
798
799
                break;
        }
800

801
        // Attributes: data-...
802
        $attribute .= Support::doAttribute(DATA_HIDDEN, $hidden);
803
        $attribute .= Support::doAttribute(DATA_DISABLED, $disabled);
804
805
        $attribute .= Support::doAttribute(DATA_REQUIRED, $required);

806
807
808
        return $attribute;
    }

809
810
811
812
813
814
815
    /**
     * @return string
     */
    private function getHelpBlock() {
        return '<div class="help-block with-errors"></div>';
    }

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

        // Fill $itemKey & $itemValue
838
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
839
840
841

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

        if ($formElement['checkBoxMode'] === 'multi') {
847
//            $htmlFormElementId .= '[]';
848
        } else {
849
            // Fill meaningfull defaults to parameter: checked|unchecked  (CHECKBOX_VALUE_CHECKED|CHECKBOX_VALUE_UNCHECKED)
850
851
852
            $this->prepareCheckboxCheckedUncheckedValue($itemKey, $formElement);
        }

853
        $attributeBase = $this->getAttributeFeMode($formElement[FE_MODE]);
854
        $attributeBase .= Support::doAttribute('type', $formElement[FE_TYPE]);
855
856
857

        switch ($formElement['checkBoxMode']) {
            case 'single':
858
                $html = $this->buildCheckboxSingle($formElement, $htmlFormElementId, $attributeBase, $value, $json);
859
860
                break;
            case 'multi';
861
                $html = $this->buildCheckboxMulti($formElement, $htmlFormElementId, $attributeBase, $value, $itemKey, $itemValue, $json);
862
863
                break;
            default:
864
                throw new UserFormException('checkBoxMode: \'' . $formElement['checkBoxMode'] . '\' is unknown.', ERROR_CHECKBOXMODE_UNKNOWN);
865
        }
866

867
868
869
        return $html;
    }

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

890
891
892
        if (count($formElement) < 20)
            throw new CodeException("Invalid (none or to small) Formelement", ERROR_MISSING_FORMELEMENT);

893
        // Call getItemsForEnumOrSet() only if there a corresponding column really exist.
894
        if (false !== $this->store->getVar($formElement['name'], STORE_TABLE_COLUMN_TYPES)) {
895
896
            $itemValue = $this->getItemsForEnumOrSet($formElement['name'], $fieldType);
        }
897
898

        if (is_array($formElement['sql1'])) {
899
900
901
            if (count($formElement['sql1']) > 0) {
                $keys = array_keys($formElement['sql1'][0]);
                $itemKey = array_column($formElement['sql1'], 'id');
902

903
904
905
906
                // 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]);
                }
907

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

        if (count($itemKey) === 0) {
            $itemKey = $itemValue;
        }
928
929
930
931
932
933
934
935
936
937

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

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

Carsten  Rose's avatar
Carsten Rose committed
939
940
        if (isset($formElement['emptyHide'])) {
            if (isset($itemValue['']))
941
                unset($itemValue['']);
Carsten  Rose's avatar
Carsten Rose committed
942
            if (isset($itemKey['']))
943
944
945
                unset($itemKey['']);

        }
946
947
948
    }

    /**
949
950
     * Get the attribute definition list of an enum or set column. For strings, get the default value. Return elements as an array.
     *
951
952
953
     * @param $column
     * @param $fieldType
     * @return array
954
     * @throws UserFormException
955
956
957
958
959
960
961
     */
    private function getItemsForEnumOrSet($column, &$fieldType) {

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

        if ($fieldTypeDefinition === false) {
962
            throw new UserFormException("Column '$column' unknown in table '" . $this->formSpec['tableName'] . "'", ERROR_DB_UNKNOWN_COLUMN);
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
        }

        $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