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

9
10
11
namespace qfq;

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

require_once(__DIR__ . '/../qfq/store/Store.php');
require_once(__DIR__ . '/../qfq/Constants.php');
require_once(__DIR__ . '/../qfq/exceptions/DbException.php');
19
require_once(__DIR__ . '/../qfq/exceptions/UserFormException.php');
20
require_once(__DIR__ . '/../qfq/Database.php');
21
require_once(__DIR__ . '/../qfq/helper/HelperFormElement.php');
22
require_once(__DIR__ . '/../qfq/helper/Support.php');
23
require_once(__DIR__ . '/../qfq/helper/OnArray.php');
24
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
        $htmlHead = '';
        $htmlTail = '';
149
        $htmlT3vars = '';
Carsten  Rose's avatar
Carsten Rose committed
150
151
152
        $htmlSubrecords = '';
        $htmlElements = '';
        $json = array();
153
154
155
156
157
158
159
160

        $modeCollectFe = FLAG_DYNAMIC_UPDATE;
        $storeUse = STORE_USE_DEFAULT;

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

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

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

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

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

        // <form>
        if ($mode === FORM_LOAD) {
185
            $htmlT3vars = $this->prepareT3VarsForSave();
186
187
188
189
            $htmlTail = $this->tail();
            $htmlSubrecords = $this->doSubrecords();
        }

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

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

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

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

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

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

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

213
214
215
        $html .= $this->getFormTag();

        return $html;
216
217
    }

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

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

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

235
        $queryString = Support::arrayToQueryString($queryStringArray);
236

237
238
        $sip = $this->store->getSipInstance();
        $url = $sip->queryStringToSip($queryString);
239

240
        return $url;
241
242
243
    }

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

        if ($flagOmitEmpty && $value === "") {
254
            return '';
255
256
        }

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

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

        $attribute = $this->getFormTagAtrributes();

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

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

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

        return $attribute;
    }

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

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

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

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

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

    }
329

330
    abstract public function getProcessFilter();
331
332

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

353
354
355
        // 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];

356
        // get current data record
357
        if ($recordId > 0 && $this->store->getVar('id', STORE_RECORD) === false) {
358
            $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] . "'.");
359
            $this->store->setStore($row, STORE_RECORD);
360
        }
361

362
363
        $this->checkAutoFocus();

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

367
368
            if (($filter === FORM_ELEMENTS_NATIVE && $fe[FE_TYPE] === 'subrecord')
                || ($filter === FORM_ELEMENTS_SUBRECORD && $fe[FE_TYPE] !== 'subrecord')
369
//                || ($filter === FORM_ELEMENTS_DYNAMIC_UPDATE && $fe[FE_DYNAMIC_UPDATE] === 'no')
370
371
372
373
            ) {
                continue; // skip this FE
            }

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

376
377
            $debugStack = array();

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

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

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

391
            // Some Defaults
392
            $formElement = Support::setFeDefaults($formElement, $this->formSpec);
393

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

398
399
            //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];
400

401
            // Get default value
402
403
404
405
406
407
408
409
410
411
412
//            $value = ($formElement[FE_VALUE] === '') ? $this->store->getVar($name, $storeUse,
//                $formElement['checkType']) : $formElement[FE_VALUE];

            $value = $formElement[FE_VALUE];
            // If there is no value, check the default.
            if ($value === '') {
                // Only take the default, if the FE is a real tablecolumn.
                if ($this->store->getVar($formElement[FE_NAME], STORE_RECORD) !== false) {
                    $value = $this->store->getVar($name, $storeUse, $formElement['checkType']);
                }
            }
413
414
            // Typically: $htmlElementNameIdZero = true
            // After Saving a record, staying on the form, the FormElements on the Client are still known as '<feName>:0'.
415
            $htmlFormElementId = HelperFormElement::buildFormElementName($formElement[FE_NAME], ($htmlElementNameIdZero) ? 0 : $recordId);
416

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

Carsten  Rose's avatar
Carsten Rose committed
420
            $jsonElement = array();
421
            // Render pure element
422
            $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementId, $value, $jsonElement, $mode);
Carsten  Rose's avatar
Carsten Rose committed
423
424
425
426
427
428
429
430

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

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

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

450
                $html .= $formElement[FE_HTML_BEFORE] . $this->$buildRowName($formElement, $elementHtml, $htmlFormElementId) . $formElement[FE_HTML_AFTER];
451
            }
452
        }
453

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

457
458
459
        return $html;
    }

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
508
    /**
     * 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';
        }
    }

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

511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
    /**
     * Copy a subset of current STORE_TYPO3 variables to SIP. Set a hidden form field to submit the assigned SIP to save/update.
     *
     * @throws CodeException
     * @throws UserFormException
     */
    private function prepareT3VarsForSave() {

        $t3VarsSip = $this->store->copyT3VarsToSip();

        return $this->buildNativeHidden(CLIENT_TYPO3VARS, $t3VarsSip);

    }

    /**
     * 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) . '">';
    }

536
537
538
539
    abstract public function tail();

    abstract public function doSubrecords();

540
541
542
    /**
     * Create a hidden sip, based on latest STORE_SIP Values. Return complete HTML 'hidden' element.
     *
543
     * @param array $json
544
545
546
547
     * @return string  <input type='hidden' name='s' value='<sip>'>
     * @throws CodeException
     * @throws \qfq\UserFormException
     */
548
    public function buildHiddenSip(array &$json) {
549

550
        $sipArray = $this->store->getStore(STORE_SIP);
551
552

        // do not include system vars
553
554
555
556
557
558
559
560
        unset($sipArray[SIP_SIP]);
        unset($sipArray[SIP_URLPARAM]);

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

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

561
        $json[] = $this->getJsonElementUpdate(CLIENT_SIP, $sipValue, FE_MODE_SHOW);
562
563
564
565
566

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

    /**
Carsten  Rose's avatar
Carsten Rose committed
567
568
     * Create an array with standard elements and add 'form-element', 'value'.
     *
569
570
     * @param $htmlFormElementId
     * @param string|array $value
571
     * @param string $feMode disabled|readonly|''
572
573
     * @return array
     */
574
    private function getJsonElementUpdate($htmlFormElementId, $value, $feMode) {
575

576
        $json = $this->getJsonFeMode($feMode);
577
578
579
580
581
582
583

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

        return $json;
    }

584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
    /**
     * 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
599
600
     * Depending of $feMode set variables $hidden, $disabled, $required to 'yes' or 'no'.
     *
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
     * @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:
619
                $disabled = 'yes';  // convert the UI status 'readonly' to the HTML/CSS status 'disabled'.
620
621
622
623
624
625
626
627
628
629
                break;
            case FE_MODE_HIDDEN:
                $hidden = 'yes';
                break;
            default:
                throw new UserFormException("Unknown mode '$feMode'", ERROR_UNKNOWN_MODE);
                break;
        }
    }

Carsten  Rose's avatar
Carsten Rose committed
630
631
632
633
    /**
     * Takes the current SIP ('form' and additional parameter), set SIP_RECORD_ID=0 and create a new 'NewRecordUrl'.
     *
     * @throws CodeException
634
     * @throws \qfq\UserFormException
Carsten  Rose's avatar
Carsten Rose committed
635
636
637
638
     */
    public function deriveNewRecordUrlFromExistingSip(&$toolTipNew) {
        $urlParam = $this->store->getStore(STORE_SIP);
        $urlParam[SIP_RECORD_ID] = 0;
639

Carsten  Rose's avatar
Carsten Rose committed
640
641
        unset($urlParam[SIP_SIP]);
        unset($urlParam[SIP_URLPARAM]);
642
643

        Support::appendTypo3ParameterToArray($urlParam);
Carsten  Rose's avatar
Carsten Rose committed
644
645
646
647
648

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

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

649
        if ($this->showDebugInfo) {
650
            //TODO: missing decoding of SIP
651
652
            $toolTipNew .= PHP_EOL . PHP_EOL . OnArray::toString($urlParam, ' = ', PHP_EOL, "'");
        }
Carsten  Rose's avatar
Carsten Rose committed
653
654
655
656

        return $url;
    }

657
    abstract public function buildRowPill(array $formElement, $elementHtml);
658

659
    abstract public function buildRowFieldset(array $formElement, $elementHtml);
660

661
662
    abstract public function buildRowTemplateGroup(array $formElement, $elementHtml);

663
    abstract public function buildRowSubrecord(array $formElement, $elementHtml);
664

665
    /**
666
667
     * Builds a label, typically for an html-'<input>'-element.
     *
668
669
     * @param string $htmlFormElementId
     * @param string $label
670
671
     * @return string
     */
672
    public function buildLabel($htmlFormElementId, $label) {
673
674
675
676
        $attributes = Support::doAttribute('for', $htmlFormElementId);
        $attributes .= Support::doAttribute('class', 'control-label');

        $html = Support::wrapTag("<label $attributes>", $label);
677
678

        return $html;
679
680
    }

681
682
683
684
    /**
     * 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
685
     *           [pattern="$pattern"] [required="required"] [disabled="disabled"] value="$value">
686
687
688
689
690
     *
     *
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
691
     * @param array $json
692
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE
693
     * @return string
694
     * @throws \qfq\UserFormException
695
     */
696
    public function buildInput(array $formElement, $htmlFormElementId, $value, array &$json, $mode = FORM_LOAD) {
697
        $textarea = '';
698

699
        $attribute = Support::doAttribute('name', $htmlFormElementId);
700
        $attribute .= Support::doAttribute('class', 'form-control');
701

702
        if (isset($formElement[FE_RETYPE_SOURCE_NAME])) {
703
704
            $htmlFormElementIdPrimary = str_replace(RETYPE_FE_NAME_EXTENSION, '', $htmlFormElementId);
            $attribute .= Support::doAttribute('data-match', '[name=' . str_replace(':', '\\:', $htmlFormElementIdPrimary) . ']');
705
706
        }

707
        // Check for input type 'textarea'
708
        $colsRows = explode(',', $formElement['size'], 2);
709
        if (count($colsRows) === 2) {
710
            // <textarea>
711
712
            $htmlTag = '<textarea';

713
714
            $attribute .= Support::doAttribute('cols', $colsRows[0]);
            $attribute .= Support::doAttribute('rows', $colsRows[1]);
715
            $textarea = htmlentities($value) . '</textarea>';
716
717

        } else {
Carsten  Rose's avatar
Carsten Rose committed
718
719
720
721
            $htmlTag = '<input';

            $this->adjustMaxLength($formElement);

722
            if ($formElement['maxLength'] > 0 && $value !== '') {
Carsten  Rose's avatar
Carsten Rose committed
723
                // crop string only if it's not empty (substr returns false on empty strings)
724
                $value = substr($value, 0, $formElement['maxLength']);
725
            }
726
727
728
729

            // '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
730
        }
731

732
        $attribute .= $this->getAttributeList($formElement, ['autocomplete', 'autofocus', 'placeholder']);
733
        $attribute .= $this->getAttributeList($formElement, [F_FE_DATA_PATTERN_ERROR, F_FE_DATA_REQUIRED_ERROR, F_FE_DATA_MATCH_ERROR, F_FE_DATA_ERROR]);
734
        $attribute .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : '');
735
        $attribute .= Support::doAttribute('title', $formElement['tooltip']);
Carsten  Rose's avatar
Carsten Rose committed
736
        $attribute .= $this->getInputCheckPattern($formElement['checkType'], $formElement['checkPattern']);
737

738
        $attribute .= $this->getAttributeFeMode($formElement[FE_MODE]);
739

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

742
        return "$htmlTag $attribute>$textarea" . $this->getHelpBlock();
743

744
745
    }

Carsten  Rose's avatar
Carsten Rose committed
746
    /**
Carsten  Rose's avatar
Carsten Rose committed
747
748
     * 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
749
750
751
752
753
754
755
     * @param array $formElement
     */
    private function adjustMaxLength(array &$formElement) {

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

756
        switch ($formElement[FE_TYPE]) {
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
            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
777
        if ($maxLength !== false) {
778
            if (is_numeric($formElement['maxLength']) && $formElement['maxLength'] != 0) {
Carsten  Rose's avatar
Carsten Rose committed
779
780
781
782
783
784
785
786
787
                if ($formElement['maxLength'] > $maxLength) {
                    $formElement['maxLength'] = $maxLength;
                }
            } else {
                $formElement['maxLength'] = $maxLength;
            }
        }
    }

788
    /**
789
790
     * Get column spec from tabledefinition and parse size of it. If nothing defined, return false.
     *
791
     * @param $column
792
     * @return bool|int  a) 'false' if there is no length definition, b) length definition, c) date|time|datetime|timestamp use hardcoded length
793
794
795
796
797
     */
    private function getColumnSize($column) {
        $matches = array();

        $typeSpec = $this->store->getVar($column, STORE_TABLE_COLUMN_TYPES);
798
799
800
801
802
803
804
805
806
        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:
807
808
809
                if (substr($typeSpec, 0, 4) === 'set(' || substr($typeSpec, 0, 5) === 'enum(') {
                    return $this->maxLengthSetEnum($typeSpec);
                }
810
811
                break;
        }
812

813
        // e.g.: string(64) >> 64, enum('yes','no') >> false
814
815
816
817
818
819
        if (1 === preg_match('/\((.+)\)/', $typeSpec, $matches)) {
            if (is_numeric($matches[1]))
                return $matches[1];
        }

        return false;
820
821
    }

822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
    /**
     * 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;
    }

845
846
    /**
     * Builds a HTML attribute list, based on  $attributeList.
847
     *
848
     * E.g.: attributeList: [ 'type', 'autofocus' ]
849
     *       generates: 'type="$formElement[FE_TYPE]" autofocus="$formElement['autofocus']" '
850
851
852
     *
     * @param array $formElement
     * @param array $attributeList
853
     * @param bool $flagOmitEmpty
854
855
     * @return string
     */
856
    private function getAttributeList(array $formElement, array $attributeList, $flagOmitEmpty = true) {
857
858
859
        $attribute = '';
        foreach ($attributeList as $item) {
            if (isset($formElement[$item]))
860
                $attribute .= Support::doAttribute(strtolower($item), $formElement[$item], $flagOmitEmpty);
861
862
863
864
865
866
        }
        return $attribute;
    }

    /**
     * Construct HTML Input attribute for Client Validation:
867
     *
868
     *   type     data                      result
869
     *   -------  -----------------------   -------------------------------------------------------------------------------
870
871
     *   min|max  <min value>|<max value>   min="$attrData[0]"|max="$attrData[1]"
     *   pattern  <regexp>                  pattern="$data"
Carsten  Rose's avatar
Carsten Rose committed
872
     *   digit    -                         pattern="^[0-9]*$"
873
     *   email    -                         pattern="^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\.[a-z]{2,4})$"
874
     *   alnumx   -
875
     *
876
     * For 'min/max' and 'pattern' the 'data' will be injected in the attribute string via '%s'.
877
878
879
880
     *
     * @param $type
     * @param $data
     * @return string
881
     * @throws \qfq\UserFormException
882
     */
Carsten  Rose's avatar
Carsten Rose committed
883
    private function getInputCheckPattern($type, $data) {
884
885
        $attribute = '';

886
887
        if ($type === '') {
            return '';
888
        }
889

890
891
892
893
894
        switch ($type) {
            case SANITIZE_ALLOW_MIN_MAX:
            case SANITIZE_ALLOW_MIN_MAX_DATE:
                $arrData = explode("|", $data);
                if (count($arrData) != 2 || $arrData[0] == '' || $arrData[1] == '')
895
                    throw new UserFormException("Missing MIN|MAX values", ERROR_MISSING_MIN_MAX);
896

897
898
899
                $attribute = 'min="' . $arrData[0] . '" ';
                $attribute .= 'max="' . $arrData[1] . '" ';
                break;
900

901
902
903
904
905
906
907
908
909
910
            case SANITIZE_ALLOW_PATTERN:
                $attribute = 'pattern="' . $data . '" ';
                break;

            case SANITIZE_ALLOW_ALL:
                break;

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

913
914
915
916
        return $attribute;
    }

    /**
917
     * Set corresponding html attributes readonly/required/disabled, based on $formElement[FE_MODE].
918
     *
919
     * @param string $feMode
920
     * @return string
921
     * @throws UserFormException
922
     */
923
    private function getAttributeFeMode($feMode) {
924
925
        $attribute = '';

926
927
928
929
930
        $this->getFeMode($feMode, $hidden, $disabled, $required);

        switch ($feMode) {
            case FE_MODE_HIDDEN:
            case FE_MODE_SHOW:
931
                break;
932
933
934
            case FE_MODE_REQUIRED:
            case FE_MODE_READONLY:
                $attribute .= Support::doAttribute($feMode, $feMode);
935
936
                break;
            default:
937
                throw new UserFormException("Unknown mode '$feMode'", ERROR_UNKNOWN_MODE);
938
939
                break;
        }
940

941
        // Attributes: data-...
942
        $attribute .= Support::doAttribute(DATA_HIDDEN, $hidden);
943
        $attribute .= Support::doAttribute(DATA_DISABLED, $disabled);
944
945
        $attribute .= Support::doAttribute(DATA_REQUIRED, $required);

946
947
948
        return $attribute;
    }

949
    /**
Carsten  Rose's avatar
Carsten Rose committed
950
951
     * Build HelpBlock
     *
952
953
954
     * @return string
     */
    private function getHelpBlock() {
955
        return '<div class="help-block with-errors hidden"></div>';
956
957
    }

958
959
960
    /**
     * Builds HTML 'checkbox' element.
     *
961
     * Checkboxes will only be submitted, if they are checked. Therefore, a hidden element with the unchecked value will be transferred first.
962
963
964
     *
     * Format: <input type="hidden" name="$htmlFormElementId" value="$valueUnChecked">
     *         <input name="$htmlFormElementId" type="checkbox" [autofocus="autofocus"]
Carsten  Rose's avatar
Carsten Rose committed
965
     *            [required="required"] [disabled="disabled"] value="<value>" [checked="checked"] >
966
967
968
969
     *
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
970
     * @param array $json
971
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE*
972
     * @return string
973
974
     * @throws CodeException
     * @throws \qfq\UserFormException
975
     */
976
    public function buildCheckbox(array $formElement, $htmlFormElementId, $value, array &$json, $mode = FORM_LOAD) {
977
978
979
980
        $itemKey = array();
        $itemValue = array();