', $input . $formElement[FE_TMP_EXTRA_BUTTON_HTML]); } } $input .= $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 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[FE_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[FE_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, $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 $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 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 \qfq\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['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[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 $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[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('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 $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[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; } $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 $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[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 $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[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 $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) { $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); } $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 $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[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 = ''; $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 ($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 $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[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('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 $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[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(); for ($ii = 0; $ii < count($itemValue); $ii++) { $option .= ''; } $json = $this->getFormElementForJson($htmlFormElementName, $jsonValues, $formElement); $html = ''; $formElement = HelperFormElement::prepareExtraButton($formElement, false); $html = $html . $this->getHelpBlock() . $formElement[FE_TMP_EXTRA_BUTTON_HTML]; return $html . $formElement[FE_INPUT_EXTRA_BUTTON_INFO]; } /** * 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[FE_SUBRECORD_OPTION]); $flagEdit = Support::findInSet(SUBRECORD_EDIT, $formElement[FE_SUBRECORD_OPTION]); if ($flagDelete = Support::findInSet(SUBRECORD_DELETE, $formElement[FE_SUBRECORD_OPTION])) { $targetTableName = $this->getFormTable($formElement[SUBRECORD_PARAMETER_FORM]); } } $columns = $linkNew; if (isset($formElement[FE_SQL1][0])) { // construct column attributes $control = $this->getSubrecordColumnControl(array_keys($formElement[FE_SQL1][0])); // Subrecord: Column titles $columns .= '' . implode('', $control['title']) . ''; } if ($flagDelete) { $columns .= ''; } // Table head $html = Support::wrapTag('', $columns); foreach ($formElement[FE_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->showDebugInfoFlag) { $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("