FillStoreForm.php 11 KB
Newer Older
Carsten  Rose's avatar
Carsten Rose committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
<?php
/**
 * Created by PhpStorm.
 * User: crose
 * Date: 3/23/16
 * Time: 1:31 PM
 */

namespace qfq;

require_once(__DIR__ . '/Store.php');
require_once(__DIR__ . '/../Database.php');
require_once(__DIR__ . '/../Constants.php');
require_once(__DIR__ . '/../helper/HelperFormElement.php');
15
require_once(__DIR__ . '/../exceptions/UserFormException.php');
Carsten  Rose's avatar
Carsten Rose committed
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

class FillStoreForm {

    /**
     * @var Store
     */
    private $store = null;

    /**
     * @var Database
     */
    private $db = null;

    /**
     * @var array
     */
    private $feSpecNative = array();

34
35
36
37
38
    /**
     * @var Evaluate
     */
    private $evaluate = null;

Carsten  Rose's avatar
Carsten Rose committed
39
40
41
42
    /**
     *
     */
    public function __construct() {
43

Carsten  Rose's avatar
Carsten Rose committed
44
45
46
        $this->store = Store::getInstance();
        $this->db = new Database();
        $this->feSpecNative = $this->loadFormElementsBasedOnSIP();
47
48
        $this->evaluate = new Evaluate($this->store, $this->db);

Carsten  Rose's avatar
Carsten Rose committed
49
50
    }

Carsten  Rose's avatar
Carsten Rose committed
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
    /**
     * Checks if there are templateGroups defined. If yes, expand them. Return expanded feSpecNative array.
     *
     * @param array $feSpecTemplateGroup
     * @param array $feSpecNative
     * @return array
     */
    private function expandTemplateGroupFormElement(array $feSpecTemplateGroup, array $feSpecNative) {
        $expanded = array();

        if(count($feSpecTemplateGroup)==0) {
            return $feSpecNative; // No templateGroups >> nothing to do >> just return
        }

        // Iterate over all 'FormElements': part of a templateGroup?
        foreach($feSpecNative as $fe) {
            $flagCopied=false;

            if($fe[FE_ID_CONTAINER]>0) {
                // Search for a corresponding template group.
                foreach ($feSpecTemplateGroup as $templateGroup) {
                    if ($fe[FE_ID_CONTAINER] = $templateGroup[FE_ID]) {

                        $flagCopied=true;

                        // Get max copies per template group
                        $maxCopies = ($templateGroup[FE_MAX_LENGTH] == 0 || $templateGroup[FE_MAX_LENGTH] == '') ? FE_TEMPLATE_GROUP_DEFAULT_MAX_LENGTH : $templateGroup[FE_MAX_LENGTH];

                        // Copy each native FormElement
                        $template = $fe[FE_NAME];
                        for ($ii = 1; $ii <= $maxCopies; $ii++) {
82
                            $fe[FE_NAME] = str_replace(FE_TEMPLATE_GROUP_NAME_PATTERN, $ii, $template);
Carsten  Rose's avatar
Carsten Rose committed
83
84
85
86
87
88
89
90
91
92
93
94
95
96
                            $expanded[] = $fe;
                        }
                    }
                }
            }

            if(!$flagCopied) {
                $expanded[] = $fe;
            }
        }

        return $expanded;
    }

Carsten  Rose's avatar
Carsten Rose committed
97
98
99
    /**
     * Loads a minimal definition of FormElement of the form specified in SIP.
     *
Carsten  Rose's avatar
Carsten Rose committed
100
     * @return array
Carsten  Rose's avatar
Carsten Rose committed
101
102
     * @throws CodeException
     * @throws DbException
103
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
104
105
     */
    private function loadFormElementsBasedOnSIP() {
106
        $formName = $this->store->getVar(SIP_FORM, STORE_SIP);
Carsten  Rose's avatar
Carsten Rose committed
107

108
109
110
        // Preparation for Log, Debug
        $this->store->setVar(SYSTEM_FORM, $formName, STORE_SYSTEM);

Carsten  Rose's avatar
Carsten Rose committed
111
112
113
        $feSpecNative = $this->db->sql(SQL_FORM_ELEMENT_SIMPLE_ALL_CONTAINER, ROW_EXPECT_GE_1, [$formName],
            'Form or FormElements not found: ' . ERROR_FORM_NOT_FOUND);
        HelperFormElement::explodeParameterInArrayElements($feSpecNative);
Carsten  Rose's avatar
Carsten Rose committed
114

Carsten  Rose's avatar
Carsten Rose committed
115
116
117
118
        $feSpecTemplateGroup = $this->db->sql(SQL_FORM_ELEMENT_CONTAINER_TEMPLATE_GROUP, ROW_REGULAR, [$formName]);
        HelperFormElement::explodeParameterInArrayElements($feSpecTemplateGroup);

        $feSpecNative = $this->expandTemplateGroupFormElement($feSpecTemplateGroup, $feSpecNative);
Carsten  Rose's avatar
Carsten Rose committed
119

120

Carsten  Rose's avatar
Carsten Rose committed
121
122
123
124
125
126
127
128
        return $feSpecNative;
    }

    /**
     * Copies all current form parameter from STORE_CLIENT to STORE_FORM. Checks the values against FormElement
     * definition and throws an exception if check fails. FormElements.type=hidden will be taken from STORE_SIP.
     *
     * @throws CodeException
129
     * @throws UserFormException
Carsten  Rose's avatar
Carsten Rose committed
130
131
     */
    public function process() {
132
133
134
        // The following 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];

Carsten  Rose's avatar
Carsten Rose committed
135
136
137
138
139
140
141
142
        $html = '';
        $newValues = array();

        $clientValues = $this->store->getStore(STORE_CLIENT);

        // Retrieve SIP vars, e.g. for HIDDEN elements.
        $sipValues = $this->store->getStore(STORE_SIP);

143
        // Copy SIP Values; not necessarily defined as a FormElement.
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
        foreach ($sipValues as $key => $value) {
            switch ($key) {
                case SIP_SIP:
                case SIP_RECORD_ID:
                case SIP_FORM:
                case SIP_TABLE:
                case SIP_URLPARAM:
                case 'id':
                    break;
                default:
                    $newValues[$key] = $value;
                    break;
            }
        }

Carsten  Rose's avatar
#2067    
Carsten Rose committed
159
160
161
162
163
        // Check if there is a 'new record already saved' situation:
        // yes: the names of the input fields are submitted with '<fieldname>:0' instead of '<fieldname>:<id>'
        // no: regular situation, take real 'recordid'
        $fakeRecordId = isset($sipValues[SIP_MAKE_URLPARAM_UNIQ]) ? 0 : $sipValues[SIP_RECORD_ID];

Carsten  Rose's avatar
Carsten Rose committed
164
165
166
167
168
169
170
        // Iterate over all formelements. Sanatize values. Built an assoc array $newValues.
        foreach ($this->feSpecNative AS $formElement) {

            // Never get a predefined 'id'
            if ($formElement['name'] === 'id')
                continue;

171
172
173
            // Preparation for Log, Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($formElement), STORE_SYSTEM);

174
            // Evaluate current FormElement: e.g. FE_MODE_SQL
175
            $formElement = $this->evaluate->parseArray($formElement, $skip, $debugStack);
176

177
            // Get related formElement. Construct the field name used in the form.
Carsten  Rose's avatar
#2067    
Carsten Rose committed
178
            $clientFieldName = HelperFormElement::buildFormElementName($formElement['name'], $fakeRecordId);
Carsten  Rose's avatar
Carsten Rose committed
179

180
181
            // Some Defaults
            $formElement = Support::setFeDefaults($formElement);
Carsten  Rose's avatar
Carsten Rose committed
182

183
184
            if ($formElement[FE_TYPE] === FE_TYPE_EXTRA) {
                // Extra elements will be transferred by SIP
Carsten  Rose's avatar
Carsten Rose committed
185
                if (!isset($sipValues[$formElement['name']])) {
186
                    throw new CodeException("Missing the " . FE_TYPE_EXTRA . " field '" . $formElement['name'] . "' in SIP.", ERROR_MISSING_HIDDEN_FIELD_IN_SIP);
Carsten  Rose's avatar
Carsten Rose committed
187
188
189
190
191
192
                }

                $newValues[$formElement['name']] = $sipValues[$formElement['name']];
                continue;
            }

193
            // Checkbox Multi: collect values
194
            if ($formElement[FE_TYPE] === 'checkbox') {
195
196
197
198
                $val = $this->collectMultiValues($clientFieldName, $clientValues);
                if($val !== false) {
                    $clientValues[$clientFieldName] = $val;
                }
199
200
            }

201
            if ($formElement[FE_MODE] === FE_MODE_REQUIRED) {
202
203
204
205
206
                if (!isset($clientValues[$clientFieldName]) || ($clientValues[$clientFieldName] === '')) {
                    throw new UserFormException("Missing required value.", ERROR_REQUIRED_VALUE_EMPTY);
                }
            }

207
208
209
210
211
212
213
214
215
216
217
            // copy value to $newValues
            if (isset($clientValues[$clientFieldName])) {
                if ($formElement[FE_DYNAMIC_UPDATE] === 'yes' || $formElement[FE_MODE] === FE_MODE_REQUIRED || $formElement[FE_MODE] === FE_MODE_SHOW) {
                    switch ($formElement[FE_TYPE]) {
                        case 'date':
                        case 'datetime':
                        case 'time':
                            if ($clientValues[$clientFieldName] !== '') // do not check empty values
                                $newValues[$formElement['name']] = $this->doDateTime($formElement, $clientValues[$clientFieldName]);
                            break;
                        default:
218
219
220
221
222
223
224
                            // Check only if their is something
                            if($clientValues[$clientFieldName] !== '') {
                                $newValues[$formElement['name']] = Sanitize::sanitize($clientValues[$clientFieldName],
                                    $formElement['checkType'], $formElement['checkPattern'], SANATIZE_EXCEPTION);
                            } else {
                                $newValues[$formElement['name']] ='';
                            }
225
                            break;
226
                    }
227
                }
Carsten  Rose's avatar
Carsten Rose committed
228
229
230
231
232
233
            }
        }

        $this->store->setVarArray($newValues, STORE_FORM, true);
    }

234
    /**
235
     * Steps through all $clientValues (POST vars) and collect all with the name _?_${clientFieldName} in a comma seperated string (MYSQL ENUM type).
236
     * If there is no element '_h_${clientFieldName}', than there are no multi values - return the already given `$clientValues[$clientFieldName]`.
237
     *
238
239
     * @param $clientFieldName
     * @param array $clientValues
240
     * @return string
241
     */
242
    private function collectMultiValues($clientFieldName, array $clientValues) {
243
244

        $checkboxKey = HelperFormElement::prependFormElementIdCheckBoxMulti($clientFieldName, 'h');
245

246
247
248
249
250
251
252
        // For templateGroups: all expanded FormElements will be tried to collect - this fails for not submitted fields.
        // Therefore skip not existing clientvalues.
        if(!isset($clientValues[$checkboxKey])) {
            return false;
        }

        // Check if there is a hidden value with naming in checkbox multi syntax
253
        if (isset($clientValues[$checkboxKey])) {
254
            $checkboxValue = $clientValues[$checkboxKey];
255

256
257
258
            $pattern = '/' . HelperFormElement::prependFormElementIdCheckBoxMulti($clientFieldName, '\d+') . '/';
            foreach ($clientValues as $key => $value) {
                if (1 === preg_match($pattern, $key)) {
259
                    $checkboxValue .= ',' . $value;
260
261
262
                }
            }

263
264
265
266
            if (isset($checkboxValue[0]) && $checkboxValue[0] === ',') {
                $checkboxValue = substr($checkboxValue, 1);
            }

267
268
269
270
271
272
            $clientValues[$clientFieldName] = $checkboxValue;
        }

        return $clientValues[$clientFieldName];
    }

273
274
275
    /**
     * Check  $value as date/datime/time value and convert it to FORMAT_DATE_INTERNATIONAL.
     *
276
     * @param array $formElement - if not set, set $formElement[FE_DATE_FORMAT]
277
278
279
280
281
282
     * @param string $value - date/datetime/time value in format FORMAT_DATE_INTERNATIONAL or FORMAT_DATE_GERMAN
     * @return string - checked datetime string
     * @throws UserFormException
     */
    private function doDateTime(array &$formElement, $value) {

283
        $regexp = Support::dateTimeRegexp($formElement[FE_TYPE], $formElement[FE_DATE_FORMAT]);
284
285
286
287
288
289

        if (1 !== preg_match('/' . $regexp . '/', $value, $matches)) {
            $placeholder = Support::getDateTimePlaceholder($formElement);
            throw new UserFormException("DateTime format not recognized: $placeholder / $value ", ERROR_DATE_TIME_FORMAT_NOT_RECOGNISED);
        }

290
        $showTime = $formElement[FE_TYPE] == 'date' ? '0' : '1';
291
292
293
294
        $value = Support::convertDateTime($value, FORMAT_DATE_INTERNATIONAL, '1', $showTime, $formElement[FE_SHOW_SECONDS]);

        return $value;
    }
Carsten  Rose's avatar
Carsten Rose committed
295
}