AbstractBuildForm.php 96.2 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')
367
//                || ($filter === FORM_ELEMENTS_DYNAMIC_UPDATE && $fe[FE_DYNAMIC_UPDATE] === '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
            // Some Defaults
390
            $formElement = Support::setFeDefaults($formElement, $this->formSpec);
391

392
            if ($flagOutput === true) {
393
                $this->fillWrapLabelInputNote($formElement[FE_BS_LABEL_COLUMNS], $formElement[FE_BS_INPUT_COLUMNS], $formElement[FE_BS_NOTE_COLUMNS]);
394
            }
395

396
397
            //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];
398

399
            // Get default value
400
            $value = ($formElement[FE_VALUE] === '') ? $this->store->getVar($name, $storeUse,
401
                $formElement['checkType']) : $formElement[FE_VALUE];
Carsten  Rose's avatar
Carsten Rose committed
402

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

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

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

            // 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
421
                if ($modeCollectFe === FLAG_ALL || ($modeCollectFe == FLAG_DYNAMIC_UPDATE && $fe[FE_DYNAMIC_UPDATE] == 'yes')) {
Carsten  Rose's avatar
Carsten Rose committed
422
423
424
425
426
427
                    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
428
429
                }
            }
430

431
432
433
434
435
            if ($flagOutput) {
                // debugStack as Tooltip
                if ($this->showDebugInfo && count($debugStack) > 0) {
                    $elementHtml = Support::appendTooltip($elementHtml, implode("\n", $debugStack));
                }
436

437
438
                // Construct Marshaller Name: buildRow
                $buildRowName = 'buildRow' . $this->buildRowName[$formElement[FE_TYPE]];
439

440
                $html .= $formElement[FE_HTML_BEFORE] . $this->$buildRowName($formElement, $elementHtml, $htmlFormElementId) . $formElement[FE_HTML_AFTER];
441
            }
442
        }
443

444
445
446
        // Log / Debug: Last FormElement has been processed.
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

447
448
449
        return $html;
    }

450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
    /**
     * 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';
        }
    }

499
500
    abstract public function fillWrapLabelInputNote($label, $input, $note);

501
502
503
504
    abstract public function tail();

    abstract public function doSubrecords();

505
506
507
    /**
     * Create a hidden sip, based on latest STORE_SIP Values. Return complete HTML 'hidden' element.
     *
508
     * @param array $json
509
510
511
512
     * @return string  <input type='hidden' name='s' value='<sip>'>
     * @throws CodeException
     * @throws \qfq\UserFormException
     */
513
    public function buildHiddenSip(array &$json) {
514

515
        $sipArray = $this->store->getStore(STORE_SIP);
516
517

        // do not include system vars
518
519
520
521
522
523
524
525
        unset($sipArray[SIP_SIP]);
        unset($sipArray[SIP_URLPARAM]);

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

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

526
        $json[] = $this->getJsonElementUpdate(CLIENT_SIP, $sipValue, FE_MODE_SHOW);
527
528
529
530
531

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

    /**
Carsten  Rose's avatar
Carsten Rose committed
532
533
     * Create an array with standard elements and add 'form-element', 'value'.
     *
534
535
     * @param $htmlFormElementId
     * @param string|array $value
536
     * @param string $feMode disabled|readonly|''
537
538
     * @return array
     */
539
    private function getJsonElementUpdate($htmlFormElementId, $value, $feMode) {
540

541
        $json = $this->getJsonFeMode($feMode);
542
543
544
545
546
547
548

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

        return $json;
    }

549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
    /**
     * 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
564
565
     * Depending of $feMode set variables $hidden, $disabled, $required to 'yes' or 'no'.
     *
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
     * @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:
584
                $disabled = 'yes';  // convert the UI status 'readonly' to the HTML/CSS status 'disabled'.
585
586
587
588
589
590
591
592
593
594
                break;
            case FE_MODE_HIDDEN:
                $hidden = 'yes';
                break;
            default:
                throw new UserFormException("Unknown mode '$feMode'", ERROR_UNKNOWN_MODE);
                break;
        }
    }

595
596
597
598
599
600
601
602
603
604
605
    /**
     * 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
606
607
608
609
    /**
     * Takes the current SIP ('form' and additional parameter), set SIP_RECORD_ID=0 and create a new 'NewRecordUrl'.
     *
     * @throws CodeException
610
     * @throws \qfq\UserFormException
Carsten  Rose's avatar
Carsten Rose committed
611
612
613
614
     */
    public function deriveNewRecordUrlFromExistingSip(&$toolTipNew) {
        $urlParam = $this->store->getStore(STORE_SIP);
        $urlParam[SIP_RECORD_ID] = 0;
615

Carsten  Rose's avatar
Carsten Rose committed
616
617
        unset($urlParam[SIP_SIP]);
        unset($urlParam[SIP_URLPARAM]);
618
619

        Support::appendTypo3ParameterToArray($urlParam);
Carsten  Rose's avatar
Carsten Rose committed
620
621
622
623
624

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

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

625
        if ($this->showDebugInfo) {
626
            //TODO: missing decoding of SIP
627
628
            $toolTipNew .= PHP_EOL . PHP_EOL . OnArray::toString($urlParam, ' = ', PHP_EOL, "'");
        }
Carsten  Rose's avatar
Carsten Rose committed
629
630
631
632

        return $url;
    }

633
    abstract public function buildRowPill(array $formElement, $elementHtml);
634

635
    abstract public function buildRowFieldset(array $formElement, $elementHtml);
636

637
638
    abstract public function buildRowTemplateGroup(array $formElement, $elementHtml);

639
    abstract public function buildRowSubrecord(array $formElement, $elementHtml);
640

641
    /**
642
643
     * Builds a label, typically for an html-'<input>'-element.
     *
644
645
     * @param string $htmlFormElementId
     * @param string $label
646
647
     * @return string
     */
648
    public function buildLabel($htmlFormElementId, $label) {
649
650
651
652
        $attributes = Support::doAttribute('for', $htmlFormElementId);
        $attributes .= Support::doAttribute('class', 'control-label');

        $html = Support::wrapTag("<label $attributes>", $label);
653
654

        return $html;
655
656
    }

657
658
659
660
    /**
     * 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
661
     *           [pattern="$pattern"] [required="required"] [disabled="disabled"] value="$value">
662
663
664
665
666
     *
     *
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
667
     * @param array $json
668
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE
669
     * @return string
670
     * @throws \qfq\UserFormException
671
     */
672
    public function buildInput(array $formElement, $htmlFormElementId, $value, array &$json, $mode = FORM_LOAD) {
673
        $textarea = '';
674

675
        $attribute = Support::doAttribute('name', $htmlFormElementId);
676
        $attribute .= Support::doAttribute('class', 'form-control');
677

678
        if (isset($formElement[FE_RETYPE_SOURCE_NAME])) {
679
680
            $htmlFormElementIdPrimary = str_replace(RETYPE_FE_NAME_EXTENSION, '', $htmlFormElementId);
            $attribute .= Support::doAttribute('data-match', '[name=' . str_replace(':', '\\:', $htmlFormElementIdPrimary) . ']');
681
682
        }

683
        // Check for input type 'textarea'
684
        $colsRows = explode(',', $formElement['size'], 2);
685
        if (count($colsRows) === 2) {
686
            // <textarea>
687
688
            $htmlTag = '<textarea';

689
690
            $attribute .= Support::doAttribute('cols', $colsRows[0]);
            $attribute .= Support::doAttribute('rows', $colsRows[1]);
691
            $textarea = htmlentities($value) . '</textarea>';
692
693

        } else {
Carsten  Rose's avatar
Carsten Rose committed
694
695
696
697
            $htmlTag = '<input';

            $this->adjustMaxLength($formElement);

698
            if ($formElement['maxLength'] > 0 && $value !== '') {
Carsten  Rose's avatar
Carsten Rose committed
699
                // crop string only if it's not empty (substr returns false on empty strings)
700
                $value = substr($value, 0, $formElement['maxLength']);
701
            }
702
703
704
705

            // '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
706
        }
707

708
        $attribute .= $this->getAttributeList($formElement, ['autocomplete', 'autofocus', 'placeholder']);
709
        $attribute .= $this->getAttributeList($formElement, [F_FE_DATA_PATTERN_ERROR, F_FE_DATA_REQUIRED_ERROR, F_FE_DATA_MATCH_ERROR, F_FE_DATA_ERROR]);
710
        $attribute .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : '');
711
        $attribute .= Support::doAttribute('title', $formElement['tooltip']);
Carsten  Rose's avatar
Carsten Rose committed
712
        $attribute .= $this->getInputCheckPattern($formElement['checkType'], $formElement['checkPattern']);
713

714
        $attribute .= $this->getAttributeFeMode($formElement[FE_MODE]);
715

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

718
        return "$htmlTag $attribute>$textarea" . $this->getHelpBlock();
719

720
721
    }

Carsten  Rose's avatar
Carsten Rose committed
722
    /**
Carsten  Rose's avatar
Carsten Rose committed
723
724
     * 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
725
726
727
728
729
730
731
     * @param array $formElement
     */
    private function adjustMaxLength(array &$formElement) {

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

732
        switch ($formElement[FE_TYPE]) {
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
            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
753
        if ($maxLength !== false) {
754
            if (is_numeric($formElement['maxLength']) && $formElement['maxLength'] != 0) {
Carsten  Rose's avatar
Carsten Rose committed
755
756
757
758
759
760
761
762
763
                if ($formElement['maxLength'] > $maxLength) {
                    $formElement['maxLength'] = $maxLength;
                }
            } else {
                $formElement['maxLength'] = $maxLength;
            }
        }
    }

764
    /**
765
766
     * Get column spec from tabledefinition and parse size of it. If nothing defined, return false.
     *
767
     * @param $column
768
     * @return bool|int  a) 'false' if there is no length definition, b) length definition, c) date|time|datetime|timestamp use hardcoded length
769
770
771
772
773
     */
    private function getColumnSize($column) {
        $matches = array();

        $typeSpec = $this->store->getVar($column, STORE_TABLE_COLUMN_TYPES);
774
775
776
777
778
779
780
781
782
        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:
783
784
785
                if (substr($typeSpec, 0, 4) === 'set(' || substr($typeSpec, 0, 5) === 'enum(') {
                    return $this->maxLengthSetEnum($typeSpec);
                }
786
787
                break;
        }
788

789
        // e.g.: string(64) >> 64, enum('yes','no') >> false
790
791
792
793
794
795
        if (1 === preg_match('/\((.+)\)/', $typeSpec, $matches)) {
            if (is_numeric($matches[1]))
                return $matches[1];
        }

        return false;
796
797
    }

798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
    /**
     * 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;
    }

821
822
    /**
     * Builds a HTML attribute list, based on  $attributeList.
823
     *
824
     * E.g.: attributeList: [ 'type', 'autofocus' ]
825
     *       generates: 'type="$formElement[FE_TYPE]" autofocus="$formElement['autofocus']" '
826
827
828
     *
     * @param array $formElement
     * @param array $attributeList
829
     * @param bool $flagOmitEmpty
830
831
     * @return string
     */
832
    private function getAttributeList(array $formElement, array $attributeList, $flagOmitEmpty = true) {
833
834
835
        $attribute = '';
        foreach ($attributeList as $item) {
            if (isset($formElement[$item]))
836
                $attribute .= Support::doAttribute(strtolower($item), $formElement[$item], $flagOmitEmpty);
837
838
839
840
841
842
        }
        return $attribute;
    }

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

862
863
        if ($type === '') {
            return '';
864
        }
865

866
867
868
869
870
        switch ($type) {
            case SANITIZE_ALLOW_MIN_MAX:
            case SANITIZE_ALLOW_MIN_MAX_DATE:
                $arrData = explode("|", $data);
                if (count($arrData) != 2 || $arrData[0] == '' || $arrData[1] == '')
871
                    throw new UserFormException("Missing MIN|MAX values", ERROR_MISSING_MIN_MAX);
872

873
874
875
                $attribute = 'min="' . $arrData[0] . '" ';
                $attribute .= 'max="' . $arrData[1] . '" ';
                break;
876

877
878
879
880
881
882
883
884
885
886
            case SANITIZE_ALLOW_PATTERN:
                $attribute = 'pattern="' . $data . '" ';
                break;

            case SANITIZE_ALLOW_ALL:
                break;

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

889
890
891
892
        return $attribute;
    }

    /**
893
     * Set corresponding html attributes readonly/required/disabled, based on $formElement[FE_MODE].
894
     *
895
     * @param string $feMode
896
     * @return string
897
     * @throws UserFormException
898
     */
899
    private function getAttributeFeMode($feMode) {
900
901
        $attribute = '';

902
903
904
905
906
        $this->getFeMode($feMode, $hidden, $disabled, $required);

        switch ($feMode) {
            case FE_MODE_HIDDEN:
            case FE_MODE_SHOW:
907
                break;
908
909
910
            case FE_MODE_REQUIRED:
            case FE_MODE_READONLY:
                $attribute .= Support::doAttribute($feMode, $feMode);
911
912
                break;
            default:
913
                throw new UserFormException("Unknown mode '$feMode'", ERROR_UNKNOWN_MODE);
914
915
                break;
        }
916

917
        // Attributes: data-...
918
        $attribute .= Support::doAttribute(DATA_HIDDEN, $hidden);
919
        $attribute .= Support::doAttribute(DATA_DISABLED, $disabled);
920
921
        $attribute .= Support::doAttribute(DATA_REQUIRED, $required);

922
923
924
        return $attribute;
    }

925
    /**
Carsten  Rose's avatar
Carsten Rose committed
926
927
     * Build HelpBlock
     *
928
929
930
     * @return string
     */
    private function getHelpBlock() {
931
        return '<div class="help-block with-errors hidden"></div>';
932
933
    }

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

        // Fill $itemKey & $itemValue
957
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
958
959
960

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

        if ($formElement['checkBoxMode'] === 'multi') {
966
//            $htmlFormElementId .= '[]';
Carsten  Rose's avatar