AbstractBuildForm.php 93 KB
Newer Older
1
<?php
Carsten  Rose's avatar
Carsten Rose committed
2
3
4
5
6
7
/**
 * Created by PhpStorm.
 * User: crose
 * Date: 1/6/16
 * Time: 8:02 PM
 */
Carsten  Rose's avatar
Carsten Rose committed
8

9
10
11
namespace qfq;

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

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

26
27

/**
Carsten  Rose's avatar
Carsten Rose committed
28
29
 * Class AbstractBuildForm
 * @package qfq
30
 */
31
abstract class AbstractBuildForm {
32
33
34
35
36
    protected $formSpec = array();  // copy of the loaded form
    protected $feSpecAction = array(); // copy of all formElement.class='action' of the loaded form
    protected $feSpecNative = array(); // copy of all formElement.class='native' of the loaded form
    protected $buildElementFunctionName = array();
    protected $pattern = array();
37
    protected $wrap = array();
38
    protected $symbol = array();
Carsten  Rose's avatar
Carsten Rose committed
39
    protected $showDebugInfo = false;
40
    protected $inputCheckPattern = array();
Carsten  Rose's avatar
Carsten Rose committed
41

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

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

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

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

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

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

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

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

132
        $this->inputCheckPattern = Sanitize::inputCheckPatternArray();
133
134
    }

135
136
    abstract public function fillWrap();

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

        $modeCollectFe = FLAG_DYNAMIC_UPDATE;
        $storeUse = STORE_USE_DEFAULT;

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

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

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

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

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

        // <form>
        if ($mode === FORM_LOAD) {
            $htmlTail = $this->tail();
            $htmlSubrecords = $this->doSubrecords();
        }

188
189
190
        $htmlSip = $this->buildHiddenSip($json);

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

193
    /**
194
     * Builds the head area of the form.
195
     *
196
     * @return string
197
     */
198
199
    public function head() {
        $html = '';
200

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

203
204
205
        // Logged in BE User will see a FormEdit Link
        $sipParamString = OnArray::toString($this->store->getStore(STORE_SIP), ':', ', ', "'");
        $formEditUrl = $this->createFormEditUrl();
206

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

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

211
212
213
        $html .= $this->getFormTag();

        return $html;
214
215
    }

216
    /**
217
     * If SHOW_DEBUG_INFO=yes: create a link (incl. SIP) to edit the current form. Show also the hidden content of the SIP.
218
     *
219
     * @return string String: <a href="?pageId&sip=....">Edit</a> <small>[sip:..., r:..., urlparam:..., ...]</small>
220
     */
221
    public function createFormEditUrl() {
222

Carsten  Rose's avatar
Carsten Rose committed
223
        if (!$this->showDebugInfo) {
224
225
            return '';
        }
226

227
228
229
230
231
        $queryStringArray = [
            'id' => $this->store->getVar(TYPO3_PAGE_ID, STORE_TYPO3),
            'form' => 'form',
            'r' => $this->formSpec['id']
        ];
232

233
        $queryString = Support::arrayToQueryString($queryStringArray);
234

235
236
        $sip = $this->store->getSipInstance();
        $url = $sip->queryStringToSip($queryString);
237

238
        return $url;
239
240
241
    }

    /**
242
243
     * Wrap's $this->wrap[$item][WRAP_SETUP_START] around $value. If $flagOmitEmpty==true && $value=='': return ''.
     *
244
245
246
247
248
249
     * @param $item
     * @param $value
     * @param bool|false $flagOmitEmpty
     * @return string
     */
    public function wrapItem($item, $value, $flagOmitEmpty = false) {
250
251

        if ($flagOmitEmpty && $value === "") {
252
            return '';
253
254
        }

255
256
257
258
        return $this->wrap[$item][WRAP_SETUP_START] . $value . $this->wrap[$item][WRAP_SETUP_END];
    }

    /**
259
     * Returns '<form ...>'-tag with various attributes.
260
261
262
263
264
265
266
267
268
269
270
271
272
     *
     * @return string
     */
    public function getFormTag() {

        $attribute = $this->getFormTagAtrributes();

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

    /**
     * Build an assoc array with standard form attributes.
     *
273
     * @return array
274
275
276
     */
    public function getFormTagAtrributes() {

277
        $attribute['id'] = $this->getFormId();
278
279
280
281
282
283
284
285
286
287
        $attribute['method'] = 'post';
        $attribute['action'] = $this->getActionUrl();
        $attribute['target'] = '_top';
        $attribute['accept-charset'] = 'UTF-8';
        $attribute['autocomplete'] = 'on';
        $attribute['enctype'] = $this->getEncType();

        return $attribute;
    }

288
    /**
Carsten  Rose's avatar
Carsten Rose committed
289
290
     * Return a uniq form id
     *
291
292
293
294
295
296
297
298
299
     * @return string
     */
    public function getFormId() {
        if ($this->formId === null) {
            $this->formId = uniqid('qfq-form-');
        }
        return $this->formId;
    }

300
301
302
    /**
     * Builds the HTML 'form'-tag inlcuding all attributes and target.
     *
303
304
     * Notice: the SIP will be transferred as POST Parameter.
     *
305
306
307
308
309
     * @return string
     * @throws DbException
     */
    public function getActionUrl() {

310
        return API_DIR . '/save.php';
311
312
313
314
315
316
317
318
319
320
321
322
    }

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

323
        $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"');
324
325
326
        return (count($result) === 1) ? 'multipart/form-data' : 'application/x-www-form-urlencoded';

    }
327

328
    abstract public function getProcessFilter();
329
330

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

351
352
353
        // The following 'FormElement.parameter' will never be used during load (fe.type='upload').
        $skip = [FE_SQL_UPDATE, FE_SQL_INSERT, FE_SQL_DELETE, FE_SQL_AFTER, FE_SQL_BEFORE, F_FE_PARAMETER];

354
        // get current data record
355
        if ($recordId > 0 && $this->store->getVar('id', STORE_RECORD) === false) {
356
            $row = $this->db->sql("SELECT * FROM " . $this->formSpec[F_TABLE_NAME] . " WHERE id = ?", ROW_EXPECT_1, array($recordId), "Form '" . $this->formSpec[F_NAME] . "' failed to load record '$recordId' from table '" . $this->formSpec[F_TABLE_NAME] . "'.");
357
            $this->store->setVarArray($row, STORE_RECORD);
358
        }
359

360
361
        $this->checkAutoFocus();

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

365
366
            if (($filter === FORM_ELEMENTS_NATIVE && $fe[FE_TYPE] === 'subrecord')
                || ($filter === FORM_ELEMENTS_SUBRECORD && $fe[FE_TYPE] !== 'subrecord')
Carsten  Rose's avatar
Carsten Rose committed
367
//                || ($filter === FORM_ELEMENTS_DYNAMIC_UPDATE && $fe['dynamicUpdate'] === 'no')
368
369
370
371
            ) {
                continue; // skip this FE
            }

372
            $flagOutput = ($fe[FE_TYPE] !== FE_TYPE_EXTRA); // type='extra' will not displayed not trasnmitted to the form
373

374
375
            $debugStack = array();

376
377
            // Preparation for Log, Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($fe), STORE_SYSTEM);
378

379
380
            // for Upload FormElements, it's necessary to precalculate an optional given 'slaveId'.
            if ($fe[FE_TYPE] === FE_TYPE_UPLOAD) {
381
                Support::setIfNotSet($fe, FE_SLAVE_ID);
382
383
                $slaveId = Support::falseEmptyToZero($this->evaluate->parse($fe[FE_SLAVE_ID]));
                $this->store->setVar(VAR_SLAVE_ID, $slaveId, STORE_VAR);
384
385
            }

386
            // evaluate current FormElement
387
            $formElement = $this->evaluate->parseArray($fe, $skip, $debugStack);
388

389
390
391
            // Some Defaults
            $formElement = Support::setFeDefaults($formElement);

392
393
394
395
396
397
398
399
400
            if ($flagOutput === true) {
                Support::setIfNotSet($formElement, F_BS_LABEL_COLUMNS);
                Support::setIfNotSet($formElement, F_BS_INPUT_COLUMNS);
                Support::setIfNotSet($formElement, F_BS_NOTE_COLUMNS);
                $label = ($formElement[F_BS_LABEL_COLUMNS] == '') ? $this->formSpec[F_BS_LABEL_COLUMNS] : $formElement[F_BS_LABEL_COLUMNS];
                $input = ($formElement[F_BS_INPUT_COLUMNS] == '') ? $this->formSpec[F_BS_INPUT_COLUMNS] : $formElement[F_BS_INPUT_COLUMNS];
                $note = ($formElement[F_BS_NOTE_COLUMNS] == '') ? $this->formSpec[F_BS_NOTE_COLUMNS] : $formElement[F_BS_NOTE_COLUMNS];
                $this->fillWrapLabelInputNote($label, $input, $note);
            }
401

402
403
            //In case the current element is a 'RETYPE' element: take the element name of the source FormElement. Needed in the next row to retrieve the default value.
            $name = (isset($formElement[FE_RETYPE_SOURCE_NAME])) ? $formElement[FE_RETYPE_SOURCE_NAME] : $formElement[FE_NAME];
404

405
            // Get default value
406
            $value = ($formElement[FE_VALUE] === '') ? $this->store->getVar($name, $storeUse,
407
                $formElement['checkType']) : $formElement[FE_VALUE];
Carsten  Rose's avatar
Carsten Rose committed
408

409
410
            // Typically: $htmlElementNameIdZero = true
            // After Saving a record, staying on the form, the FormElements on the Client are still known as '<feName>:0'.
411
            $htmlFormElementId = HelperFormElement::buildFormElementName($formElement[FE_NAME], ($htmlElementNameIdZero) ? 0 : $recordId);
412

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

Carsten  Rose's avatar
Carsten Rose committed
416
            $jsonElement = array();
417
            // Render pure element
418
            $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementId, $value, $jsonElement, $mode);
Carsten  Rose's avatar
Carsten Rose committed
419

420
421
//            $fake0 = $fe['dynamicUpdate'];
//            $fake1 = $formElement['dynamicUpdate'];
Carsten  Rose's avatar
Carsten Rose committed
422
423
424
425
426
427
428
429

            // 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
430
                if ($modeCollectFe === FLAG_ALL || ($modeCollectFe == FLAG_DYNAMIC_UPDATE && $fe['dynamicUpdate'] == 'yes')) {
Carsten  Rose's avatar
Carsten Rose committed
431
432
433
434
435
436
                    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
437
438
                }
            }
439

440
441
442
443
444
            if ($flagOutput) {
                // debugStack as Tooltip
                if ($this->showDebugInfo && count($debugStack) > 0) {
                    $elementHtml = Support::appendTooltip($elementHtml, implode("\n", $debugStack));
                }
445

446
447
                // Construct Marshaller Name: buildRow
                $buildRowName = 'buildRow' . $this->buildRowName[$formElement[FE_TYPE]];
448

449
450
                $html .= $this->$buildRowName($formElement, $elementHtml, $htmlFormElementId);
            }
451
        }
452

453
454
455
        // Log / Debug: Last FormElement has been processed.
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

456
457
458
        return $html;
    }

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
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
    /**
     * Check if there is an explicit 'autofocus' definition in at least one FE.
     * Found: do nothing, it will be rendered at the correct position.
     * Not found: set 'autofocus' on the first FE.
     *
     * Accepted misbehaviour on forms with pills: if there is at least one editable element on the first pill,
     *   the other pills are not checked - independent if there was a definition on the first pill or not.
     *   Reason: checks happens per pill - if there is no explizit definition on the first pill, take the first editable
     *           element of that pill.
     */
    private function checkAutoFocus() {
        static $found = false;
        $idx = false;

        if ($found) {
            return;
        }

        // Search if there is an explicit autofocus definition.
        for ($i = 0; $i < count($this->feSpecNative); ++$i) {
            // Only check native elements which will be shown
            if ($this->feSpecNative[$i][FE_CLASS] == FE_CLASS_NATIVE &&
                ($this->feSpecNative[$i][FE_MODE] == FE_MODE_SHOW || $this->feSpecNative[$i][FE_MODE] == FE_MODE_REQUIRED)
            ) {
                // Check if there is an explicit definition.
                if (isset($this->feSpecNative[$i][FE_AUTOFOCUS])) {
                    if ($this->feSpecNative[$i][FE_AUTOFOCUS] == '' || $this->feSpecNative[$i][FE_AUTOFOCUS] == '1') {
                        $this->feSpecNative[$i][FE_AUTOFOCUS] = '1'; // fix to '=1'
                    } else {
                        unset($this->feSpecNative[$i][FE_AUTOFOCUS]);
                    }
                    $found = true;
                    return;
                }

                if ($idx === false) {
                    $idx = $i;
                }
            }
        }

        // No explicit definition found: take the first found editable element.
        if ($idx !== false) {
            $found = true;
            // No explicit definition found: set autofocus.
            $this->feSpecNative[$idx][FE_AUTOFOCUS] = '1';
        }
    }

508
509
    abstract public function fillWrapLabelInputNote($label, $input, $note);

510
511
512
513
    abstract public function tail();

    abstract public function doSubrecords();

514
515
516
    /**
     * Create a hidden sip, based on latest STORE_SIP Values. Return complete HTML 'hidden' element.
     *
517
     * @param array $json
518
519
520
521
     * @return string  <input type='hidden' name='s' value='<sip>'>
     * @throws CodeException
     * @throws \qfq\UserFormException
     */
522
    public function buildHiddenSip(array &$json) {
523

524
        $sipArray = $this->store->getStore(STORE_SIP);
525
526

        // do not include system vars
527
528
529
530
531
532
533
534
        unset($sipArray[SIP_SIP]);
        unset($sipArray[SIP_URLPARAM]);

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

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

535
        $json[] = $this->getJsonElementUpdate(CLIENT_SIP, $sipValue, FE_MODE_SHOW);
536
537
538
539
540

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

    /**
Carsten  Rose's avatar
Carsten Rose committed
541
542
     * Create an array with standard elements and add 'form-element', 'value'.
     *
543
544
     * @param $htmlFormElementId
     * @param string|array $value
545
     * @param string $feMode disabled|readonly|''
546
547
     * @return array
     */
548
    private function getJsonElementUpdate($htmlFormElementId, $value, $feMode) {
549

550
        $json = $this->getJsonFeMode($feMode);
551
552
553
554
555
556
557

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

        return $json;
    }

558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
    /**
     * 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'];
    }

    /**
Carsten  Rose's avatar
Carsten Rose committed
573
574
     * Depending of $feMode set variables $hidden, $disabled, $required to 'yes' or 'no'.
     *
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
     * @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:
593
                $disabled = 'yes';  // convert the UI status 'readonly' to the HTML/CSS status 'disabled'.
594
595
596
597
598
599
600
601
602
603
                break;
            case FE_MODE_HIDDEN:
                $hidden = 'yes';
                break;
            default:
                throw new UserFormException("Unknown mode '$feMode'", ERROR_UNKNOWN_MODE);
                break;
        }
    }

604
605
606
607
608
609
610
611
612
613
614
    /**
     * 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
615
616
617
618
    /**
     * Takes the current SIP ('form' and additional parameter), set SIP_RECORD_ID=0 and create a new 'NewRecordUrl'.
     *
     * @throws CodeException
619
     * @throws \qfq\UserFormException
Carsten  Rose's avatar
Carsten Rose committed
620
621
622
623
     */
    public function deriveNewRecordUrlFromExistingSip(&$toolTipNew) {
        $urlParam = $this->store->getStore(STORE_SIP);
        $urlParam[SIP_RECORD_ID] = 0;
624

Carsten  Rose's avatar
Carsten Rose committed
625
626
        unset($urlParam[SIP_SIP]);
        unset($urlParam[SIP_URLPARAM]);
627
628

        Support::appendTypo3ParameterToArray($urlParam);
Carsten  Rose's avatar
Carsten Rose committed
629
630
631
632
633

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

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

634
        if ($this->showDebugInfo) {
635
            //TODO: missing decoding of SIP
636
637
            $toolTipNew .= PHP_EOL . PHP_EOL . OnArray::toString($urlParam, ' = ', PHP_EOL, "'");
        }
Carsten  Rose's avatar
Carsten Rose committed
638
639
640
641

        return $url;
    }

642
    abstract public function buildRowPill(array $formElement, $elementHtml);
643

644
    abstract public function buildRowFieldset(array $formElement, $elementHtml);
645

646
647
    abstract public function buildRowTemplateGroup(array $formElement, $elementHtml);

648
    abstract public function buildRowSubrecord(array $formElement, $elementHtml);
649

650
    /**
651
652
     * Builds a label, typically for an html-'<input>'-element.
     *
653
654
     * @param string $htmlFormElementId
     * @param string $label
655
656
     * @return string
     */
657
    public function buildLabel($htmlFormElementId, $label) {
658
659
660
661
        $attributes = Support::doAttribute('for', $htmlFormElementId);
        $attributes .= Support::doAttribute('class', 'control-label');

        $html = Support::wrapTag("<label $attributes>", $label);
662
663

        return $html;
664
665
    }

666
667
668
669
    /**
     * 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
670
     *           [pattern="$pattern"] [required="required"] [disabled="disabled"] value="$value">
671
672
673
674
675
     *
     *
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
676
     * @param array $json
677
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE
678
     * @return string
679
     * @throws \qfq\UserFormException
680
     */
681
    public function buildInput(array $formElement, $htmlFormElementId, $value, array &$json, $mode = FORM_LOAD) {
682
        $textarea = '';
683

684
        $attribute = Support::doAttribute('name', $htmlFormElementId);
685
        $attribute .= Support::doAttribute('class', 'form-control');
686

687
        if (isset($formElement[FE_RETYPE_SOURCE_NAME])) {
688
689
            $htmlFormElementIdPrimary = str_replace(RETYPE_FE_NAME_EXTENSION, '', $htmlFormElementId);
            $attribute .= Support::doAttribute('data-match', '[name=' . str_replace(':', '\\:', $htmlFormElementIdPrimary) . ']');
690
691
        }

692
        // Check for input type 'textarea'
693
        $colsRows = explode(',', $formElement['size'], 2);
694
        if (count($colsRows) === 2) {
695
            // <textarea>
696
697
            $htmlTag = '<textarea';

698
699
            $attribute .= Support::doAttribute('cols', $colsRows[0]);
            $attribute .= Support::doAttribute('rows', $colsRows[1]);
700
            $textarea = htmlentities($value) . '</textarea>';
701
702

        } else {
Carsten  Rose's avatar
Carsten Rose committed
703
704
705
706
            $htmlTag = '<input';

            $this->adjustMaxLength($formElement);

707
            if ($formElement['maxLength'] > 0 && $value !== '') {
Carsten  Rose's avatar
Carsten Rose committed
708
                // crop string only if it's not empty (substr returns false on empty strings)
709
                $value = substr($value, 0, $formElement['maxLength']);
710
            }
711
712
713
714

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

717
        $attribute .= $this->getAttributeList($formElement, ['autocomplete', 'autofocus', 'placeholder']);
718
        $attribute .= $this->getAttributeList($formElement, [F_FE_DATA_PATTERN_ERROR, F_FE_DATA_REQUIRED_ERROR, F_FE_DATA_MATCH_ERROR, F_FE_DATA_ERROR]);
719
720
        $attribute .= Support::doAttribute('data-load', ($formElement['dynamicUpdate'] === 'yes') ? 'data-load' : '');
        $attribute .= Support::doAttribute('title', $formElement['tooltip']);
Carsten  Rose's avatar
Carsten Rose committed
721
        $attribute .= $this->getInputCheckPattern($formElement['checkType'], $formElement['checkPattern']);
722

723
        $attribute .= $this->getAttributeFeMode($formElement[FE_MODE]);
724

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

727
        return "$htmlTag $attribute>$textarea" . $this->getHelpBlock();
728

729
730
    }

Carsten  Rose's avatar
Carsten Rose committed
731
    /**
Carsten  Rose's avatar
Carsten Rose committed
732
733
     * Calculates the maxlength of an input field, based on formElement type, formElement user definition and table.field definition.
     *
Carsten  Rose's avatar
Carsten Rose committed
734
735
736
737
738
739
740
     * @param array $formElement
     */
    private function adjustMaxLength(array &$formElement) {

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

741
        switch ($formElement[FE_TYPE]) {
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
            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
762
        if ($maxLength !== false) {
763
            if (is_numeric($formElement['maxLength']) && $formElement['maxLength'] != 0) {
Carsten  Rose's avatar
Carsten Rose committed
764
765
766
767
768
769
770
771
772
                if ($formElement['maxLength'] > $maxLength) {
                    $formElement['maxLength'] = $maxLength;
                }
            } else {
                $formElement['maxLength'] = $maxLength;
            }
        }
    }

773
    /**
774
775
     * Get column spec from tabledefinition and parse size of it. If nothing defined, return false.
     *
776
     * @param $column
777
     * @return bool|int  a) 'false' if there is no length definition, b) length definition, c) date|time|datetime|timestamp use hardcoded length
778
779
780
781
782
     */
    private function getColumnSize($column) {
        $matches = array();

        $typeSpec = $this->store->getVar($column, STORE_TABLE_COLUMN_TYPES);
783
784
785
786
787
788
789
790
791
        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:
792
793
794
                if (substr($typeSpec, 0, 4) === 'set(' || substr($typeSpec, 0, 5) === 'enum(') {
                    return $this->maxLengthSetEnum($typeSpec);
                }
795
796
                break;
        }
797

798
        // e.g.: string(64) >> 64, enum('yes','no') >> false
799
800
801
802
803
804
        if (1 === preg_match('/\((.+)\)/', $typeSpec, $matches)) {
            if (is_numeric($matches[1]))
                return $matches[1];
        }

        return false;
805
806
    }

807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
    /**
     * Get the strlen of the longest element in enum('val1','val2',...,'valn') or set('val1','val2',...,'valn')
     *
     * @param string $typeSpec
     * @return int
     */
    private function maxLengthSetEnum($typeSpec) {
        $startPos = (substr($typeSpec, 0, 4) === 'set(') ? 4 : 5;
        $max = 0;

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

        return $max;
    }

830
831
    /**
     * Builds a HTML attribute list, based on  $attributeList.
832
     *
833
     * E.g.: attributeList: [ 'type', 'autofocus' ]
834
     *       generates: 'type="$formElement[FE_TYPE]" autofocus="$formElement['autofocus']" '
835
836
837
     *
     * @param array $formElement
     * @param array $attributeList
838
     * @param bool $flagOmitEmpty
839
840
     * @return string
     */
841
    private function getAttributeList(array $formElement, array $attributeList, $flagOmitEmpty = true) {
842
843
844
        $attribute = '';
        foreach ($attributeList as $item) {
            if (isset($formElement[$item]))
845
                $attribute .= Support::doAttribute(strtolower($item), $formElement[$item], $flagOmitEmpty);
846
847
848
849
850
851
        }
        return $attribute;
    }

    /**
     * Construct HTML Input attribute for Client Validation:
852
     *
853
     *   type     data                      result
854
     *   -------  -----------------------   -------------------------------------------------------------------------------
855
856
     *   min|max  <min value>|<max value>   min="$attrData[0]"|max="$attrData[1]"
     *   pattern  <regexp>                  pattern="$data"
Carsten  Rose's avatar
Carsten Rose committed
857
     *   digit    -                         pattern="^[0-9]*$"
858
     *   email    -                         pattern="^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\.[a-z]{2,4})$"
859
     *   alnumx   -
860
     *
861
     * For 'min/max' and 'pattern' the 'data' will be injected in the attribute string via '%s'.
862
863
864
865
     *
     * @param $type
     * @param $data
     * @return string
866
     * @throws \qfq\UserFormException
867
     */
Carsten  Rose's avatar
Carsten Rose committed
868
    private function getInputCheckPattern($type, $data) {
869
870
        $attribute = '';

871
872
        if ($type === '') {
            return '';
873
        }
874

875
876
877
878
879
        switch ($type) {
            case SANITIZE_ALLOW_MIN_MAX:
            case SANITIZE_ALLOW_MIN_MAX_DATE:
                $arrData = explode("|", $data);
                if (count($arrData) != 2 || $arrData[0] == '' || $arrData[1] == '')
880
                    throw new UserFormException("Missing MIN|MAX values", ERROR_MISSING_MIN_MAX);
881

882
883
884
                $attribute = 'min="' . $arrData[0] . '" ';
                $attribute .= 'max="' . $arrData[1] . '" ';
                break;
885

886
887
888
889
890
891
892
893
894
895
            case SANITIZE_ALLOW_PATTERN:
                $attribute = 'pattern="' . $data . '" ';
                break;

            case SANITIZE_ALLOW_ALL:
                break;

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

898
899
900
901
        return $attribute;
    }

    /**
902
     * Set corresponding html attributes readonly/required/disabled, based on $formElement[FE_MODE].
903
     *
904
     * @param string $feMode
905
     * @return string
906
     * @throws UserFormException
907
     */
908
    private function getAttributeFeMode($feMode) {
909
910
        $attribute = '';

911
912
913
914
915
        $this->getFeMode($feMode, $hidden, $disabled, $required);

        switch ($feMode) {
            case FE_MODE_HIDDEN:
            case FE_MODE_SHOW:
916
                break;
917
918
919
            case FE_MODE_REQUIRED:
            case FE_MODE_READONLY:
                $attribute .= Support::doAttribute($feMode, $feMode);
920
921
                break;
            default:
922
                throw new UserFormException("Unknown mode '$feMode'", ERROR_UNKNOWN_MODE);
923
924
                break;
        }
925

926
        // Attributes: data-...
927
        $attribute .= Support::doAttribute(DATA_HIDDEN, $hidden);
928
        $attribute .= Support::doAttribute(DATA_DISABLED, $disabled);
929
930
        $attribute .= Support::doAttribute(DATA_REQUIRED, $required);

931
932
933
        return $attribute;
    }

934
    /**
Carsten  Rose's avatar
Carsten Rose committed
935
936
     * Build HelpBlock
     *
937
938
939
     * @return string
     */
    private function getHelpBlock() {
940
941
        //TODO: #3066 Class 'hidden' einbauen
//        return '<div class="help-block with-errors hidden"></div>';
942
        return '<div class="help-block with-errors hidden"></div>';
943
944
    }

945
946
947
    /**
     * Builds HTML 'checkbox' element.
     *
948
     * Checkboxes will only be submitted, if they are checked. Therefore, a hidden element with the unchecked value will be transferred first.
949
950
951
     *
     * Format: <input type="hidden" name="$htmlFormElementId" value="$valueUnChecked">
     *         <input name="$htmlFormElementId" type="checkbox" [autofocus="autofocus"]
Carsten  Rose's avatar
Carsten Rose committed
952
     *            [required="required"] [disabled="disabled"] value="<value>" [checked="checked"] >
953
954
955
956
     *
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
957
     * @param array $json
958
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE*
959
     * @return string
960
961
     * @throws CodeException
     * @throws \qfq\UserFormException
962
     */
963
    public function buildCheckbox(array $formElement, $htmlFormElementId, $value, array &$json, $mode = FORM_LOAD) {
964
965
966
967
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
968
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
969
970
971

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

        if ($formElement['checkBoxMode'] === 'multi') {
977
//            $htmlFormElementId .= '[]';