around everything // Logged in BE User will see a FormEdit Link $sipParamString = OnArray::toString($this->store->getStore(STORE_SIP), ':', ', ', "'"); $formEditUrl = $this->createFormEditorUrl(FORM_NAME_FORM, $this->formSpec[F_ID]); $html .= "

Edit [$sipParamString]

"; $html .= $this->wrapItem(WRAP_SETUP_TITLE, $this->formSpec[F_TITLE], true); $html .= $this->getFormTag(); return $html; } /** * If SHOW_DEBUG_INFO=yes: create a link (incl. SIP) to edit the current form. Show also the hidden content of * the SIP. * * @param string $form FORM_NAME_FORM | FORM_NAME_FORM_ELEMENT * @param int $recordId id of form or formElement * @param array $param * * @return string String: Edit [sip:..., r:..., urlparam:..., * ...] * @throws \CodeException * @throws \UserFormException */ public function createFormEditorUrl($form, $recordId, array $param = array()) { if (!$this->showDebugInfoFlag) { return ''; } $queryStringArray = [ 'id' => $this->store->getVar(SYSTEM_EDIT_FORM_PAGE, STORE_SYSTEM), 'form' => $form, 'r' => $recordId, PARAM_DB_INDEX_DATA => $this->dbIndexQfq, ]; $queryStringArray = array_merge($queryStringArray, $param); $queryString = Support::arrayToQueryString($queryStringArray); $sip = $this->store->getSipInstance(); $url = $sip->queryStringToSip($queryString); return $url; } /** * Wrap's $this->wrap[$item][WRAP_SETUP_START] around $value. If $flagOmitEmpty==true && $value=='': return ''. * * @param string $item * @param string $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]; } /** * Returns ''-tag with various attributes. * * @return string * @throws \CodeException * @throws \DbException * @throws \UserFormException */ public function getFormTag() { $md5 = ''; $attribute = $this->getFormTagAttributes(); $honeypot = $this->getHoneypotVars(); $md5 = $this->buildInputRecordHashMd5(); return '' . $honeypot . $md5; } /** * Build MD5 from the current record. Return HTML Input element. * * @return string * @throws \CodeException * @throws \DbException * @throws \UserFormException */ public function buildInputRecordHashMd5() { $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_ZERO); $md5 = $this->buildRecordHashMd5($this->formSpec[F_TABLE_NAME], $recordId, $this->formSpec[F_PRIMARY_KEY]); $data = ""; // $data = ""; return $data; } /** * @param $tableName * @param $recordId * @param string $primaryKey * * @return string * @throws \CodeException * @throws \DbException * @throws \UserFormException */ public function buildRecordHashMd5($tableName, $recordId, $primaryKey = F_PRIMARY_KEY_DEFAULT) { $record = array(); if ($recordId != 0) { $record = $this->dbArray[$this->dbIndexData]->sql("SELECT * FROM `$tableName` WHERE `$primaryKey`=?", ROW_EXPECT_1, [$recordId], "Record to load not found. " . (FEATURE_FORM_FILE_SYNC ? FormAsFile::errorHintFormImport($tableName) : '')); } if (isset($record[F_FILE_STATS])) { // why: The column "fileStats" in the Form table is modified when a form is exported to a file but nothing else changes. unset($record[F_FILE_STATS]); } return OnArray::getMd5($record); } /** * Create HTML Input vars to detect bot automatic filling of forms. * * @return string * @throws \CodeException * @throws \UserFormException */ public function getHoneypotVars() { $html = ''; $vars = $this->store->getVar(SYSTEM_SECURITY_VARS_HONEYPOT, STORE_SYSTEM); // Iterate over all fake vars $arr = explode(',', $vars); foreach ($arr as $name) { $name = trim($name); if ($name === '') { continue; } $html .= ""; } return $html; } /** * Build an assoc array with standard form attributes. * * @return array * @throws \CodeException * @throws \DbException * @throws \UserFormException */ public function getFormTagAttributes() { $attribute['id'] = $this->getFormId(); $attribute['method'] = 'post'; $attribute['action'] = $this->getActionUrl(); $attribute['target'] = '_top'; $attribute['accept-charset'] = 'UTF-8'; $attribute[FE_INPUT_AUTOCOMPLETE] = 'on'; $attribute['enctype'] = $this->getEncType(); $attribute['data-disable-return-key-submit'] = $this->formSpec[F_ENTER_AS_SUBMIT] == '1' ? "false" : "true"; // attribute meaning is inverted $attribute['data-activate-first-required-tab'] = $this->formSpec[F_ACTIVATE_FIRST_REQUIRED_TAB] == '1' ? "true" : "false"; // attribute meaning is inverted return $attribute; } /** * Return a uniq form id * * @return string */ public function getFormId() { if ($this->formId === null) { $this->formId = uniqid('qfq-form-'); } return $this->formId; } /** * Builds the HTML 'form'-tag inlcuding all attributes and target. * * Notice: the SIP will be transferred as POST Parameter. * * @return string */ public function getActionUrl() { return Path::urlApi(API_SAVE_PHP); } /** * Determines the enctype. * * See: https://www.w3.org/wiki/HTML/Elements/form#HTML_Attributes * * @return string * @throws \CodeException * @throws \DbException * @throws \UserFormException */ public function getEncType() { $result = $this->dbArray[$this->dbIndexQfq]->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"'); return (count($result) === 1) ? 'multipart/form-data' : 'application/x-www-form-urlencoded'; } /** * @return mixed */ abstract public function getProcessFilter(); /** * @param array|string $value * * @return array|string * @throws \CodeException * @throws \DbException * @throws \DownloadException * @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * @throws \Twig\Error\LoaderError * @throws \Twig\Error\RuntimeError * @throws \Twig\Error\SyntaxError * @throws \UserFormException * @throws \UserReportException */ private function processReportSyntax($value) { if (is_array($value)) { $new = array(); //might happen for e.g Template Groups foreach ($value as $item) { $new[] = $this->processReportSyntax($item); } return $new; } $value = trim($value); if (substr($value, 0, 8) == SHEBANG_REPORT) { if ($this->report === null) { $this->report = new Report(array(), $this->evaluate, false); } if ($this->bodytextParser === null) { $this->bodytextParser = new BodytextParser(); } $storeRecord = $this->store->getStore(STORE_RECORD); $value = $this->report->process($this->bodytextParser->process($value)); $this->store->setStore($storeRecord, STORE_RECORD, true); $this->store->setVar(SYSTEM_REPORT_FULL_LEVEL, '', STORE_SYSTEM); // debug } return $value; } /** * Process all FormElements in $this->feSpecNative: Collect and return all HTML code & JSON. * * @param int $recordId * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD * @param int $feIdContainer * @param array $json * @param string $modeCollectFe * @param bool $htmlElementNameIdZero * @param string $storeUseDefault * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * @param bool $flagMulti * * @return string * @throws \CodeException * @throws \DbException * @throws \DownloadException * @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * @throws \Twig\Error\LoaderError * @throws \Twig\Error\RuntimeError * @throws \Twig\Error\SyntaxError * @throws \UserFormException * @throws \UserReportException */ public function elements($recordId, $filter, $feIdContainer, array &$json, $modeCollectFe = FLAG_DYNAMIC_UPDATE, $htmlElementNameIdZero = false, $storeUseDefault = STORE_USE_DEFAULT, $mode = FORM_LOAD, $flagMulti = false) { $html = ''; // The following 'FormElement.parameter' will never be used during load (fe.type='upload'). FE_PARAMETER has been already expanded. $skip = [FE_SQL_UPDATE, FE_SQL_INSERT, FE_SQL_DELETE, FE_SQL_AFTER, FE_SQL_BEFORE, FE_PARAMETER, FE_FILL_STORE_VAR, FE_FILE_DOWNLOAD_BUTTON, FE_TYPEAHEAD_GLUE_INSERT, FE_TYPEAHEAD_GLUE_DELETE, FE_TYPEAHEAD_TAG_INSERT, FE_TYPEAHEAD_INITIAL_SUGGESTION]; // get current data record $primaryKey = $this->formSpec[F_PRIMARY_KEY]; if ($recordId > 0 && $this->store->getVar($primaryKey, STORE_RECORD) === false) { $tableName = $this->formSpec[F_TABLE_NAME]; $row = $this->dbArray[$this->dbIndexData]->sql("SELECT * FROM `$tableName` WHERE `$primaryKey` = ?", ROW_EXPECT_1, array($recordId), "Form '" . $this->formSpec[F_NAME] . "' failed to load record '$primaryKey'='$recordId' from table '" . $this->formSpec[F_TABLE_NAME] . "'."); $this->store->setStore($row, STORE_RECORD); } $this->checkAutoFocus(); $parameterLanguageFieldName = $this->store->getVar(SYSTEM_PARAMETER_LANGUAGE_FIELD_NAME, STORE_SYSTEM); // Iterate over all FormElements foreach ($this->feSpecNative as $fe) { $storeUse = $storeUseDefault; if (($filter === FORM_ELEMENTS_NATIVE && $fe[FE_TYPE] === 'subrecord') || ($filter === FORM_ELEMENTS_SUBRECORD && $fe[FE_TYPE] !== 'subrecord') // || ($filter === FORM_ELEMENTS_DYNAMIC_UPDATE && $fe[FE_DYNAMIC_UPDATE] === 'no') ) { continue; // skip this FE } // #7705. Dirty fix: 'form_save and fresh created tg element can't be updated, cause the HTML id is unknown: skip those. if ($mode == FORM_SAVE && false != stripos($fe[FE_NAME], '%d')) { continue; // skip this FE } $flagOutput = ($fe[FE_TYPE] !== FE_TYPE_EXTRA); // type='extra' will not displayed and not transmitted to the form. $debugStack = array(); // Preparation for Log, Debug $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($fe), STORE_SYSTEM); $this->store->setVar(SYSTEM_FORM_ELEMENT_ID, $fe[FE_ID], STORE_SYSTEM); // Fill STORE_LDAP $fe = $this->prepareFillStoreFireLdap($fe); if (isset($fe[FE_FILL_STORE_VAR])) { $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, FE_FILL_STORE_VAR, STORE_SYSTEM); // debug $fe[FE_FILL_STORE_VAR] = $this->evaluate->parse($fe[FE_FILL_STORE_VAR], ROW_EXPECT_0_1); $this->store->appendToStore($fe[FE_FILL_STORE_VAR], STORE_VAR); } // If given, slaveId will be copied to STORE_VAR if (!empty($fe[FE_SLAVE_ID])) { $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, FE_SLAVE_ID, STORE_SYSTEM); // debug $slaveId = Support::falseEmptyToZero($this->evaluate->parse($fe[FE_SLAVE_ID])); $this->store->setVar(VAR_SLAVE_ID, $slaveId, STORE_VAR); } $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, FE_VALUE, STORE_SYSTEM); // debug $fe[FE_VALUE] = $this->processReportSyntax($fe[FE_VALUE]); $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, FE_NOTE, STORE_SYSTEM); // debug $fe[FE_NOTE] = $this->processReportSyntax($fe[FE_NOTE]); // ** evaluate current FormElement ** $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, 'Some of the columns of current FormElement', STORE_SYSTEM); // debug $formElement = $this->evaluate->parseArray($fe, $skip, $debugStack); $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, 'Set language', STORE_SYSTEM); // debug $formElement = HelperFormElement::setLanguage($formElement, $parameterLanguageFieldName); // Some Defaults $formElement = Support::setFeDefaults($formElement, $this->formSpec); // // Copy global readonly mode. // if ($this->formSpec[F_MODE] == F_MODE_READONLY) { // $fe[FE_MODE] = FE_MODE_READONLY; // $fe[FE_MODE_SQL] = ''; // } if ($flagOutput === true && !$flagMulti) { $this->fillWrapLabelInputNote($formElement[FE_BS_LABEL_COLUMNS], $formElement[FE_BS_INPUT_COLUMNS], $formElement[FE_BS_NOTE_COLUMNS]); } Support::setIfNotSet($formElement, FE_VALUE); if (is_array($formElement[FE_VALUE])) { $formElement[FE_VALUE] = (count($formElement[FE_VALUE])) > 0 ? current($formElement[FE_VALUE][0]) : ''; } $value = $formElement[FE_VALUE]; if ($value === '') { // #2064 / Only take the default, if the FE is a real tablecolumn. // #3426 / Dynamic Update: Inputs loose the new content and shows the old value. if ($storeUse == STORE_USE_DEFAULT && $this->store->getVar($formElement[FE_NAME], STORE_TABLE_COLUMN_TYPES) === false) { $storeUse = str_replace(STORE_TABLE_DEFAULT, '', $storeUse); // Remove STORE_DEFAULT } // In case the current element is a 'RETYPE' element: take the element name of the source FormElement. Needed to retrieve the default value later. $name = (isset($formElement[FE_RETYPE_SOURCE_NAME])) ? $formElement[FE_RETYPE_SOURCE_NAME] : $formElement[FE_NAME]; // Retrieve value via FSRVD $sanitizeClass = ($mode == FORM_UPDATE) ? SANITIZE_ALLOW_ALL : $formElement[FE_CHECK_TYPE]; $value = $this->store->getVar($name, $storeUse, $sanitizeClass, $foundInStore); // For typeAhead fields: perform prefetch to display description instead of key (#5444) if ($mode == FORM_SAVE && isset($fe[FE_TYPEAHEAD_SQL_PREFETCH])) { $config = [FE_TYPEAHEAD_SQL_PREFETCH => $fe[FE_TYPEAHEAD_SQL_PREFETCH]]; $value = TypeAhead::typeAheadSqlPrefetch($config, $value, $this->dbArray[$this->dbIndexData]); } } if ($formElement[FE_ENCODE] === FE_ENCODE_SPECIALCHAR) { // $value = htmlspecialchars_decode($value, ENT_QUOTES); $value = Support::htmlEntityEncodeDecode(MODE_DECODE, $value); } // Typically: $htmlElementNameIdZero = true // After Saving a record, staying on the form, the FormElements on the Client are still known as ':0'. $htmlFormElementName = HelperFormElement::buildFormElementName($formElement, ($htmlElementNameIdZero) ? 0 : $recordId); $formElement[FE_HTML_ID] = HelperFormElement::buildFormElementId($this->formSpec[F_ID], $formElement[FE_ID], ($htmlElementNameIdZero) ? 0 : $recordId, $formElement[FE_TG_INDEX]); // Construct Marshaller Name: buildElement $buildElementFunctionName = 'build' . $this->buildElementFunctionName[$formElement[FE_TYPE]]; $jsonElement = array(); $elementExtra = ''; // Render pure element $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementName, $value, $jsonElement, $mode); // container elements do not have dynamicUpdate='yes'. Instead they deliver nested elements. if ($formElement[FE_CLASS] == FE_CLASS_CONTAINER) { if (count($jsonElement) > 0) { $json = array_merge($json, $jsonElement); } } else { // for non-container elements: just add the current json status if ($modeCollectFe === FLAG_ALL || ($modeCollectFe == FLAG_DYNAMIC_UPDATE && $fe[FE_DYNAMIC_UPDATE] === 'yes')) { 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; } } } if ($flagOutput) { // debugStack as Tooltip if ($this->showDebugInfoFlag) { if (count($debugStack) > 0) { $elementHtml .= Support::doTooltip($formElement[FE_HTML_ID] . HTML_ID_EXTENSION_TOOLTIP, implode("\n", $debugStack)); } if (!$flagMulti) { // Build 'FormElement' Edit symbol. MultiForms: Edit symbol is in thead. $feEditUrl = $this->createFormEditorUrl(FORM_NAME_FORM_ELEMENT, $formElement[FE_ID], ['formId' => $formElement[FE_FORM_ID]]); $titleAttr = Support::doAttribute('title', $this->formSpec[FE_NAME] . ' / ' . $formElement[FE_NAME] . ' [' . $formElement[FE_ID] . ']'); $icon = Support::wrapTag('', ''); $elementHtml .= Support::wrapTag("", $icon); } } // Construct Marshaller Name: buildRow... $tmpName = $flagMulti ? 'MultiElement' : $this->buildRowName[$formElement[FE_TYPE]]; $buildRowName = 'buildRow' . $tmpName; $html .= $formElement[FE_HTML_BEFORE] . $this->$buildRowName($formElement, $elementHtml, $htmlFormElementName) . $formElement[FE_HTML_AFTER]; } } $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, '', STORE_SYSTEM); // debug // Log / Debug: Last FormElement has been processed. $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM); return $html; } /** * @param array $formElement * @param $elementHtml * * @return string */ public function buildRowMultiElement(array $formElement, $elementHtml) { $before = ($formElement[FE_HTML_BEFORE] == '') ? '' : $formElement[FE_HTML_BEFORE]; $after = ($formElement[FE_HTML_AFTER] == '') ? '' : $formElement[FE_HTML_AFTER]; return $before . $elementHtml . $after; } /** * Checks if LDAP search is requested. * Yes: prepare configuration and fire the query. * No: do nothing. * * @param array $formElement * * @return array * @throws \CodeException * @throws \DbException * @throws \UserFormException * @throws \UserReportException */ private function prepareFillStoreFireLdap(array $formElement) { if (isset($formElement[FE_FILL_STORE_LDAP]) || isset($formElement[FE_TYPEAHEAD_LDAP])) { $keyNames = [F_LDAP_SERVER, F_LDAP_BASE_DN, F_LDAP_ATTRIBUTES, F_LDAP_SEARCH, F_TYPEAHEAD_LDAP_SEARCH, F_TYPEAHEAD_LDAP_SEARCH_PER_TOKEN, F_TYPEAHEAD_LDAP_SEARCH_PREFETCH, F_TYPEAHEAD_LIMIT, F_TYPEAHEAD_MINLENGTH, F_TYPEAHEAD_LDAP_VALUE_PRINTF, F_TYPEAHEAD_LDAP_ID_PRINTF, F_LDAP_TIME_LIMIT, F_LDAP_USE_BIND_CREDENTIALS]; $formElement = OnArray::copyArrayItemsIfNotAlreadyExist($this->formSpec, $formElement, $keyNames); } else { return $formElement; // nothing to do. } if (isset($formElement[FE_FILL_STORE_LDAP])) { // Extract necessary elements $config = OnArray::getArrayItems($formElement, [FE_LDAP_SERVER, FE_LDAP_BASE_DN, FE_LDAP_SEARCH, FE_LDAP_ATTRIBUTES]); $this->store->setVar(SYSTEM_FORM_ELEMENT_COLUMN, FE_LDAP_SERVER . ',' . FE_LDAP_BASE_DN . ',' . FE_LDAP_SEARCH . ',' . FE_LDAP_ATTRIBUTES, STORE_SYSTEM); $config = $this->evaluate->parseArray($config); if ($formElement[FE_LDAP_USE_BIND_CREDENTIALS] == 1) { $config[SYSTEM_LDAP_1_RDN] = $this->store->getVar(SYSTEM_LDAP_1_RDN, STORE_SYSTEM); $config[SYSTEM_LDAP_1_PASSWORD] = $this->store->getVar(SYSTEM_LDAP_1_PASSWORD, STORE_SYSTEM); } $ldap = new Ldap(); $arr = $ldap->process($config, '', MODE_LDAP_SINGLE); $this->store->setStore($arr, STORE_LDAP, true); } return $formElement; } /** * 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 explicit 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 || $this->feSpecNative[$i][FE_MODE] == FE_MODE_SHOW_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'; } } /** * @param $label * @param $input * @param $note */ abstract public function fillWrapLabelInputNote($label, $input, $note); /** * Copy a subset of current STORE_TYPO3 variables to SIP. Set a hidden form field to submit the assigned SIP to * save/update. * * @return string * @throws \CodeException * @throws \UserFormException */ private function prepareT3VarsForSave() { $t3VarsSip = $this->store->copyT3VarsToSip(); return HelperFormElement::buildNativeHidden(CLIENT_TYPO3VARS, $t3VarsSip); } /** * */ abstract public function tail(); /** * */ abstract public function doSubrecords(); /** * Get all elements from STORE_ADDITIONAL_FORM_ELEMENTS and return them as a string. * * @return string * @throws \CodeException * @throws \UserFormException */ private function buildAdditionalFormElements() { $data = $this->store->getStore(STORE_ADDITIONAL_FORM_ELEMENTS); return is_array($data) ? implode('', $data) : ''; } /** * Create a hidden sip, based on latest STORE_SIP Values. Return complete HTML 'hidden' element. * * @param array $json * * @return string * @throws \CodeException * @throws \UserFormException */ public function buildHiddenSip(array &$json) { $sipArray = $this->store->getStore(STORE_SIP); // do not include system vars unset($sipArray[SIP_SIP]); unset($sipArray[SIP_URLPARAM]); $queryString = Support::arrayToQueryString($sipArray); $sip = $this->store->getSipInstance(); $sipValue = $sip->queryStringToSip($queryString, RETURN_SIP); $json[] = $this->getFormElementForJson(CLIENT_SIP, $sipValue, [FE_MODE => FE_MODE_SHOW]); return HelperFormElement::buildNativeHidden(CLIENT_SIP, $sipValue); } /** * Create an array with standard elements for 'mode' (hidden, disabled, required, readonly) * 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. * * @param string $htmlFormElementName * @param string|array $value * @param array $formElement * * @param int $optionIdx * @param string $class * @return array * @throws \CodeException * @throws \UserFormException */ private function getFormElementForJson($htmlFormElementName, $value, array $formElement, $optionIdx = 0, $optionClass = '') { $addClassRequired = array(); $json = HelperFormElement::getJsonFeMode($formElement[FE_MODE]); // disabled, required $json[API_FORM_UPDATE_FORM_ELEMENT] = $htmlFormElementName; if (isset($formElement[FE_FLAG_ROW_OPEN_TAG]) && isset($formElement[FE_FLAG_ROW_CLOSE_TAG])) { $flagRowUpdate = ($formElement[FE_FLAG_ROW_OPEN_TAG] && $formElement[FE_FLAG_ROW_CLOSE_TAG]); } else { $flagRowUpdate = true; } $statusHidden = ($formElement[FE_MODE] == 'hidden'); $pattern = null; if (isset($formElement[FE_CHECK_PATTERN]) && $formElement[FE_CHECK_PATTERN] != '') { $pattern = $statusHidden ? false : $formElement[FE_CHECK_PATTERN]; } // 'value' update via 'form-update' on the full row: only if there is no other FE in that row if ($flagRowUpdate) { $json[API_FORM_UPDATE_VALUE] = $value; //CR if ($pattern !== null) { // $json['pattern'] = $pattern; // } } if ($formElement[FE_MODE] == FE_MODE_REQUIRED || $formElement[FE_MODE] == FE_MODE_SHOW_REQUIRED) { $addClassRequired = HelperFormElement::getRequiredPositionClass($formElement[F_FE_REQUIRED_POSITION]); } // Label if (isset($formElement[FE_LABEL])) { $key = $formElement[FE_HTML_ID] . HTML_ID_EXTENSION_LABEL; $json[API_ELEMENT_UPDATE][$key][API_ELEMENT_CONTENT] = HelperFormElement::buildLabel($htmlFormElementName, $formElement[FE_LABEL], $addClassRequired[FE_LABEL] ?? ''); } // Note if (isset($formElement[FE_NOTE])) { $key = $formElement[FE_HTML_ID] . HTML_ID_EXTENSION_NOTE; if (!empty($addClassRequired[FE_NOTE])) { $formElement[FE_NOTE] = Support::wrapTag('', $formElement[FE_NOTE]); } $json[API_ELEMENT_UPDATE][$key][API_ELEMENT_CONTENT] = $formElement[FE_NOTE]; } // Input if (isset($formElement[FE_TYPE])) { $key = $formElement[FE_HTML_ID] . HTML_ID_EXTENSION_INPUT; // For FE.type='note': update the column 'input' if ($formElement[FE_TYPE] === FE_TYPE_NOTE) { $json[API_ELEMENT_UPDATE][$key][API_ELEMENT_CONTENT] = $value; } // Check show/hide: only FE with FE_MODE_SQL given, might change. if (!empty($formElement[FE_MODE_SQL])) { $class = is_numeric($formElement[FE_BS_INPUT_COLUMNS]) ? ('col-md-' . $formElement[FE_BS_INPUT_COLUMNS]) : $formElement[FE_BS_INPUT_COLUMNS]; // $class = 'col-md-' . $formElement[FE_BS_INPUT_COLUMNS] . ' '; $json[API_ELEMENT_UPDATE][$key][API_ELEMENT_ATTRIBUTE]['required'] = ($formElement[FE_MODE] == 'required'); $json[API_ELEMENT_UPDATE][$key][API_ELEMENT_ATTRIBUTE]['hidden'] = $statusHidden; $json[API_ELEMENT_UPDATE][$key][API_ELEMENT_ATTRIBUTE]['readonly'] = $json['disabled'] ? 'readonly' : 'false'; // Checkbox: Copy attributes to every checkbox (appreciated by screen reader): if ($formElement[FE_TYPE] == FE_TYPE_CHECKBOX) { $optionsId = $formElement[FE_HTML_ID] . '-' . $optionIdx; $json[API_ELEMENT_UPDATE][$optionsId][API_ELEMENT_ATTRIBUTE] = $json[API_ELEMENT_UPDATE][$key][API_ELEMENT_ATTRIBUTE]; $json[API_ELEMENT_UPDATE][$optionsId][API_ELEMENT_ATTRIBUTE]['data-disabled'] = $json['disabled'] ? 'yes' : 'no'; $json[API_ELEMENT_UPDATE][$optionsId][API_ELEMENT_ATTRIBUTE]['data-required'] = $json['required'] ? 'yes' : 'no'; // Update label class (i.e.: 'qfq-disabled') of Checkbox/Radio (i.e. readonly on/off). if (isset($formElement[FE_TMP_CLASS_OPTION])) { $optionsLabelId = HelperFormElement::getCheckboxRadioOptionId($formElement[FE_HTML_ID], $optionIdx, HTML_ID_EXTENSION_LABEL); $json[API_ELEMENT_UPDATE][$optionsLabelId][API_ELEMENT_ATTRIBUTE]['class'] = $formElement[FE_TMP_CLASS_OPTION]; } } $class .= ($formElement[FE_MODE] == FE_MODE_HIDDEN) ? ' hidden' : ''; $json[API_ELEMENT_UPDATE][$key][API_ELEMENT_ATTRIBUTE]['class'] = $class; if ($pattern !== null) { $json[API_ELEMENT_UPDATE][$key][API_ELEMENT_ATTRIBUTE]['pattern'] = $pattern; } } // #3647 // if (!$flagRowUpdate) { // #4771 - temporary workaround: SELECT in 'multi FE row' won't updated after 'save' or with dynamic update. //TODO #5016 - exception for FE_TYPE_CHECKBOX should be removed ASAP if ($formElement[FE_TYPE] != FE_TYPE_SELECT && $formElement[FE_TYPE] != FE_TYPE_UPLOAD && $formElement[FE_TYPE] != FE_TYPE_CHECKBOX) { $json[API_ELEMENT_UPDATE][$formElement[FE_HTML_ID]][API_ELEMENT_ATTRIBUTE]['value'] = $value; $json[API_ELEMENT_UPDATE][$formElement[FE_HTML_ID]][API_ELEMENT_ATTRIBUTE]['required'] = ($formElement[FE_MODE] == 'required'); $json[API_ELEMENT_UPDATE][$formElement[FE_HTML_ID]][API_ELEMENT_ATTRIBUTE]['hidden'] = $statusHidden; if ($pattern !== null) { $json[API_ELEMENT_UPDATE][$formElement[FE_HTML_ID]][API_ELEMENT_ATTRIBUTE]['pattern'] = $pattern; } } } // Show / Hide the complete FormElement Row. if (isset($formElement[FE_HTML_ID])) { // HIDDEN_SIP comes without a real existing FE structure. // Activate 'show' or 'hidden' on the current FormElement via JSON 'API_ELEMENT_UPDATE' $class = $this->wrap[WRAP_SETUP_ELEMENT][WRAP_SETUP_CLASS]; if ($formElement[FE_MODE] == FE_MODE_HIDDEN) { $class .= ' hidden'; } if (!empty($addClassRequired[FE_INPUT])) { $class .= ' ' . $addClassRequired[FE_INPUT]; } $key = $formElement[FE_HTML_ID] . HTML_ID_EXTENSION_ROW; $json[API_ELEMENT_UPDATE][$key][API_ELEMENT_ATTRIBUTE]['class'] = $class; // $json[API_ELEMENT_UPDATE][$key][API_ELEMENT_ATTRIBUTE]['buggy'] = $class; } return $json; } /** * Takes the current SIP ('form' and additional parameter), set SIP_RECORD_ID=0 and create a new 'NewRecordUrl'. * * @param $toolTipNew * @return string * @throws \CodeException * @throws \UserFormException * @throws \UserReportException */ public function deriveNewRecordUrlFromExistingSip(&$toolTipNew) { $urlParam = $this->store->getNonSystemSipParam(); $urlParam[SIP_RECORD_ID] = 0; $urlParam[SIP_FORM] = $this->formSpec[F_NAME]; Support::appendTypo3ParameterToArray($urlParam); $sip = $this->store->getSipInstance(); $url = $sip->queryStringToSip(OnArray::toString($urlParam)); if ($this->showDebugInfoFlag) { //TODO: missing decoding of SIP $toolTipNew .= PHP_EOL . PHP_EOL . OnArray::toString($urlParam, ' = ', PHP_EOL, "'"); } return $url; } /** * @param array $formElement * @param $elementHtml * @return mixed */ abstract public function buildRowPill(array $formElement, $elementHtml); /** * @param array $formElement * @param $elementHtml * @return mixed */ abstract public function buildRowFieldset(array $formElement, $elementHtml); /** * @param array $formElement * @param $elementHtml * @return mixed */ abstract public function buildRowTemplateGroup(array $formElement, $elementHtml); /** * @param array $formElement * @param $elementHtml * @return mixed */ abstract public function buildRowSubrecord(array $formElement, $elementHtml); /** * Builds HTML 'input' element. * Format: * * @param array $formElement * @param string $htmlFormElementName * @param string $value * @param array $json Return updates in this array - will be later converted to JSON. * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * * @return string complete rendered HTML input element. * @throws \CodeException * @throws \UserFormException * @throws \UserReportException */ public function buildInput(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { $textarea = ''; $attribute = ''; $class = 'form-control'; $elementCharacterCount = ''; if (isset($formElement[FE_INPUT_CLEAR_ME]) && $formElement[FE_INPUT_CLEAR_ME] != '0') { $class .= ' qfq-clear-me'; } if ($formElement[FE_MAX_LENGTH] > 0 && $value !== '') { // crop string only if it's not empty (substr returns false on empty strings) $value = mb_substr($value, 0, $formElement[FE_MAX_LENGTH]); } if ($formElement[FE_HIDE_ZERO] != '0' && $value == '0') { $value = ''; } if ($formElement[FE_DECIMAL_FORMAT] !== '') { if ($value !== '') { // empty string causes exception in number_format() $decimalScale = explode(',', $formElement[FE_DECIMAL_FORMAT])[1]; // scale: Nachkommastellen $value = number_format($value, $decimalScale, '.', ''); } } // Check if typeAhead[Tag] needs to build if ('' != ($typeAheadUrlParam = $this->typeAheadBuildParam($formElement))) { if (empty($formElement[FE_INPUT_TYPE])) { $formElement[FE_INPUT_TYPE] = FE_TYPE_SEARCH; // typeahead behaves better with 'search' instead of 'text' } if (empty($formElement[FE_INPUT_AUTOCOMPLETE])) { $formElement[FE_INPUT_AUTOCOMPLETE] = 'off'; // typeahead behaves better with 'autocomplete'='off' } // Collect typeAhead initial suggestion if (!empty($formElement[FE_TYPEAHEAD_INITIAL_SUGGESTION])) { // $formElement[FE_TYPEAHEAD_MINLENGTH] = 0; // If a suggestion is defined: minLength becomes automatically 0 $arr = $this->evaluate->parse($formElement[FE_TYPEAHEAD_INITIAL_SUGGESTION]); $arr = $this->dbArray[$this->dbIndexData]->makeArrayDict($arr, TYPEAHEAD_SQL_KEY_NAME, API_TYPEAHEAD_VALUE, API_TYPEAHEAD_KEY, API_TYPEAHEAD_VALUE); $attribute .= Support::doAttribute(DATA_TYPEAHEAD_INITIAL_SUGGESTION, json_encode($arr)); } $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]); if (HelperFormElement::booleParameter($formElement[FE_TYPEAHEAD_PEDANTIC] ?? '-')) { $attribute .= Support::doAttribute(DATA_TYPEAHEAD_PEDANTIC, 'true'); } // Tag if (HelperFormElement::booleParameter($formElement[FE_TYPEAHEAD_TAG] ?? '-')) { $attribute .= Support::doAttribute(DATA_TYPEAHEAD_TAG, 'true'); // Default: tab, comma $kk = '[' . ($formElement[FE_TYPEAHEAD_TAG_DELIMITER] ?? '9,44') . ']'; $attribute .= Support::doAttribute(DATA_TYPEAHEAD_TAG_DELIMITER, $kk); $formElement[FE_INPUT_TYPE] = 'hidden'; // Client: TAG handling expects the '$value' as a JSON string. $arr = KeyValueStringParser::parse($value, PARAM_KEY_VALUE_DELIMITER, PARAM_LIST_DELIMITER, KVP_IF_VALUE_EMPTY_COPY_KEY); $value = OnArray::arrayToQfqJson($arr); } } 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 = ""; 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]; } } $attribute .= Support::doAttribute('id', $formElement[FE_HTML_ID]); $attribute .= Support::doAttribute('name', $htmlFormElementName); $attribute .= Support::doAttribute(ATTRIBUTE_DATA_REFERENCE, $formElement[FE_DATA_REFERENCE]); if (isset($formElement[FE_RETYPE_SOURCE_NAME])) { $htmlFormElementNamePrimary = str_replace(RETYPE_FE_NAME_EXTENSION, '', $htmlFormElementName); $attribute .= Support::doAttribute('data-match', '[name=' . str_replace(':', '\\:', $htmlFormElementNamePrimary) . ']'); } // '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); } // In case the user specifies MIN & MAX with numbers, the html tag 'type' has to be 'number', to make the range check work in the browser. if (empty($formElement[FE_INPUT_TYPE]) && !empty($formElement[FE_MIN]) && !empty($formElement[FE_MAX]) && is_numeric($formElement[FE_MIN]) && is_numeric($formElement[FE_MAX]) ) { $formElement[FE_INPUT_TYPE] = 'number'; } // Check for input type 'textarea'. Possible notation: a) '', b) '', c) ',', d) ',,' $colsRows = explode(',', $formElement[FE_SIZE], 3); if (empty($colsRows[1])) { $colsRows[1] = 1; } // Active Textarea if min-height>1 (rows) or third parameter max-height>0 $flagTextarea = ($colsRows[1] > 1 || ($colsRows[2] ?? '') > 0); $formElement = HelperFormElement::prepareExtraButton($formElement, !$flagTextarea); if ($flagTextarea) { $htmlTag = '> enable auto-grow (if nothing is defined: enable auto-grow) $maxHeight = $colsRows[2] ?? '350'; if ($maxHeight != '0') { $class .= ' ' . CLASS_FORM_ELEMENT_AUTO_GROW; $attribute .= Support::doAttribute(ATTRIBUTE_DATA_MAX_HEIGHT, $maxHeight); } $textarea = htmlentities($value) . ''; } else { $htmlTag = '