formSpec['class'], TRUE) . '>'; // main

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

Edit [$sipParamString]

"; $html .= $this->wrapItem(WRAP_SETUP_TITLE, $this->formSpec['title'], true); $html .= $this->getFormTag(); return $html; } /** * If SHOW_DEBUG_INFO=yes: create a link (incl. SIP) to edit the current form. Show also the hidden content of the SIP. * * @return string String: Edit [sip:..., r:..., urlparam:..., ...] */ public function createFormEditUrl() { if (!$this->showDebugInfo) { return ''; } $queryStringArray = [ 'id' => $this->store->getVar(TYPO3_PAGE_ID, STORE_TYPO3), 'form' => 'form', 'r' => $this->formSpec['id'] ]; $queryString = Support::arrayToQueryString($queryStringArray); $sip = $this->store->getSipInstance(); $url = $sip->queryStringToSip($queryString); return $url; } /** * Wrap's $this->wrap[$item][WRAP_SETUP_START] around $value. If $flagOmitEmpty==true && $value=='': return ''. * * @param $item * @param $value * @param bool|false $flagOmitEmpty * @return string */ public function wrapItem($item, $value, $flagOmitEmpty = false) { if ($flagOmitEmpty && $value === "") return ''; return $this->wrap[$item][WRAP_SETUP_START] . $value . $this->wrap[$item][WRAP_SETUP_END]; } /** * Returns ''-tag with various attributes. * * @return string */ public function getFormTag() { $attribute = $this->getFormTagAtrributes(); return ''; } /** * Build an assoc array with standard form attributes. * * @return array */ public function getFormTagAtrributes() { $attribute['id'] = $this->getFormId(); $attribute['method'] = 'post'; $attribute['action'] = $this->getActionUrl(); $attribute['target'] = '_top'; $attribute['accept-charset'] = 'UTF-8'; $attribute['autocomplete'] = 'on'; $attribute['enctype'] = $this->getEncType(); return $attribute; } /** * @return string */ public function getFormId() { if ($this->formId === null) { $this->formId = uniqid('qfq-form-'); } return $this->formId; } /** * Builds the HTML 'form'-tag inlcuding all attributes and target. * * Notice: the SIP will be transferred as POST Parameter. * * @return string * @throws DbException */ public function getActionUrl() { return API_DIR . '/save.php'; } /** * Determines the enctype. * * See: https://www.w3.org/wiki/HTML/Elements/form#HTML_Attributes * * @return string * @throws DbException */ public function getEncType() { $result = $this->db->sql("SELECT id FROM FormElement AS fe WHERE fe.formId=? AND fe.type='upload' LIMIT 1", ROW_REGULAR, [$this->formSpec['id']], 'Look for Formelement.type="upload"'); return (count($result) === 1) ? 'multipart/form-data' : 'application/x-www-form-urlencoded'; } abstract public function tail(); abstract public function doSubrecords(); abstract public function getProcessFilter(); /** * Process all FormElements: build corresponding HTML code. Collect and return all HTML code. * * @param $recordId * @param string $filter FORM_ELEMENTS_NATIVE | FORM_ELEMENTS_SUBRECORD | FORM_ELEMENTS_NATIVE_SUBRECORD * @param int $feIdContainer * @param array $json * @param string $modeCollectFe * @param bool $htmlElementNameIdZero * @param string $storeUse * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * @return string * @throws CodeException * @throws DbException * @throws \qfq\UserFormException */ public function elements($recordId, $filter = FORM_ELEMENTS_NATIVE, $feIdContainer = 0, array &$json, $modeCollectFe = FLAG_DYNAMIC_UPDATE, $htmlElementNameIdZero = false, $storeUse = STORE_USE_DEFAULT, $mode = FORM_LOAD) { $html = ''; $flagOutput = false; // get current data record if ($recordId > 0 && $this->store->getVar('id', STORE_RECORD) === false) { $row = $this->db->sql("SELECT * FROM " . $this->formSpec[F_TABLE_NAME] . " WHERE id = ?", ROW_EXPECT_1, array($recordId)); $this->store->setVarArray($row, STORE_RECORD); } // Iterate over all FormElements foreach ($this->feSpecNative as $fe) { if (($filter === FORM_ELEMENTS_NATIVE && $fe[FE_TYPE] === 'subrecord') || ($filter === FORM_ELEMENTS_SUBRECORD && $fe[FE_TYPE] !== 'subrecord') // || ($filter === FORM_ELEMENTS_DYNAMIC_UPDATE && $fe['dynamicUpdate'] === 'no') ) { continue; // skip this FE } $flagOutput = ($fe[FE_TYPE] !== FE_TYPE_EXTRA); $debugStack = array(); // Preparation for Log, Debug $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($fe), STORE_SYSTEM); // evaluate current FormElement $formElement = $this->evaluate->parseArray($fe, $debugStack); // Some Defaults $formElement = Support::setFeDefaults($formElement); if ($flagOutput === true) { Support::setIfNotSet($formElement, F_BS_LABEL_COLUMNS); Support::setIfNotSet($formElement, F_BS_INPUT_COLUMNS); Support::setIfNotSet($formElement, F_BS_NOTE_COLUMNS); $label = ($formElement[F_BS_LABEL_COLUMNS] == '') ? $this->formSpec[F_BS_LABEL_COLUMNS] : $formElement[F_BS_LABEL_COLUMNS]; $input = ($formElement[F_BS_INPUT_COLUMNS] == '') ? $this->formSpec[F_BS_INPUT_COLUMNS] : $formElement[F_BS_INPUT_COLUMNS]; $note = ($formElement[F_BS_NOTE_COLUMNS] == '') ? $this->formSpec[F_BS_NOTE_COLUMNS] : $formElement[F_BS_NOTE_COLUMNS]; $this->fillWrapLabelInputNote($label, $input, $note); } // Get default value $value = ($formElement['value'] === '') ? $this->store->getVar($formElement['name'], $storeUse, $formElement['checkType']) : $formElement['value']; // Typically: $htmlElementNameIdZero = true // After Saving a record, staying on the form, the FormElements on the Client are still known as ':0'. $htmlFormElementId = HelperFormElement::buildFormElementName($formElement['name'], ($htmlElementNameIdZero) ? 0 : $recordId); // Construct Marshaller Name: buildElement $buildElementFunctionName = 'build' . $this->buildElementFunctionName[$formElement[FE_TYPE]]; $jsonElement = array(); // Render pure element $elementHtml = $this->$buildElementFunctionName($formElement, $htmlFormElementId, $value, $jsonElement, $mode); // $fake0 = $fe['dynamicUpdate']; // $fake1 = $formElement['dynamicUpdate']; // container elements do not have dynamicUpdate='yes'. Instead they deliver nested elements. if ($formElement['class'] == 'container') { if (count($jsonElement) > 0) { $json = array_merge($json, $jsonElement); } } else { // for non container elements: just add the current json status if ($modeCollectFe === FLAG_ALL || ($modeCollectFe == FLAG_DYNAMIC_UPDATE && $fe['dynamicUpdate'] == 'yes')) { if (isset($jsonElement[0]) && is_array($jsonElement[0])) { // Checkboxes are delivered as array of arrays: unnest them and append them to the existing json array. $json = array_merge($json, $jsonElement); } else { $json[] = $jsonElement; } } } if ($flagOutput) { // debugStack as Tooltip if ($this->showDebugInfo && count($debugStack) > 0) { $elementHtml = Support::appendTooltip($elementHtml, implode("\n", $debugStack)); } // Construct Marshaller Name: buildRow $buildRowName = 'buildRow' . $this->buildRowName[$formElement[FE_TYPE]]; $html .= $this->$buildRowName($formElement, $elementHtml, $htmlFormElementId); } } // Log / Debug: Last FormElement has been processed. $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM); return $html; } abstract public function fillWrapLabelInputNote($label, $input, $note); /** * Create a hidden sip, based on latest STORE_SIP Values. Return complete HTML 'hidden' element. * * @param array $json * @return string * @throws CodeException * @throws \qfq\UserFormException */ public function buildHiddenSip(array &$json) { $sipArray = $this->store->getStore(STORE_SIP); // do not include system vars unset($sipArray[SIP_SIP]); unset($sipArray[SIP_URLPARAM]); $queryString = Support::arrayToQueryString($sipArray); $sip = $this->store->getSipInstance(); $sipValue = $sip->queryStringToSip($queryString, RETURN_SIP); $json[] = $this->getJsonElementUpdate(CLIENT_SIP, $sipValue, FE_MODE_SHOW); return $this->buildNativeHidden(CLIENT_SIP, $sipValue); } /** * @param $htmlFormElementId * @param string|array $value * @param string $feMode disabled|readonly|'' * @return array */ private function getJsonElementUpdate($htmlFormElementId, $value, $feMode) { $json = $this->getJsonFeMode($feMode); $json['form-element'] = $htmlFormElementId; $json['value'] = $value; return $json; } /** * Set corresponding JSON attributes readonly/required/disabled, based on $formElement[FE_MODE]. * * @param array $feMode * @return array * @throws UserFormException */ private function getJsonFeMode($feMode) { $this->getFeMode($feMode, $hidden, $disabled, $required); return [API_JSON_HIDDEN => $hidden === 'yes', API_JSON_DISABLED => $disabled === 'yes', API_JSON_REQUIRED => $required === 'yes']; } /** * @param $feMode * @param $hidden * @param $disabled * @param $required * @throws \qfq\UserFormException */ private function getFeMode($feMode, &$hidden, &$disabled, &$required) { $hidden = 'no'; $disabled = 'no'; $required = 'no'; switch ($feMode) { case FE_MODE_SHOW: break; case FE_MODE_REQUIRED: $required = 'yes'; break; case FE_MODE_READONLY: $disabled = 'yes'; // convert the UI status 'readonly' to the HTML/CSS status 'disabled'. break; case FE_MODE_HIDDEN: $hidden = 'yes'; break; default: throw new UserFormException("Unknown mode '$feMode'", ERROR_UNKNOWN_MODE); break; } } /** * Builds a real HTML hidden form element. Useful for checkboxes, Multiple-Select and Radios. * * @param $htmlFormElementId * @param $value * @return string */ public function buildNativeHidden($htmlFormElementId, $value) { return ''; } /** * Takes the current SIP ('form' and additional parameter), set SIP_RECORD_ID=0 and create a new 'NewRecordUrl'. * * @throws CodeException * @throws \qfq\UserFormException */ public function deriveNewRecordUrlFromExistingSip(&$toolTipNew) { $urlParam = $this->store->getStore(STORE_SIP); $urlParam[SIP_RECORD_ID] = 0; unset($urlParam[SIP_SIP]); unset($urlParam[SIP_URLPARAM]); Support::appendTypo3ParameterToArray($urlParam); $sip = $this->store->getSipInstance(); $url = $sip->queryStringToSip(OnArray::toString($urlParam)); if ($this->showDebugInfo) { //TODO: missing decoding of SIP $toolTipNew .= PHP_EOL . PHP_EOL . OnArray::toString($urlParam, ' = ', PHP_EOL, "'"); } return $url; } abstract public function buildRowNative(array $formElement, $htmlElement, $htmlFormElementId); abstract public function buildRowPill(array $formElement, $elementHtml); abstract public function buildRowFieldset(array $formElement, $elementHtml); abstract public function buildRowSubrecord(array $formElement, $elementHtml); /** * Builds a label, typically for an html-''-element. * * @param string $htmlFormElementId * @param string $label * @return string */ public function buildLabel($htmlFormElementId, $label) { $attributes = Support::doAttribute('for', $htmlFormElementId); $attributes .= Support::doAttribute('class', 'control-label'); $html = Support::wrapTag("", $label); return $html; } /** * Builds HTML 'input' element. * Format: * * * @param array $formElement * @param $htmlFormElementId * @param $value * @param array $json * @param string $mode FORM_LOAD | FORM_UPDATE | FORM_SAVE * @return string * @throws \qfq\UserFormException */ public function buildInput(array $formElement, $htmlFormElementId, $value, array &$json, $mode = FORM_LOAD) { $textarea = ''; $attribute = Support::doAttribute('name', $htmlFormElementId); $attribute .= Support::doAttribute('class', 'form-control'); // Check for input type 'textarea' $colsRows = explode(',', $formElement['size'], 2); if (count($colsRows) === 2) { // '; } else { $htmlTag = 'adjustMaxLength($formElement); if ($formElement['maxLength'] > 0 && $value !== '') { // crop string only if it's not empty (substr returns false on empty strings) $value = substr($value, 0, $formElement['maxLength']); } // 'maxLength' needs an upper 'L': naming convention for DB tables! $attribute .= $this->getAttributeList($formElement, ['type', 'size', 'maxLength']); $attribute .= Support::doAttribute('value', htmlentities($value), false); } $attribute .= $this->getAttributeList($formElement, ['autocomplete', 'autofocus', 'placeholder']); $attribute .= Support::doAttribute('data-load', ($formElement['dynamicUpdate'] === 'yes') ? 'data-load' : ''); $attribute .= Support::doAttribute('title', $formElement['tooltip']); $attribute .= $this->getInputCheckPattern($formElement['checkType'], $formElement['checkPattern']); $attribute .= $this->getAttributeFeMode($formElement[FE_MODE]); $json = $this->getJsonElementUpdate($htmlFormElementId, $value, $formElement[FE_MODE]); return "$htmlTag $attribute>$textarea" . $this->getHelpBlock(); } /** * @param array $formElement */ private function adjustMaxLength(array &$formElement) { // MIN( $formElement['maxLength'], tabledefinition) $maxLength = $this->getColumnSize($formElement['name']); switch ($formElement[FE_TYPE]) { case 'date': $feMaxLength = 10; break; case 'datetime': $feMaxLength = 19; break; case 'time': $feMaxLength = 8; break; default: $feMaxLength = false; break; } // In case the underlying tablecolumn is not of type date/time, the $maxLength might be to high: correct if ($feMaxLength !== false && $maxLength !== false && $feMaxLength < $maxLength) { $maxLength = $feMaxLength; } // date/datetime if ($maxLength !== false) { if (is_numeric($formElement['maxLength']) && $formElement['maxLength'] != 0) { if ($formElement['maxLength'] > $maxLength) { $formElement['maxLength'] = $maxLength; } } else { $formElement['maxLength'] = $maxLength; } } } /** * Get column spec from tabledefinition and parse size of it. If nothing defined, return false. * * @param $column * @return bool|int a) 'false' if there is no length definition, b) length definition, c) date|time|datetime|timestamp use hardcoded length */ private function getColumnSize($column) { $matches = array(); $typeSpec = $this->store->getVar($column, STORE_TABLE_COLUMN_TYPES); switch ($typeSpec) { case 'date': // yyyy-mm-dd return 10; case 'datetime': // yyyy-mm-dd hh:mm:ss case 'timestamp': // yyyy-mm-dd hh:mm:ss return 19; case 'time': // hh:mm:ss return 8; default: if (substr($typeSpec, 0, 4) === 'set(' || substr($typeSpec, 0, 5) === 'enum(') { return $this->maxLengthSetEnum($typeSpec); } break; } // e.g.: string(64) >> 64, enum('yes','no') >> false if (1 === preg_match('/$(.+)$/', $typeSpec, $matches)) { if (is_numeric($matches[1])) return $matches[1]; } return false; } /** * Get the strlen of the longest element in enum('val1','val2',...,'valn') or set('val1','val2',...,'valn') * * @param string $typeSpec * @return int */ private function maxLengthSetEnum($typeSpec) { $startPos = (substr($typeSpec, 0, 4) === 'set(') ? 4 : 5; $max = 0; $valueList = substr($typeSpec, $startPos, strlen($typeSpec) - $startPos - 1); $valueArr = explode(',', $valueList); foreach ($valueArr as $value) { $value = trim($value, "'"); $len = strlen($value); if ($len > $max) { $max = $len; } } return $max; } /** * Builds a HTML attribute list, based on $attributeList. * * E.g.: attributeList: [ 'type', 'autofocus' ] * generates: 'type="$formElement[FE_TYPE]" autofocus="$formElement['autofocus']" ' * * @param array $formElement * @param array $attributeList * @return string */ private function getAttributeList(array $formElement, array $attributeList) { $attribute = ''; foreach ($attributeList as $item) { if (isset($formElement[$item])) $attribute .= Support::doAttribute(strtolower($item), $formElement[$item]); } return $attribute; } /** * Construct HTML Input attribute for Client Validation: * * type data result * ------- ----------------------- ------------------------------------------------------------------------------- * min|max | min="$attrData[0]"|max="$attrData[1]" * pattern pattern="$data" * digit - pattern="^[0-9]*$" * email - pattern="^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\.[a-z]{2,4})$" * alnumx - * * For 'min/max' and 'pattern' the 'data' will be injected in the attribute string via '%s'. * * @param $type * @param $data * @return string * @throws \qfq\UserFormException */ private function getInputCheckPattern($type, $data) { $attribute = ''; if ($type === '') { return ''; } switch ($type) { case SANITIZE_ALLOW_MIN_MAX: case SANITIZE_ALLOW_MIN_MAX_DATE: $arrData = explode("|", $data); if (count($arrData) != 2 || $arrData[0] == '' || $arrData[1] == '') throw new UserFormException("Missing MIN|MAX values", ERROR_MISSING_MIN_MAX); $attribute = 'min="' . $arrData[0] . '" '; $attribute .= 'max="' . $arrData[1] . '" '; break; case SANITIZE_ALLOW_PATTERN: $attribute = 'pattern="' . $data . '" '; break; case SANITIZE_ALLOW_ALL: break; default: $attribute = 'pattern="' . $this->inputCheckPattern[$type] . '" '; break; } return $attribute; } /** * Set corresponding html attributes readonly/required/disabled, based on $formElement[FE_MODE]. * * @param string $feMode * @return string * @throws UserFormException */ private function getAttributeFeMode($feMode) { $attribute = ''; $this->getFeMode($feMode, $hidden, $disabled, $required); switch ($feMode) { case FE_MODE_HIDDEN: case FE_MODE_SHOW: break; case FE_MODE_REQUIRED: case FE_MODE_READONLY: $attribute .= Support::doAttribute($feMode, $feMode); break; default: throw new UserFormException("Unknown mode '$feMode'", ERROR_UNKNOWN_MODE); break; } // Attributes: data-... $attribute .= Support::doAttribute(DATA_HIDDEN, $hidden); $attribute .= Support::doAttribute(DATA_DISABLED, $disabled); $attribute .= Support::doAttribute(DATA_REQUIRED, $required); return $attribute; } /** * @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 $htmlFormElementId * @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, $htmlFormElementId, $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') { // $htmlFormElementId .= '[]'; } else { // Fill meaningfull defaults to parameter: checked|unchecked (CHECKBOX_VALUE_CHECKED|CHECKBOX_VALUE_UNCHECKED) $this->prepareCheckboxCheckedUncheckedValue($itemKey, $formElement); } $attributeBase = $this->getAttributeFeMode($formElement[FE_MODE]); $attributeBase .= Support::doAttribute('type', $formElement[FE_TYPE]); switch ($formElement['checkBoxMode']) { case 'single': $html = $this->buildCheckboxSingle($formElement, $htmlFormElementId, $attributeBase, $value, $json); break; case 'multi'; $html = $this->buildCheckboxMulti($formElement, $htmlFormElementId, $attributeBase, $value, $itemKey, $itemValue, $json); break; default: throw new UserFormException('checkBoxMode: \'' . $formElement['checkBoxMode'] . '\' is unknown.', ERROR_CHECKBOXMODE_UNKNOWN); } return $html; } /** * Look for key/value list (in this order, first match counts) in * a) `sql1` * b) `parameter:itemList` * c) table.column definition * * Copies the found keys to &$itemKey and the values to &$itemValue * If there are no &$itemKey, copy &$itemValue to &$itemKey. * * @param array $formElement * @param $itemKey * @param $itemValue * @throws CodeException * @throws \qfq\UserFormException */ public function getKeyValueListFromSqlEnumSpec(array $formElement, &$itemKey, &$itemValue) { $fieldType = ''; $itemKey = array(); $itemValue = array(); if (count($formElement) < 20) throw new CodeException("Invalid (none or to small) Formelement", ERROR_MISSING_FORMELEMENT); // Call getItemsForEnumOrSet() only if there a corresponding column really exist. if (false !== $this->store->getVar($formElement['name'], STORE_TABLE_COLUMN_TYPES)) { $itemValue = $this->getItemsForEnumOrSet($formElement['name'], $fieldType); } if (is_array($formElement['sql1'])) { if (count($formElement['sql1']) > 0) { $keys = array_keys($formElement['sql1'][0]); $itemKey = array_column($formElement['sql1'], 'id'); // If there is no column 'id' and at least two columns in total if (count($itemKey) === 0 && count($keys) >= 2) { $itemKey = array_column($formElement['sql1'], $keys[0]); } $itemValue = array_column($formElement['sql1'], 'label'); // If there is no column 'label' (e.g.: SHOW tables) if (count($itemValue) === 0) { $idx = count($keys) == 1 ? 0 : 1; $itemValue = array_column($formElement['sql1'], $keys[$idx]); } } } elseif (isset($formElement['itemList']) && strlen($formElement['itemList']) > 0) { $arr = KeyValueStringParser::parse($formElement['itemList'], ':', ',', KVP_IF_VALUE_EMPTY_COPY_KEY); $itemValue = array_values($arr); $itemKey = array_keys($arr); } elseif ($fieldType === 'enum' || $fieldType === 'set') { // already done at the beginning with '$this->getItemsForEnumOrSet($formElement['name'], $fieldType);' } else { throw new UserFormException("Missing definition (- nothing found in 'sql1', 'parameter:itemValues', 'enum-' or 'set-definition'", ERROR_MISSING_ITEM_VALUES); } if (count($itemKey) === 0) { $itemKey = $itemValue; } if (isset($formElement['emptyItemAtStart'])) { array_unshift($itemKey, ''); array_unshift($itemValue, ''); } if (isset($formElement['emptyItemAtEnd'])) { $itemValue[] = ''; $itemKey[] = ''; } if (isset($formElement['emptyHide'])) { if (isset($itemValue[''])) unset($itemValue['']); if (isset($itemKey[''])) unset($itemKey['']); } } /** * Get the attribute definition list of an enum or set column. For strings, get the default value. Return elements as an array. * * @param $column * @param $fieldType * @return array * @throws UserFormException */ private function getItemsForEnumOrSet($column, &$fieldType) { // Get column definition $fieldTypeDefinition = $this->store->getVar($column, STORE_TABLE_COLUMN_TYPES); if ($fieldTypeDefinition === false) { throw new UserFormException("Column '$column' unknown in table '" . $this->formSpec[F_TABLE_NAME] . "'", ERROR_DB_UNKNOWN_COLUMN); } $length = strlen($fieldTypeDefinition); // enum('... set(' switch (substr($fieldTypeDefinition, 0, 4)) { case 'enum': $startPosition = 5; break; case 'set(': $startPosition = 4; break; default: $fieldType = 'string'; return array(); } // enum('a','b','c', ...) >> [ 'a', 'b', 'c', ... ] // set('a','b','c', ...) >> [ 'a', 'b', 'c', ... ] $values = substr($fieldTypeDefinition, $startPosition, $length - $startPosition - 1); $items = OnArray::trimArray(explode(',', $values), "'"); $fieldType = substr($fieldTypeDefinition, 0, $startPosition - 1); return $items; } /** * For CheckBox's with only one checkbox: if no parameter:checked|unchecked is defined, take defaults: * * checked: first Element in $itemKey * unchecked: '' * * @param array $itemKey * @param array $formElement * @throws UserFormException */ private function prepareCheckboxCheckedUncheckedValue(array $itemKey, array &$formElement) { if (!isset($formElement[CHECKBOX_VALUE_CHECKED])) { if (isset($itemKey[0])) { // First element in $itemKey list $formElement[CHECKBOX_VALUE_CHECKED] = $itemKey[0]; } else { // Take column default value $formElement[CHECKBOX_VALUE_CHECKED] = $this->store->getVar($formElement['name'], STORE_TABLE_DEFAULT); } } // unchecked if (!isset($formElement[CHECKBOX_VALUE_UNCHECKED])) { if (isset($itemKey[1])) { $formElement[CHECKBOX_VALUE_UNCHECKED] = ($itemKey[0] === $formElement['checked']) ? $itemKey[1] : $itemKey[0]; } else { $formElement[CHECKBOX_VALUE_UNCHECKED] = ''; } } if ($formElement[CHECKBOX_VALUE_CHECKED] === $formElement[CHECKBOX_VALUE_UNCHECKED]) { throw new UserFormException('FormElement: type=checkbox - checked and unchecked can\'t be the same: ' . $formElement[CHECKBOX_VALUE_CHECKED], ERROR_CHECKBOX_EQUAL); } } /** * Build a Checkbox based on two values. * * @param array $formElement * @param $htmlFormElementId * @param $attribute * @param $value * @param array $json * @return string */ public function buildCheckboxSingle(array $formElement, $htmlFormElementId, $attribute, $value, array &$json) { $html = ''; $valueJson = false; $attribute .= Support::doAttribute('name', $htmlFormElementId); $attribute .= Support::doAttribute('value', $formElement['checked'], false); $attribute .= Support::doAttribute('title', $formElement['tooltip']); $attribute .= Support::doAttribute('data-load', ($formElement['dynamicUpdate'] === 'yes') ? 'data-load' : ''); if ($formElement['checked'] === $value) { $attribute .= Support::doAttribute('checked', 'checked'); $valueJson = true; } $attribute .= $this->getAttributeList($formElement, ['autofocus']); $html = $this->buildNativeHidden($htmlFormElementId, $formElement['unchecked']); $html .= ''; if (isset($formElement['label2'])) { $html .= $formElement['label2']; } $html = Support::wrapTag("", $html, true); $html = Support::wrapTag("

", $html, true); $json = $this->getJsonElementUpdate($htmlFormElementId, $valueJson, $formElement[FE_MODE]); 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 $htmlFormElementId * @param $attributeBase * @param $value * @param array $itemKey * @param array $itemValue * @param array $json * @return string */ public function buildCheckboxMulti(array $formElement, $htmlFormElementId, $attributeBase, $value, array $itemKey, array $itemValue, array &$json) { $json = array(); // Defines which of the checkboxes will be checked. $values = explode(',', $value); // $attributeBase .= Support::doAttribute('name', $htmlFormElementId); $attributeBase .= Support::doAttribute('data-load', ($formElement['dynamicUpdate'] === 'yes') ? 'data-load' : ''); $html = $this->buildNativeHidden(HelperFormElement::prependFormElementIdCheckBoxMulti($htmlFormElementId, 'h'), ''); $orientation = ($formElement['maxLength'] > 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; $htmlFormElementIdUniq = HelperFormElement::prependFormElementIdCheckBoxMulti($htmlFormElementId, $ii); $attribute .= Support::doAttribute('name', $htmlFormElementIdUniq); // Do this only the first round. if ($flagFirst) { $flagFirst = false; if (isset($formElement['autofocus'])) $attribute .= Support::doAttribute('autofocus', $formElement['autofocus']); } $attribute .= Support::doAttribute('value', $itemKey[$ii]); // Check if the given key is found in field. if (false !== array_search($itemKey[$ii], $values)) { $attribute .= Support::doAttribute('checked', 'checked'); $jsonValue = true; } // ' ' - This is necessary to correctly align an empty input. $value = ($itemValue[$ii] === '') ? ' ' : $itemValue[$ii]; $htmlElement = '' . $value; // With ALIGN_HORIZONTAL: the label causes some trouble: skip it if (($orientation === ALIGN_VERTICAL)) { $htmlElement = Support::wrapTag('', $htmlElement); } $htmlElement = Support::wrapTag("

", $htmlElement, true); // control orientation if ($formElement['maxLength'] > 1) { if ($jj == $formElement['maxLength']) { $jj = 0; $br = '
'; } else { $br = ''; } } $html .= $htmlElement . $br; $json[] = $this->getJsonElementUpdate($htmlFormElementIdUniq, $jsonValue, $formElement[FE_MODE]); } // if (isset($formElement[CHECKBOX_ORIENTATION]) && $formElement[CHECKBOX_ORIENTATION] !== 'vertical') // $html = Support::wrapTag("

", $html, true); // 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 $htmlFormElementId * @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, $htmlFormElementId, $value, array &$json, $mode = FORM_LOAD) { if ($mode === FORM_LOAD) { // Split 'grId:0' in 'grId' and '0' $name = explode(':', $htmlFormElementId, 2); $this->store->setVar($name[0], $value, STORE_SIP, false); } } /** * Build HTML 'radio' element. * * Checkboxes will only be submitted, if they are checked. Therefore, a hidden element with the unchecked value will be transfered first. * * Format: * * * @param array $formElement * @param $htmlFormElementId * @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, $htmlFormElementId, $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 .= Support::doAttribute('name', $htmlFormElementId); $attributeBase .= Support::doAttribute('type', $formElement[FE_TYPE]); $attributeBase .= Support::doAttribute('data-load', ($formElement['dynamicUpdate'] === 'yes') ? 'data-load' : ''); $jj = 0; $flagFirst = true; $orientation = ($formElement['maxLength'] > 1) ? ALIGN_HORIZONTAL : ALIGN_VERTICAL; $radioClass = ($orientation === ALIGN_HORIZONTAL) ? 'radio-inline' : 'radio'; $br = ''; $html = $this->buildNativeHidden($htmlFormElementId, $value); for ($ii = 0; $ii < count($itemValue); $ii++) { $jj++; $attribute = $attributeBase; // if ($flagFirst) { $flagFirst = false; if (isset($formElement['autofocus'])) $attribute .= Support::doAttribute('autofocus', $formElement['autofocus']); } $attribute .= Support::doAttribute('value', $itemKey[$ii]); $attribute .= Support::doAttribute('title', $formElement['tooltip']); if ($itemKey[$ii] === $value) { $attribute .= Support::doAttribute('checked', 'checked'); } // ' ' - This is necessary to correctly align an empty input. $tmpValue = ($itemValue[$ii] === '') ? ' ' : $itemValue[$ii]; $htmlElement = '' . $tmpValue; // With ALIGN_HORIZONTAL: the label causes some trouble: skip it if (($orientation === ALIGN_VERTICAL)) { $htmlElement = Support::wrapTag('', $htmlElement); } if ($formElement['maxLength'] > 1) { if ($jj == $formElement['maxLength']) { $jj = 0; $br = '
'; } else { $br = ''; } } $htmlElement = Support::wrapTag("

", $htmlElement) . $br; $html .= $htmlElement; } $json = $this->getJsonElementUpdate($htmlFormElementId, $value, $formElement[FE_MODE]); return $html; } /** * Builds a Selct (Dropdown) Box. * * @param array $formElement * @param $htmlFormElementId * @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, $htmlFormElementId, $value, array &$json, $mode = FORM_LOAD) { $itemKey = array(); $itemValue = array(); // Fill $itemKey & $itemValue $this->getKeyValueListFromSqlEnumSpec($formElement, $itemKey, $itemValue); $attribute = $this->getAttributeFeMode($formElement[FE_MODE]); $attribute .= Support::doAttribute('name', $htmlFormElementId); $attribute .= Support::doAttribute('class', 'form-control'); $attribute .= Support::doAttribute('title', $formElement['tooltip']); $attribute .= $this->getAttributeList($formElement, ['autofocus']); $attribute .= Support::doAttribute('data-load', ($formElement['dynamicUpdate'] === 'yes') ? 'data-load' : ''); if (isset($formElement['size']) && $formElement['size'] > 1) { $attribute .= Support::doAttribute('size', $formElement['size']); $attribute .= Support::doAttribute('multiple', 'multiple'); } $option = ''; $firstSelect = true; $jsonValues = array(); for ($ii = 0; $ii < count($itemValue); $ii++) { $option .= ''; } $json = $this->getJsonElementUpdate($htmlFormElementId, $jsonValues, $formElement[FE_MODE]); return '' . $this->getHelpBlock(); } /** * Construct a HTML table of the subrecord data. * Column syntax definition: https://wikiit.math.uzh.ch/it/projekt/qfq/qfq-jqwidgets/Documentation#Type:_subrecord * * @param array $formElement * @param $htmlFormElementId * @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, $htmlFormElementId, $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])) { $linkNew = Support::wrapTag('', $this->createFormLink($formElement, 0, $primaryRecord, $this->symbol[SYMBOL_NEW], 'New')); // Decode settings in subrecordOption $flagNew = Support::findInSet(SUBRECORD_NEW, $formElement['subrecordOption']); $flagEdit = Support::findInSet(SUBRECORD_EDIT, $formElement['subrecordOption']); if ($flagDelete = Support::findInSet(SUBRECORD_DELETE, $formElement['subrecordOption'])) { $targetTableName = $this->getFormTable($formElement[SUBRECORD_PARAMETER_FORM]); } } $columns = $linkNew; if (isset($formElement['sql1'][0])) { // construct column attributes $control = $this->getSubrecordColumnControl(array_keys($formElement['sql1'][0])); // Subrecord: Column titles $columns .= '' . implode('', $control['title']) . ''; } if ($flagDelete) $columns .= ''; // Table head $html = Support::wrapTag('', $columns); foreach ($formElement['sql1'] as $row) { $rowHtml = ''; if ($flagEdit) { $rowHtml .= Support::wrapTag('', $this->createFormLink($formElement, $row[$nameColumnId], $primaryRecord, $this->symbol[SYMBOL_EDIT], 'Edit')); } elseif ($flagNew) { $rowHtml .= Support::wrapTag('', $rowHtml, false); } // All columns foreach ($row as $columnName => $value) { if (isset($control['title'][$columnName])) $rowHtml .= Support::wrapTag('', $this->renderCell($control, $columnName, $value)); } if ($flagDelete) { $s = $this->createDeleteUrl($targetTableName, $row['id'], RETURN_SIP); $rowHtml .= Support::wrapTag('', Support::wrapTag("