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 */ public function createFormEditorUrl($form, $recordId, array $param = array()) { if (!$this->showDebugInfo) { return ''; } $queryStringArray = [ 'id' => $this->store->getVar(SYSTEM_EDIT_FORM_PAGE, STORE_SYSTEM), 'form' => $form, 'r' => $recordId ]; $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 $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]; } /** * Returns ''-tag with various attributes. * * @return string */ public function getFormTag() { $attribute = $this->getFormTagAtrributes(); $honeypot = $this->getHoneypotVars(); return '' . $honeypot; } /** * Create HTML Input vars to detect bot automatic filling of forms. * * @return string */ 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 */ public function getFormTagAtrributes() { $attribute['id'] = $this->getFormId(); $attribute['method'] = 'post'; $attribute['action'] = $this->getActionUrl(); $attribute['target'] = '_top'; $attribute['accept-charset'] = 'UTF-8'; $attribute['autocomplete'] = 'on'; $attribute['enctype'] = $this->getEncType(); 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 * @throws DbException */ public function getActionUrl() { return API_DIR . '/save.php'; } /** * Determines the enctype. * * See: https://www.w3.org/wiki/HTML/Elements/form#HTML_Attributes * * @return string * @throws DbException */ public function getEncType() { $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"'); return (count($result) === 1) ? 'multipart/form-data' : 'application/x-www-form-urlencoded'; } abstract public function getProcessFilter(); /** * Process all FormElements: Collect and return all HTML code & JSON. * * @param $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 * @return string * @throws CodeException * @throws DbException * @throws \qfq\UserFormException */ public function elements($recordId, $filter = FORM_ELEMENTS_NATIVE, $feIdContainer = 0, array &$json, $modeCollectFe = FLAG_DYNAMIC_UPDATE, $htmlElementNameIdZero = false, $storeUseDefault = STORE_USE_DEFAULT, $mode = FORM_LOAD) { $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]; // get current data record if ($recordId > 0 && $this->store->getVar('id', STORE_RECORD) === false) { $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] . "'."); $this->store->setStore($row, STORE_RECORD); } $this->checkAutoFocus(); // 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 } $flagOutput = ($fe[FE_TYPE] !== FE_TYPE_EXTRA); // type='extra' will not displayed and not transmitted to the form $debugStack = array(); // Copy global readonly mode. if ($this->formSpec[F_MODE] == F_MODE_READONLY) { $fe[FE_MODE] = FE_MODE_READONLY; $fe[FE_MODE_SQL] = ''; } // Preparation for Log, Debug $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($fe), STORE_SYSTEM); // Fill STORE_LDAP $fe = $this->prepareFillStoreFireLdap($fe); // for Upload FormElements, it's necessary to precalculate an optional given 'slaveId'. if ($fe[FE_TYPE] === FE_TYPE_UPLOAD) { Support::setIfNotSet($fe, FE_SLAVE_ID); $slaveId = Support::falseEmptyToZero($this->evaluate->parse($fe[FE_SLAVE_ID])); $this->store->setVar(VAR_SLAVE_ID, $slaveId, STORE_VAR); } // ** evaluate current FormElement ** $formElement = $this->evaluate->parseArray($fe, $skip, $debugStack); // Some Defaults $formElement = Support::setFeDefaults($formElement, $this->formSpec); if ($flagOutput === true) { $this->fillWrapLabelInputNote($formElement[FE_BS_LABEL_COLUMNS], $formElement[FE_BS_INPUT_COLUMNS], $formElement[FE_BS_NOTE_COLUMNS]); } //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]; $value = ''; Support::setIfNotSet($formElement, FE_VALUE); if (is_array($formElement[FE_VALUE])) { $formElement[FE_VALUE] = (count($formElement[FE_VALUE])) > 0 ? current($formElement[FE_VALUE][0]) : ''; } // If is FormElement['value'] explicit defined: take it // There are two options: a) single value, b) array of values (template Group) // if (is_array($formElement[FE_VALUE])) { // // For Templates Groups, the 'value' has to be defined as '{{!SELECT ...' wich returns all selected records in an array. // $idx = isset($formElement[FE_TEMPLATE_GROUP_CURRENT_IDX]) ? $formElement[FE_TEMPLATE_GROUP_CURRENT_IDX] - 1 : 0; // if (isset($formElement[FE_VALUE][$idx]) && is_array($formElement[FE_VALUE][$idx])) { // $value = current($formElement[FE_VALUE][$idx]); // if ($value === false) { // $value = ''; // } // } // } else { $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 } // Retrieve value via FSRVD $value = $this->store->getVar($name, $storeUse, $formElement[FE_CHECK_TYPE], $foundInStore); if ($foundInStore == STORE_RECORD && $formElement[FE_ENCODE] === FE_ENCODE_SPECIALCHAR) { $value = htmlspecialchars_decode($value, ENT_QUOTES); } } // 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, 0); // 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->showDebugInfo) { if (count($debugStack) > 0) { $elementHtml .= Support::doTooltip($formElement[FE_HTML_ID] . HTML_ID_EXTENSION_TOOLTIP, implode("\n", $debugStack)); } // Build 'FormElement' Edit symbol $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 $buildRowName = 'buildRow' . $this->buildRowName[$formElement[FE_TYPE]]; $html .= $formElement[FE_HTML_BEFORE] . $this->$buildRowName($formElement, $elementHtml, $htmlFormElementName) . $formElement[FE_HTML_AFTER]; } } // Log / Debug: Last FormElement has been processed. $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM); return $html; } /** * 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])) { $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]); $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 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'; } } 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. * * @throws CodeException * @throws UserFormException */ private function prepareT3VarsForSave() { $t3VarsSip = $this->store->copyT3VarsToSip(); return $this->buildNativeHidden(CLIENT_TYPO3VARS, $t3VarsSip); } /** * Builds a real HTML hidden form element. Useful for checkboxes, Multiple-Select and Radios. * * @param $htmlFormElementName * @param $value * @return string */ public function buildNativeHidden($htmlFormElementName, $value) { return ''; } 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 \qfq\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 \qfq\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 $this->buildNativeHidden(CLIENT_SIP, $sipValue); } /** * 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. * * @param string $htmlFormElementName * @param string|array $value * @param array $formElement * @return array */ private function getFormElementForJson($htmlFormElementName, $value, array $formElement) { $json = $this->getJsonFeMode($formElement[FE_MODE]); $json['form-element'] = $htmlFormElementName; $json['value'] = $value; if (isset($formElement[FE_LABEL])) { $key = $formElement[FE_HTML_ID] . HTML_ID_EXTENSION_LABEL; $json[API_ELEMENT_UPDATE][$key][API_ELEMENT_CONTENT] = $this->buildLabel($htmlFormElementName, $formElement[FE_LABEL]); } 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]; } return $json; } /** * 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']; } /** * Depending of $feMode set variables $hidden, $disabled, $required to 'yes' or 'no'. * * @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: $disabled = 'yes'; // convert the UI status 'readonly' to the HTML/CSS status 'disabled'. break; case FE_MODE_HIDDEN: $hidden = 'yes'; break; default: throw new UserFormException("Unknown mode '$feMode'", ERROR_UNKNOWN_MODE); break; } } /** * Builds a label, typically for an html-''-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); return $html; } /** * Takes the current SIP ('form' and additional parameter), set SIP_RECORD_ID=0 and create a new 'NewRecordUrl'. * * @throws CodeException * @throws \qfq\UserFormException */ public function deriveNewRecordUrlFromExistingSip(&$toolTipNew) { $urlParam = $this->store->getStore(STORE_SIP); $urlParam[SIP_RECORD_ID] = 0; unset($urlParam[SIP_SIP]); unset($urlParam[SIP_URLPARAM]); Support::appendTypo3ParameterToArray($urlParam); $sip = $this->store->getSipInstance(); $url = $sip->queryStringToSip(OnArray::toString($urlParam)); if ($this->showDebugInfo) { //TODO: missing decoding of SIP $toolTipNew .= PHP_EOL . PHP_EOL . OnArray::toString($urlParam, ' = ', PHP_EOL, "'"); } return $url; } abstract public function buildRowPill(array $formElement, $elementHtml); abstract public function buildRowFieldset(array $formElement, $elementHtml); abstract public function buildRowTemplateGroup(array $formElement, $elementHtml); 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 \qfq\UserFormException */ public function buildInput(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { $textarea = ''; $attribute = ''; $class = 'form-control'; $elementCharacterCount = ''; $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]); if (isset($formElement[FE_TYPEAHEAD_PEDANTIC])) { $attribute .= Support::doAttribute(DATA_TYPEAHEAD_PEDANTIC, 'true'); } } 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('class', $class); if (isset($formElement[FE_RETYPE_SOURCE_NAME])) { $htmlFormElementNamePrimary = str_replace(RETYPE_FE_NAME_EXTENSION, '', $htmlFormElementName); $attribute .= Support::doAttribute('data-match', '[name=' . str_replace(':', '\\:', $htmlFormElementNamePrimary) . ']'); } $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); } // Check for input type 'textarea'. $colsRows = explode(',', $formElement['size'], 2); if (count($colsRows) === 2) { // $htmlTag = '<textarea'; $attribute .= Support::doAttribute('cols', $colsRows[0]); $attribute .= Support::doAttribute('rows', $colsRows[1]); $textarea = htmlentities($value) . ''; } else { $htmlTag = 'getAttributeList($formElement, ['type', 'size']); $attribute .= Support::doAttribute('value', htmlentities($value), false); } $attribute .= $this->getAttributeList($formElement, ['autocomplete', 'autofocus', 'placeholder']); $attribute .= $this->getAttributeList($formElement, [F_FE_DATA_PATTERN_ERROR, F_FE_DATA_REQUIRED_ERROR, F_FE_DATA_MATCH_ERROR, F_FE_DATA_ERROR]); $attribute .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : ''); $attribute .= Support::doAttribute('title', $formElement['tooltip']); $attribute .= $this->getInputCheckPattern($formElement[FE_CHECK_TYPE], $formElement[FE_CHECK_PATTERN]); $attribute .= $this->getAttributeFeMode($formElement[FE_MODE]); $json = $this->getFormElementForJson($htmlFormElementName, $value, $formElement); return "$htmlTag $attribute>$textarea" . $elementCharacterCount . $this->getHelpBlock(); } /** * Check $formElement for FE_TYPE_AHEAD_SQL or FE_TYPE_AHEAD_LDAP_SERVER. * 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 * * @param array $formElement * @return string * @throws UserFormException */ private function typeAheadBuildParam(array &$formElement) { $urlParam = ''; $formElement[FE_TYPEAHEAD_LIMIT] = Support::setIfNotSet($formElement, FE_TYPEAHEAD_LIMIT, TYPEAHEAD_DEFAULT_LIMIT); $formElement[FE_TYPEAHEAD_MINLENGTH] = Support::setIfNotSet($formElement, FE_TYPEAHEAD_MINLENGTH, 2); if (isset($formElement[FE_TYPEAHEAD_SQL])) { $sql = $this->checkSqlAppendLimit($formElement[FE_TYPEAHEAD_SQL], $formElement[FE_TYPEAHEAD_LIMIT]); $urlParam = FE_TYPEAHEAD_SQL . '=' . $sql; } elseif (isset($formElement[FE_TYPEAHEAD_LDAP])) { $formElement[FE_LDAP_SERVER] = Support::setIfNotSet($formElement, FE_LDAP_SERVER); $formElement[FE_LDAP_BASE_DN] = Support::setIfNotSet($formElement, FE_LDAP_BASE_DN); $formElement[FE_TYPEAHEAD_LDAP_SEARCH] = Support::setIfNotSet($formElement, FE_TYPEAHEAD_LDAP_SEARCH); $formElement[FE_TYPEAHEAD_LDAP_SEARCH_PREFETCH] = Support::setIfNotSet($formElement, FE_TYPEAHEAD_LDAP_SEARCH_PREFETCH); $formElement[FE_TYPEAHEAD_LDAP_VALUE_PRINTF] = Support::setIfNotSet($formElement, FE_TYPEAHEAD_LDAP_VALUE_PRINTF); $formElement[FE_TYPEAHEAD_LDAP_ID_PRINTF] = Support::setIfNotSet($formElement, FE_TYPEAHEAD_LDAP_ID_PRINTF); $formElement[FE_LDAP_USE_BIND_CREDENTIALS] = Support::setIfNotSet($formElement, FE_LDAP_USE_BIND_CREDENTIALS); 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); } } if ($formElement[FE_TYPEAHEAD_LDAP_VALUE_PRINTF] . $formElement[FE_TYPEAHEAD_LDAP_ID_PRINTF] == '') { throw new UserFormException('Missing definition: ' . FE_TYPEAHEAD_LDAP_VALUE_PRINTF . ' or ' . FE_TYPEAHEAD_LDAP_ID_PRINTF, ERROR_MISSING_DEFINITON); } $arr = [ FE_LDAP_SERVER => $formElement[FE_LDAP_SERVER], FE_LDAP_BASE_DN => $formElement[FE_LDAP_BASE_DN], FE_TYPEAHEAD_LDAP_SEARCH => $formElement[FE_TYPEAHEAD_LDAP_SEARCH], FE_TYPEAHEAD_LDAP_SEARCH_PREFETCH => $formElement[FE_TYPEAHEAD_LDAP_SEARCH_PREFETCH], FE_TYPEAHEAD_LDAP_VALUE_PRINTF => $formElement[FE_TYPEAHEAD_LDAP_VALUE_PRINTF], FE_TYPEAHEAD_LDAP_ID_PRINTF => $formElement[FE_TYPEAHEAD_LDAP_ID_PRINTF], FE_TYPEAHEAD_LIMIT => $formElement[FE_TYPEAHEAD_LIMIT], ]; if (isset($formElement[FE_TYPEAHEAD_LDAP_SEARCH_PER_TOKEN])) { $arr[FE_TYPEAHEAD_LDAP_SEARCH_PER_TOKEN] = '1'; } if ($formElement[FE_LDAP_USE_BIND_CREDENTIALS] == '1') { $arr[SYSTEM_LDAP_1_RDN] = $this->store->getVar(SYSTEM_LDAP_1_RDN, STORE_SYSTEM); $arr[SYSTEM_LDAP_1_PASSWORD] = $this->store->getVar(SYSTEM_LDAP_1_PASSWORD, STORE_SYSTEM); } $urlParam = OnArray::toString($arr); } 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); } if (false === stristr($sql, ' LIMIT ')) { $sql .= " LIMIT $limit"; } return $sql; } /** * Calculates the maxlength of an input field, based on formElement type, formElement user definition and table.field definition. * * @param array $formElement */ private function adjustMaxLength(array &$formElement) { // MIN( $formElement['maxLength'], tabledefinition) $maxLength = $this->getColumnSize($formElement['name']); switch ($formElement[FE_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 if ($maxLength !== false) { if (is_numeric($formElement['maxLength']) && $formElement['maxLength'] != 0) { if ($formElement['maxLength'] > $maxLength) { $formElement['maxLength'] = $maxLength; } } else { $formElement['maxLength'] = $maxLength; } } } /** * Get column spec from tabledefinition and parse size of it. If nothing defined, return false. * * @param $column * @return bool|int a) 'false' if there is no length definition, b) length definition, c) date|time|datetime|timestamp use hardcoded length */ private function getColumnSize($column) { $matches = array(); $typeSpec = $this->store->getVar($column, STORE_TABLE_COLUMN_TYPES); 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: if (substr($typeSpec, 0, 4) === 'set(' || substr($typeSpec, 0, 5) === 'enum(') { return $this->maxLengthSetEnum($typeSpec); } break; } // e.g.: string(64) >> 64, enum('yes','no') >> false if (1 === preg_match('/\((.+)\)/', $typeSpec, $matches)) { if (is_numeric($matches[1])) return $matches[1]; } return false; } /** * Get the strlen of the longest element in enum('val1','val2',...,'valn') or set('val1','val2',...,'valn') * * @param string $typeSpec * @return int */ private function maxLengthSetEnum($typeSpec) { $startPos = (substr($typeSpec, 0, 4) === 'set(') ? 4 : 5; $max = 0; $valueList = substr($typeSpec, $startPos, strlen($typeSpec) - $startPos - 1); $valueArr = explode(',', $valueList); foreach ($valueArr as $value) { $value = trim($value, "'"); $len = strlen($value); if ($len > $max) { $max = $len; } } return $max; } /** * Builds a HTML attribute list, based on $attributeList. * * E.g.: attributeList: [ 'type', 'autofocus' ] * generates: 'type="$formElement[FE_TYPE]" autofocus="$formElement['autofocus']" ' * * @param array $formElement * @param array $attributeList * @param bool $flagOmitEmpty * @return string */ private function getAttributeList(array $formElement, array $attributeList, $flagOmitEmpty = true) { $attribute = ''; foreach ($attributeList as $item) { if (isset($formElement[$item])) $attribute .= Support::doAttribute(strtolower($item), $formElement[$item], $flagOmitEmpty); } return $attribute; } /** * Construct HTML Input attribute for Client Validation: * * type data result * ------- ----------------------- ------------------------------------------------------------------------------- * min|max | min="$attrData[0]"|max="$attrData[1]" * pattern pattern="$data" * digit - pattern="^[0-9]*$" * email - pattern="^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\.[a-z]{2,4})$" * alnumx - * * For 'min/max' and 'pattern' the 'data' will be injected in the attribute string via '%s'. * * @param $type * @param $data * @return string * @throws \qfq\UserFormException */ private function getInputCheckPattern($type, $data) { $attribute = ''; if ($type === '') { return ''; } switch ($type) { case SANITIZE_ALLOW_MIN_MAX: case SANITIZE_ALLOW_MIN_MAX_DATE: $arrData = explode("|", $data); if (count($arrData) != 2 || $arrData[0] == '' || $arrData[1] == '') throw new UserFormException("Missing MIN|MAX values", ERROR_MISSING_MIN_MAX); $attribute = 'min="' . $arrData[0] . '" '; $attribute .= 'max="' . $arrData[1] . '" '; break; case SANITIZE_ALLOW_PATTERN: $attribute = 'pattern="' . $data . '" '; break; case SANITIZE_ALLOW_ALL: break; default: $attribute = 'pattern="' . $this->inputCheckPattern[$type] . '" '; break; } return $attribute; } /** * Set corresponding html attributes readonly/required/disabled, based on $formElement[FE_MODE]. * * @param string $feMode * @return string * @throws UserFormException */ private function getAttributeFeMode($feMode) { $attribute = ''; $this->getFeMode($feMode, $hidden, $disabled, $required); switch ($feMode) { case FE_MODE_HIDDEN: case FE_MODE_SHOW: break; case FE_MODE_REQUIRED: case FE_MODE_READONLY: $attribute .= Support::doAttribute($feMode, $feMode); break; default: throw new UserFormException("Unknown mode '$feMode'", ERROR_UNKNOWN_MODE); break; } // Attributes: data-... $attribute .= Support::doAttribute(DATA_HIDDEN, $hidden); $attribute .= Support::doAttribute(DATA_DISABLED, $disabled); $attribute .= Support::doAttribute(DATA_REQUIRED, $required); return $attribute; } /** * Build HelpBlock * * @return string */ private function getHelpBlock() { return '

'; } /** * Builds HTML 'checkbox' element. * * Checkboxes will only be submitted, if they are checked. Therefore, a hidden element with the unchecked value will be transferred first. * * Format: * * * @param array $formElement * @param $htmlFormElementName * @param $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE* * @return string * @throws CodeException * @throws \qfq\UserFormException */ public function buildCheckbox(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { $itemKey = array(); $itemValue = array(); // Fill $itemKey & $itemValue $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue); // Get fallback, if 'checkBoxMode' is not defined: if (!isset($formElement['checkBoxMode'])) { // This fallback is problematic if 'set' or 'enum' has 2 : defaults to single but maybe multi is meant. $formElement['checkBoxMode'] = (count($itemKey) > 2) ? 'multi' : 'single'; } if ($formElement['checkBoxMode'] === 'multi') { } else { // Fill meaningfull defaults to parameter: checked|unchecked (CHECKBOX_VALUE_CHECKED|CHECKBOX_VALUE_UNCHECKED) $this->prepareCheckboxCheckedUncheckedValue($itemKey, $formElement); } $attributeBase = $this->getAttributeFeMode($formElement[FE_MODE]); $attributeBase .= Support::doAttribute('type', $formElement[FE_TYPE]); $attributeBase .= $this->getAttributeList($formElement, [F_FE_DATA_PATTERN_ERROR, F_FE_DATA_REQUIRED_ERROR, F_FE_DATA_MATCH_ERROR, F_FE_DATA_ERROR]); switch ($formElement['checkBoxMode']) { case 'single': $html = $this->buildCheckboxSingle($formElement, $htmlFormElementName, $attributeBase, $value, $json); break; case 'multi'; $html = $this->buildCheckboxMulti($formElement, $htmlFormElementName, $attributeBase, $value, $itemKey, $itemValue, $json); break; default: throw new UserFormException('checkBoxMode: \'' . $formElement['checkBoxMode'] . '\' is unknown.', ERROR_CHECKBOXMODE_UNKNOWN); } return $html . $this->getHelpBlock(); } /** * Look for key/value list (in this order, first match counts) in * a) `sql1` * b) `parameter:itemList` * c) table.column definition * * Copies the found keys to &$itemKey and the values to &$itemValue * If there are no &$itemKey, copy &$itemValue to &$itemKey. * * @param array $formElement * @param $itemKey * @param $itemValue * @throws CodeException * @throws \qfq\UserFormException */ public function getKeyValueListFromSqlEnumSpec(array $formElement, &$itemKey, &$itemValue) { $fieldType = ''; $itemKey = array(); $itemValue = array(); // Call getItemsForEnumOrSet() only if there a corresponding column really exist. if (false !== $this->store->getVar($formElement['name'], STORE_TABLE_COLUMN_TYPES)) { $itemValue = $this->getItemsForEnumOrSet($formElement['name'], $fieldType); } if (is_array($formElement['sql1'])) { if (count($formElement['sql1']) > 0) { $keys = array_keys($formElement['sql1'][0]); $itemKey = array_column($formElement['sql1'], 'id'); // 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]); } $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]); } } } elseif (isset($formElement['itemList']) && strlen($formElement['itemList']) > 0) { $arr = KeyValueStringParser::parse($formElement['itemList'], ':', ',', KVP_IF_VALUE_EMPTY_COPY_KEY); $itemValue = array_values($arr); $itemKey = array_keys($arr); } elseif ($fieldType === 'enum' || $fieldType === 'set') { // already done at the beginning with '$this->getItemsForEnumOrSet($formElement['name'], $fieldType);' } else { throw new UserFormException("Missing definition (- nothing found in 'sql1', 'parameter:itemList', 'enum-' or 'set-definition'", ERROR_MISSING_ITEM_LIST); } if (count($itemKey) === 0) { $itemKey = $itemValue; } // Process 'emptyHide' before 'emptyItemAtStart' / 'emptyItemAtEnd': than 'emptyItem*' are still possible. if (isset($formElement['emptyHide'])) { $itemKey = OnArray::removeEmptyElementsFromArray($itemKey); $itemValue = OnArray::removeEmptyElementsFromArray($itemValue); } if (isset($formElement['emptyItemAtStart'])) { array_unshift($itemKey, ''); array_unshift($itemValue, ''); } if (isset($formElement['emptyItemAtEnd'])) { $itemValue[] = ''; $itemKey[] = ''; } } /** * Get the attribute definition list of an enum or set column. For strings, get the default value. Return elements as an array. * * @param $column * @param $fieldType * @return array * @throws UserFormException */ private function getItemsForEnumOrSet($column, &$fieldType) { // Get column definition $fieldTypeDefinition = $this->store->getVar($column, STORE_TABLE_COLUMN_TYPES); if ($fieldTypeDefinition === false) { throw new UserFormException("Column '$column' unknown in table '" . $this->formSpec[F_TABLE_NAME] . "'", ERROR_DB_UNKNOWN_COLUMN); } $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', ... ] $values = substr($fieldTypeDefinition, $startPosition, $length - $startPosition - 1); $items = OnArray::trimArray(explode(',', $values), "'"); $fieldType = substr($fieldTypeDefinition, 0, $startPosition - 1); return $items; } /** * For CheckBox's with only one checkbox: if no parameter:checked|unchecked is defined, take defaults: * * checked: first Element in $itemKey * unchecked: '' * * @param array $itemKey * @param array $formElement * @throws UserFormException */ private function prepareCheckboxCheckedUncheckedValue(array $itemKey, array &$formElement) { if (!isset($formElement[CHECKBOX_VALUE_CHECKED])) { if (isset($itemKey[0])) { // First element in $itemKey list $formElement[CHECKBOX_VALUE_CHECKED] = $itemKey[0]; } else { // Take column default value $formElement[CHECKBOX_VALUE_CHECKED] = $this->store->getVar($formElement['name'], STORE_TABLE_DEFAULT); } } // unchecked if (!isset($formElement[CHECKBOX_VALUE_UNCHECKED])) { if (isset($itemKey[1])) { $formElement[CHECKBOX_VALUE_UNCHECKED] = ($itemKey[0] === $formElement['checked']) ? $itemKey[1] : $itemKey[0]; } else { $formElement[CHECKBOX_VALUE_UNCHECKED] = ''; } } if ($formElement[CHECKBOX_VALUE_CHECKED] === $formElement[CHECKBOX_VALUE_UNCHECKED]) { throw new UserFormException('FormElement: type=checkbox - checked and unchecked can\'t be the same: ' . $formElement[CHECKBOX_VALUE_CHECKED], ERROR_CHECKBOX_EQUAL); } } /** * Build a Checkbox based on two values. Either in HTML plain layout or with Bootstrap Button class. * * @param array $formElement * @param $htmlFormElementName * @param $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * @return string * @throws CodeException * @throws \qfq\UserFormException */ public function buildCheckboxSingle(array $formElement, $htmlFormElementName, $attribute, $value, array &$json, $mode = FORM_LOAD) { if (isset($formElement[FE_BUTTON_CLASS])) { if ($formElement[FE_BUTTON_CLASS] == '') { $formElement[FE_BUTTON_CLASS] = 'btn-default'; } return $this->constructCheckboxSingleButton($formElement, $htmlFormElementName, $attribute, $value, $json); } else { return $this->constructCheckboxSinglePlain($formElement, $htmlFormElementName, $attribute, $value, $json); } } /** * Build a Checkbox based on two values with Bootstrap Button class. * *

* * * Checkbox 1 (pre-checked) * *

* * @param array $formElement * @param $htmlFormElementName * @param $attribute * @param $value * @param array $json * @return string */ public function constructCheckboxSingleButton(array $formElement, $htmlFormElementName, $attribute, $value, array &$json) { $html = ''; $valueJson = false; $attribute .= Support::doAttribute('id', $formElement[FE_HTML_ID]); $attribute .= Support::doAttribute('name', $htmlFormElementName); $attribute .= Support::doAttribute('value', $formElement['checked'], false); $attribute .= Support::doAttribute('title', $formElement['tooltip']); $attribute .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : ''); $attribute .= Support::doAttribute('autocomplete', 'off'); $classActive = ''; if ($formElement['checked'] === $value) { $attribute .= Support::doAttribute('checked', 'checked'); $valueJson = true; $classActive = ' active'; } $attribute .= $this->getAttributeList($formElement, ['autofocus']); $attribute .= $this->getAttributeList($formElement, [F_FE_DATA_PATTERN_ERROR, F_FE_DATA_REQUIRED_ERROR, F_FE_DATA_MATCH_ERROR, F_FE_DATA_ERROR]); $htmlHidden = $this->buildNativeHidden($htmlFormElementName, $formElement['unchecked']); $this->store->setVar($htmlFormElementName, $htmlHidden, STORE_ADDITIONAL_FORM_ELEMENTS, false); $html = ''; $htmlElement = ''; if (isset($formElement['label2'])) { $htmlElement .= $formElement['label2']; } else { $htmlElement .= $formElement['checked']; } $html .= Support::wrapTag("", $htmlElement, true); $html = Support::wrapTag('

', $html); $json = $this->getFormElementForJson($htmlFormElementName, $valueJson, $formElement); return $html; } /** * Build a single HTML plain checkbox based on two values. * Create a 'hidden' input field and a 'checkbox' input field - both with the same HTML 'name'. * HTML does not submit an unchecked checkbox. Then only the 'hidden' input field is submitted. * * Format: * * * @param array $formElement * @param $htmlFormElementName * @param $attribute * @param $value * @param array $json * @return string */ public function constructCheckboxSinglePlain(array $formElement, $htmlFormElementName, $attribute, $value, array &$json) { $html = ''; $valueJson = false; $attribute .= Support::doAttribute('id', $formElement[FE_HTML_ID]); $attribute .= Support::doAttribute('name', $htmlFormElementName); $attribute .= Support::doAttribute('value', $formElement['checked'], false); $attribute .= Support::doAttribute('title', $formElement['tooltip']); $attribute .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : ''); if ($formElement['checked'] === $value) { $attribute .= Support::doAttribute('checked', 'checked'); $valueJson = true; } $attribute .= $this->getAttributeList($formElement, ['autofocus']); $attribute .= $this->getAttributeList($formElement, [F_FE_DATA_PATTERN_ERROR, F_FE_DATA_REQUIRED_ERROR, F_FE_DATA_MATCH_ERROR, F_FE_DATA_ERROR]); $htmlHidden = $this->buildNativeHidden($htmlFormElementName, $formElement['unchecked']); $this->store->setVar($htmlFormElementName, $htmlHidden, STORE_ADDITIONAL_FORM_ELEMENTS, false); $html = ''; $html .= ''; if (isset($formElement['label2'])) { $html .= $formElement['label2']; } $html = Support::wrapTag("", $html, true); $html = Support::wrapTag("

", $html, true); $json = $this->getFormElementForJson($htmlFormElementName, $valueJson, $formElement); return $html; } /** * Build a Checkbox based on two values. Either in HTML plain layout or with Bootstrap Button class. * * @param array $formElement * @param $htmlFormElementName * @param $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * @return string * @throws CodeException * @throws \qfq\UserFormException */ public function buildCheckboxMulti(array $formElement, $htmlFormElementName, $attributeBase, $value, array $itemKey, array $itemValue, array &$json) { if (isset($formElement[FE_BUTTON_CLASS])) { if ($formElement[FE_BUTTON_CLASS] == '') { $formElement[FE_BUTTON_CLASS] = 'btn-default'; } return $this->constructCheckboxMultiButton($formElement, $htmlFormElementName, $attributeBase, $value, $itemKey, $itemValue, $json); } else { return $this->constructCheckboxMultiPlain($formElement, $htmlFormElementName, $attributeBase, $value, $itemKey, $itemValue, $json); } } /** * @param array $formElement * @param $htmlFormElementName * @param $htmlHidden * @throws CodeException * @throws UserFormException */ private function fillStoreAdditionalFormElementsCheckboxHidden(array $formElement, $htmlFormElementName, $htmlHidden) { if (isset($formElement[NAME_TG_COPIES]) && $formElement[NAME_TG_COPIES] > 0) { for ($ii = 1; $ii <= $formElement[NAME_TG_COPIES]; $ii++) { $key = str_replace('%d', $ii, $htmlFormElementName); $value = str_replace('%d', $ii, $htmlHidden); $this->store->setVar($key, $value, STORE_ADDITIONAL_FORM_ELEMENTS, true); } } else { $this->store->setVar($htmlFormElementName, $htmlHidden, STORE_ADDITIONAL_FORM_ELEMENTS, false); } } /** * Build as many Checkboxes as items. * * Layout: The Bootstrap Layout needs very special setup, the checkboxes are wrapped differently with

* depending of if they aligned horizontal or vertical. * * @param array $formElement * @param $htmlFormElementName * @param $attributeBase * @param $value * @param array $itemKey * @param array $itemValue * @param array $json * @return string */ public function constructCheckboxMultiButton(array $formElement, $htmlFormElementName, $attributeBase, $value, array $itemKey, array $itemValue, array &$json) { $json = array(); // Defines which of the checkboxes will be checked. $values = explode(',', $value); $attributeBase .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : ''); $attributeBase .= $this->getAttributeList($formElement, [F_FE_DATA_PATTERN_ERROR, F_FE_DATA_REQUIRED_ERROR, F_FE_DATA_MATCH_ERROR, F_FE_DATA_ERROR]); $key = HelperFormElement::prependFormElementNameCheckBoxMulti($htmlFormElementName, 'h'); $htmlHidden = $this->buildNativeHidden($key, ''); $this->fillStoreAdditionalFormElementsCheckboxHidden($formElement, $htmlFormElementName, $htmlHidden); $html = ''; $attribute = $attributeBase; if (isset($formElement['autofocus'])) { $attribute .= Support::doAttribute('autofocus', $formElement['autofocus']); } for ($ii = 0, $jj = 1; $ii < count($itemKey); $ii++, $jj++) { $jsonValue = false; $classActive = ''; $htmlFormElementNameUniq = HelperFormElement::prependFormElementNameCheckBoxMulti($htmlFormElementName, $ii); $attribute .= Support::doAttribute('id', $formElement[FE_HTML_ID] . '-' . $ii); $attribute .= Support::doAttribute('name', $htmlFormElementNameUniq); $attribute .= Support::doAttribute('value', $itemKey[$ii]); // Check if the given key is found in field. if (false !== array_search($itemKey[$ii], $values)) { $attribute .= Support::doAttribute('checked', 'checked'); $jsonValue = true; $classActive = ' active'; } // ' ' - This is necessary to correctly align an empty input. $value = ($itemValue[$ii] === '') ? ' ' : $itemValue[$ii]; $htmlElement = '' . $value; $html .= Support::wrapTag("", $htmlElement, true); $json[] = $this->getFormElementForJson($htmlFormElementNameUniq, $jsonValue, $formElement); // Init for the next checkbox $attribute = $attributeBase; } $html = Support::wrapTag('

', $html); return $html; } /** * Build as many Checkboxes as items. * * Layout: The Bootstrap Layout needs very special setup, the checkboxes are wrapped differently with

* depending of if they aligned horizontal or vertical. * * @param array $formElement * @param $htmlFormElementName * @param $attributeBase * @param $value * @param array $itemKey * @param array $itemValue * @param array $json * @return string */ public function constructCheckboxMultiPlain(array $formElement, $htmlFormElementName, $attributeBase, $value, array $itemKey, array $itemValue, array &$json) { $json = array(); // Defines which of the checkboxes will be checked. $values = explode(',', $value); $attributeBase .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : ''); $attributeBase .= $this->getAttributeList($formElement, [F_FE_DATA_PATTERN_ERROR, F_FE_DATA_REQUIRED_ERROR, F_FE_DATA_MATCH_ERROR, F_FE_DATA_ERROR]); $key = HelperFormElement::prependFormElementNameCheckBoxMulti($htmlFormElementName, 'h'); $htmlHidden = $this->buildNativeHidden($key, ''); $this->fillStoreAdditionalFormElementsCheckboxHidden($formElement, $htmlFormElementName, $htmlHidden); $html = ''; $orientation = ($formElement[FE_MAX_LENGTH] > 1) ? ALIGN_HORIZONTAL : ALIGN_VERTICAL; $checkboxClass = ($orientation === ALIGN_HORIZONTAL) ? 'checkbox-inline' : 'checkbox'; $br = ''; $flagFirst = true; for ($ii = 0, $jj = 1; $ii < count($itemKey); $ii++, $jj++) { $jsonValue = false; $attribute = $attributeBase; $htmlFormElementNameUniq = HelperFormElement::prependFormElementNameCheckBoxMulti($htmlFormElementName, $ii); $attribute .= Support::doAttribute('id', $formElement[FE_HTML_ID] . '-' . $ii); $attribute .= Support::doAttribute('name', $htmlFormElementNameUniq); // Do this only the first round. if ($flagFirst) { $flagFirst = false; if (isset($formElement['autofocus'])) $attribute .= Support::doAttribute('autofocus', $formElement['autofocus']); } $attribute .= Support::doAttribute('value', $itemKey[$ii]); // Check if the given key is found in field. if (false !== array_search($itemKey[$ii], $values)) { $attribute .= Support::doAttribute('checked', 'checked'); $jsonValue = true; } // ' ' - This is necessary to correctly align an empty input. $value = ($itemValue[$ii] === '') ? ' ' : $itemValue[$ii]; $htmlElement = '' . $value; // With ALIGN_HORIZONTAL: the label causes some trouble: skip it if (($orientation === ALIGN_VERTICAL)) { $htmlElement = Support::wrapTag('', $htmlElement); } $htmlElement = Support::wrapTag("

", $htmlElement, true); // control orientation if ($formElement[FE_MAX_LENGTH] > 1) { if ($jj == $formElement[FE_MAX_LENGTH]) { $jj = 0; $br = '
'; } else { $br = ''; } } $html .= $htmlElement . $br; $json[] = $this->getFormElementForJson($htmlFormElementNameUniq, $jsonValue, $formElement); } return $html; } /** * Submit extra (hidden) values by SIP. * * Sometimes, it's usefull to precalculate values during formload and to submit them as hidden fields. * To avoid any manipulation on those fields, the values will be transferred by SIP. * * @param array $formElement * @param $htmlFormElementName * @param $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * @return string * @throws CodeException * @throws \qfq\UserFormException */ public function buildExtra(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { if ($mode === FORM_LOAD) { // Split 'grId:0' in 'grId' and '0' // $name = explode(':', $htmlFormElementName, 2); // $this->store->setVar($name[0], $value, STORE_SIP, false); $this->store->setVar($formElement[FE_NAME], $value, STORE_SIP, false); } } /** * Build HTML 'radio' element. * * Format: * * * @param array $formElement * @param $htmlFormElementName * @param $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * @return string * @throws CodeException * @throws \qfq\UserFormException */ public function buildRadio(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { if (isset($formElement[FE_BUTTON_CLASS])) { if ($formElement[FE_BUTTON_CLASS] == '') { $formElement[FE_BUTTON_CLASS] = 'btn-default'; } $html = $this->constructRadioButton($formElement, $htmlFormElementName, $value, $json, $mode); } else { $html = $this->constructRadioPlain($formElement, $htmlFormElementName, $value, $json, $mode); } return $html . $this->getHelpBlock(); } /** * Build Bootstrap Button 'radio' element. * *

* * * Radio 1 (preselected) * * * * Radio 2 * * * * Radio 3 * * *

* * @param array $formElement * @param $htmlFormElementName * @param $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * @return string * @throws CodeException * @throws \qfq\UserFormException */ private function constructRadioButton(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { $itemKey = array(); $itemValue = array(); // Fill $itemKey & $itemValue $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue); $attributeBase = $this->getAttributeFeMode($formElement[FE_MODE]); $attributeBase .= $this->getAttributeList($formElement, [F_FE_DATA_PATTERN_ERROR, F_FE_DATA_REQUIRED_ERROR, F_FE_DATA_MATCH_ERROR, F_FE_DATA_ERROR]); $attributeBase .= Support::doAttribute('id', $formElement[FE_HTML_ID]); $attributeBase .= Support::doAttribute('name', $htmlFormElementName); $attributeBase .= Support::doAttribute('type', $formElement[FE_TYPE]); $attributeBase .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : ''); $attributeBase .= Support::doAttribute('autocomplete', 'off'); $attribute = $attributeBase; if (isset($formElement['autofocus'])) { $attribute .= Support::doAttribute('autofocus', $formElement['autofocus']); } $htmlHidden = $this->buildNativeHidden($htmlFormElementName, $value); $this->store->setVar($htmlFormElementName, $htmlHidden, STORE_ADDITIONAL_FORM_ELEMENTS, false); $html = ''; for ($ii = 0; $ii < count($itemValue); $ii++) { $classActive = ''; $attribute .= Support::doAttribute('value', $itemKey[$ii]); $attribute .= Support::doAttribute('title', $formElement['tooltip']); if ($itemKey[$ii] === $value) { $attribute .= Support::doAttribute('checked', 'checked'); $classActive = ' active'; } $htmlElement = '' . $itemValue[$ii]; $htmlElement = Support::wrapTag("", $htmlElement); $html .= $htmlElement; // Init for the next round $attribute = $attributeBase; } $html = Support::wrapTag('

', $html); $json = $this->getFormElementForJson($htmlFormElementName, $value, $formElement); return $html; } /** * Build plain HTML 'radio' element. * * Format: * * * @param array $formElement * @param $htmlFormElementName * @param $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * @return string * @throws CodeException * @throws \qfq\UserFormException */ private function constructRadioPlain(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { $attributeBase = ''; if (isset($formElement[FE_BUTTON_CLASS])) { return $this->constructRadioButton($formElement, $htmlFormElementName, $value, $json, $mode); } $itemKey = array(); $itemValue = array(); // Fill $itemKey & $itemValue $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue); $attributeBase .= $this->getAttributeFeMode($formElement[FE_MODE]); $attributeBase .= $this->getAttributeList($formElement, [F_FE_DATA_PATTERN_ERROR, F_FE_DATA_REQUIRED_ERROR, F_FE_DATA_MATCH_ERROR, F_FE_DATA_ERROR]); $attributeBase .= Support::doAttribute('id', $formElement[FE_HTML_ID]); $attributeBase .= Support::doAttribute('name', $htmlFormElementName); $attributeBase .= Support::doAttribute('type', $formElement[FE_TYPE]); $attributeBase .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : ''); $jj = 0; $orientation = ($formElement[FE_MAX_LENGTH] > 1) ? ALIGN_HORIZONTAL : ALIGN_VERTICAL; $radioClass = ($orientation === ALIGN_HORIZONTAL) ? 'radio-inline' : 'radio'; $br = ''; $attribute = $attributeBase; if (isset($formElement['autofocus'])) { $attribute .= Support::doAttribute('autofocus', $formElement['autofocus']); } $html = $this->buildNativeHidden($htmlFormElementName, $value); for ($ii = 0; $ii < count($itemValue); $ii++) { $jj++; $attribute .= Support::doAttribute('value', $itemKey[$ii]); $attribute .= Support::doAttribute('title', $formElement['tooltip']); if ($itemKey[$ii] === $value) { $attribute .= Support::doAttribute('checked', 'checked'); } // ' ' - This is necessary to correctly align an empty input. $tmpValue = ($itemValue[$ii] === '') ? ' ' : $itemValue[$ii]; $htmlElement = '' . $tmpValue; // With ALIGN_HORIZONTAL: the label causes some trouble: skip it if (($orientation === ALIGN_VERTICAL)) { $htmlElement = Support::wrapTag('', $htmlElement); } if ($formElement[FE_MAX_LENGTH] > 1) { if ($jj == $formElement[FE_MAX_LENGTH]) { $jj = 0; $br = '
'; } else { $br = ''; } } $htmlElement = Support::wrapTag("

", $htmlElement) . $br; $html .= $htmlElement; $attribute = $attributeBase; } $json = $this->getFormElementForJson($htmlFormElementName, $value, $formElement); return $html; } /** * Builds a Selct (Dropdown) Box. * * @param array $formElement * @param $htmlFormElementName * @param $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * @return mixed * @throws CodeException * @throws \qfq\UserFormException */ public function buildSelect(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { $itemKey = array(); $itemValue = array(); $attribute = ''; // Fill $itemKey & $itemValue $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue); $attribute .= $this->getAttributeFeMode($formElement[FE_MODE]); $attribute .= Support::doAttribute('id', $formElement[FE_HTML_ID]); $attribute .= Support::doAttribute('name', $htmlFormElementName); $attribute .= Support::doAttribute('class', 'form-control'); $attribute .= Support::doAttribute('title', $formElement['tooltip']); $attribute .= $this->getAttributeList($formElement, ['autofocus']); $attribute .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : ''); $attribute .= $this->getAttributeList($formElement, [F_FE_DATA_PATTERN_ERROR, F_FE_DATA_REQUIRED_ERROR, F_FE_DATA_MATCH_ERROR, F_FE_DATA_ERROR]); if (isset($formElement['size']) && $formElement['size'] > 1) { $attribute .= Support::doAttribute('size', $formElement['size']); $attribute .= Support::doAttribute('multiple', 'multiple'); } $option = ''; $firstSelect = true; $jsonValues = array(); for ($ii = 0; $ii < count($itemValue); $ii++) { $option .= ' $itemKey[$ii], 'text' => $itemValue[$ii], 'selected' => ($itemKey[$ii] == $value && $firstSelect) ]; if ($itemKey[$ii] == $value && $firstSelect) { $option .= 'selected'; $firstSelect = false; } $option .= '>' . $itemValue[$ii] . ''; } $json = $this->getFormElementForJson($htmlFormElementName, $jsonValues, $formElement); return '' . $option . '' . $this->getHelpBlock(); } /** * Construct a HTML table of the subrecord data. * Column syntax definition: https://wikiit.math.uzh.ch/it/projekt/qfq/qfq-jqwidgets/Documentation#Type:_subrecord * * @param array $formElement * @param $htmlFormElementName * @param $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * @return string * @throws CodeException * @throws \qfq\UserFormException */ public function buildSubrecord(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { $rcText = false; $nameColumnId = 'id'; $targetTableName = ''; $flagNew = false; $flagEdit = false; $flagDelete = false; $linkNew = ''; $control = array(); $primaryRecord = $this->store->getStore(STORE_RECORD); if (!$this->prepareSubrecod($formElement, $primaryRecord, $rcText, $nameColumnId)) { return $rcText; } if (isset($formElement[SUBRECORD_PARAMETER_FORM])) { Support::setIfNotSet($formElement, F_EXTRA_DELETE_FORM, ''); $formElement[F_FINAL_DELETE_FORM] = $formElement[F_EXTRA_DELETE_FORM] != '' ? $formElement[F_EXTRA_DELETE_FORM] : $formElement[SUBRECORD_PARAMETER_FORM]; $linkNew = Support::wrapTag('', $this->createFormLink($formElement, 0, $primaryRecord, $this->symbol[SYMBOL_NEW], 'New')); // Decode settings in subrecordOption $flagNew = Support::findInSet(SUBRECORD_NEW, $formElement['subrecordOption']); $flagEdit = Support::findInSet(SUBRECORD_EDIT, $formElement['subrecordOption']); if ($flagDelete = Support::findInSet(SUBRECORD_DELETE, $formElement['subrecordOption'])) { $targetTableName = $this->getFormTable($formElement[SUBRECORD_PARAMETER_FORM]); } } $columns = $linkNew; if (isset($formElement['sql1'][0])) { // construct column attributes $control = $this->getSubrecordColumnControl(array_keys($formElement['sql1'][0])); // Subrecord: Column titles $columns .= '' . implode('', $control['title']) . ''; } if ($flagDelete) { $columns .= ''; } // Table head $html = Support::wrapTag('', $columns); foreach ($formElement['sql1'] as $row) { $rowHtml = ''; if ($flagEdit) { $rowHtml .= Support::wrapTag('', $this->createFormLink($formElement, $row[$nameColumnId], $primaryRecord, $this->symbol[SYMBOL_EDIT], 'Edit')); } elseif ($flagNew) { $rowHtml .= Support::wrapTag('', $rowHtml, false); } // All columns foreach ($row as $columnName => $value) { if (isset($control['title'][$columnName])) { $rowHtml .= Support::wrapTag('', $this->renderCell($control, $columnName, $value)); } } if ($flagDelete) { $toolTip = 'Delete'; if ($this->showDebugInfo) { $toolTip .= PHP_EOL . "form = '" . $formElement[F_FINAL_DELETE_FORM] . "'" . PHP_EOL . "r = '" . $row[$nameColumnId] . "'"; } // $buttonDelete = $this->buildButtonCode('delete-button', $toolTip, GLYPH_ICON_DELETE, $disabled); $s = $this->createDeleteUrl($formElement[F_FINAL_DELETE_FORM], '', $row[$nameColumnId], RETURN_SIP); // $rowHtml .= Support::wrapTag('', Support::wrapTag("", '')); $rowHtml .= Support::wrapTag('', Support::wrapTag("", '')); } Support::setIfNotSet($row, FE_SUBRECORD_ROW_CLASS); $rowClass = 'record '; $rowClass .= $row[FE_SUBRECORD_ROW_CLASS]; Support::setIfNotSet($row, FE_SUBRECORD_ROW_TITLE); $rowTitle = $row[FE_SUBRECORD_ROW_TITLE]; $rowAttribute = Support::doAttribute('class', $rowClass); $rowAttribute .= Support::doAttribute('title', $rowTitle); $html .= Support::wrapTag("", $rowHtml, true); } return Support::wrapTag('', $html, true); } /** * Prepare Subrecord: * - check if the current record has an recordId>0. If not, subrecord can't be edited. Return a message. * - check if there is an SELECT statement for the subrecords. * - determine &$nameColumnId * * @param $formElement * @param $primaryRecord * @param $rcText * @param $nameColumnId * @return bool * @throws \qfq\UserFormException */ private function prepareSubrecod(array $formElement, array $primaryRecord, &$rcText, &$nameColumnId) { if (!isset($primaryRecord['id'])) { $rcText = 'Please save and close record and reopen it.'; return false; } if (!is_array($formElement['sql1'])) { throw new UserFormException('Missing \'sql1\' Query', ERROR_MISSING_SQL1); } // No records? if (count($formElement['sql1']) == 0) { $rcText = ''; return true; } // Check if $nameColumnId column exist. if (!isset($formElement['sql1'][0][$nameColumnId])) { // no: try fallback. $nameColumnId = '_id'; if (!isset($formElement['sql1'][0][$nameColumnId])) { throw new UserFormException('Missing column \'id\' or \'_id\' in subrecord query', ERROR_SUBRECORD_MISSING_COLUMN_ID); } } if (!isset($formElement['sql1'][0][$nameColumnId])) { throw new UserFormException('Missing column \'id\' (or "_id") in \'sql1\' Query', ERROR_DB_MISSING_COLUMN_ID); } return true; } /** * Renders an Link with a symbol (edit/new) and register a new SIP to grant permission to the link.. * * Returns [icon] * * Link: ?s=& * SIP: form = $formElement['form'] (provided via formElement[FE_PARAMETER]) * r = $targetRecordId * Parse $formElement['detail'] with possible key/value pairs. E.g.: detail=id:gr_id,#{{a}}:p_id,#12:x_id * gr_id = <> * p_id = <> * x_id = 12 (constant) * * * @param $formElement * @param $targetRecordId * @param $record * @return string * @throws UserFormException */ private function createFormLink(array $formElement, $targetRecordId, array $record, $symbol, $toolTip) { //TODO: Umstellen auf Benutzung der Link Klasse. $queryStringArray = [ SIP_FORM => $formElement[SUBRECORD_PARAMETER_FORM], SIP_RECORD_ID => $targetRecordId ]; // Add custom query parameter if (isset($formElement[SUBRECORD_PARAMETER_DETAIL])) { $detailParam = KeyValueStringParser::parse($formElement[SUBRECORD_PARAMETER_DETAIL]); foreach ($detailParam as $src => $dest) { // Constants if ($src[0] == '&') { $queryStringArray[$dest] = substr($src, 1); continue; } // Form record values or parameter if (isset($record[$src])) { $queryStringArray[$dest] = $record[$src]; } } } if ($this->showDebugInfo) $toolTip .= PHP_EOL . OnArray::toString($queryStringArray, ' = ', PHP_EOL, "'"); Support::appendTypo3ParameterToArray($queryStringArray); // If there is a specific targetpage defined, take it. if (isset($formElement[SUBRECORD_PARAMETER_PAGE]) && $formElement[SUBRECORD_PARAMETER_PAGE] !== '') { $queryStringArray['id'] = $formElement[SUBRECORD_PARAMETER_PAGE]; } //----------------- $queryString = Support::arrayToQueryString($queryStringArray); $sip = $this->store->getSipInstance(); $url = $sip->queryStringToSip($queryString); return Support::wrapTag('', $symbol); } /** * Get the name for the given form $formName. If not found, return ''. * * @param $formName * @return string tableName for $formName * @throws CodeException * @throws DbException */ private function getFormTable($formName) { $row = $this->db->sql("SELECT " . F_TABLE_NAME . " FROM Form AS f WHERE f.name = ?", ROW_EXPECT_0_1, [$formName]); if (isset($row[F_TABLE_NAME])) { return $row[F_TABLE_NAME]; } return ''; } /** * Get various column format information based on the 'raw' column title. The attributes are separated by '|' and specified as 'key' or 'key=value'. * * - Return all parsed values as an assoc array. * - For regular columns: If there is no 'width' specified, take the default 'SUBRECORD_COLUMN_WIDTH' * - For 'icon / url / mailto': no width limit. * * Returned assoc array: * title Only key. Element is non numeric, which is not a keyword 'width/nostrip/icon/url/mailto' * width Key/Value Pair. Not provided for 'icon/url/mailto'. * nostrip Only key. Do not strip HTML Tags from the content. * icon Only key. Value will rendered (later) as an image. * url Only key. Value will rendered (later) as a 'href' * mailto Only key. Value will rendered (later) as a 'href mailto' * * * @param array $titleRaw * @return array * @throws UserFormException */ private function getSubrecordColumnControl(array $titleRaw) { $control = array(); foreach ($titleRaw AS $columnName) { switch ($columnName) { case FE_SUBRECORD_ROW_CLASS: case FE_SUBRECORD_ROW_TITLE: continue 2; default: break; } $flagWidthLimit = true; $control['width'][$columnName] = SUBRECORD_COLUMN_WIDTH; // a) 'City@width=40', b) 'Status@icon', c) 'Mailto@width=80@nostrip' $arr = KeyValueStringParser::parse($columnName, '=', '|', KVP_IF_VALUE_EMPTY_COPY_KEY); foreach ($arr as $attribute => $value) { switch ($attribute) { case 'width': case 'nostrip': case 'title': case 'link': break; case 'icon': case 'url': case 'mailto': $flagWidthLimit = false; break; default: $attribute = is_numeric($value) ? 'width' : 'title'; break; } $control[$attribute][$columnName] = $value; } if (!isset($control['title'][$columnName])) $control['title'][$columnName] = ''; // Fallback: Might be wrong, but better than nothing. // Don't render Columns starting with '_...'. if (substr($control['title'][$columnName], 0, 1) === '_') { unset($control['title'][$columnName]); // Do not render column later. continue; } // Limit title length $control['title'][$columnName] = substr($control['title'][$columnName], 0, $control['width'][$columnName]); if (!$flagWidthLimit) { $control['width'][$columnName] = false; } } return $control; } /** * Renders $value as specified in array $control * * nostrip: by default, HTML tags are removed. With this attribute, the value will be delivered as it is. * width: if there is a size limit - apply it. * icon: The cell will be rendered as an image. $value should contain the name of an image in 'fileadmin/icons/' * mailto: The cell will be rendered as an tag with the 'mailto' attribute. * url: The cell will be rendered as an tag. The value will be exploded by '|'. $value[0] = href, value[1] = text. * E.g. $value = 'www.math.uzh.ch/?id=45&v=234|Show details for Modul 123' >> Show details for Modul 123 * * @param array $control * @param $columnName * @param $columnValue * @return string */ private function renderCell(array $control, $columnName, $columnValue) { $link = null; switch ($columnName) { case FE_SUBRECORD_ROW_CLASS: case FE_SUBRECORD_ROW_TITLE: return ''; default: break; } $arr = explode('|', $columnValue); if (count($arr) == 1) $arr[1] = $arr[0]; // $cell = isset($control['nostrip'][$columnName]) ? $columnValue : strip_tags($columnValue); if (isset($control['nostrip'][$columnName])) { $cell = $columnValue; $control['width'][$columnName] = false; } else { $cell = strip_tags($columnValue); } if ($control['width'][$columnName] !== false && $control['width'][$columnName] != 0) { $cell = substr($cell, 0, $control['width'][$columnName]); } if (isset($control['icon'][$columnName])) { $cell = ($cell === '') ? '' : ""; } if (isset($control['mailto'][$columnName])) { $cell = "$arr[1]"; } if (isset($control['url'][$columnName])) { $cell = "$arr[1]"; } if (isset($control['link'][$columnName])) { if (!isset($link)) { $link = new Link($this->sip); } $cell = $link->renderLink($columnValue); } return $cell; } /** * Create a link (incl. SIP) to delete the current record. * * @param string $formName if there is a form, specify that * @param string $tableName if there is no form , specify the table from where to delete the record. * @param int $recordId record to delete * @param string $mode * * mode=RETURN_URL: return complete URL * * mode=RETURN_SIP: returns only the sip * * mode=RETURN_ARRAY: returns array with url ('_url') and all decoded and created parameters. * @return string String: "API_DIR/delete.php?sip=...." * @throws CodeException */ public function createDeleteUrl($formName, $tableName, $recordId, $mode = RETURN_URL) { $queryStringArray = [ SIP_RECORD_ID => $recordId, SIP_MODE_ANSWER => MODE_JSON ]; if ($formName !== '') { $queryStringArray[SIP_FORM] = $formName; } if ($tableName !== '') { $queryStringArray[SIP_TABLE] = $tableName; } $queryString = Support::arrayToQueryString($queryStringArray); $sip = $this->store->getSipInstance(); return $sip->queryStringToSip($queryString, $mode, API_DIR . '/' . API_DELETE_PHP); } /** * Build an Upload (File) Button. * * @param array $formElement * @param $htmlFormElementName * @param $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * @return string * @throws CodeException * @throws \qfq\UserFormException */ public function buildFile(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { $attribute = ''; if (empty($formElement[FE_FILE_MIME_TYPE_ACCEPT])) { $formElement[FE_FILE_MIME_TYPE_ACCEPT] = UPLOAD_DEFAULT_MIME_TYPE; } # Build param array for uniq SIP $arr = array(); $arr['fake_uniq_never_use_this'] = uniqid(); // make sure we get a new SIP. This is needed for multiple forms (same user) with r=0 $arr[CLIENT_SIP_FOR_FORM] = $this->store->getVar(SIP_SIP, STORE_SIP); $arr[CLIENT_FE_NAME] = $formElement['name']; $arr[CLIENT_FORM] = $this->formSpec['name']; $arr[CLIENT_RECORD_ID] = $this->store->getVar(SIP_RECORD_ID, STORE_SIP); $arr[CLIENT_PAGE_ID] = 'fake'; $arr[EXISTING_PATH_FILE_NAME] = $value; $arr[FE_FILE_MIME_TYPE_ACCEPT] = $formElement[FE_FILE_MIME_TYPE_ACCEPT]; $arr[FE_FILE_MAX_FILE_SIZE] = empty($formElement[FE_FILE_MAX_FILE_SIZE]) ? UPLOAD_DEFAULT_MAX_SIZE : $formElement[FE_FILE_MAX_FILE_SIZE]; $sipUpload = $this->sip->queryStringToSip(OnArray::toString($arr), RETURN_SIP); $hiddenSipUpload = $this->buildNativeHidden($htmlFormElementName, $sipUpload); $attribute .= Support::doAttribute('id', $formElement[FE_HTML_ID]); $attribute .= Support::doAttribute('name', $htmlFormElementName); // $attribute .= Support::doAttribute('class', 'form-control'); $attribute .= Support::doAttribute('type', 'file'); $attribute .= Support::doAttribute('title', $formElement['tooltip']); $attribute .= $this->getAttributeList($formElement, [FE_AUTOFOCUS, FE_FILE_MIME_TYPE_ACCEPT]); $attribute .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : ''); $attribute .= Support::doAttribute('data-sip', $sipUpload); if ($value === '' || $value === false) { $textDeleteClass = 'hidden'; $uploadClass = ''; } else { $textDeleteClass = ''; $uploadClass = 'hidden'; $formElement[FE_MODE] = FE_MODE_HIDDEN; } $attribute .= $this->getAttributeFeMode($formElement[FE_MODE]); $attribute .= Support::doAttribute('class', $uploadClass, true); $htmlInputFile = '' . $this->getHelpBlock(); $deleteButton = Support::wrapTag("", $this->symbol[SYMBOL_DELETE]); $htmlFilename = Support::wrapTag("", $value, false); $htmlTextDelete = Support::wrapTag("

", $htmlFilename . ' ' . $deleteButton); //

$json = $this->getFormElementForJson($htmlFormElementName, $value, $formElement); return $htmlTextDelete . $htmlInputFile . $hiddenSipUpload; } /** * Builds HTML 'input' element. * Format: * * * @param array $formElement * @param $htmlFormElementName * @param $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * @return string * @throws UserFormException */ public function buildDateTime(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { $attribute = ''; $attribute .= Support::doAttribute('id', $formElement[FE_HTML_ID]); $attribute .= Support::doAttribute('name', $htmlFormElementName); $attribute .= Support::doAttribute('class', 'form-control'); $arrMinMax = null; $this->adjustMaxLength($formElement); $showTime = ($formElement[FE_TYPE] == 'time' || $formElement[FE_TYPE] == 'datetime') ? 1 : 0; $value = Support::convertDateTime($value, $formElement[FE_DATE_FORMAT], $formElement[FE_SHOW_ZERO], $showTime, $formElement[FE_SHOW_SECONDS]); $tmpPattern = $formElement[FE_CHECK_PATTERN]; $formElement[FE_CHECK_PATTERN] = Support::dateTimeRegexp($formElement[FE_TYPE], $formElement[FE_DATE_FORMAT]); switch ($formElement[FE_CHECK_TYPE]) { case SANITIZE_ALLOW_PATTERN: $formElement[FE_CHECK_PATTERN] = $tmpPattern; break; case SANITIZE_ALLOW_MIN_MAX_DATE: $arrMinMax = explode('|', $formElement[FE_CHECK_PATTERN], 2); if (count($arrMinMax) != 2) { throw new UserFormException('Missing min|max definition', ERROR_MISSING_MIN_MAX); } break; case SANITIZE_ALLOW_ALL: case SANITIZE_ALLOW_ALNUMX: case SANITIZE_ALLOW_ALLBUT: $formElement[FE_CHECK_TYPE] = SANITIZE_ALLOW_PATTERN; break; default: throw new UserFormException("Checktype not applicable for date/time: '" . $formElement[FE_CHECK_TYPE] . "'", ERROR_NOT_APPLICABLE); } // truncate if necessary if ($value != '' && $formElement[FE_MAX_LENGTH] > 0) { $value = substr($value, 0, $formElement[FE_MAX_LENGTH]); } // See: https://project.math.uzh.ch/issues/3536 // $type = $formElement[FE_TYPE]; // if ($type === 'datetime') { // $type = 'datetime-local'; // } $type = 'text'; // date|time|datetime|datetime-local are not appropriate - only I18n representation possible. $attribute .= Support::doAttribute('type', $type); // 'maxLength' needs an upper 'L': naming convention for DB tables! $attribute .= $this->getAttributeList($formElement, ['size', 'maxLength']); $attribute .= Support::doAttribute('value', htmlentities($value), false); $attribute .= $this->getAttributeList($formElement, [F_FE_DATA_PATTERN_ERROR, F_FE_DATA_REQUIRED_ERROR, F_FE_DATA_MATCH_ERROR, F_FE_DATA_ERROR]); if ($formElement['placeholder'] == '') { $timePattern = ($formElement[FE_SHOW_SECONDS] == 1) ? 'hh:mm:ss' : 'hh:mm'; switch ($formElement[FE_TYPE]) { case 'date': $placeholder = $formElement[FE_DATE_FORMAT]; break; case 'datetime': $placeholder = $formElement[FE_DATE_FORMAT] . ' ' . $timePattern; break; case 'time': $placeholder = $timePattern; break; default: throw new UserFormException("Unexpected Formelement type: '" . $formElement[FE_TYPE] . "'", ERROR_FORMELEMENT_TYPE); } $formElement['placeholder'] = $placeholder; } $attribute .= $this->getAttributeList($formElement, ['autocomplete', 'autofocus', 'placeholder']); $attribute .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : ''); $attribute .= Support::doAttribute('title', $formElement['tooltip']); $attribute .= $this->getInputCheckPattern($formElement[FE_CHECK_TYPE], $formElement[FE_CHECK_PATTERN]); if (is_array($arrMinMax)) { $attribute .= Support::doAttribute('min', $arrMinMax[0]); $attribute .= Support::doAttribute('max', $arrMinMax[1]); } $attribute .= $this->getAttributeFeMode($formElement[FE_MODE]); $json = $this->getFormElementForJson($htmlFormElementName, $value, $formElement); return "" . $this->getHelpBlock(); } /** * Builds HTML 'input' element. * Format: * * * @param array $formElement * @param $htmlFormElementName * @param $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * @return string * @throws UserFormException */ public function buildDateJQW(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { $arrMinMax = null; // if ($formElement['placeholder'] == '') { // $timePattern = ($formElement[FE_SHOW_SECONDS] == 1) ? 'hh:mm:ss' : 'hh:mm'; // switch ($formElement[FE_TYPE]) { // case 'date': // $placeholder = $formElement[FE_DATE_FORMAT]; // break; // case 'datetime': // $placeholder = $formElement[FE_DATE_FORMAT] . ' ' . $timePattern; // break; // case 'time': // $placeholder = $timePattern; // break; // default: // throw new UserFormException("Unexpected Formelement type: '" . $formElement[FE_TYPE] . "'", ERROR_FORMELEMENT_TYPE); // } // $formElement['placeholder'] = $placeholder; // } // switch ($formElement['checkType']) { //// case SANITIZE_ALLOW_PATTERN: //// $formElement['checkPattern'] = $tmpPattern; //// break; // case SANITIZE_ALLOW_MIN_MAX_DATE: // $arrMinMax = explode('|', $formElement['checkPattern'], 2); // if (count($arrMinMax) != 2) { // throw new UserFormException('Missing min|max definition', ERROR_MISSING_MIN_MAX); // } // break; //// case SANITIZE_ALLOW_ALL: //// case SANITIZE_ALLOW_ALNUMX: //// case SANITIZE_ALLOW_ALLBUT: //// $formElement['checkType'] = SANITIZE_ALLOW_PATTERN; //// break; // default: // throw new UserFormException("Checktype not applicable for date/time: '" . $formElement['checkType'] . "'", ERROR_NOT_APPLICABLE); // } $this->adjustMaxLength($formElement); $showTime = ($formElement[FE_TYPE] == 'time' || $formElement[FE_TYPE] == 'datetime') ? 1 : 0; $value = Support::convertDateTime($value, $formElement[FE_DATE_FORMAT], $formElement[FE_SHOW_ZERO], $showTime, $formElement[FE_SHOW_SECONDS]); // $formElement[FE_DATE_FORMAT] $attribute = Support::doAttribute('id', $htmlFormElementName); $attribute .= Support::doAttribute('class', 'jqw-datetimepicker'); $attribute .= Support::doAttribute('data-control-name', "$htmlFormElementName"); $attribute .= Support::doAttribute('data-format-string', "dd.MM.yyyy HH:mm"); $attribute .= Support::doAttribute('data-show-time-button', "true"); // $attribute .= Support::doAttribute('data-placeholder', $formElement['placeholder']); $attribute .= Support::doAttribute('data-value', htmlentities($value), false); // $attribute .= Support::doAttribute('data-autofocus', $formElement['autofocus']); $attribute .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : ''); $attribute .= Support::doAttribute('data-title', $formElement['tooltip']); // if (is_array($arrMinMax)) { // $attribute .= Support::doAttribute('data-min', $arrMinMax[0]); // $attribute .= Support::doAttribute('data-max', $arrMinMax[1]); // } $attribute .= $this->getAttributeFeMode($formElement[FE_MODE]); // $json = $this->getJsonElementUpdate($htmlFormElementName, $value, $formElement[FE_MODE]); $element = Support::wrapTag("

", '', false); return $element . $this->getHelpBlock(); } /** * Build a HTML 'textarea' element which becomes a TinyMCE Editor. * List of possible plugins: https://www.tinymce.com/docs/plugins/ * * @param array $formElement * @param $htmlFormElementName * @param $value * @param array $json * @param string $mode * @return string * @throws \qfq\UserFormException */ public function buildEditor(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { $attribute = ''; //TODO plugin autoresize nutzen um Editorgroesse anzugeben $this->adjustMaxLength($formElement); $attribute .= Support::doAttribute('id', $formElement[FE_HTML_ID]); $attribute .= Support::doAttribute('name', $htmlFormElementName); // $attribute .= Support::doAttribute('id', $htmlFormElementName); $attribute .= Support::doAttribute('class', 'qfq-tinymce'); $attribute .= Support::doAttribute('data-control-name', "$htmlFormElementName"); $attribute .= Support::doAttribute('data-placeholder', $formElement['placeholder']); // $attribute .= Support::doAttribute('data-autofocus', $formElement['autofocus']); $attribute .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : ''); $attribute .= Support::doAttribute('data-title', $formElement['tooltip']); $formElement = $this->setEditorConfig($formElement, $htmlFormElementName); // $formElement['editor-plugins']='autoresize code' // $formElement['editor-contextmenu']='link image | cell row column' $json = $this->getPrefixedElementsAsJSON(FE_EDITOR_PREFIX, $formElement); $attribute .= Support::doAttribute('data-config', $json, true, ESCAPE_WITH_HTML_QUOTE); $attribute .= $this->getAttributeFeMode($formElement[FE_MODE]); $attribute .= $this->getAttributeList($formElement, [F_FE_DATA_PATTERN_ERROR, F_FE_DATA_REQUIRED_ERROR, F_FE_DATA_MATCH_ERROR, F_FE_DATA_ERROR]); $json = $this->getFormElementForJson($htmlFormElementName, $value, $formElement); $element = Support::wrapTag("", htmlentities($value), false); return $element . $this->getHelpBlock(); } /** * Parse $formElement[FE_EDITOR_*] settings and build editor settings. * * @param array $formElement * @param $htmlFormElementName * @return array */ private function setEditorConfig(array $formElement, $htmlFormElementName) { $flagMaxHeight = false; // plugins if (!isset($formElement[FE_EDITOR_PREFIX . 'plugins'])) { $formElement[FE_EDITOR_PREFIX . 'plugins'] = 'code link searchreplace table textcolor textpattern visualchars'; } // toolbar: https://www.tinymce.com/docs/advanced/editor-control-identifiers/#toolbarcontrols if (!isset($formElement[FE_EDITOR_PREFIX . 'toolbar'])) { $formElement[FE_EDITOR_PREFIX . 'toolbar'] = 'code searchreplace undo redo | ' . 'styleselect link table | fontselect fontsizeselect | ' . 'bullist numlist outdent indent | forecolor backcolor bold italic'; } // menubar if (!isset($formElement[FE_EDITOR_PREFIX . 'menubar'])) { $formElement[FE_EDITOR_PREFIX . 'menubar'] = 'false'; } // autofocus if (isset($formElement['autofocus']) && $formElement['autofocus'] == 'yes') { $formElement[FE_EDITOR_PREFIX . 'auto_focus'] = $htmlFormElementName; } // Check for min_height, max_height $minMax = explode(',', $formElement['size'], 2); if (isset($minMax[0]) && ctype_digit($minMax[0]) && !isset($formElement[FE_EDITOR_PREFIX . 'min_height'])) { $formElement[FE_EDITOR_PREFIX . 'min_height'] = $minMax[0]; } if (isset($minMax[1]) && ctype_digit($minMax[1]) && !isset($formElement[FE_EDITOR_PREFIX . 'max_height'])) { $formElement[FE_EDITOR_PREFIX . 'max_height'] = $minMax[1]; $flagMaxHeight = true; } // statusbar: disable if not user defined and if no max_height is given. if (!$flagMaxHeight && !isset($formElement[FE_EDITOR_PREFIX . 'statusbar'])) { $formElement[FE_EDITOR_PREFIX . 'statusbar'] = 'false'; } return $formElement; } /** * Searches for '$prefix*' elements in $formElement. Collect all found elements, strip $prefix (=$keyName) and * returns keys/values JSON encoded. * Only 'alpha' chars are allowed as keyName. * Empty $settings are ok. * * @param string $prefix * @param array $formElement * @return string * @throws \qfq\UserFormException */ private function getPrefixedElementsAsJSON($prefix, array $formElement) { $settings = array(); // E.g.: $key = editor-plugins foreach ($formElement as $key => $value) { if (substr($key, 0, strlen($prefix)) == $prefix) { $keyName = substr($key, strlen($prefix)); if ($keyName == '') { throw new UserFormException("Empty '" . $prefix . "*' keyname: '" . $keyName . "'", ERROR_INVALID_EDITOR_PROPERTY_NAME); } // $value might be boolean false, which should be used! Do not compare with ''. if (isset($value)) { // real boolean are important for TinyMCE config 'statusbar', 'menubar', ... if ($value === 'false') $value = false; if ($value === 'true') $value = true; $settings[$keyName] = $value; } } } return json_encode($settings); } /** * Build Grid JQW element. * * @param array $formElement * @param $htmlFormElementName * @param $value * @param $fake * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * @throws UserFormException */ public function buildGridJQW(array $formElement, $htmlFormElementName, $value, $fake, $mode = FORM_LOAD) { // TODO: implement throw new UserFormException("Not implemented yet: buildGridJQW()", ERROR_NOT_IMPLEMENTED); } /** * Build Note. * * @param array $formElement * @param $htmlFormElementName * @param $value * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * @param array $json * @return mixed */ public function buildNote(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { $json = $this->getFormElementForJson($htmlFormElementName, $value, $formElement); // return Support::wrapTag("<div class='" . CLASS_NOTE . "'>", $value); } /** * Build Pill: * * @param array $formElement * @param $htmlFormElementName * @param $value * @param array $json * @return mixed */ public function buildPill(array $formElement, $htmlFormElementName, $value, array &$json) { return $value; } /** * Build a HTML fieldset. Renders all assigned FormElements inside the fieldset. * * @param array $formElement * @param $htmlFormElementName * @param $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * @return mixed * @throws CodeException * @throws DbException */ public function buildFieldset(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { $attribute = ''; // save parent processed FE's $tmpStore = $this->feSpecNative; $attribute .= Support::doAttribute('id', $formElement[FE_HTML_ID]); $attribute .= Support::doAttribute('name', $htmlFormElementName); $attribute .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : ''); // <fieldset> $html = '<fieldset ' . $attribute . '>'; if ($formElement[FE_LABEL] !== '') { $html .= '<legend>' . $formElement[FE_LABEL] . '</legend>'; } $html .= $this->wrap[WRAP_SETUP_IN_FIELDSET][WRAP_SETUP_START]; // child FE's $this->feSpecNative = $this->db->getNativeFormElements(SQL_FORM_ELEMENT_SPECIFIC_CONTAINER, ['yes', $this->formSpec["id"], 'native,container', $formElement['id']], $this->formSpec); $html .= $this->elements($this->store->getVar(SIP_RECORD_ID, STORE_SIP), FORM_ELEMENTS_NATIVE_SUBRECORD, 0, $json); $html .= $this->wrap[WRAP_SETUP_IN_FIELDSET][WRAP_SETUP_END]; $html .= '</fieldset>'; // restore parent processed FE's $this->feSpecNative = $tmpStore; $json = $this->getFormElementForJson($htmlFormElementName, $value, $formElement); return $html; } /** * @param array $formElementArr * @param $tgMaxCopies * @return array */ private function fillFeSpecNativeCheckboxWithTgMax(array $formElementArr, $tgMaxCopies) { foreach ($formElementArr as $key => $formElement) { if ($formElement[FE_TYPE] = FE_TYPE_CHECKBOX) { $formElementArr[$key][NAME_TG_COPIES] = $tgMaxCopies; } } return $formElementArr; } /** * Build a 'templateGroup'. Renders all assigned FormElements of the templateGroup. * If there are already vlaues for the formElements, fill as much copies as values exist * * @param array $formElement * @param $htmlFormElementName * @param $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * @return mixed * @throws CodeException * @throws DbException */ public function buildTemplateGroup(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { $attribute = ''; $html = ''; $addClass = Support::setIfNotSet($formElement, FE_TEMPLATE_GROUP_ADD_CLASS, 'btn btn-default'); $addText = Support::setIfNotSet($formElement, FE_TEMPLATE_GROUP_ADD_TEXT, 'Add'); $removeClass = Support::setIfNotSet($formElement, FE_TEMPLATE_GROUP_REMOVE_CLASS, 'btn btn-default'); $removeText = Support::setIfNotSet($formElement, FE_TEMPLATE_GROUP_REMOVE_TEXT, 'Remove'); $classCustom = Support::setIfNotSet($formElement, FE_TEMPLATE_GROUP_CLASS); // save parent processed FE's $feSpecNativeSave = $this->feSpecNative; $addButtonId = 'add_button_' . $formElement[FE_ID]; $qfqFieldsName = 'qfq_fields_' . $formElement[FE_ID]; // ='qfq-fields' $templateName = 'template_' . $formElement[FE_ID]; // ='template' $targetName = 'target_' . $formElement[FE_ID]; // ='template' Support::setIfNotSet($formElement, FE_MAX_LENGTH, '5', ''); $max = $formElement[FE_MAX_LENGTH]; $codeJs = <<<EOT <script type="text/javascript"> $(function () { $(".$qfqFieldsName").each( function () { QfqNS.initializeFields(this); } ); }); </script> EOT; $htmlAdd = <<<EOT <button type="button" id="$addButtonId" class="$addClass" onclick="QfqNS.addFields('#$templateName', '#$targetName', $max)">$addText</button> EOT; $htmlDelete = <<<EOT <div class="qfq-note-no-padding"> <button type="button" class="$removeClass" onclick="QfqNS.removeFields(this)">$removeText</button> </div> EOT; // child FE's $this->feSpecNative = $this->db->getNativeFormElements(SQL_FORM_ELEMENT_SPECIFIC_CONTAINER, ['yes', $this->formSpec[F_ID], 'native,container', $formElement[FE_ID]], $this->formSpec); // Count defined FormElements in the current templateGroup $elementsTotal = count($this->feSpecNative); if ($elementsTotal < 1) { // Nothting to do: return. $this->feSpecNative = $feSpecNativeSave; return ''; } $this->feSpecNative = $this->fillFeSpecNativeCheckboxWithTgMax($this->feSpecNative, $max); // If there are already elements filled, take them. $html = $this->templateGroupCollectFilledElements($max, $htmlDelete, $json); $attribute = Support::doAttribute('class', $qfqFieldsName); $attribute .= Support::doAttribute('id', $targetName); $attribute .= Support::doAttribute('data-qfq-line-template', '#' . $templateName); $attribute .= Support::doAttribute('data-qfq-line-add-button', '#' . $addButtonId); // Element where the effective FormElements will be copied to. The BS 'col-md-* Classes are inside the template, not here. This here should be pure data without wrapping. $html = Support::wrapTag("<div $attribute>", $html, false); // Add button, row below: The label & note of the FormElement 'templateGroup' will be used for the add button row. $tmpFe = $formElement; $tmpFe[FE_NAME] = '_add'; $tmpFe[FE_LABEL] = ''; $tmpFe[FE_NOTE] = ''; $this->fillWrapLabelInputNote($tmpFe[FE_BS_LABEL_COLUMNS], $tmpFe[FE_BS_INPUT_COLUMNS], $tmpFe[FE_BS_NOTE_COLUMNS]); $html .= $this->buildRowNative($tmpFe, $htmlAdd, $htmlFormElementName); $html = $this->wrap[WRAP_SETUP_IN_TEMPLATE_GROUP][WRAP_SETUP_START] . $html . $this->wrap[WRAP_SETUP_IN_TEMPLATE_GROUP][WRAP_SETUP_END]; // Append 'delete' Button after 'note' of the templateGroups last element. $this->feSpecNative[$elementsTotal - 1][FE_NOTE] .= $htmlDelete; // Get FE natives $template = $this->elements($this->store->getVar(SIP_RECORD_ID, STORE_SIP), FORM_ELEMENTS_NATIVE, 0, $json); // Wrap the main html code $attribute = Support::doAttribute('class', ['qfq-line', $classCustom]); $template = Support::wrapTag("<div $attribute>", $template); $template = Support::wrapTag('<script id="' . $templateName . '" type="text/' . $templateName . '">', $template); $html .= $template . $codeJs; // restore parent processed FE's $this->feSpecNative = $feSpecNativeSave; //TODO: nicht klar ob das hier noetig ist. // $json = $this->getJsonElementUpdate($htmlFormElementName, $value, $formElement[FE_MODE]); return $html; } /** * Build real FormElements based on the current templateGroup FormElements in $this->feSpecNative. * Take a templateGroup 'copy', if at least one of the elements is filled with a non default value. * Stop filling elements if there are no further elements filled. * * @param int $max * @param string $htmlDelete * @param array $json * @return string * @throws CodeException * @throws \qfq\UserFormException */ private function templateGroupCollectFilledElements($max, $htmlDelete, array &$json) { $record = $this->store->getStore(STORE_RECORD); // current values if ($record === false || count($record) === 0) { return ''; } $default = $this->store->getStore(STORE_TABLE_DEFAULT); // current defaults // evaluate FE_VALUE on all templateGroup FormElements: After this call, in case of non-primary FEs, FE_VALUE // might contain an array of values for all copies of the current FE. $maxForeignRecords = $this->templateGroupDoValue(); $lastFilled = 0; // Marker if there is at least one element per copy who is filled. $feSpecNativeCopy = array(); for ($ii = 1; $ii <= $max; $ii++) { // Per copy, iterate over all templateGroup FormElements. foreach ($this->feSpecNative as $fe) { $fe[FE_NAME] = str_replace(FE_TEMPLATE_GROUP_NAME_PATTERN, $ii, $fe[FE_NAME]); $fe[FE_LABEL] = str_replace(FE_TEMPLATE_GROUP_NAME_PATTERN, $ii, $fe[FE_LABEL]); $fe[FE_NOTE] = str_replace(FE_TEMPLATE_GROUP_NAME_PATTERN, $ii, $fe[FE_NOTE]); $columnName = $fe[FE_NAME]; // Column of primary table? if (isset($record[$columnName])) { if ($record[$columnName] != $default[$columnName]) { $lastFilled = max($ii, $lastFilled); } } else { $lastFilled = max($maxForeignRecords, $lastFilled); if (is_array($fe[FE_VALUE]) && isset($fe[FE_VALUE][$ii - 1])) { $fe[FE_VALUE] = current($fe[FE_VALUE][$ii - 1]); // replace array with current value } // $fe[FE_TEMPLATE_GROUP_CURRENT_IDX] = $ii; } $feSpecNativeCopy[$ii - 1][] = $fe; // Build array with current copy of templateGroup. } // Append $htmlDelete on the last element of all copies, but not the first. if ($ii > 1) { // Count defined FormElements in the current templateGroup $last = count($feSpecNativeCopy[$ii - 1]) - 1; // Append 'delete' Button at the note of the last element $feSpecNativeCopy[$ii - 1][$last][FE_NOTE] .= $htmlDelete; } } // Nothing found: return if (count($feSpecNativeCopy) == 0) { return ''; } $feSpecNativeSave = $this->feSpecNative; $lastFilled = min($lastFilled, $max); // It's possible (external records) that there are more fetched values than the maximum allows - skip those. $html = ''; for ($ii = 0; $ii < $lastFilled; $ii++) { $this->feSpecNative = $feSpecNativeCopy[$ii]; $htmlCopy = $this->elements($this->store->getVar(SIP_RECORD_ID, STORE_SIP), FORM_ELEMENTS_NATIVE, 0, $json); $htmlCopy = Support::wrapTag('<div class="qfq-line">', $htmlCopy); $html .= $htmlCopy; } $this->feSpecNative = $feSpecNativeSave; return $html; } /** * Evaluate for all FormElements of the current templateGroup the field FE_VALUE. * If the specific FormElement is not a real column of the primary table, than the value is probably a '{{!SELECT ...' * statement, that one will be fired. * In case of an non-primary FE, the result array are the values for the copies of the specific FE. * * Additional the maximum count of all select rows will be determined and returned. * * @return int max number of records in FormElement[FE_VALUE] over all FormElements. * @throws UserFormException */ private function templateGroupDoValue() { // Fire 'value' statement $tgMax = 0; foreach ($this->feSpecNative as $key => $arr) { $this->feSpecNative[$key][FE_VALUE] = $this->evaluate->parse($arr[FE_VALUE]); if (is_array($this->feSpecNative[$key][FE_VALUE])) { $cnt = count($this->feSpecNative[$key][FE_VALUE]); $tgMax = max($cnt, $tgMax); } } return $tgMax; } abstract public function buildRowNative(array $formElement, $htmlElement, $htmlFormElementName); }