', $input . $formElement[FE_TMP_EXTRA_BUTTON_HTML]); } } $input .= $this->getHelpBlock() . $elementCharacterCount; if (isset($formElement[FE_INPUT_EXTRA_BUTTON_INFO])) { $input .= $formElement[FE_INPUT_EXTRA_BUTTON_INFO]; } return $input; } /** * 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 CodeException * @throws UserFormException */ private function typeAheadBuildParam(array &$formElement) { $arr = []; $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]); $formElement[FE_TYPEAHEAD_SQL_PREFETCH] = Support::setIfNotSet($formElement, FE_TYPEAHEAD_SQL_PREFETCH); $arr = [ FE_TYPEAHEAD_SQL => $sql, FE_TYPEAHEAD_SQL_PREFETCH => $formElement[FE_TYPEAHEAD_SQL_PREFETCH] ]; } 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); } } return OnArray::toString($arr); } /** * Checks if $sql contains a SELECT statement. * Check for existence of a LIMIT Parameter. If not found add one. * * @param string $sql * @param int $limit * * @return string Checked and maybe extended $sql statement. * @throws \qfq\UserFormException */ private function checkSqlAppendLimit($sql, $limit) { $sqlTest = ''; $sql = trim($sql); if ($sql[0] == '[') { // Remove optional existing dbIndex token. $pos = strpos($sql, ']'); $sqlTest = substr($sql, $pos + 1); } else { $sqlTest = $sql; } if (false === stristr(substr($sqlTest, 0, 7), 'SELECT ')) { throw new UserFormException("Expect a SELECT statement in " . FE_TYPEAHEAD_SQL . " - got: " . $sqlTest, ERROR_BROKEN_PARAMETER); } if (false === stristr($sql, ' LIMIT ')) { $sql .= " LIMIT $limit"; } return $sql; } /** * Builds a HTML attribute list, based on $attributeList. * * E.g.: attributeList: [ 'type', 'autofocus' ] * generates: 'type="$formElement[FE_TYPE]" autofocus="$formElement[FE_AUTOFOCUS]" ' * * @param array $formElement * @param array $attributeList * @param bool $flagOmitEmpty * * @return string * @throws CodeException */ 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; } /** * Set corresponding html attributes readonly/required/disabled, based on $formElement[FE_MODE]. * * @param string $feMode * * @param bool $cssDisable * @return string * @throws CodeException * @throws UserFormException */ private function getAttributeFeMode($feMode, $cssDisable = true) { $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); if ($cssDisable) { $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 string $htmlFormElementName * @param string $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE* * * @return string * @throws CodeException * @throws 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 meaningful 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); } $formElement = HelperFormElement::prepareExtraButton($formElement, false); return $html . $formElement[FE_TMP_EXTRA_BUTTON_HTML] . $this->getHelpBlock() . $formElement[FE_INPUT_EXTRA_BUTTON_INFO]; } /** * 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 array $itemKey * @param array $itemValue * * @throws CodeException * @throws UserFormException */ public function getKeyValueListFromSqlEnumSpec(array $formElement, array &$itemKey, array &$itemValue) { $fieldType = ''; $itemKey = array(); $itemValue = array(); // Call getItemsForEnumOrSet() only if there a corresponding column really exist. if (false !== $this->store->getVar($formElement[FE_NAME], STORE_TABLE_COLUMN_TYPES)) { $itemValue = $this->getItemsForEnumOrSet($formElement[FE_NAME], $fieldType); } if (is_array($formElement[FE_SQL1])) { if (count($formElement[FE_SQL1]) > 0) { $keys = array_keys($formElement[FE_SQL1][0]); $itemKey = array_column($formElement[FE_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[FE_SQL1], $keys[0]); } $itemValue = array_column($formElement[FE_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[FE_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[FE_NAME], $fieldType);' } elseif (isset($formElement[FE_CHECKBOX_CHECKED]) && $formElement[FE_TYPE] == FE_TYPE_CHECKBOX) { // Nothing to do here. } 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[FE_EMPTY_ITEM_AT_START])) { $placeholder = isset($formElement[FE_PLACEHOLDER]) ? $formElement[FE_PLACEHOLDER] : ''; array_unshift($itemKey, ''); array_unshift($itemValue, $placeholder); } if (isset($formElement[FE_EMPTY_ITEM_AT_END])) { $itemKey[] = ''; $itemValue[] = ''; } } /** * Get the attribute definition list of an enum or set column. For strings, get the default value. Return * elements as an array. * * @param string $column * @param string $fieldType * * @return array * @throws CodeException * @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 CodeException * @throws UserFormException */ private function prepareCheckboxCheckedUncheckedValue(array $itemKey, array &$formElement) { if (!isset($formElement[FE_CHECKBOX_CHECKED])) { if (isset($itemKey[0])) { // First element in $itemKey list $formElement[FE_CHECKBOX_CHECKED] = $itemKey[0]; } else { // Take column default value $formElement[FE_CHECKBOX_CHECKED] = $this->store->getVar($formElement[FE_NAME], STORE_TABLE_DEFAULT); } } // unchecked if (!isset($formElement[FE_CHECKBOX_UNCHECKED])) { if (isset($itemKey[1])) { $formElement[FE_CHECKBOX_UNCHECKED] = ($itemKey[0] === $formElement[FE_CHECKBOX_CHECKED]) ? $itemKey[1] : $itemKey[0]; } else { $formElement[FE_CHECKBOX_UNCHECKED] = ''; } } if ($formElement[FE_CHECKBOX_CHECKED] === $formElement[FE_CHECKBOX_UNCHECKED]) { throw new UserFormException('FormElement: type=checkbox - checked and unchecked can\'t be the same: ' . $formElement[FE_CHECKBOX_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 string $htmlFormElementName * @param $attribute * @param string $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * * @return string * @throws CodeException * @throws 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. * * * * @param array $formElement * @param string $htmlFormElementName * @param string $attribute * @param string $value * @param array $json * * @return string * @throws CodeException * @throws UserFormException */ 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[FE_CHECKBOX_CHECKED], false); $attribute .= Support::doAttribute('title', $formElement[FE_TOOLTIP]); $attribute .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : ''); $attribute .= Support::doAttribute(FE_INPUT_AUTOCOMPLETE, 'off'); $classActive = ''; if ($formElement[FE_CHECKBOX_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[FE_CHECKBOX_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 string $htmlFormElementName * @param string $attribute * @param string $value * @param array $json * * @return string * @throws CodeException * @throws UserFormException */ 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[FE_CHECKBOX_CHECKED], false); $attribute .= Support::doAttribute('title', $formElement[FE_TOOLTIP]); $attribute .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : ''); if ($formElement[FE_CHECKBOX_CHECKED] === $value) { $attribute .= Support::doAttribute('checked', 'checked'); // $valueJson = true; $valueJson = $value; } $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[FE_CHECKBOX_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 string $htmlFormElementName * @param $attributeBase * @param string $value * @param array $itemKey * @param array $itemValue * @param array $json * @return string * @throws CodeException * @throws 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 string $htmlFormElementName * @param string $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 string $htmlFormElementName * @param string $attributeBase * @param string $value * @param array $itemKey * @param array $itemValue * @param array $json * * @return string * @throws CodeException * @throws UserFormException */ 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[FE_AUTOFOCUS])) { $attribute .= Support::doAttribute('autofocus', $formElement[FE_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 string $htmlFormElementName * @param string $attributeBase * @param string $value * @param array $itemKey * @param array $itemValue * @param array $json * * @return string * @throws CodeException * @throws UserFormException */ 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[FE_AUTOFOCUS])) $attribute .= Support::doAttribute('autofocus', $formElement[FE_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 string $htmlFormElementName * @param string $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * * @return string * @throws CodeException * @throws UserFormException */ public function buildExtra(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { if ($mode === FORM_LOAD) { $this->store->setVar($formElement[FE_NAME], $value, STORE_SIP, false); } return; } /** * Build HTML 'radio' element. * * Format: * * * @param array $formElement * @param string $htmlFormElementName * @param string $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * * @return string * @throws CodeException * @throws 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); } $formElement = HelperFormElement::prepareExtraButton($formElement, false); return $html . $formElement[FE_TMP_EXTRA_BUTTON_HTML] . $this->getHelpBlock() . $formElement[FE_INPUT_EXTRA_BUTTON_INFO]; } /** * Build Bootstrap Button 'radio' element. * *

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

* * @param array $formElement * @param string $htmlFormElementName * @param string $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * * @return string * @throws CodeException * @throws 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(FE_INPUT_AUTOCOMPLETE, 'off'); $attribute = $attributeBase; if (isset($formElement[FE_AUTOFOCUS])) { $attribute .= Support::doAttribute('autofocus', $formElement[FE_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 = ''; $classReadonly = ''; $attribute .= Support::doAttribute('id', $formElement[FE_HTML_ID] . '-' . $ii); $attribute .= Support::doAttribute('value', $itemKey[$ii], false); // Always set value, even to '' - #3832 $attribute .= Support::doAttribute('title', $formElement[FE_TOOLTIP]); if ($itemKey[$ii] == $value) { $attribute .= Support::doAttribute('checked', 'checked'); $classActive = ' active'; } if ($formElement[FE_MODE] == FE_MODE_READONLY) { $classReadonly = ' noclick'; if ($itemKey[$ii] != $value) { $classReadonly .= ' disabled'; } } if ($itemValue[$ii] == '') { // In case the value is empty, the rendered button looks bad. Set ' '. $itemValue[$ii] = ' '; } $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 string $htmlFormElementName * @param string $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * * @return string * @throws CodeException * @throws 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('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[FE_AUTOFOCUS])) { $attribute .= Support::doAttribute('autofocus', $formElement[FE_AUTOFOCUS]); } $html = $this->buildNativeHidden($htmlFormElementName, $value); for ($ii = 0; $ii < count($itemValue); $ii++) { $jj++; $attribute .= Support::doAttribute('id', $formElement[FE_HTML_ID] . '-' . $ii); $attribute .= Support::doAttribute('value', $itemKey[$ii], false); // Always set value, even to '' - #3832 $attribute .= Support::doAttribute('title', $formElement[FE_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 string $htmlFormElementName * @param string $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * * @return mixed * @throws CodeException * @throws UserFormException */ public function buildSelect(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { $itemKey = array(); $itemValue = array(); $attribute = ''; if (!empty($formElement[FE_PLACEHOLDER])) { $formElement[FE_EMPTY_ITEM_AT_START] = ''; if (isset($formElement[FE_EMPTY_ITEM_AT_END])) { unset($formElement[FE_EMPTY_ITEM_AT_END]); } } // Fill $itemKey & $itemValue $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue); $attribute .= Support::doAttribute('id', $formElement[FE_HTML_ID]); $attribute .= Support::doAttribute('name', $htmlFormElementName); $attribute .= Support::doAttribute('class', 'form-control'); $attribute .= Support::doAttribute('title', $formElement[FE_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[FE_SIZE]) && $formElement[FE_SIZE] > 1) { $attribute .= Support::doAttribute('size', $formElement[FE_SIZE]); $attribute .= Support::doAttribute('multiple', 'multiple'); } $option = ''; $firstSelect = true; $jsonValues = array(); $total = count($itemValue); for ($ii = 0; $ii < $total; $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); $formElement = HelperFormElement::prepareExtraButton($formElement, false); $attribute .= $this->getAttributeFeMode($formElement[FE_MODE]); $html = '' . $option . ''; $html = $html . $this->getHelpBlock() . $formElement[FE_TMP_EXTRA_BUTTON_HTML]; return $html . $formElement[FE_INPUT_EXTRA_BUTTON_INFO]; } /** * @param string $linkNew Complete Button, incl. SIP href * @param bool $flagDelete Flag to show if there is columns 'delete' rendered. * @param array $firstRow First row of all subrecords to extract columntitles * @param array $control Array with column names / format. * * @return string * @throws UserFormException */ private function subrecordHead($linkNew, $flagDelete, array $firstRow, array &$control) { $columns = $linkNew; if (!empty($firstRow)) { // construct column attributes $control = $this->getSubrecordColumnControl(array_keys($firstRow)); // Subrecord: Column titles $columns .= '' . implode('', $control[SUBRECORD_COLUMN_TITLE]) . ''; } if ($flagDelete) { $columns .= ''; } return Support::wrapTag('', $columns); } /** * Construct a HTML table of the subrecord data. * Column syntax * definition:https://docs.typo3.org/typo3cms/drafts/github/T3DocumentationStarter/Public-Info-053/Manual.html#type-subrecord * * @param array $formElement * @param string $htmlFormElementName * @param string $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * * @return string * @throws CodeException * @throws UserFormException * @throws UserReportException */ 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); $cssClassColumnId = $this->store->getVar(SYSTEM_CSS_CLASS_COLUMN_ID, STORE_SYSTEM . STORE_EMPTY); if (!$this->prepareSubrecord($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]; // Decode settings in subrecordOption $flagNew = Support::findInSet(SUBRECORD_NEW, $formElement[FE_SUBRECORD_OPTION]) && ($formElement[FE_MODE] != FE_MODE_READONLY); $flagEdit = Support::findInSet(SUBRECORD_EDIT, $formElement[FE_SUBRECORD_OPTION]); $flagDelete = Support::findInSet(SUBRECORD_DELETE, $formElement[FE_SUBRECORD_OPTION]) && ($formElement[FE_MODE] != FE_MODE_READONLY); $linkNew = $flagNew ? Support::wrapTag('', $this->createFormLink($formElement, 0, $primaryRecord, $this->symbol[SYMBOL_NEW], 'New')) : ''; } $firstRow = isset($formElement[FE_SQL1][0]) ? $formElement[FE_SQL1][0] : array(); $htmlHead = $this->subrecordHead($linkNew, $flagDelete, $firstRow, $control); $htmlBody = ''; foreach ($formElement[FE_SQL1] as $row) { $rowHtml = ''; if ($flagEdit) { $toolTip = ($formElement[FE_MODE] == FE_MODE_READONLY) ? 'Show' : 'Edit'; $symbol = ($formElement[FE_MODE] == FE_MODE_READONLY) ? $this->symbol[SYMBOL_SHOW] : $this->symbol[SYMBOL_EDIT]; $rowHtml .= Support::wrapTag('', $this->createFormLink($formElement, $row[$nameColumnId], $primaryRecord, $symbol, $toolTip, $row)); } elseif ($flagNew) { $rowHtml .= Support::wrapTag('', $rowHtml, false); } // All columns foreach ($row as $columnName => $value) { if (isset($control[SUBRECORD_COLUMN_TITLE][$columnName])) { $rowHtml .= Support::wrapTag("", $this->renderCell($control, $columnName, $value, $cssClassColumnId)); } } if ($flagDelete) { $toolTip = 'Delete'; if ($this->showDebugInfoFlag) { $toolTip .= PHP_EOL . "form = '" . $formElement[F_FINAL_DELETE_FORM] . "'" . PHP_EOL . "r = '" . $row[$nameColumnId] . "'"; } $s = $this->createDeleteUrl($formElement[F_FINAL_DELETE_FORM], $row[$nameColumnId], RETURN_SIP); $rowHtml .= Support::wrapTag('', Support::wrapTag("", '')); } Support::setIfNotSet($row, SUBRECORD_COLUMN_ROW_CLASS); $rowClass = 'record '; $rowClass .= $row[SUBRECORD_COLUMN_ROW_CLASS]; $rowTooltip = ''; if (isset($row[SUBRECORD_COLUMN_ROW_TOOLTIP])) { $rowTooltip = $row[SUBRECORD_COLUMN_ROW_TOOLTIP]; } elseif (isset($row[SUBRECORD_COLUMN_ROW_TITLE])) { // backward compatibility $rowTooltip = $row[SUBRECORD_COLUMN_ROW_TITLE]; } $rowAttribute = Support::doAttribute('class', $rowClass); $rowAttribute .= Support::doAttribute('title', $rowTooltip); $htmlBody .= Support::wrapTag("", $rowHtml, true); } $attribute = Support::doAttribute('class', $formElement[FE_SUBRECORD_TABLE_CLASS]); return Support::wrapTag("", $htmlHead . Support::wrapTag('', $htmlBody), 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 array $formElement * @param array $primaryRecord * @param string $rcText * @param string $nameColumnId * * @return bool * @throws \qfq\UserFormException */ private function prepareSubrecord(array $formElement, array $primaryRecord, &$rcText, &$nameColumnId) { if (!isset($primaryRecord['id'])) { $rcText = 'Please save this record first.'; return false; } if (!is_array($formElement[FE_SQL1])) { throw new UserFormException('Missing \'sql1\' Query', ERROR_MISSING_SQL1); } // No records? if (count($formElement[FE_SQL1]) == 0) { $rcText = ''; return true; } // Check if $nameColumnId column exist. if (!isset($formElement[FE_SQL1][0][$nameColumnId])) { // no: try fallback. $nameColumnId = '_id'; if (!isset($formElement[FE_SQL1][0][$nameColumnId])) { throw new UserFormException('Missing column \'id\' or \'_id\' in subrecord query', ERROR_SUBRECORD_MISSING_COLUMN_ID); } } if (!isset($formElement[FE_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 array $formElement * @param string $targetRecordId * @param array $record * * @param $symbol * @param $toolTip * @param array $currentRow * @return string * @throws CodeException * @throws UserFormException */ private function createFormLink(array $formElement, $targetRecordId, array $record, $symbol, $toolTip, $currentRow = array()) { //TODO: Umstellen auf Benutzung der Link Klasse. $queryStringArray = [ SIP_FORM => $formElement[SUBRECORD_PARAMETER_FORM], SIP_RECORD_ID => $targetRecordId, PARAM_DB_INDEX_DATA => $this->formSpec[F_DB_INDEX], ]; // Inherit current F_MODE if ($this->formSpec[F_MODE] != '') { $queryStringArray[F_MODE_GLOBAL] = $this->formSpec[F_MODE]; } // 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]; continue; } // Current row - check '$src' and '_$src' ) foreach (['', '_'] as $pre) { if (isset($currentRow[$pre . $src])) { $queryStringArray[$dest] = $currentRow[$pre . $src]; continue 2; } } $queryStringArray[$dest] = ERROR_SUBRECORD_DETAIL_COLUMN_NOT_FOUND; } } if ($this->showDebugInfoFlag) $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 string $formName * * @return string tableName for $formName * @throws CodeException * @throws DbException * @throws UserFormException */ private function getFormTable($formName) { $row = $this->dbArray[$this->dbIndexQfq]->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' * maxLength 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 SUBRECORD_COLUMN_ROW_CLASS: case SUBRECORD_COLUMN_ROW_TOOLTIP: case SUBRECORD_COLUMN_ROW_TITLE: // Backward compatibility continue 2; default: break; } $flagWidthLimit = true; $control[SUBRECORD_COLUMN_MAX_LENGTH][$columnName] = SUBRECORD_COLUMN_DEFAULT_MAX_LENGTH; // a) 'City@maxLength=40', b) 'Status@icon', c) 'Mailto@maxLength=80@nostrip' $arr = KeyValueStringParser::parse($columnName, '=', '|', KVP_IF_VALUE_EMPTY_COPY_KEY); foreach ($arr as $attribute => $value) { switch ($attribute) { case SUBRECORD_COLUMN_MAX_LENGTH: case SUBRECORD_COLUMN_NO_STRIP: case SUBRECORD_COLUMN_TITLE: case SUBRECORD_COLUMN_LINK: break; case SUBRECORD_COLUMN_ICON: case SUBRECORD_COLUMN_URL: case SUBRECORD_COLUMN_MAILTO: $flagWidthLimit = false; break; default: $attribute = is_numeric($value) ? SUBRECORD_COLUMN_MAX_LENGTH : SUBRECORD_COLUMN_TITLE; break; } $control[$attribute][$columnName] = $value; } if (!isset($control[SUBRECORD_COLUMN_TITLE][$columnName])) { $control[SUBRECORD_COLUMN_TITLE][$columnName] = ''; // Fallback: Might be wrong, but better than nothing. } // Don't render Columns starting with '_...'. if (substr($control[SUBRECORD_COLUMN_TITLE][$columnName], 0, 1) === '_') { unset($control[SUBRECORD_COLUMN_TITLE][$columnName]); // Do not render column later. continue; } // Limit title length $control[SUBRECORD_COLUMN_TITLE][$columnName] = mb_substr($control[SUBRECORD_COLUMN_TITLE][$columnName], 0, $control[SUBRECORD_COLUMN_MAX_LENGTH][$columnName]); if (!$flagWidthLimit) { $control[SUBRECORD_COLUMN_MAX_LENGTH][$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 string $columnName * @param string $columnValue * @param string $cssClassColumnId * * @return string * @throws CodeException * @throws UserFormException * @throws UserReportException */ private function renderCell(array $control, $columnName, $columnValue, $cssClassColumnId) { $link = null; switch ($columnName) { case SUBRECORD_COLUMN_ROW_CLASS: case SUBRECORD_COLUMN_ROW_TITLE: return ''; default: break; } $arr = explode('|', $columnValue); if (count($arr) == 1) { $arr[1] = $arr[0]; } if (isset($control[SUBRECORD_COLUMN_NO_STRIP][$columnName])) { $cell = $columnValue; $control[SUBRECORD_COLUMN_MAX_LENGTH][$columnName] = false; } else { $cell = strip_tags($columnValue); } if ($control[SUBRECORD_COLUMN_MAX_LENGTH][$columnName] !== false && $control[SUBRECORD_COLUMN_MAX_LENGTH][$columnName] != 0) { $cell = mb_substr($cell, 0, $control[SUBRECORD_COLUMN_MAX_LENGTH][$columnName]); } if (isset($control[SUBRECORD_COLUMN_ICON][$columnName])) { $cell = ($cell === '') ? '' : ""; } if (isset($control[SUBRECORD_COLUMN_MAILTO][$columnName])) { $cell = "$arr[1]"; } if (isset($control[SUBRECORD_COLUMN_URL][$columnName])) { $cell = "$arr[1]"; } if (isset($control[SUBRECORD_COLUMN_LINK][$columnName])) { if (!isset($link)) { $link = new Link($this->sip, $this->dbIndexData); } $cell = $link->renderLink($columnValue); } if(strcasecmp($columnName, 'id')==0){ $cell = Support::wrapTag('', $cell,true); } return $cell; } /** * Create a link (incl. SIP) to delete the current record. * * @param string $formName if there is a form, specify that * @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 ('sipUrl') and all decoded and created * parameters. * * @return string String: "API_DIR/delete.php?sip=...." * @throws CodeException * @throws UserFormException */ public function createDeleteUrl($formName, $recordId, $mode = RETURN_URL) { $urlParam = $this->store->getNonSystemSipParam(); // especially 'periodId' from calling URL should be passed to delete.php to evaluate it later. Support::appendTypo3ParameterToArray($urlParam); $urlParam[SIP_RECORD_ID] = $recordId; $urlParam[SIP_FORM] = $formName; $urlParam[SIP_MODE_ANSWER] = MODE_JSON; // $urlParam[PARAM_DB_INDEX_DATA] = $this->formSpec[F_DB_INDEX]; $queryString = Support::arrayToQueryString($urlParam); $sip = $this->store->getSipInstance(); return $sip->queryStringToSip($queryString, $mode, API_DIR . '/' . API_DELETE_PHP); } /** * Build an Upload (File) Button. * * @param array $formElement * @param string $htmlFormElementName * @param string $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * * @return string * @throws CodeException * @throws DbException * @throws UserFormException * @throws UserReportException */ public function buildFile(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { $attribute = ''; $this->store->appendToStore(HelperFile::pathinfo($value), STORE_VAR); if (empty($formElement[FE_FILE_MIME_TYPE_ACCEPT])) { $formElement[FE_FILE_MIME_TYPE_ACCEPT] = UPLOAD_DEFAULT_MIME_TYPE; } Support::setIfNotSet($formElement, FE_FILE_CAPTURE); if ($formElement[FE_FILE_CAPTURE] == FE_FILE_CAPTURE_CAMERA) { $formElement[FE_FILE_MIME_TYPE_ACCEPT] = 'image/*'; } # 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[FE_NAME]; $arr[CLIENT_FORM] = $this->formSpec[F_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]; $arr[FE_FILE_MAX_FILE_SIZE] = Support::returnBytes($arr[FE_FILE_MAX_FILE_SIZE]); if ((Support::returnBytes(ini_get('post_max_size')) < $arr[FE_FILE_MAX_FILE_SIZE]) || (Support::returnBytes(ini_get('upload_max_filesize')) < $arr[FE_FILE_MAX_FILE_SIZE]) ) { throw new UserFormException("Configured 'maxFileSize'=" . $arr[FE_FILE_MAX_FILE_SIZE] . " bigger than at least of one of the php.ini setttings 'post_max_size'=" . ini_get('post_max_size') . " or 'upload_max_filesize'=" . ini_get('upload_max_filesize'), ERROR_MAX_FILE_SIZE_TOO_BIG); } $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[FE_TOOLTIP]); $attribute .= Support::doAttribute(FE_FILE_CAPTURE, $formElement[FE_FILE_CAPTURE], true); $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); $json = $this->getFormElementForJson($htmlFormElementName, $value, $formElement); // Below, $formElement[FE_MODE]=FE_MODE_REQUIRED will be changed. Get the JSON unchanged if ($value === '' || $value === false) { $textDeleteClass = 'hidden'; $uploadClass = ''; } else { $textDeleteClass = ''; $uploadClass = 'hidden'; if ($formElement[FE_MODE] == FE_MODE_REQUIRED) { $formElement[FE_MODE] = FE_MODE_SHOW; // #4495 - Upload, which already has been uploaded should not marked as requires $attribute .= Support::doAttribute(DATA_REQUIRED, FE_MODE_REQUIRED); } // $formElement[FE_MODE] = FE_MODE_HIDDEN; // #3876, CR did not understand why we need this here. Comment. If active, this element will be hide on each dynamic update. } $attribute .= $this->getAttributeFeMode($formElement[FE_MODE]); $attribute .= Support::doAttribute('class', $uploadClass, true); // $htmlInputFile = '' . $this->getHelpBlock(); // with BS3: https://stackoverflow.com/questions/11235206/twitter-bootstrap-form-file-element-upload-button/25053973#25053973 $attribute .= Support::doAttribute('style', "display:none;"); $htmlInputFile = ''; $attributeFileLabel = Support::doAttribute('for', $formElement[FE_HTML_ID]); $attributeFileLabel .= Support::doAttribute('class', 'btn btn-default ' . $uploadClass); Support::setIfNotSet($formElement, FE_FILE_BUTTON_TEXT, FE_FILE_BUTTON_TEXT_DEFAULT); $htmlInputFile = Support::wrapTag("", $htmlInputFile . $formElement[FE_FILE_BUTTON_TEXT]); $deleteButton = Support::wrapTag("", $this->symbol[SYMBOL_DELETE]); if (Support::isEnabled($formElement, FE_FILE_DOWNLOAD_BUTTON)) { if (is_readable($value)) { $link = new Link($this->sip, $this->dbIndexData); $value = $link->renderLink('s|M:file|d|F:' . $value . '|' . $this->evaluate->parse($formElement[FE_FILE_DOWNLOAD_BUTTON])); } else { // In case debugging is off: showing download button means 'never show the real pathfilename' if (!$this->showDebugInfoFlag) { $value = ''; } $value .= " - file not found, please check field 'value'"; } } $htmlFilename = Support::wrapTag("", $value, false); $htmlTextDelete = Support::wrapTag("

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

$formElement = HelperFormElement::prepareExtraButton($formElement, false); return $htmlTextDelete . $htmlInputFile . $hiddenSipUpload . $formElement[FE_TMP_EXTRA_BUTTON_HTML] . $formElement[FE_INPUT_EXTRA_BUTTON_INFO]; } /** * Build a Fabric Annotate Element * * @param array $formElement * @param string $htmlFormElementName * @param string $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * * @return string * @throws CodeException * @throws UserFormException */ public function buildAnnotate(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { if ($mode == FORM_LOAD && !empty($formElement[FE_IMAGE_SOURCE])) { if (!is_readable($formElement[FE_IMAGE_SOURCE])) { throw new UserFormException("Error reading file: " . $formElement[FE_IMAGE_SOURCE], ERROR_IO_READ_FILE); } } if (!empty($value) && json_decode($value) === null) { throw new UserFormException("Fabric data: JSON structure not valid", ERROR_BROKEN_JSON_STRUCTURE); } // $attributeImage = Support::doAttribute('id', 'qfq-fabric-image-1'); // $attributeImage .= Support::doAttribute('src', $this->fileToSipUrl($formElement[FE_IMAGE_SOURCE])); // $attributeImage .= Support::doAttribute('class', 'qfq-fabric-image'); // $htmlImage = Support::wrapTag('', '', false); // $attributeFabric = Support::doAttribute('id', 'fabric'); $attributeFabric = Support::doAttribute('class', FABRIC_CSS_CLASS); $attributeFabric .= Support::doAttribute('data-background-image', $this->fileToSipUrl($formElement[FE_IMAGE_SOURCE])); $attributeFabric .= Support::doAttribute('data-control-name', $formElement[FE_HTML_ID]); $attributeFabric .= Support::doAttribute('data-buttons', 'typo3conf/ext/qfq/Resources/Public/Json/fabric.buttons.json'); $attributeFabric .= Support::doAttribute('data-emojis', 'typo3conf/ext/qfq/Resources/Public/Json/qfq.emoji.json'); $attributeFabric .= $this->getAttributeFeMode($formElement[FE_MODE]); $htmlFabric = Support::wrapTag('

', '', false); $attributeInput = Support::doAttribute('id', $formElement[FE_HTML_ID]); $attributeInput .= Support::doAttribute('name', $htmlFormElementName); $attributeInput .= Support::doAttribute('type', 'hidden'); $attributeInput .= Support::doAttribute('value', htmlentities($value), false); $htmlInput = Support::wrapTag('', '', false); $html = $htmlFabric . $htmlInput . $this->getHelpBlock(); // $json = $this->getFormElementForJson($htmlFormElementName, $value, $formElement); return $html; } /** * Build a Fabric ImageCut Element * * @param array $formElement * @param string $htmlFormElementName * @param string $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * * @return string * @throws CodeException * @throws UserFormException */ public function buildImageCut(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { $htmlImage = ''; if ($mode == FORM_LOAD && !empty($formElement[FE_IMAGE_SOURCE])) { if (!is_readable($formElement[FE_IMAGE_SOURCE])) { throw new UserFormException("Error reading file: " . $formElement[FE_IMAGE_SOURCE], ERROR_IO_READ_FILE); } } if ($mode === FORM_LOAD) { // Store source filename in SIP $field = HelperFormElement::AppendFormElementNameImageCut($formElement); $this->store->setVar($field, $value, STORE_SIP, false); } $htmlFabricId = $formElement[FE_HTML_ID]; $htmlFabricImageId = $formElement[FE_HTML_ID] . '-image'; $imageFileName = $this->fileToSipUrl($value); //

//

$attributeFabric = Support::doAttribute('class', FABRIC_CSS_CLASS); $attributeFabric .= Support::doAttribute('data-buttons', 'typo3conf/ext/qfq/Resources/Public/Json/fabric.editor.buttons.json'); $attributeFabric .= Support::doAttribute('data-edit-image', 'true'); $attributeFabric .= Support::doAttribute('data-background-image', $imageFileName); $attributeFabric .= Support::doAttribute('data-control-name', $htmlFabricId); if (!empty($formElement[FE_IMAGE_CUT_RESIZE_WIDTH]) && ctype_digit($formElement[FE_IMAGE_CUT_RESIZE_WIDTH])) { $attributeFabric .= Support::doAttribute('data-image-resize-width', $formElement[FE_IMAGE_CUT_RESIZE_WIDTH]); } $attributeFabric .= Support::doAttribute('data-image-output', $htmlFabricImageId); $attributeFabric .= $this->getAttributeFeMode($formElement[FE_MODE]); $htmlFabric = Support::wrapTag('

', '', false); // $attributeInput = Support::doAttribute('id', $htmlFabricId); $attributeInput .= Support::doAttribute('name', $htmlFormElementName); $attributeInput .= Support::doAttribute('type', 'hidden'); $htmlInput = Support::wrapTag('', '', false); // - this element is for future use. It's not necessary for the function and is not used yet. $attributeImage = Support::doAttribute('id', $htmlFabricImageId); $htmlImage = Support::wrapTag('', '', false); $html = $htmlFabric . $this->getHelpBlock() . $htmlInput . $htmlImage; // $tmpUrlParam[DOWNLOAD_MODE] = $this->getDownloadModeNCheck($vars); // $tmpUrlParam[DOWNLOAD_EXPORT_FILENAME] = $vars[NAME_DOWNLOAD]; // $tmpUrlParam[SIP_DOWNLOAD_PARAMETER] = base64_encode(implode(PARAM_DELIMITER, $vars[NAME_DOWNLOAD_ELEMENTS])); // $vars[NAME_URL_PARAM] = KeyValueStringParser::unparse($tmpUrlParam, '=', '&'); // $json = $this->getFormElementForJson($htmlFormElementName, $value, $formElement); return $html; } /** * @param string $pathFileName * @return string SIP encoded URL * @throws CodeException * @throws UserFormException */ private function fileToSipUrl($pathFileName) { $param[DOWNLOAD_MODE] = DOWNLOAD_MODE_FILE; $param[SIP_DOWNLOAD_PARAMETER] = base64_encode(TOKEN_FILE . PARAM_TOKEN_DELIMITER . $pathFileName); $url = $this->sip->queryStringToSip(API_DIR . '/' . API_DOWNLOAD_PHP . '?' . KeyValueStringParser::unparse($param, '=', '&'), RETURN_URL); return $url; } /** * Builds HTML 'input' element. * Format: * * @param array $formElement * @param string $htmlFormElementName * @param string $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * * @return string * @throws CodeException * @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'); $showTime = ($formElement[FE_TYPE] == 'time' || $formElement[FE_TYPE] == 'datetime') ? 1 : 0; if ($value == 'CURRENT_TIMESTAMP') { $value = date('Y-m-d H:i:s'); } $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], $formElement[FE_TIME_IS_OPTIONAL]); switch ($formElement[FE_CHECK_TYPE]) { case SANITIZE_ALLOW_PATTERN: $formElement[FE_CHECK_PATTERN] = $tmpPattern; 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); if ($formElement[FE_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': if ($formElement[FE_TIME_IS_OPTIONAL] == 1) $timePattern = "[$timePattern]"; $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[FE_PLACEHOLDER] = $placeholder; } if ($formElement[F_FE_DATA_PATTERN_ERROR] == '') $formElement[F_FE_DATA_PATTERN_ERROR] = "Please match this format: $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 .= $this->getAttributeList($formElement, [FE_INPUT_AUTOCOMPLETE, 'autofocus', 'placeholder']); $attribute .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : ''); $attribute .= Support::doAttribute('title', $formElement[FE_TOOLTIP]); $pattern = Sanitize::getInputCheckPattern($formElement[FE_CHECK_TYPE], $formElement[FE_CHECK_PATTERN], '', $rcSanitizeMessage); $attribute .= ($pattern === '') ? '' : 'pattern="' . $pattern . '" '; $attribute .= $this->getAttributeList($formElement, [FE_MIN, FE_MAX]); $json = $this->getFormElementForJson($htmlFormElementName, $value, $formElement); $formElement = HelperFormElement::prepareExtraButton($formElement, true); $attribute .= $this->getAttributeFeMode($formElement[FE_MODE]); $input = "" . $this->getHelpBlock() . $formElement[FE_TMP_EXTRA_BUTTON_HTML]; if ($formElement[FE_TMP_EXTRA_BUTTON_HTML] !== '') { $input = Support::wrapTag('

', $input); } return $input . $formElement[FE_INPUT_EXTRA_BUTTON_INFO]; } /** * Builds HTML 'input' element. * Format: * * * @param array $formElement * @param string $htmlFormElementName * @param string $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * * @return string * @throws CodeException * @throws UserFormException */ public function buildDateJQW(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { $arrMinMax = null; // if ($formElement[FE_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[FE_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); // } $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[FE_PLACEHOLDER]); $attribute .= Support::doAttribute('data-value', htmlentities($value), false); // $attribute .= Support::doAttribute('data-autofocus', $formElement[FE_AUTOFOCUS]); $attribute .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : ''); $attribute .= Support::doAttribute('data-title', $formElement[FE_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 string $htmlFormElementName * @param string $value * @param array $json * @param string $mode * * @return string * @throws CodeException * @throws UserFormException */ public function buildEditor(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { $attribute = ''; //TODO plugin autoresize nutzen um Editorgroesse anzugeben $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[FE_PLACEHOLDER]); // $attribute .= Support::doAttribute('data-autofocus', $formElement[FE_AUTOFOCUS]); $attribute .= Support::doAttribute('data-load', ($formElement[FE_DYNAMIC_UPDATE] === 'yes') ? 'data-load' : ''); $attribute .= Support::doAttribute('data-title', $formElement[FE_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); $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); $html = Support::wrapTag("", htmlentities($value), false); $formElement = HelperFormElement::prepareExtraButton($formElement, false); return $html . $this->getHelpBlock() . $formElement[FE_TMP_EXTRA_BUTTON_HTML] . $formElement[FE_INPUT_EXTRA_BUTTON_INFO]; } /** * Parse $formElement[FE_EDITOR_*] settings and build editor settings. * * @param array $formElement * @param string $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[FE_AUTOFOCUS]) && $formElement[FE_AUTOFOCUS] == 'yes') { $formElement[FE_EDITOR_PREFIX . 'auto_focus'] = $htmlFormElementName; } // Check for min_height, max_height $minMax = explode(',', $formElement[FE_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 string $htmlFormElementName * @param string $value * @param string $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 string $htmlFormElementName * @param string $value * @param array $json * * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * @return mixed * @throws CodeException * @throws UserFormException */ public function buildNote(array $formElement, $htmlFormElementName, $value, array &$json, $mode = FORM_LOAD) { $json = $this->getFormElementForJson($htmlFormElementName, $value, $formElement); $attribute = Support::doAttribute('id', $formElement[FE_HTML_ID] . HTML_ID_EXTENSION_INPUT); return Support::wrapTag("<div $attribute class='" . CLASS_NOTE . "'>", $value); } /** * Build Pill. * * @param array $formElement * @param string $htmlFormElementName * @param string $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 string $htmlFormElementName * @param string $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * * @return mixed * @throws CodeException * @throws DbException * @throws UserFormException * @throws UserReportException */ 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->dbArray[$this->dbIndexQfq]->getNativeFormElements(SQL_FORM_ELEMENT_SPECIFIC_CONTAINER, ['yes', $this->formSpec["id"], 'native,container', $formElement[FE_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 int $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 string $htmlFormElementName * @param string $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * * @return mixed * @throws CodeException * @throws DbException * @throws UserFormException * @throws UserReportException */ 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->dbArray[$this->dbIndexQfq]->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) { // Nothing 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 DbException * @throws UserFormException * @throws UserReportException */ 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]); $fe[FE_TG_INDEX] = $ii; $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 CodeException * @throws DbException * @throws UserFormException * @throws UserReportException */ 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; } /** * @param array $formElement * @param $htmlElement * @param $htmlFormElementName * @return mixed */ abstract public function buildRowNative(array $formElement, $htmlElement, $htmlFormElementName); }