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

9
10
11
namespace qfq;

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

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

25
26

/**
Carsten  Rose's avatar
Carsten Rose committed
27
28
 * Class AbstractBuildForm
 * @package qfq
29
 */
30
abstract class AbstractBuildForm {
31
32
33
    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
34
    protected $store = null;
Carsten  Rose's avatar
Carsten Rose committed
35
    protected $evaluate = null;
36
37
    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
    /**
     * @var string
     */
48
49
    private $formId = null;

50
51
52
53
54
    /**
     * @var Sip
     */
    private $sip = null;

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

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

73
        // render mode specific
74
        $this->fillWrap();
75
76
77

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

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

118
119
120
        $this->symbol[SYMBOL_EDIT] = "<span class='glyphicon glyphicon-pencil'></span>";
        $this->symbol[SYMBOL_NEW] = "<span class='glyphicon glyphicon-plus'></span>";
        $this->symbol[SYMBOL_DELETE] = "<span class='glyphicon glyphicon-trash'></span>";
121

122
        $this->inputCheckPattern = Sanitize::inputCheckPatternArray();
123
124
    }

125
126
    abstract public function fillWrap();

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

        $modeCollectFe = FLAG_DYNAMIC_UPDATE;
        $storeUse = STORE_USE_DEFAULT;

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

151
        // <form>
Carsten  Rose's avatar
Carsten Rose committed
152
153
154
155
156
        if ($mode === FORM_LOAD) {
            $htmlHead = $this->head();
            $htmlTail = $this->tail();
            $htmlSubrecords = $this->doSubrecords();
        }
157

158
        $filter = $this->getProcessFilter();
159

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

162
163
            $parentRecords = $this->db->sql($this->formSpec['multiSql']);
            foreach ($parentRecords as $row) {
164
                $this->store->setVarArray($row, STORE_PARENT_RECORD, true);
Carsten  Rose's avatar
Carsten Rose committed
165
                $jsonTmp = array();
166
                $htmlElements = $this->elements($row['_id'], $filter, 0, $jsonTmp, $modeCollectFe);
Carsten  Rose's avatar
Carsten Rose committed
167
                $json[] = $jsonTmp;
168
169
            }
        } else {
170
            $htmlElements = $this->elements($this->store->getVar(SIP_RECORD_ID, STORE_SIP), $filter, 0, $json, $modeCollectFe, $htmlElementNameIdZero, $storeUse);
171
172
        }

173
174
        $htmlSip = $this->buildHiddenSip($json);

175
        // </form>
176

177
        return ($mode === FORM_LOAD) ? $htmlHead . $htmlElements . $htmlSip . $htmlTail . $htmlSubrecords : $json;
178
179
    }

180
    /**
181
     * Builds the head area of the form.
182
     *
183
     * @return string
184
     */
185
186
    public function head() {
        $html = '';
187

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

190
191
192
        // Logged in BE User will see a FormEdit Link
        $sipParamString = OnArray::toString($this->store->getStore(STORE_SIP), ':', ', ', "'");
        $formEditUrl = $this->createFormEditUrl();
193

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

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

198
199
200
        $html .= $this->getFormTag();

        return $html;
201
202
    }

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

Carsten  Rose's avatar
Carsten Rose committed
210
        if (!$this->showDebugInfo) {
211
212
            return '';
        }
213

214
215
216
217
218
        $queryStringArray = [
            'id' => $this->store->getVar(TYPO3_PAGE_ID, STORE_TYPO3),
            'form' => 'form',
            'r' => $this->formSpec['id']
        ];
219

220
        $queryString = Support::arrayToQueryString($queryStringArray);
221

222
223
        $sip = $this->store->getSipInstance();
        $url = $sip->queryStringToSip($queryString);
224

225
        return $url;
226
227
228
    }

    /**
229
230
     * Wrap's $this->wrap[$item][WRAP_SETUP_START] around $value. If $flagOmitEmpty==true && $value=='': return ''.
     *
231
232
233
234
235
236
237
238
239
240
241
242
     * @param $item
     * @param $value
     * @param bool|false $flagOmitEmpty
     * @return string
     */
    public function wrapItem($item, $value, $flagOmitEmpty = false) {
        if ($flagOmitEmpty && $value === "")
            return '';
        return $this->wrap[$item][WRAP_SETUP_START] . $value . $this->wrap[$item][WRAP_SETUP_END];
    }

    /**
243
     * Returns '<form ...>'-tag with various attributes.
244
245
246
247
248
249
250
251
252
253
254
255
256
     *
     * @return string
     */
    public function getFormTag() {

        $attribute = $this->getFormTagAtrributes();

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

    /**
     * Build an assoc array with standard form attributes.
     *
257
     * @return array
258
259
260
     */
    public function getFormTagAtrributes() {

261
        $attribute['id'] = $this->getFormId();
262
263
264
265
266
267
268
269
270
271
        $attribute['method'] = 'post';
        $attribute['action'] = $this->getActionUrl();
        $attribute['target'] = '_top';
        $attribute['accept-charset'] = 'UTF-8';
        $attribute['autocomplete'] = 'on';
        $attribute['enctype'] = $this->getEncType();

        return $attribute;
    }

272
273
274
275
276
277
278
279
280
281
    /**
     * @return string
     */
    public function getFormId() {
        if ($this->formId === null) {
            $this->formId = uniqid('qfq-form-');
        }
        return $this->formId;
    }

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

292
        return API_DIR . '/save.php';
293
294
295
296
297
298
299
300
301
302
303
304
    }

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

305
        $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"');
306
307
308
        return (count($result) === 1) ? 'multipart/form-data' : 'application/x-www-form-urlencoded';

    }
309

Carsten  Rose's avatar
Carsten Rose committed
310
311
312
313
    abstract public function tail();

    abstract public function doSubrecords();

314
    abstract public function getProcessFilter();
315
316

    /**
317
318
     * Process all FormElements: build corresponding HTML code. Collect and return all HTML code.
     *
319
     * @param $recordId
320
     * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD
321
     * @param int $feIdContainer
322
     * @return string
323
324
     * @throws CodeException
     * @throws DbException
325
     * @throws \qfq\UserFormException
326
     */
327
    public function elements($recordId, $filter = FORM_ELEMENTS_NATIVE, $feIdContainer = 0, &$json,
328
                             $modeCollectFe = FLAG_DYNAMIC_UPDATE, $htmlElementNameIdZero = false, $storeUse = STORE_USE_DEFAULT) {
329
330
331
        $html = '';

        // get current data record
332
        if ($recordId > 0 && $this->store->getVar('id', STORE_RECORD) === false) {
333
334
            $row = $this->db->sql("SELECT * FROM " . $this->formSpec['tableName'] . " WHERE id = ?", ROW_EXPECT_1, array($recordId));
            $this->store->setVarArray($row, STORE_RECORD);
335
        }
336
337
338

        // Iterate over all FormElements
        foreach ($this->feSpecNative as $fe) {
Carsten  Rose's avatar
Carsten Rose committed
339
340
341
            if (($filter === FORM_ELEMENTS_NATIVE && $fe['type'] === 'subrecord')
                || ($filter === FORM_ELEMENTS_SUBRECORD && $fe['type'] !== 'subrecord')
//                || ($filter === FORM_ELEMENTS_DYNAMIC_UPDATE && $fe['dynamicUpdate'] === 'no')
342
343
344
345
            ) {
                continue; // skip this FE
            }

346
347
            $debugStack = array();

348
349
            // Preparation for Log, Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($fe), STORE_SYSTEM);
350
351

            // evaluate current FormElement
352
            $evaluate = new Evaluate($this->store, $this->db);
353
            $formElement = $evaluate->parseArray($fe, $debugStack);
354

355
356
357
            // Some Defaults
            $formElement = Support::setFeDefaults($formElement);

358
359
360
361
362
            $label = ($formElement[F_BS_LABEL_COLUMNS] == '') ? $this->formSpec[F_BS_LABEL_COLUMNS] : $formElement[F_BS_LABEL_COLUMNS];
            $input = ($formElement[F_BS_INPUT_COLUMNS] == '') ? $this->formSpec[F_BS_INPUT_COLUMNS] : $formElement[F_BS_INPUT_COLUMNS];
            $note = ($formElement[F_BS_NOTE_COLUMNS] == '') ? $this->formSpec[F_BS_NOTE_COLUMNS] : $formElement[F_BS_NOTE_COLUMNS];
            $this->fillWrapLabelInputNote($label, $input, $note);

363
            // Get default value
364
            $value = ($formElement['value'] === '') ? $this->store->getVar($formElement['name'], $storeUse,
365
                $formElement['checkType']) : $formElement['value'];
Carsten  Rose's avatar
Carsten Rose committed
366

367
368
369
            // Typically: $htmlElementNameIdZero = true
            // After Saving a record, staying on the form, the FormElements on the Client are still known as '<feName>:0'.
            $htmlFormElementId = HelperFormElement::buildFormElementId($formElement['name'], ($htmlElementNameIdZero) ? 0 : $recordId);
370

Carsten  Rose's avatar
Carsten Rose committed
371
            // Construct Marshaller Name: buildElement
372
373
            $buildElementFunctionName = 'build' . $this->buildElementFunctionName[$formElement['type']];

Carsten  Rose's avatar
Carsten Rose committed
374
            $jsonElement = array();
375
            // Render pure element
Carsten  Rose's avatar
Carsten Rose committed
376
377
            $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementId, $value, $jsonElement);

378
379
//            $fake0 = $fe['dynamicUpdate'];
//            $fake1 = $formElement['dynamicUpdate'];
Carsten  Rose's avatar
Carsten Rose committed
380
381
382
383
384
385
386
387

            // 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
388
                if ($modeCollectFe === FLAG_ALL || ($modeCollectFe == FLAG_DYNAMIC_UPDATE && $fe['dynamicUpdate'] == 'yes')) {
Carsten  Rose's avatar
Carsten Rose committed
389
390
391
                    $json[] = $jsonElement;
                }
            }
392
393

            // debugStack as Tooltip
Carsten  Rose's avatar
Carsten Rose committed
394
            if ($this->showDebugInfo && count($debugStack) > 0) {
395
396
//                $elementHtml = Support::appendTooltip($elementHtml, implode("\n", OnArray::htmlentitiesOnArray($debugStack)));
                $elementHtml = Support::appendTooltip($elementHtml, implode("\n", $debugStack));
397
398
            }

Carsten  Rose's avatar
Carsten Rose committed
399
            // Construct Marshaller Name: buildRow
400
401
            $buildRowName = 'buildRow' . $this->buildRowName[$formElement['type']];

402
            $html .= $this->$buildRowName($formElement, $elementHtml, $htmlFormElementId);
Carsten  Rose's avatar
Carsten Rose committed
403
//            break;
404
        }
405

406
407
408
        // Log / Debug: Last FormElement has been processed.
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

409
410
411
        return $html;
    }

412
413
    abstract public function fillWrapLabelInputNote($label, $input, $note);

414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
    /**
     * Create a hidden sip, based on latest STORE_SIP Values. Return complete HTML 'hidden' element.
     *
     * @param $json
     * @return string  <input type='hidden' name='s' value='<sip>'>
     * @throws CodeException
     * @throws \qfq\UserFormException
     */
    public function buildHiddenSip(&$json) {
        $sipArray = $this->store->getStore(STORE_SIP);
        unset($sipArray[SIP_SIP]);
        unset($sipArray[SIP_URLPARAM]);

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

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

        $json[] = $this->getJsonElementUpdate(CLIENT_SIP, $sipValue, '');

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

    /**
     * @param $htmlFormElementId
     * @param string|array $value
     * @param string $mode disabled|readonly|''
     * @return array
     */
    private function getJsonElementUpdate($htmlFormElementId, $value, $mode) {
        $json = array();

        $json['form-element'] = $htmlFormElementId;
        $json['value'] = $value;
        $json['disabled'] = ($mode === 'disabled');
        $json['readonly'] = ($mode === 'readonly');

        return $json;
    }

    /**
     * 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
465
466
467
468
    /**
     * Takes the current SIP ('form' and additional parameter), set SIP_RECORD_ID=0 and create a new 'NewRecordUrl'.
     *
     * @throws CodeException
469
     * @throws \qfq\UserFormException
Carsten  Rose's avatar
Carsten Rose committed
470
471
472
473
     */
    public function deriveNewRecordUrlFromExistingSip(&$toolTipNew) {
        $urlParam = $this->store->getStore(STORE_SIP);
        $urlParam[SIP_RECORD_ID] = 0;
474

Carsten  Rose's avatar
Carsten Rose committed
475
476
        unset($urlParam[SIP_SIP]);
        unset($urlParam[SIP_URLPARAM]);
477
478

        Support::appendTypo3ParameterToArray($urlParam);
Carsten  Rose's avatar
Carsten Rose committed
479
480
481
482
483

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

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

484
        if ($this->showDebugInfo) {
485
            //TODO: missing decoding of SIP
486
487
            $toolTipNew .= PHP_EOL . PHP_EOL . OnArray::toString($urlParam, ' = ', PHP_EOL, "'");
        }
Carsten  Rose's avatar
Carsten Rose committed
488
489
490
491

        return $url;
    }

492
    abstract public function buildRowNative(array $formElement, $htmlElement, $htmlFormElementId);
493

494
    abstract public function buildRowPill(array $formElement, $elementHtml);
495

496
    abstract public function buildRowFieldset(array $formElement, $elementHtml);
497

498
    abstract public function buildRowSubrecord(array $formElement, $elementHtml);
499

500
    /**
501
502
     * Builds a label, typically for an html-'<input>'-element.
     *
503
504
     * @param string $htmlFormElementId
     * @param string $label
505
506
     * @return string
     */
507
    public function buildLabel($htmlFormElementId, $label) {
508
509
510
511
        $attributes = Support::doAttribute('for', $htmlFormElementId);
        $attributes .= Support::doAttribute('class', 'control-label');

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

        return $html;
514
515
    }

516
517
518
519
520
521
522
523
524
525
526
    /**
     * 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"]
     *           [pattern="$pattern"] [readonly="readonly"] [required="required"] [disabled="disabled"] value="$value">
     *
     *
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return string
527
     * @throws UserFormException
528
     */
Carsten  Rose's avatar
Carsten Rose committed
529
    public function buildInput(array $formElement, $htmlFormElementId, $value, &$json) {
530
        $textarea = '';
531

532
        $attribute = Support::doAttribute('name', $htmlFormElementId);
533
        $attribute .= Support::doAttribute('class', 'form-control');
534

535
        // Check for input type 'textarea'
536
        $colsRows = explode(',', $formElement['size'], 2);
537
        if (count($colsRows) === 2) {
538
            // <textarea>
539
540
            $htmlTag = '<textarea';

541
542
            $attribute .= Support::doAttribute('cols', $colsRows[0]);
            $attribute .= Support::doAttribute('rows', $colsRows[1]);
543
            $textarea = htmlentities($value) . '</textarea>';
544
545

        } else {
Carsten  Rose's avatar
Carsten Rose committed
546
547
548
549
            $htmlTag = '<input';

            $this->adjustMaxLength($formElement);

550
551
            // <input>
            if ($formElement['maxLength'] > 0) {
Carsten  Rose's avatar
Carsten Rose committed
552
553
554
                // crop string only if it's not empty (substr returns false on empty strings)
                if ($value !== '')
                    $value = substr($value, 0, $formElement['maxLength']);
555

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

562
        $attribute .= $this->getAttributeList($formElement, ['autocomplete', 'autofocus', 'placeholder']);
563
564
        $attribute .= Support::doAttribute('data-load', ($formElement['dynamicUpdate'] === 'yes') ? 'data-load' : '');
        $attribute .= Support::doAttribute('title', $formElement['tooltip']);
Carsten  Rose's avatar
Carsten Rose committed
565
        $attribute .= $this->getInputCheckPattern($formElement['checkType'], $formElement['checkPattern']);
566

Carsten  Rose's avatar
Carsten Rose committed
567
        $attribute .= $this->getAttributeMode($formElement);
568

Carsten  Rose's avatar
Carsten Rose committed
569
570
        $json = $this->getJsonElementUpdate($htmlFormElementId, $value, $formElement['mode']);

571
        return "$htmlTag $attribute>$textarea" . $this->getHelpBlock();
572

573
574
    }

Carsten  Rose's avatar
Carsten Rose committed
575
576
577
578
579
580
581
582
    /**
     * @param array $formElement
     */
    private function adjustMaxLength(array &$formElement) {

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

583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
        switch ($formElement['type']) {
            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
604
605
606
607
608
609
610
611
612
613
614
        if ($maxLength !== false) {
            if (is_numeric($formElement['maxLength'])) {
                if ($formElement['maxLength'] > $maxLength) {
                    $formElement['maxLength'] = $maxLength;
                }
            } else {
                $formElement['maxLength'] = $maxLength;
            }
        }
    }

615
    /**
616
617
     * Get column spec from tabledefinition and parse size of it. If nothing defined, return false.
     *
618
     * @param $column
619
     * @return bool|int  a) 'false' if there is no length definition, b) length definition, c) date|time|datetime|timestamp use hardcoded length
620
621
622
623
624
     */
    private function getColumnSize($column) {
        $matches = array();

        $typeSpec = $this->store->getVar($column, STORE_TABLE_COLUMN_TYPES);
625
626
627
628
629
630
631
632
633
634
635
        switch ($typeSpec) {
            case 'date': // yyyy-mm-dd
                return 10;
            case 'datetime': // yyyy-mm-dd hh:mm:ss
            case 'timestamp': // yyyy-mm-dd hh:mm:ss
                return 19;
            case 'time': // hh:mm:ss
                return 8;
            default:
                break;
        }
636

637
        // e.g.: string(64) >> 64, enum('yes','no') >> false
638
639
640
641
642
643
        if (1 === preg_match('/\((.+)\)/', $typeSpec, $matches)) {
            if (is_numeric($matches[1]))
                return $matches[1];
        }

        return false;
644
645
646
647
    }

    /**
     * Builds a HTML attribute list, based on  $attributeList.
648
     *
649
650
651
652
653
654
655
     * E.g.: attributeList: [ 'type', 'autofocus' ]
     *       generates: 'type="$formElement['type']" autofocus="$formElement['autofocus']" '
     *
     * @param array $formElement
     * @param array $attributeList
     * @return string
     */
Carsten  Rose's avatar
Carsten Rose committed
656
    private function getAttributeList(array $formElement, array $attributeList) {
657
658
659
        $attribute = '';
        foreach ($attributeList as $item) {
            if (isset($formElement[$item]))
660
                $attribute .= Support::doAttribute(strtolower($item), $formElement[$item]);
661
662
663
664
665
666
        }
        return $attribute;
    }

    /**
     * Construct HTML Input attribute for Client Validation:
667
     *
668
     *   type     data                      result
669
     *   -------  -----------------------   -------------------------------------------------------------------------------
670
671
     *   min|max  <min value>|<max value>   min="$attrData[0]"|max="$attrData[1]"
     *   pattern  <regexp>                  pattern="$data"
Carsten  Rose's avatar
Carsten Rose committed
672
     *   digit    -                         pattern="^[0-9]*$"
673
     *   email    -                         pattern="^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\.[a-z]{2,4})$"
674
     *   alnumx   -
675
     *
676
     * For 'min/max' and 'pattern' the 'data' will be injected in the attribute string via '%s'.
677
678
679
680
     *
     * @param $type
     * @param $data
     * @return string
681
     * @throws \qfq\UserFormException
682
     */
Carsten  Rose's avatar
Carsten Rose committed
683
    private function getInputCheckPattern($type, $data) {
684
685
        $attribute = '';

686
687
        if ($type === '') {
            return '';
688
        }
689

690
691
692
693
694
        switch ($type) {
            case SANITIZE_ALLOW_MIN_MAX:
            case SANITIZE_ALLOW_MIN_MAX_DATE:
                $arrData = explode("|", $data);
                if (count($arrData) != 2 || $arrData[0] == '' || $arrData[1] == '')
695
                    throw new UserFormException("Missing MIN|MAX values", ERROR_MISSING_MIN_MAX);
696

697
698
699
                $attribute = 'min="' . $arrData[0] . '" ';
                $attribute .= 'max="' . $arrData[1] . '" ';
                break;
700

701
702
703
704
705
706
707
708
709
710
            case SANITIZE_ALLOW_PATTERN:
                $attribute = 'pattern="' . $data . '" ';
                break;

            case SANITIZE_ALLOW_ALL:
                break;

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

713
714
715
716
        return $attribute;
    }

    /**
717
718
     * Set corresponding html attributes readonly/required/disabled, based on $formElement['mode'].
     *
719
720
     * @param array $formElement
     * @return string
721
     * @throws UserFormException
722
     */
Carsten  Rose's avatar
Carsten Rose committed
723
    private function getAttributeMode(array $formElement) {
724
725
726
727
728
729
        $attribute = '';

        switch ($formElement['mode']) {
            case 'show':
                break;
            case 'readonly':
730
                $attribute .= Support::doAttribute('readonly', 'readonly');
731
732
                break;
            case 'required':
733
                $attribute .= Support::doAttribute('required', 'required');
734
735
736
737
                break;
            case 'lock':
                break;
            case 'disabled':
738
                $attribute .= Support::doAttribute('disabled', 'disabled');
739
740
                break;
            default:
741
742
                // Preparation for Log, Debug
                $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($formElement), STORE_SYSTEM);
743
                $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, 'mode', STORE_SYSTEM);
744
                throw new UserFormException("Unknown mode '" . $formElement['mode'] . "'", ERROR_UNKNOWN_MODE);
745
746
747
748
749
                break;
        }
        return $attribute;
    }

750
751
752
753
754
755
756
    /**
     * @return string
     */
    private function getHelpBlock() {
        return '<div class="help-block with-errors"></div>';
    }

757
758
759
    /**
     * Builds HTML 'checkbox' element.
     *
760
     * Checkboxes will only be submitted, if they are checked. Therefore, a hidden element with the unchecked value will be transferred first.
761
762
763
764
765
766
767
768
769
     *
     * Format: <input type="hidden" name="$htmlFormElementId" value="$valueUnChecked">
     *         <input name="$htmlFormElementId" type="checkbox" [autofocus="autofocus"]
     *            [readonly="readonly"] [required="required"] [disabled="disabled"] value="<value>" [checked="checked"] >
     *
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $value
     * @return string
770
     * @throws UserFormException
771
     */
Carsten  Rose's avatar
Carsten Rose committed
772
    public function buildCheckbox(array $formElement, $htmlFormElementId, $value, &$json) {
773
774
775
776
        $itemKey = array();
        $itemValue = array();

        // Fill $itemKey & $itemValue
777
        $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue);
778
779
780

        // Get fallback, if 'checkBoxMode' is not defined:
        if (!isset($formElement['checkBoxMode'])) {
781
            // This fallback is problematic if 'set' or 'enum' has 2 : defaults to single but maybe multi is meant.
782
783
784
785
786
787
            $formElement['checkBoxMode'] = (count($itemKey) > 2) ? 'multi' : 'single';
        }

        if ($formElement['checkBoxMode'] === 'multi') {
            $htmlFormElementId .= '[]';
        } else {
788
            // Fill meaningfull defaults to parameter: checked|unchecked  (CHECKBOX_VALUE_CHECKED|CHECKBOX_VALUE_UNCHECKED)
789
790
791
            $this->prepareCheckboxCheckedUncheckedValue($itemKey, $formElement);
        }

Carsten  Rose's avatar
Carsten Rose committed
792
        $attributeBase = $this->getAttributeMode($formElement);
793
        $attributeBase .= Support::doAttribute('type', $formElement['type']);
794
795
796
797
798
799
800
801
802

        switch ($formElement['checkBoxMode']) {
            case 'single':
                $html = $this->buildCheckboxSingle($formElement, $htmlFormElementId, $attributeBase, $value);
                break;
            case 'multi';
                $html = $this->buildCheckboxMulti($formElement, $htmlFormElementId, $attributeBase, $value, $itemKey, $itemValue);
                break;
            default:
803
                throw new UserFormException('checkBoxMode: \'' . $formElement['checkBoxMode'] . '\' is unknown.', ERROR_CHECKBOXMODE_UNKNOWN);
804
        }
805

Carsten  Rose's avatar
Carsten Rose committed
806
        $json = $this->getJsonElementUpdate($htmlFormElementId, $value, $formElement['mode']);
807
//        return Support::wrapTag('<div class="checkbox">', $html, true);
808
809
810
        return $html;
    }

811
    /**
812
813
814
815
816
     * Look for key/value list (in this order, first match counts) in
     *  a) `sql1`
     *  b) `parameter:itemList`
     *  c) table.column definition
     *
817
     * Copies the found keys to &$itemKey and the values to &$itemValue
818
     * If there are no &$itemKey, copy &$itemValue to &$itemKey.
819
820
821
822
     *
     * @param array $formElement
     * @param $itemKey
     * @param $itemValue
823
     * @throws CodeException
824
     * @throws \qfq\UserFormException
825
     */
826
    public function getKeyValueListFromSqlEnumSpec(array $formElement, &$itemKey, &$itemValue) {
827
828
829
830
        $fieldType = '';
        $itemKey = array();
        $itemValue = array();

831
832
833
        if (count($formElement) < 20)
            throw new CodeException("Invalid (none or to small) Formelement", ERROR_MISSING_FORMELEMENT);

834
        // Call getItemsForEnumOrSet() only if there a corresponding column really exist.
835
        if (false !== $this->store->getVar($formElement['name'], STORE_TABLE_COLUMN_TYPES)) {
836
837
            $itemValue = $this->getItemsForEnumOrSet($formElement['name'], $fieldType);
        }
838
839

        if (is_array($formElement['sql1'])) {
840
841
842
            if (count($formElement['sql1']) > 0) {
                $keys = array_keys($formElement['sql1'][0]);
                $itemKey = array_column($formElement['sql1'], 'id');
843

844
845
846
847
                // If there is no column 'id' and at least two columns in total
                if (count($itemKey) === 0 && count($keys) >= 2) {
                    $itemKey = array_column($formElement['sql1'], $keys[0]);
                }
848

849
850
851
852
853
854
                $itemValue = array_column($formElement['sql1'], 'label');
                // If there is no column 'label' (e.g.: SHOW tables)
                if (count($itemValue) === 0) {
                    $idx = count($keys) == 1 ? 0 : 1;
                    $itemValue = array_column($formElement['sql1'], $keys[$idx]);
                }
855
            }
856
        } elseif (isset($formElement['itemList']) && strlen($formElement['itemList']) > 0) {
857
            $arr = KeyValueStringParser::parse($formElement['itemList'], ':', ',', KVP_IF_VALUE_EMPTY_COPY_KEY);
858
859
            $itemValue = array_values($arr);
            $itemKey = array_keys($arr);
860
        } elseif ($fieldType === 'enum' || $fieldType === 'set') {
Carsten  Rose's avatar
Carsten Rose committed
861
            // already done at the beginning with '$this->getItemsForEnumOrSet($formElement['name'], $fieldType);'
862
        } else {
863
            throw new UserFormException("Missing definition (- nothing found in 'sql1', 'parameter:itemValues', 'enum-' or 'set-definition'", ERROR_MISSING_ITEM_VALUES);
864
865
866
867
868
        }

        if (count($itemKey) === 0) {
            $itemKey = $itemValue;
        }
869
870
871
872
873
874
875
876
877
878

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

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

Carsten  Rose's avatar
Carsten Rose committed
880
881
        if (isset($formElement['emptyHide'])) {
            if (isset($itemValue['']))
882
                unset($itemValue['']);
Carsten  Rose's avatar
Carsten Rose committed
883
            if (isset($itemKey['']))
884
885
886
                unset($itemKey['']);

        }
887
888
889
    }

    /**
890
891
     * Get the attribute definition list of an enum or set column. For strings, get the default value. Return elements as an array.
     *
892
893
894
     * @param $column
     * @param $fieldType
     * @return array
895
     * @throws UserFormException
896
897
898
899
900
901
902
     */
    private function getItemsForEnumOrSet($column, &$fieldType) {

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

        if ($fieldTypeDefinition === false) {
903
            throw new UserFormException("Column '$column' unknown in table '" . $this->formSpec['tableName'] . "'", ERROR_DB_UNKNOWN_COLUMN);
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
        }

        $length = strlen($fieldTypeDefinition);

        // enum('...   set('
        switch (substr($fieldTypeDefinition, 0, 4)) {
            case 'enum':
                $startPosition = 5;
                break;
            case 'set(':
                $startPosition = 4;
                break;
            default:
                $fieldType = 'string';
                return array();
        }

        // enum('a','b','c', ...)   >> [ 'a', 'b', 'c', ... ]
        // set('a','b','c', ...)   >> [ 'a', 'b', 'c', ... ]
        $items = OnArray::trimArray(explode(',', substr($fieldTypeDefinition, $startPosition, $length - $startPosition - 1)), "'");
        $fieldType = substr($fieldTypeDefinition, 0, $startPosition - 1);

        return $items;
    }

    /**
     * For CheckBox's with only one checkbox: if no parameter:checked|unchecked is defined, take defaults:
931
     *
932
933
934
935
936
     *    checked: first Element in $itemKey
     *  unchecked: ''
     *
     * @param array $itemKey
     * @param array $formElement
937
     * @throws UserFormException
938
939
940
     */
    private function prepareCheckboxCheckedUncheckedValue(array $itemKey, array &$formElement) {

941
        if (!isset($formElement[CHECKBOX_VALUE_CHECKED])) {
942
943
            if (isset($itemKey[0])) {
                // First element in $itemKey list
944
                $formElement[CHECKBOX_VALUE_CHECKED] = $itemKey[0];
945
946
            } else {
                // Take column default value
947
                $formElement[CHECKBOX_VALUE_CHECKED] = $this->store->getVar($formElement['name'], STORE_TABLE_DEFAULT);
948
949
950
951
            }
        }

        // unchecked
952
        if (!isset($formElement[CHECKBOX_VALUE_UNCHECKED])) {
953
            if (isset($itemKey[1])) {
954
                $formElement[CHECKBOX_VALUE_UNCHECKED] = ($itemKey[0] === $formElement['checked']) ? $itemKey[1] : $itemKey[0];
955
            } else {
956
                $formElement[CHECKBOX_VALUE_UNCHECKED] = '';
957
958
959
            }
        }

960
        if ($formElement[CHECKBOX_VALUE_CHECKED] === $formElement[CHECKBOX_VALUE_UNCHECKED]) {
961
            throw new UserFormException('FormElement: type=checkbox - checked and unchecked can\'t be the same: ' . $formElement[CHECKBOX_VALUE_CHECKED], ERROR_CHECKBOX_EQUAL);
962
963
964
965
966
        }

    }

    /**
967
968
     * Build a Checkbox based on two values.
     *
969
970
971
972
973
974
     * @param array $formElement
     * @param $htmlFormElementId
     * @param $attribute
     * @param $value
     * @return string
     */
975
    public function buildCheckboxSingle(array $formElement, $htmlFormElementId, $attribute, $value) {
976
        $html = '';
977

978
979
        $attribute .= Support::doAttribute('name', $htmlFormElementId);
        $attribute .= Support::doAttribute('value', $formElement['checked'], false);
980
        $attribute .= Support::doAttribute('title', $formElement['tooltip']);
981
        $attribute .= Support::doAttribute('data-load', ($formElement['dynamicUpdate'] === 'yes') ? 'data-load' : '');
Carsten  Rose's avatar
Carsten Rose committed
982

983
        if ($formElement['checked'] === $value) {
984
            $attribute .= Support::doAttribute('checked', 'checked');
985
986
        }

Carsten  Rose's avatar
Carsten Rose committed
987
        $attribute .= $this->getAttributeList($formElement, ['autofocus']);
988

989
        $html = $this->buildNativeHidden($htmlFormElementId, $formElement['unchecked']);
990
991
992
993
994
995

        $html .= '<input ' . $attribute . '>';
        if (isset($formElement['label2'])) {
            $html .= $formElement['label2'];
        }