AbstractBuildForm.php 118 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;
Carsten  Rose's avatar
Carsten Rose committed
12
13
14
15

//use qfq\Store;
//use qfq\OnArray;
//use qfq\UserFormException;
16
17
18
19

require_once(__DIR__ . '/../qfq/store/Store.php');
require_once(__DIR__ . '/../qfq/Constants.php');
require_once(__DIR__ . '/../qfq/exceptions/DbException.php');
20
require_once(__DIR__ . '/../qfq/exceptions/UserFormException.php');
21
require_once(__DIR__ . '/../qfq/Database.php');
22
require_once(__DIR__ . '/../qfq/helper/HelperFormElement.php');
23
require_once(__DIR__ . '/../qfq/helper/Support.php');
24
require_once(__DIR__ . '/../qfq/helper/OnArray.php');
Carsten  Rose's avatar
Carsten Rose committed
25
require_once(__DIR__ . '/../qfq/helper/Ldap.php');
26
require_once(__DIR__ . '/../qfq/report/Link.php');
27

28
/**
Carsten  Rose's avatar
Carsten Rose committed
29
30
 * Class AbstractBuildForm
 * @package qfq
31
 */
32
abstract class AbstractBuildForm {
33
34
35
36
37
    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();
38
    protected $wrap = array();
39
    protected $symbol = array();
Carsten  Rose's avatar
Carsten Rose committed
40
    protected $showDebugInfo = false;
41
    protected $inputCheckPattern = array();
Carsten  Rose's avatar
Carsten Rose committed
42

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

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

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

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

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

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

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

129
130
131
        $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>";
132

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

136
137
    abstract public function fillWrap();

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

        $modeCollectFe = FLAG_DYNAMIC_UPDATE;
        $storeUse = STORE_USE_DEFAULT;

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

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

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

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

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

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

192
193
        $htmlSip = $this->buildHiddenSip($json);

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

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

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

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

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

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

215
216
217
        $html .= $this->getFormTag();

        return $html;
218
219
    }

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

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

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

237
        $queryString = Support::arrayToQueryString($queryStringArray);
238

239
240
        $sip = $this->store->getSipInstance();
        $url = $sip->queryStringToSip($queryString);
241

242
        return $url;
243
244
245
    }

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

        if ($flagOmitEmpty && $value === "") {
256
            return '';
257
258
        }

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

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

        $attribute = $this->getFormTagAtrributes();

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

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

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

        return $attribute;
    }

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

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

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

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

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

    }
331

332
    abstract public function getProcessFilter();
333
334

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

356
        // The following 'FormElement.parameter' will never be used during load (fe.type='upload'). FE_PARAMETER has been already expanded.
357
        $skip = [FE_SQL_UPDATE, FE_SQL_INSERT, FE_SQL_DELETE, FE_SQL_AFTER, FE_SQL_BEFORE, FE_PARAMETER];
358

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

367
368
        $this->checkAutoFocus();

369
370
        // Iterate over all FormElements
        foreach ($this->feSpecNative as $fe) {
371

372
373
            if (($filter === FORM_ELEMENTS_NATIVE && $fe[FE_TYPE] === 'subrecord')
                || ($filter === FORM_ELEMENTS_SUBRECORD && $fe[FE_TYPE] !== 'subrecord')
374
//                || ($filter === FORM_ELEMENTS_DYNAMIC_UPDATE && $fe[FE_DYNAMIC_UPDATE] === 'no')
375
376
377
378
            ) {
                continue; // skip this FE
            }

Carsten  Rose's avatar
Carsten Rose committed
379
            $flagOutput = ($fe[FE_TYPE] !== FE_TYPE_EXTRA); // type='extra' will not displayed and not transmitted to the form
380

381
382
            $debugStack = array();

383
384
            // Preparation for Log, Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($fe), STORE_SYSTEM);
385

Carsten  Rose's avatar
Carsten Rose committed
386
387
            // Fill STORE_LDAP
            $fe = $this->prepareFillStoreFireLdap($fe);
388

389
390
            // for Upload FormElements, it's necessary to precalculate an optional given 'slaveId'.
            if ($fe[FE_TYPE] === FE_TYPE_UPLOAD) {
391
                Support::setIfNotSet($fe, FE_SLAVE_ID);
392
393
                $slaveId = Support::falseEmptyToZero($this->evaluate->parse($fe[FE_SLAVE_ID]));
                $this->store->setVar(VAR_SLAVE_ID, $slaveId, STORE_VAR);
394
395
            }

Carsten  Rose's avatar
Carsten Rose committed
396
            // ** evaluate current FormElement **
397
            $formElement = $this->evaluate->parseArray($fe, $skip, $debugStack);
398

399
            // Some Defaults
400
            $formElement = Support::setFeDefaults($formElement, $this->formSpec);
401

402
            if ($flagOutput === true) {
403
                $this->fillWrapLabelInputNote($formElement[FE_BS_LABEL_COLUMNS], $formElement[FE_BS_INPUT_COLUMNS], $formElement[FE_BS_NOTE_COLUMNS]);
404
            }
405

406
407
            //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];
408

409
            // If there is a value explicit defined: take it
410
411
            $value = $formElement[FE_VALUE];
            if ($value === '') {
412
                // Only take the default, if the FE is a real tablecolumn. See #2064
413
                if ($this->store->getVar($formElement[FE_NAME], STORE_TABLE_COLUMN_TYPES) !== false) {
414
415
416
                    $value = $this->store->getVar($name, $storeUse, $formElement['checkType']);
                }
            }
417

418
419
            // Typically: $htmlElementNameIdZero = true
            // After Saving a record, staying on the form, the FormElements on the Client are still known as '<feName>:0'.
420
421
422
            $htmlFormElementName = HelperFormElement::buildFormElementName($formElement[FE_NAME], ($htmlElementNameIdZero) ? 0 : $recordId);
            $formElement[FE_HTML_ID] = HelperFormElement::buildFormElementId($this->formSpec[F_ID], $formElement[FE_ID], ($htmlElementNameIdZero) ? 0 : $recordId, 0);

423

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

Carsten  Rose's avatar
Carsten Rose committed
427
            $jsonElement = array();
428
            $elementExtra = '';
429
            // Render pure element
430
            $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementName, $value, $jsonElement, $mode);
Carsten  Rose's avatar
Carsten Rose committed
431
432

            // container elements do not have dynamicUpdate='yes'. Instead they deliver nested elements.
433
            if ($formElement[FE_CLASS] == FE_CLASS_CONTAINER) {
Carsten  Rose's avatar
Carsten Rose committed
434
435
436
437
438
                if (count($jsonElement) > 0) {
                    $json = array_merge($json, $jsonElement);
                }
            } else {
                // for non container elements: just add the current json status
439
                if ($modeCollectFe === FLAG_ALL || ($modeCollectFe == FLAG_DYNAMIC_UPDATE && $fe[FE_DYNAMIC_UPDATE] == 'yes')) {
Carsten  Rose's avatar
Carsten Rose committed
440
441
442
443
444
445
                    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
446
447
                }
            }
448

449
450
451
            if ($flagOutput) {
                // debugStack as Tooltip
                if ($this->showDebugInfo && count($debugStack) > 0) {
452
                    $elementHtml .= Support::doTooltip($formElement[FE_HTML_ID] . HTML_ID_EXTENSION_TOOLTIP, implode("\n", $debugStack));
453
                }
454

455
456
                // Construct Marshaller Name: buildRow
                $buildRowName = 'buildRow' . $this->buildRowName[$formElement[FE_TYPE]];
457

458
                $html .= $formElement[FE_HTML_BEFORE] . $this->$buildRowName($formElement, $elementHtml, $htmlFormElementName) . $formElement[FE_HTML_AFTER];
459
            }
460
        }
461

462
463
464
        // Log / Debug: Last FormElement has been processed.
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

465
466
467
        return $html;
    }

468
    /**
Carsten  Rose's avatar
Carsten Rose committed
469
470
471
472
473
474
475
476
477
478
479
480
481
     * Checks if LDAP search is requested.
     * Yes: prepare configuration and fire the query.
     * No: do nothing.
     *
     * @param array $formElement
     * @return array
     * @throws CodeException
     * @throws UserFormException
     */
    private function prepareFillStoreFireLdap(array $formElement) {
        $config = array();

        if (isset($formElement[FE_FILL_STORE_LDAP]) || isset($formElement[FE_TYPEAHEAD_LDAP])) {
482
483
484
            $keyNames = [F_LDAP_SERVER, F_LDAP_BASE_DN, F_LDAP_ATTRIBUTES, F_LDAP_SEARCH, F_TYPEAHEAD_LDAP_SEARCH, F_TYPEAHEAD_LIMIT,
                F_TYPEAHEAD_MINLENGTH, F_TYPEAHEAD_LDAP_VALUE_PRINTF, F_TYPEAHEAD_LDAP_KEY_PRINTF, F_LDAP_TIME_LIMIT];
            $formElement = OnArray::copyArrayItemsIfNotAlreadyExist($this->formSpec, $formElement, $keyNames);
Carsten  Rose's avatar
Carsten Rose committed
485
486
487
488
489
490
491
        } else {
            return $formElement; // nothing to do.
        }

        if (isset($formElement[FE_FILL_STORE_LDAP])) {

            // Extract necessary elements
492
            $config = OnArray::getArrayItems($formElement, [FE_LDAP_SERVER, FE_LDAP_BASE_DN, FE_LDAP_SEARCH, FE_LDAP_ATTRIBUTES]);
Carsten  Rose's avatar
Carsten Rose committed
493
494
495
496
497
498
499
500
501
502
            $config = $this->evaluate->parseArray($config);

            $ldap = new Ldap();
            $arr = $ldap->process($config, '', MODE_LDAP_SINGLE);
            $this->store->setStore($arr, STORE_LDAP, true);
        }

        return $formElement;
    }

503
504
505
506
507
508
509
510
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
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
    /**
     * 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';
        }
    }

552
553
    abstract public function fillWrapLabelInputNote($label, $input, $note);

554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
    /**
     * 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.
     *
571
     * @param $htmlFormElementName
572
573
574
     * @param $value
     * @return string
     */
575
576
    public function buildNativeHidden($htmlFormElementName, $value) {
        return '<input type="hidden" name="' . $htmlFormElementName . '" value="' . htmlentities($value) . '">';
577
578
    }

579
580
581
582
    abstract public function tail();

    abstract public function doSubrecords();

583
584
585
586
587
588
589
590
591
592
593
594
595
596
    /**
     * Get all elements from STORE_ADDITIONAL_FORM_ELEMENTS and return them as a string.
     *
     * @return string
     * @throws CodeException
     * @throws \qfq\UserFormException
     */
    private function buildAdditionalFormElements() {

        $data = $this->store->getStore(STORE_ADDITIONAL_FORM_ELEMENTS);

        return is_array($data) ? implode('', $data) : '';
    }

597
598
599
    /**
     * Create a hidden sip, based on latest STORE_SIP Values. Return complete HTML 'hidden' element.
     *
600
     * @param array $json
601
602
603
604
     * @return string  <input type='hidden' name='s' value='<sip>'>
     * @throws CodeException
     * @throws \qfq\UserFormException
     */
605
    public function buildHiddenSip(array &$json) {
606

607
        $sipArray = $this->store->getStore(STORE_SIP);
608
609

        // do not include system vars
610
611
612
613
614
615
616
617
        unset($sipArray[SIP_SIP]);
        unset($sipArray[SIP_URLPARAM]);

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

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

618
        $json[] = $this->getFormElementForJson(CLIENT_SIP, $sipValue, [FE_MODE => FE_MODE_SHOW]);
619
620
621
622
623

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

    /**
624
625
626
     * Create an array with standard elements for 'mode' (hidden, disabled, required) and add 'form-element', 'value'.
     * 'Generic Element Update': add via API_ELEMENT_UPDATE 'label' and 'note'.
     * All collected data as array - will be later converted to JSON.
Carsten  Rose's avatar
Carsten Rose committed
627
     *
628
     * @param string $htmlFormElementName
629
     * @param string|array $value
630
     * @param array $formElement
631
632
     * @return array
     */
633
    private function getFormElementForJson($htmlFormElementName, $value, array $formElement) {
634

635
        $json = $this->getJsonFeMode($formElement[FE_MODE]);
636

637
        $json['form-element'] = $htmlFormElementName;
638
639
        $json['value'] = $value;

640
641
        if (isset($formElement[FE_LABEL])) {
            $key = $formElement[FE_HTML_ID] . HTML_ID_EXTENSION_LABEL;
642
            $json[API_ELEMENT_UPDATE][$key][API_ELEMENT_CONTENT] = $this->buildLabel($htmlFormElementName, $formElement[FE_LABEL]);
643
644
645
646
647
648
649
        }

        if (isset($formElement[FE_NOTE])) {
            $key = $formElement[FE_HTML_ID] . HTML_ID_EXTENSION_NOTE;
            $json[API_ELEMENT_UPDATE][$key][API_ELEMENT_CONTENT] = $formElement[FE_NOTE];
        }

650
651
652
        return $json;
    }

653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
    /**
     * 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
668
669
     * Depending of $feMode set variables $hidden, $disabled, $required to 'yes' or 'no'.
     *
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
     * @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:
688
                $disabled = 'yes';  // convert the UI status 'readonly' to the HTML/CSS status 'disabled'.
689
690
691
692
693
694
695
696
697
698
                break;
            case FE_MODE_HIDDEN:
                $hidden = 'yes';
                break;
            default:
                throw new UserFormException("Unknown mode '$feMode'", ERROR_UNKNOWN_MODE);
                break;
        }
    }

699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
    /**
     * Builds a label, typically for an html-'<input>'-element.
     *
     * @param string $htmlFormElementName
     * @param string $label
     * @return string
     */
    public function buildLabel($htmlFormElementName, $label) {
        $attributes = Support::doAttribute('for', $htmlFormElementName);
        $attributes .= Support::doAttribute('class', 'control-label');

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

        return $html;
    }

Carsten  Rose's avatar
Carsten Rose committed
715
716
717
718
    /**
     * Takes the current SIP ('form' and additional parameter), set SIP_RECORD_ID=0 and create a new 'NewRecordUrl'.
     *
     * @throws CodeException
719
     * @throws \qfq\UserFormException
Carsten  Rose's avatar
Carsten Rose committed
720
721
722
723
     */
    public function deriveNewRecordUrlFromExistingSip(&$toolTipNew) {
        $urlParam = $this->store->getStore(STORE_SIP);
        $urlParam[SIP_RECORD_ID] = 0;
724

Carsten  Rose's avatar
Carsten Rose committed
725
726
        unset($urlParam[SIP_SIP]);
        unset($urlParam[SIP_URLPARAM]);
727
728

        Support::appendTypo3ParameterToArray($urlParam);
Carsten  Rose's avatar
Carsten Rose committed
729
730
731
732
733

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

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

734
        if ($this->showDebugInfo) {
735
            //TODO: missing decoding of SIP
736
737
            $toolTipNew .= PHP_EOL . PHP_EOL . OnArray::toString($urlParam, ' = ', PHP_EOL, "'");
        }
Carsten  Rose's avatar
Carsten Rose committed
738
739
740
741

        return $url;
    }

742
    abstract public function buildRowPill(array $formElement, $elementHtml);
743

744
    abstract public function buildRowFieldset(array $formElement, $elementHtml);
745

746
747
    abstract public function buildRowTemplateGroup(array $formElement, $elementHtml);

748
    abstract public function buildRowSubrecord(array $formElement, $elementHtml);
749

750
751
    /**
     * Builds HTML 'input' element.
752
     * Format: <input name="$htmlFormElementName" <type="email|input|password|url" [autocomplete="autocomplete"] [autofocus="autofocus"]
753
     *           [maxlength="$maxLength"] [placeholder="$placeholder"] [size="$size"] [min="$min"] [max="$max"]
Carsten  Rose's avatar
Carsten Rose committed
754
     *           [pattern="$pattern"] [required="required"] [disabled="disabled"] value="$value">
755
756
757
     *
     *
     * @param array $formElement
758
759
     * @param string $htmlFormElementName
     * @param string $value
760
     * @param array $json Return updates in this array - will be later converted to JSON.
761
     * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE
762
     * @return string complete rendered HTML input element.
763
     * @throws \qfq\UserFormException
764
     */
765
    public function buildInput(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) {
766
        $textarea = '';
767
        $attribute = '';
768
        $class = 'form-control';
769
        $elementCharacterCount = '';
770

771
772
773
774
775
776
777
        $typeAheadUrlParam = $this->typeAheadBuildParam($formElement);
        if ($typeAheadUrlParam != '') {
            $class .= ' ' . CLASS_TYPEAHEAD;
            $dataSip = $this->sip->queryStringToSip($typeAheadUrlParam, RETURN_SIP);
            $attribute .= Support::doAttribute(DATA_TYPEAHEAD_SIP, $dataSip);
            $attribute .= Support::doAttribute(DATA_TYPEAHEAD_LIMIT, $formElement[FE_TYPEAHEAD_LIMIT]);
            $attribute .= Support::doAttribute(DATA_TYPEAHEAD_MINLENGTH, $formElement[FE_TYPEAHEAD_MINLENGTH]);
778
        }
779

780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
        if (isset($formElement[FE_CHARACTER_COUNT_WRAP])) {
            $class .= ' ' . CLASS_CHARACTER_COUNT;
            $attribute .= Support::doAttribute(DATA_CHARACTER_COUNT_ID, $formElement[FE_HTML_ID] . HTML_ID_EXTENSION_CHARACTER_COUNT);
            $attributeCC = Support::doAttribute('id', $formElement[FE_HTML_ID] . HTML_ID_EXTENSION_CHARACTER_COUNT);

            $classCC = ($formElement[FE_CHARACTER_COUNT_WRAP] == '') ? Support::doAttribute('class', 'qfq-cc-style') : '';
            $elementCharacterCount = "<span $attributeCC $classCC></span>";

            if ($formElement[FE_CHARACTER_COUNT_WRAP] != '') {
                $arr = explode('|', $formElement[FE_CHARACTER_COUNT_WRAP], 2);
                $arr[] = '';
                $arr[] = ''; //skip check that at least 2 elements exist
                $elementCharacterCount = $arr[0] . $elementCharacterCount . $arr[1];
            }
        }

796
797
        $attribute .= Support::doAttribute('id', $formElement[FE_HTML_ID]);
        $attribute .= Support::doAttribute('name', $htmlFormElementName);
798
        $attribute .= Support::doAttribute('class', $class);
799

800

801
        if (isset($formElement[FE_RETYPE_SOURCE_NAME])) {
802
803
            $htmlFormElementNamePrimary = str_replace(RETYPE_FE_NAME_EXTENSION, '', $htmlFormElementName);
            $attribute .= Support::doAttribute('data-match', '[name=' . str_replace(':', '\\:', $htmlFormElementNamePrimary) . ']');
804
805
        }

806
807
808
809
810
811
812
813
814
815
816
        $this->adjustMaxLength($formElement);

        if ($formElement[FE_MAX_LENGTH] > 0 && $value !== '') {
            // crop string only if it's not empty (substr returns false on empty strings)
            $value = substr($value, 0, $formElement[FE_MAX_LENGTH]);
        }
        // 'maxLength' needs an upper 'L': naming convention for DB tables!
        if ($formElement[FE_MAX_LENGTH] > 0) {
            $attribute .= Support::doAttribute('maxlength', $formElement[FE_MAX_LENGTH], false);
        }

817
        // Check for input type 'textarea'.
818
        $colsRows = explode(',', $formElement['size'], 2);
819
        if (count($colsRows) === 2) {
820
            // <textarea>
821
822
            $htmlTag = '<textarea';

823
824
            $attribute .= Support::doAttribute('cols', $colsRows[0]);
            $attribute .= Support::doAttribute('rows', $colsRows[1]);
825
            $textarea = htmlentities($value) . '</textarea>';
826
827

        } else {
Carsten  Rose's avatar
Carsten Rose committed
828
829
            $htmlTag = '<input';

830
            $attribute .= $this->getAttributeList($formElement, ['type', 'size']);
831
            $attribute .= Support::doAttribute('value', htmlentities($value), false);
Carsten  Rose's avatar
Carsten Rose committed
832
        }
833

834
        $attribute .= $this->getAttributeList($formElement, ['autocomplete', 'autofocus', 'placeholder']);
835
        $attribute .= $this->getAttributeList($formElement, [F_FE_DATA_PATTERN_ERROR, F_FE_DATA_REQUIRED_ERROR, F_FE_DATA_MATCH_ERROR, F_FE_DATA_ERROR]);
836
        $attribute .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : '');
837
        $attribute .= Support::doAttribute('title', $formElement['tooltip']);
Carsten  Rose's avatar
Carsten Rose committed
838
        $attribute .= $this->getInputCheckPattern($formElement['checkType'], $formElement['checkPattern']);
839

840
        $attribute .= $this->getAttributeFeMode($formElement[FE_MODE]);
841

842
        $json = $this->getFormElementForJson($htmlFormElementName, $value, $formElement);
Carsten  Rose's avatar
Carsten Rose committed
843

844
        return "$htmlTag $attribute>$textarea" . $elementCharacterCount . $this->getHelpBlock();
845

846
847
    }

848
849
    /**
     * Check $formElement for FE_TYPE_AHEAD_SQL or FE_TYPE_AHEAD_LDAP_SERVER.
Carsten  Rose's avatar
Carsten Rose committed
850
851
     * If one of them is given: build $urlParam with typeAhead Params.
     * Additionally set some parameter for later outside use, especially FE_TYPEAHEAD_LIMIT, FE_TYPEAHEAD_MINLENGTH
852
853
854
     *
     * @param array $formElement
     * @return string
Carsten  Rose's avatar
Carsten Rose committed
855
     * @throws UserFormException
856
     */
Carsten  Rose's avatar
Carsten Rose committed
857
    private function typeAheadBuildParam(array &$formElement) {
858
859
860

        $urlParam = '';

Carsten  Rose's avatar
Carsten Rose committed
861
862
863
        $formElement[FE_TYPEAHEAD_LIMIT] = Support::setIfNotSet($formElement, FE_TYPEAHEAD_LIMIT, TYPEAHEAD_DEFAULT_LIMIT);
        $formElement[FE_TYPEAHEAD_MINLENGTH] = Support::setIfNotSet($formElement, FE_TYPEAHEAD_MINLENGTH, 2);

864
        if (isset($formElement[FE_TYPEAHEAD_SQL])) {
Carsten  Rose's avatar
Carsten Rose committed
865
866
            $sql = $this->checkSqlAppendLimit($formElement[FE_TYPEAHEAD_SQL], $formElement[FE_TYPEAHEAD_LIMIT]);
            $urlParam = FE_TYPEAHEAD_SQL . '=' . $sql;
Carsten  Rose's avatar
Carsten Rose committed
867
        } elseif (isset($formElement[FE_TYPEAHEAD_LDAP])) {
868
869
            $formElement[FE_LDAP_SERVER] = Support::setIfNotSet($formElement, FE_LDAP_SERVER);
            $formElement[FE_LDAP_BASE_DN] = Support::setIfNotSet($formElement, FE_LDAP_BASE_DN);
Carsten  Rose's avatar
Carsten Rose committed
870
            $formElement[FE_TYPEAHEAD_LDAP_SEARCH] = Support::setIfNotSet($formElement, FE_TYPEAHEAD_LDAP_SEARCH);
871
872
873
            $formElement[FE_TYPEAHEAD_LDAP_VALUE_PRINTF] = Support::setIfNotSet($formElement, FE_TYPEAHEAD_LDAP_VALUE_PRINTF);
            $formElement[FE_TYPEAHEAD_LDAP_KEY_PRINTF] = Support::setIfNotSet($formElement, FE_TYPEAHEAD_LDAP_KEY_PRINTF);

Carsten  Rose's avatar
Carsten Rose committed
874
875
876
877
878
            foreach ([FE_LDAP_SERVER, FE_LDAP_BASE_DN, FE_TYPEAHEAD_LDAP_SEARCH] as $key) {
                if ($formElement[$key] == '') {
                    throw new UserFormException('Missing definition: ' . $key, ERROR_MISSING_DEFINITON);
                }
            }
879

Carsten  Rose's avatar
Carsten Rose committed
880
881
882
883
            if ($formElement[FE_TYPEAHEAD_LDAP_VALUE_PRINTF] . $formElement[FE_TYPEAHEAD_LDAP_KEY_PRINTF] == '') {
                throw new UserFormException('Missing definition: ' . FE_TYPEAHEAD_LDAP_VALUE_PRINTF . ' or ' . FE_TYPEAHEAD_LDAP_KEY_PRINTF, ERROR_MISSING_DEFINITON);
            }

884
            $arr = [
885
886
                FE_LDAP_SERVER => $formElement[FE_LDAP_SERVER],
                FE_LDAP_BASE_DN => $formElement[FE_LDAP_BASE_DN],
Carsten  Rose's avatar
Carsten Rose committed
887
                FE_TYPEAHEAD_LDAP_SEARCH => $formElement[FE_TYPEAHEAD_LDAP_SEARCH],
888
889
890
891
892
893
                FE_TYPEAHEAD_LDAP_VALUE_PRINTF => $formElement[FE_TYPEAHEAD_LDAP_VALUE_PRINTF],
                FE_TYPEAHEAD_LDAP_KEY_PRINTF => $formElement[FE_TYPEAHEAD_LDAP_KEY_PRINTF],
                FE_TYPEAHEAD_LIMIT => $formElement[FE_TYPEAHEAD_LIMIT],
            ];

            $urlParam = OnArray::toString($arr);
Carsten  Rose's avatar
Carsten Rose committed
894

895
896
        }

Carsten  Rose's avatar
Carsten Rose committed
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
        return $urlParam;
    }

    /**
     * Checks if $sql contains a SELECT statement.
     * Check for existence of a LIMIT Parameter. If not found add one.
     *
     * @param $sql
     * @param $limit
     * @return string   Checked and maybe extended $sql statement.
     * @throws \qfq\UserFormException
     */
    private function checkSqlAppendLimit($sql, $limit) {
        $sql = trim($sql);

        if (false === stristr(substr($sql, 0, 7), 'SELECT ')) {
            throw new UserFormException("Expect a SELECT statement in " . FE_TYPEAHEAD_SQL . " - got: " . $sql, ERROR_BROKEN_PARAMETER);
914
915
        }

Carsten  Rose's avatar
Carsten Rose committed
916
917
918
919
920
        if (false === stristr($sql, ' LIMIT ')) {
            $sql .= " LIMIT $limit";
        }

        return $sql;
921
922
    }

Carsten  Rose's avatar
Carsten Rose committed
923
    /**
Carsten  Rose's avatar
Carsten Rose committed
924
925
     * 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
926
927
928
929
930
931
932
     * @param array $formElement
     */
    private function adjustMaxLength(array &$formElement) {

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

933
        switch ($formElement[FE_TYPE]) {
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
            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
954
        if ($maxLength !== false) {
955
            if (is_numeric($formElement['maxLength']) && $formElement['maxLength'] != 0) {
Carsten  Rose's avatar
Carsten Rose committed
956
957
958
959
960
961
962
963
964
                if ($formElement['maxLength'] > $maxLength) {
                    $formElement['maxLength'] = $maxLength;
                }
            } else {
                $formElement['maxLength'] = $maxLength;
            }
        }
    }

965
    /**
966
967
     * Get column spec from tabledefinition and parse size of it. If nothing defined, return false.
     *
968
     * @param $column
969
     * @return bool|int  a) 'false' if there is no length definition, b) length definition, c) date|time|datetime|timestamp use hardcoded length
970
971
972
973
974
     */
    private function getColumnSize($column) {
        $matches = array();

        $typeSpec = $this->store->getVar($column, STORE_TABLE_COLUMN_TYPES);
975
976
977
978
979
980
981
982
983
        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:
984
985
986
                if (substr($typeSpec, 0, 4) === 'set(' || substr($typeSpec, 0, 5) === 'enum(') {
                    return $this->maxLengthSetEnum($typeSpec);
                }
987
988
                break;
        }
989

990
        // e.g.: string(64) >> 64, enum('yes','no') >> false
991
992
993
994
995
996
        if (1 === preg_match('/\((.+)\)/', $typeSpec, $matches)) {
            if (is_numeric($matches[1]))
                return $matches[1];
        }

        return false;
997
998
    }

999
1000
1001