ILIAS  release_8 Revision v8.24
ilIdentifiedMultiValuesInputGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

+ Inheritance diagram for ilIdentifiedMultiValuesInputGUI:
+ Collaboration diagram for ilIdentifiedMultiValuesInputGUI:

Public Member Functions

 __construct ($a_title="", $a_postvar="")
 
 getElementAddCmd ()
 
 setElementAddCmd ($elementAddCmd)
 
 getElementRemoveCmd ()
 
 setElementRemoveCmd ($elementRemoveCmd)
 
 getElementMoveUpCommand ()
 
 setElementMoveUpCommand ($elementMoveUpCommand)
 
 getElementMoveDownCommand ()
 
 setElementMoveDownCommand ($elementMoveDownCommand)
 
 setValues ($values)
 
 getValues ()
 
 setValue ($value)
 
 getValue ()
 
 setMultiValues (array $values)
 
 getMultiValues ()
 
 setIdentifiedMultiValues ($values)
 
 getIdentifiedMultiValues ()
 
 setValueByArray (array $a_values)
 
 getInput ()
 
 checkInput ()
 Check input, strip slashes etc. More...
 
 onCheckInput ()
 
 prepareReprintable (assQuestion $question)
 
- Public Member Functions inherited from ilTextInputGUI
 __construct (string $a_title="", string $a_postvar="")
 
 setValue ($a_value)
 
 getValue ()
 
 setValidationFailureMessage (string $a_msg)
 
 getValidationFailureMessage ()
 
 setValidationRegexp (string $a_value)
 
 getValidationRegexp ()
 
 setMaxLength (?int $a_maxlength)
 
 getMaxLength ()
 
 setSize (int $a_size)
 
 setInlineStyle (string $a_style)
 
 getInlineStyle ()
 
 setCssClass (string $a_class)
 
 getCssClass ()
 
 setValueByArray (array $a_values)
 
 getSize ()
 
 setSuffix (string $a_value)
 
 getSuffix ()
 
 setInputType (string $a_type)
 set input type More...
 
 getInputType ()
 
 setSubmitFormOnEnter (bool $a_val)
 
 getSubmitFormOnEnter ()
 
 checkInput ()
 Check input, strip slashes etc. More...
 
 getInput ()
 
 getDataSource ()
 
 setDataSource (string $href, string $a_delimiter=null)
 
 setDataSourceSubmitOnSelection (bool $a_stat)
 
 getDataSourceSubmitOnSelection ()
 
 setDataSourceSubmitUrl (string $a_url)
 
 getDataSourceSubmitUrl ()
 
 setMultiValues (array $a_values)
 
 render (string $a_mode="")
 
 insert (ilTemplate $a_tpl)
 
 getTableFilterHTML ()
 Get input item HTML to be inserted into table filters. More...
 
 getToolbarHTML ()
 Get input item HTML to be inserted into ilToolbarGUI. More...
 
 setDisableHtmlAutoComplete (bool $autocomplete)
 
 isHtmlAutoCompleteDisabled ()
 
 getPostValueForComparison ()
 
- Public Member Functions inherited from ilSubEnabledFormPropertyGUI
 addSubItem (ilFormPropertyGUI $a_item)
 
 getSubItems ()
 
 getSubInputItemsRecursive ()
 returns a flat array of possibly existing subitems recursively More...
 
 checkSubItemsInput ()
 Check SubItems. More...
 
 getSubForm ()
 
 getItemByPostVar (string $a_post_var)
 Get item by post var. More...
 
- Public Member Functions inherited from ilFormPropertyGUI
 __construct (string $a_title="", string $a_postvar="")
 
 executeCommand ()
 
 getType ()
 
 setTitle (string $a_title)
 
 getTitle ()
 
 setPostVar (string $a_postvar)
 
 getPostVar ()
 
 getFieldId ()
 
 setInfo (string $a_info)
 
 getInfo ()
 
 setAlert (string $a_alert)
 
 getAlert ()
 
 setRequired (bool $a_required)
 
 getRequired ()
 
 setDisabled (bool $a_disabled)
 
 getDisabled ()
 
 checkInput ()
 Check input, strip slashes etc. More...
 
 setParentForm (ilPropertyFormGUI $a_parentform)
 
 getParentForm ()
 
 setParent (ilFormPropertyGUI $a_val)
 
 getParent ()
 
 getSubForm ()
 
 hideSubForm ()
 
 setHiddenTitle (string $a_val)
 
 getHiddenTitle ()
 
 getItemByPostVar (string $a_post_var)
 Get item by post var. More...
 
 serializeData ()
 
 unserializeData (string $a_data)
 
 setParentTable ($a_val)
 Set parent table. More...
 
 getParentTable ()
 Get parent table. More...
 
 writeToSession ()
 
 clearFromSession ()
 
 readFromSession ()
 
 getHiddenTag (string $a_post_var, string $a_value)
 
 setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)
 
 getMulti ()
 
 setMultiValues (array $a_values)
 
 getMultiValues ()
 
 getContentOutsideFormTag ()
 Get content that has to reside outside of the parent form tag, e.g. More...
 
 stripSlashesAddSpaceFallback (string $a_str)
 Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...
 
 getTableFilterLabelFor ()
 Get label "for" attribute value for filter. More...
 
 getFormLabelFor ()
 Get label "for" attribute value for form. More...
 
 setRequestParam (string $key, $val)
 This writes the request (aka post) values. More...
 
- Public Member Functions inherited from ilTableFilterItem
 getTableFilterHTML ()
 Get input item HTML to be inserted into table filters. More...
 
 getTableFilterLabelFor ()
 Get label "for" attribute value. More...
 
 getToolbarHTML ()
 Get input item HTML to be inserted into ilToolbarGUI. More...
 

Data Fields

const ELEMENT_DEFAULT_ADD_CMD = 'addElement'
 
const ELEMENT_DEFAULT_REMOVE_CMD = 'removeElement'
 
const ELEMENT_DEFAULT_MOVE_UP_CMD = 'moveUpElement'
 
const ELEMENT_DEFAULT_MOVE_DOWN_CMD = 'moveDownElement'
 

Protected Member Functions

 getMultiValueSubFieldId ($identifier, $subFieldIndex)
 
 getMultiValuePosIndexedFieldId ($identifier, $positionIndex)
 
 getMultiValuePosIndexedSubFieldId ($identifier, $subFieldIndex, $positionIndex)
 
 getFieldIdFromPostVar ($tempPostVar)
 
 getPostVarSubField ($subFieldIndex)
 
 getMultiValuePostVarSubField ($identifier, $subFieldIndex)
 
 getMultiValuePostVarSubFieldPosIndexed ($identifier, $subFieldIndex, $positionIndex)
 
 getMultiValuePostVarPosIndexed ($identifier, $positionIndex)
 
 getMultiValuePostVar ($identifier)
 
 buildMultiValueSubmitVar ($identifier, $positionIndex, $submitCommand)
 
 setIdentifiedMultiValuesByArray ($a_values)
 
 prepareMultiValuesInput ($values)
 
 prepareMultiValuesSubmit ($values)
 
 getFormValuesManipulators ()
 
 addFormValuesManipulator (ilFormValuesManipulator $manipulator)
 
 getSubFieldCompletedPostVar ($subFieldIndex, $elemPostVar)
 
- Protected Member Functions inherited from ilFormPropertyGUI
 setType (string $a_type)
 
 checkParentFormTable ()
 
 getSessionKey ()
 
 getMultiIconsHTML ()
 
 int ($key)
 
 intArray ($key)
 
 str ($key)
 
 raw ($key)
 
 strArray ($key)
 
 arrayArray ($key)
 
 isRequestParamArray (string $key)
 
 getRequestParam (string $key, Refinery\Transformation $t)
 

Protected Attributes

 $elementAddCmd = self::ELEMENT_DEFAULT_ADD_CMD
 
 $elementRemoveCmd = self::ELEMENT_DEFAULT_REMOVE_CMD
 
 $elementMoveUpCommand = self::ELEMENT_DEFAULT_MOVE_UP_CMD
 
 $elementMoveDownCommand = self::ELEMENT_DEFAULT_MOVE_DOWN_CMD
 
 $identified_multi_values = array()
 
 $formValuesManipulationChain = array()
 
- Protected Attributes inherited from ilTextInputGUI
 $value = null
 
int $maxlength = 200
 
int $size = 40
 
string $validationRegexp = ""
 
string $validationFailureMessage = ''
 
string $suffix = ""
 
string $style_css = ""
 
string $css_class = ""
 
string $ajax_datasource = ""
 
string $ajax_datasource_delimiter = null
 
bool $ajax_datasource_commit = false
 
string $ajax_datasource_commit_url = ""
 
bool $submit_form_on_enter = false
 
bool $autocomplete_disabled = false
 
string $input_type = ""
 
- Protected Attributes inherited from ilSubEnabledFormPropertyGUI
array $sub_items = array()
 
- Protected Attributes inherited from ilFormPropertyGUI
array $set_params = []
 
ilTable2GUI $parent_table = null
 
ilFormPropertyGUI $parent_gui = null
 
ilCtrl $ctrl
 
ilLanguage $lng
 
string $type = ""
 
string $title = ""
 
string $postvar = ""
 
string $info = ""
 
string $alert = ""
 
bool $required = false
 
ilPropertyFormGUI $parentform = null
 
string $hidden_title = ""
 
bool $multi = false
 
bool $multi_sortable = false
 
bool $multi_addremove = true
 
array $multi_values = []
 
RequestInterface $request
 
HTTP Services $http
 
Refinery Factory $refinery = null
 
bool $disabled = false
 
ilGlobalTemplateInterface $global_tpl = null
 

Additional Inherited Members

- Static Public Member Functions inherited from ilFormPropertyGUI
static removeProhibitedCharacters (string $a_text)
 Remove prohibited characters see #19159. More...
 

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author
Björn Heyser bheys.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Definition at line 22 of file class.ilIdentifiedMultiValuesInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilIdentifiedMultiValuesInputGUI::__construct (   $a_title = "",
  $a_postvar = "" 
)

Reimplemented in ilMultipleTextsInputGUI, and ilMultipleNestedOrderingElementsInputGUI.

Definition at line 38 of file class.ilIdentifiedMultiValuesInputGUI.php.

39 {
40 parent::__construct($a_title, $a_postvar);
41
43 }
addFormValuesManipulator(ilFormValuesManipulator $manipulator)
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc

References ILIAS\GlobalScreen\Provider\__construct(), and addFormValuesManipulator().

+ Here is the call graph for this function:

Member Function Documentation

◆ addFormValuesManipulator()

ilIdentifiedMultiValuesInputGUI::addFormValuesManipulator ( ilFormValuesManipulator  $manipulator)
protected

Definition at line 273 of file class.ilIdentifiedMultiValuesInputGUI.php.

273 : void
274 {
275 $this->formValuesManipulationChain[] = $manipulator;
276 }

Referenced by __construct(), ilMultipleNestedOrderingElementsInputGUI\__construct(), ilAssNestedOrderingElementsInputGUI\__construct(), ilAssOrderingTextsInputGUI\__construct(), and ilAssOrderingImagesInputGUI\__construct().

+ Here is the caller graph for this function:

◆ buildMultiValueSubmitVar()

ilIdentifiedMultiValuesInputGUI::buildMultiValueSubmitVar (   $identifier,
  $positionIndex,
  $submitCommand 
)
protected

Definition at line 205 of file class.ilIdentifiedMultiValuesInputGUI.php.

205 : string
206 {
207 $elemSubmitVar = "cmd[{$submitCommand}][{$this->getFieldId()}]";
208 $elemSubmitVar .= "[$identifier][$positionIndex]";
209
210 return $elemSubmitVar;
211 }

Referenced by ilDclMultiTextInputGUI\render(), ilMultipleImagesInputGUI\render(), and ilMultipleTextsInputGUI\render().

+ Here is the caller graph for this function:

◆ checkInput()

ilIdentifiedMultiValuesInputGUI::checkInput ( )
final

Check input, strip slashes etc.

set alert, if input is not ok.

Reimplemented from ilTextInputGUI.

Definition at line 241 of file class.ilIdentifiedMultiValuesInputGUI.php.

241 : bool
242 {
243 return $this->onCheckInput();
244 }

References onCheckInput().

+ Here is the call graph for this function:

◆ getElementAddCmd()

ilIdentifiedMultiValuesInputGUI::getElementAddCmd ( )

◆ getElementMoveDownCommand()

ilIdentifiedMultiValuesInputGUI::getElementMoveDownCommand ( )

◆ getElementMoveUpCommand()

ilIdentifiedMultiValuesInputGUI::getElementMoveUpCommand ( )

◆ getElementRemoveCmd()

ilIdentifiedMultiValuesInputGUI::getElementRemoveCmd ( )

◆ getFieldIdFromPostVar()

ilIdentifiedMultiValuesInputGUI::getFieldIdFromPostVar (   $tempPostVar)
protected

Definition at line 156 of file class.ilIdentifiedMultiValuesInputGUI.php.

156 : string
157 {
158 $basicPostVar = $this->getPostVar();
159 $this->setPostVar($tempPostVar);
160
161 // uses getPostVar() internally, our postvar does not have the counter included
162 $multiValueFieldId = $this->getFieldId();
163 // now ALL brackets ("[", "]") are escaped, even the ones for the counter
164
165 $this->setPostVar($basicPostVar);
166 return $multiValueFieldId;
167 }
setPostVar(string $a_postvar)

References ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getPostVar(), and ilFormPropertyGUI\setPostVar().

Referenced by getMultiValuePosIndexedFieldId(), getMultiValuePosIndexedSubFieldId(), and getMultiValueSubFieldId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getFormValuesManipulators()

ilIdentifiedMultiValuesInputGUI::getFormValuesManipulators ( )
protected

Definition at line 268 of file class.ilIdentifiedMultiValuesInputGUI.php.

References $formValuesManipulationChain.

Referenced by prepareMultiValuesInput(), and prepareMultiValuesSubmit().

+ Here is the caller graph for this function:

◆ getIdentifiedMultiValues()

◆ getInput()

ilIdentifiedMultiValuesInputGUI::getInput ( )
Returns
string[]

Reimplemented from ilTextInputGUI.

Definition at line 234 of file class.ilIdentifiedMultiValuesInputGUI.php.

234 : array
235 {
236 $values = $this->arrayArray($this->getPostVar());
237
238 return $this->prepareMultiValuesSubmit($values);
239 }

References ilFormPropertyGUI\arrayArray(), ilFormPropertyGUI\getPostVar(), and prepareMultiValuesSubmit().

Referenced by ilMultipleImagesInputGUI\onCheckInput(), and ilMultipleTextsInputGUI\onCheckInput().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getMultiValuePosIndexedFieldId()

ilIdentifiedMultiValuesInputGUI::getMultiValuePosIndexedFieldId (   $identifier,
  $positionIndex 
)
protected

Definition at line 140 of file class.ilIdentifiedMultiValuesInputGUI.php.

140 : string
141 {
142 $tempPostVar = $this->getMultiValuePostVarPosIndexed($identifier, $positionIndex);
143 $multiValueFieldId = $this->getFieldIdFromPostVar($tempPostVar);
144
145 return $multiValueFieldId;
146 }

References getFieldIdFromPostVar(), and getMultiValuePostVarPosIndexed().

Referenced by ilDclMultiTextInputGUI\render(), and ilMultipleTextsInputGUI\render().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getMultiValuePosIndexedSubFieldId()

ilIdentifiedMultiValuesInputGUI::getMultiValuePosIndexedSubFieldId (   $identifier,
  $subFieldIndex,
  $positionIndex 
)
protected

Definition at line 148 of file class.ilIdentifiedMultiValuesInputGUI.php.

148 : string
149 {
150 $tempPostVar = $this->getMultiValuePostVarSubFieldPosIndexed($identifier, $subFieldIndex, $positionIndex);
151 $multiValueFieldId = $this->getFieldIdFromPostVar($tempPostVar);
152
153 return $multiValueFieldId;
154 }
getMultiValuePostVarSubFieldPosIndexed($identifier, $subFieldIndex, $positionIndex)

References getFieldIdFromPostVar(), and getMultiValuePostVarSubFieldPosIndexed().

Referenced by ilDclMultiTextInputGUI\render(), ilMultipleImagesInputGUI\render(), and ilMultipleTextsInputGUI\render().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getMultiValuePostVar()

ilIdentifiedMultiValuesInputGUI::getMultiValuePostVar (   $identifier)
protected

Definition at line 198 of file class.ilIdentifiedMultiValuesInputGUI.php.

198 : string
199 {
200 $elemPostVar = $this->getPostVar();
201 $elemPostVar .= "[$identifier]";
202 return $elemPostVar;
203 }

References ilFormPropertyGUI\getPostVar().

Referenced by getMultiValuePostVarPosIndexed(), and getMultiValuePostVarSubField().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getMultiValuePostVarPosIndexed()

ilIdentifiedMultiValuesInputGUI::getMultiValuePostVarPosIndexed (   $identifier,
  $positionIndex 
)
protected

Definition at line 190 of file class.ilIdentifiedMultiValuesInputGUI.php.

190 : string
191 {
192 $elemPostVar = $this->getMultiValuePostVar($identifier);
193 $elemPostVar .= "[$positionIndex]";
194
195 return $elemPostVar;
196 }

References getMultiValuePostVar().

Referenced by getMultiValuePosIndexedFieldId(), getMultiValuePostVarSubFieldPosIndexed(), ilDclMultiTextInputGUI\render(), and ilMultipleTextsInputGUI\render().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getMultiValuePostVarSubField()

ilIdentifiedMultiValuesInputGUI::getMultiValuePostVarSubField (   $identifier,
  $subFieldIndex 
)
protected

Definition at line 174 of file class.ilIdentifiedMultiValuesInputGUI.php.

175 {
176 $elemPostVar = $this->getMultiValuePostVar($identifier);
177 $elemPostVar = $this->getSubFieldCompletedPostVar($subFieldIndex, $elemPostVar);
178
179 return $elemPostVar;
180 }

References getMultiValuePostVar(), and getSubFieldCompletedPostVar().

Referenced by getMultiValueSubFieldId(), and ilMultipleNestedOrderingElementsInputGUI\renderListItem().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getMultiValuePostVarSubFieldPosIndexed()

ilIdentifiedMultiValuesInputGUI::getMultiValuePostVarSubFieldPosIndexed (   $identifier,
  $subFieldIndex,
  $positionIndex 
)
protected

Definition at line 182 of file class.ilIdentifiedMultiValuesInputGUI.php.

183 {
184 $elemPostVar = $this->getMultiValuePostVarPosIndexed($identifier, $positionIndex);
185 $elemPostVar = $this->getSubFieldCompletedPostVar($subFieldIndex, $elemPostVar);
186
187 return $elemPostVar;
188 }

References getMultiValuePostVarPosIndexed(), and getSubFieldCompletedPostVar().

Referenced by getMultiValuePosIndexedSubFieldId(), and ilMultipleImagesInputGUI\render().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getMultiValues()

ilIdentifiedMultiValuesInputGUI::getMultiValues ( )

Reimplemented from ilFormPropertyGUI.

Reimplemented in ilDclMultiTextInputGUI.

Definition at line 117 of file class.ilIdentifiedMultiValuesInputGUI.php.

117 : array
118 {
119 throw new ilFormException('setter unsupported, use setIdentifiedMultiValues() instead!');
120 }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...

◆ getMultiValueSubFieldId()

ilIdentifiedMultiValuesInputGUI::getMultiValueSubFieldId (   $identifier,
  $subFieldIndex 
)
protected

Definition at line 132 of file class.ilIdentifiedMultiValuesInputGUI.php.

132 : string
133 {
134 $tempPostVar = $this->getMultiValuePostVarSubField($identifier, $subFieldIndex);
135 $multiValueFieldId = $this->getFieldIdFromPostVar($tempPostVar);
136
137 return $multiValueFieldId;
138 }

References getFieldIdFromPostVar(), and getMultiValuePostVarSubField().

Referenced by ilMultipleNestedOrderingElementsInputGUI\renderListItem().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getPostVarSubField()

ilIdentifiedMultiValuesInputGUI::getPostVarSubField (   $subFieldIndex)
protected

Definition at line 169 of file class.ilIdentifiedMultiValuesInputGUI.php.

170 {
171 return $this->getSubFieldCompletedPostVar($subFieldIndex, $this->getPostVar());
172 }

References ilFormPropertyGUI\getPostVar(), and getSubFieldCompletedPostVar().

Referenced by ilMultipleNestedOrderingElementsInputGUI\renderJsInit().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getSubFieldCompletedPostVar()

ilIdentifiedMultiValuesInputGUI::getSubFieldCompletedPostVar (   $subFieldIndex,
  $elemPostVar 
)
protected
Parameters
$subFieldIndex
$elemPostVar
Returns
mixed

Definition at line 283 of file class.ilIdentifiedMultiValuesInputGUI.php.

284 {
285 $fieldPostVar = "{$this->getPostVar()}[$subFieldIndex]";
286 $elemPostVar = str_replace($this->getPostVar(), $fieldPostVar, $elemPostVar);
287 return $elemPostVar;
288 }

References ilFormPropertyGUI\getPostVar().

Referenced by getMultiValuePostVarSubField(), getMultiValuePostVarSubFieldPosIndexed(), and getPostVarSubField().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getValue()

ilIdentifiedMultiValuesInputGUI::getValue ( )
Returns
array|string

Reimplemented from ilTextInputGUI.

Reimplemented in ilDclMultiTextInputGUI.

Definition at line 107 of file class.ilIdentifiedMultiValuesInputGUI.php.

108 {
109 throw new ilFormException('setter unsupported, use setIdentifiedMultiValues() instead!');
110 }

◆ getValues()

ilIdentifiedMultiValuesInputGUI::getValues ( )
Returns
mixed
Exceptions
ilFormException

Reimplemented in ilDclMultiTextInputGUI.

Definition at line 97 of file class.ilIdentifiedMultiValuesInputGUI.php.

98 {
99 throw new ilFormException('setter unsupported, use setIdentifiedMultiValues() instead!');
100 }

◆ onCheckInput()

ilIdentifiedMultiValuesInputGUI::onCheckInput ( )
abstract

Reimplemented in ilMultipleImagesInputGUI, ilMultipleNestedOrderingElementsInputGUI, and ilMultipleTextsInputGUI.

Referenced by checkInput().

+ Here is the caller graph for this function:

◆ prepareMultiValuesInput()

ilIdentifiedMultiValuesInputGUI::prepareMultiValuesInput (   $values)
finalprotected

Definition at line 248 of file class.ilIdentifiedMultiValuesInputGUI.php.

249 {
250 foreach ($this->getFormValuesManipulators() as $manipulator) {
251 /* @var ilFormValuesManipulator $manipulator */
252 $values = $manipulator->manipulateFormInputValues($values);
253 }
254
255 return $values;
256 }

References getFormValuesManipulators().

Referenced by ilMultipleImagesInputGUI\render(), and setIdentifiedMultiValues().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ prepareMultiValuesSubmit()

ilIdentifiedMultiValuesInputGUI::prepareMultiValuesSubmit (   $values)
finalprotected

Definition at line 258 of file class.ilIdentifiedMultiValuesInputGUI.php.

259 {
260 foreach ($this->getFormValuesManipulators() as $manipulator) {
261 /* @var ilFormValuesManipulator $manipulator */
262 $values = $manipulator->manipulateFormSubmitValues($values);
263 }
264
265 return $values;
266 }

References getFormValuesManipulators().

Referenced by getInput(), and setValueByArray().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ prepareReprintable()

ilIdentifiedMultiValuesInputGUI::prepareReprintable ( assQuestion  $question)

◆ setElementAddCmd()

ilIdentifiedMultiValuesInputGUI::setElementAddCmd (   $elementAddCmd)
Parameters
string$elementAddCmd

Definition at line 53 of file class.ilIdentifiedMultiValuesInputGUI.php.

53 : void
54 {
55 $this->elementAddCmd = $elementAddCmd;
56 }

References $elementAddCmd.

◆ setElementMoveDownCommand()

ilIdentifiedMultiValuesInputGUI::setElementMoveDownCommand (   $elementMoveDownCommand)

Definition at line 83 of file class.ilIdentifiedMultiValuesInputGUI.php.

83 : void
84 {
85 $this->elementMoveDownCommand = $elementMoveDownCommand;
86 }

References $elementMoveDownCommand.

◆ setElementMoveUpCommand()

ilIdentifiedMultiValuesInputGUI::setElementMoveUpCommand (   $elementMoveUpCommand)

Definition at line 73 of file class.ilIdentifiedMultiValuesInputGUI.php.

73 : void
74 {
75 $this->elementMoveUpCommand = $elementMoveUpCommand;
76 }

References $elementMoveUpCommand.

◆ setElementRemoveCmd()

ilIdentifiedMultiValuesInputGUI::setElementRemoveCmd (   $elementRemoveCmd)

Definition at line 63 of file class.ilIdentifiedMultiValuesInputGUI.php.

63 : void
64 {
65 $this->elementRemoveCmd = $elementRemoveCmd;
66 }

References $elementRemoveCmd.

◆ setIdentifiedMultiValues()

ilIdentifiedMultiValuesInputGUI::setIdentifiedMultiValues (   $values)
final

◆ setIdentifiedMultiValuesByArray()

ilIdentifiedMultiValuesInputGUI::setIdentifiedMultiValuesByArray (   $a_values)
protected

Definition at line 226 of file class.ilIdentifiedMultiValuesInputGUI.php.

226 : void
227 {
228 $this->identified_multi_values = $a_values[$this->getPostVar()];
229 }

References ilFormPropertyGUI\getPostVar().

Referenced by setValueByArray().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setMultiValues()

ilIdentifiedMultiValuesInputGUI::setMultiValues ( array  $values)

Reimplemented from ilTextInputGUI.

Reimplemented in ilDclMultiTextInputGUI.

Definition at line 112 of file class.ilIdentifiedMultiValuesInputGUI.php.

112 : void
113 {
114 throw new ilFormException('setter unsupported, use setIdentifiedMultiValues() instead!');
115 }

◆ setValue()

ilIdentifiedMultiValuesInputGUI::setValue (   $a_value)
Parameters
string | array$a_value

Reimplemented from ilTextInputGUI.

Reimplemented in ilDclMultiTextInputGUI.

Definition at line 102 of file class.ilIdentifiedMultiValuesInputGUI.php.

102 : void
103 {
104 throw new ilFormException('setter unsupported, use setIdentifiedMultiValues() instead!');
105 }

◆ setValueByArray()

ilIdentifiedMultiValuesInputGUI::setValueByArray ( array  $a_values)
final

Reimplemented from ilTextInputGUI.

Definition at line 213 of file class.ilIdentifiedMultiValuesInputGUI.php.

213 : void
214 {
215 if (!isset($a_values[$this->getPostVar()]) || !is_array($a_values[$this->getPostVar()])) {
216 $a_values[$this->getPostVar()] = [];
217 }
218
219 $a_values[$this->getPostVar()] = $this->prepareMultiValuesSubmit(
220 $a_values[$this->getPostVar()]
221 );
222
223 $this->setIdentifiedMultiValuesByArray($a_values);
224 }

References ilFormPropertyGUI\getPostVar(), prepareMultiValuesSubmit(), and setIdentifiedMultiValuesByArray().

+ Here is the call graph for this function:

◆ setValues()

ilIdentifiedMultiValuesInputGUI::setValues (   $values)

Reimplemented in ilDclMultiTextInputGUI.

Definition at line 88 of file class.ilIdentifiedMultiValuesInputGUI.php.

88 : void
89 {
90 throw new ilFormException('setter unsupported, use setIdentifiedMultiValues() instead!');
91 }

Field Documentation

◆ $elementAddCmd

ilIdentifiedMultiValuesInputGUI::$elementAddCmd = self::ELEMENT_DEFAULT_ADD_CMD
protected

Definition at line 29 of file class.ilIdentifiedMultiValuesInputGUI.php.

Referenced by getElementAddCmd(), and setElementAddCmd().

◆ $elementMoveDownCommand

ilIdentifiedMultiValuesInputGUI::$elementMoveDownCommand = self::ELEMENT_DEFAULT_MOVE_DOWN_CMD
protected

◆ $elementMoveUpCommand

ilIdentifiedMultiValuesInputGUI::$elementMoveUpCommand = self::ELEMENT_DEFAULT_MOVE_UP_CMD
protected

◆ $elementRemoveCmd

ilIdentifiedMultiValuesInputGUI::$elementRemoveCmd = self::ELEMENT_DEFAULT_REMOVE_CMD
protected

◆ $formValuesManipulationChain

ilIdentifiedMultiValuesInputGUI::$formValuesManipulationChain = array()
protected

Definition at line 36 of file class.ilIdentifiedMultiValuesInputGUI.php.

Referenced by getFormValuesManipulators().

◆ $identified_multi_values

ilIdentifiedMultiValuesInputGUI::$identified_multi_values = array()
protected

◆ ELEMENT_DEFAULT_ADD_CMD

const ilIdentifiedMultiValuesInputGUI::ELEMENT_DEFAULT_ADD_CMD = 'addElement'

Definition at line 24 of file class.ilIdentifiedMultiValuesInputGUI.php.

◆ ELEMENT_DEFAULT_MOVE_DOWN_CMD

const ilIdentifiedMultiValuesInputGUI::ELEMENT_DEFAULT_MOVE_DOWN_CMD = 'moveDownElement'

Definition at line 27 of file class.ilIdentifiedMultiValuesInputGUI.php.

◆ ELEMENT_DEFAULT_MOVE_UP_CMD

const ilIdentifiedMultiValuesInputGUI::ELEMENT_DEFAULT_MOVE_UP_CMD = 'moveUpElement'

Definition at line 26 of file class.ilIdentifiedMultiValuesInputGUI.php.

◆ ELEMENT_DEFAULT_REMOVE_CMD

const ilIdentifiedMultiValuesInputGUI::ELEMENT_DEFAULT_REMOVE_CMD = 'removeElement'

Definition at line 25 of file class.ilIdentifiedMultiValuesInputGUI.php.


The documentation for this class was generated from the following file: