ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
ilAssOrderingQuestionAuthoringFormGUI Class Reference
+ Inheritance diagram for ilAssOrderingQuestionAuthoringFormGUI:
+ Collaboration diagram for ilAssOrderingQuestionAuthoringFormGUI:

Public Member Functions

 __construct ()
 
 addSpecificOrderingQuestionCommandButtons (assOrderingQuestion $questionOBJ)
 
 getOrderingElementInputField ()
 
 prepareValuesReprintable (assOrderingQuestion $questionOBJ)
 
 ensureReprintableFormStructure (assOrderingQuestion $questionOBJ)
 
- Public Member Functions inherited from ilAssQuestionAuthoringFormGUI
 __construct ()
 ilAssQuestionAuthoringFormGUI constructor. More...
 
 addGenericAssessmentQuestionCommandButtons (assQuestion $questionOBJ)
 
 replaceFormItemByPostVar (ilFormPropertyGUI $replacingItem)
 
- Public Member Functions inherited from ilPropertyFormGUI
 __construct ()
 
 executeCommand ()
 
 setTableWidth (string $a_width)
 
 getTableWidth ()
 
 setMode (string $a_mode)
 
 getMode ()
 
 setTitle (string $a_title)
 
 getTitle ()
 
 setTitleIcon (string $a_titleicon)
 
 getTitleIcon ()
 
 setDescription (string $a_val)
 
 getDescription ()
 
 setTopAnchor (string $a_val)
 
 getTopAnchor ()
 
 setShowTopButtons (bool $a_val)
 
 getShowTopButtons ()
 
 setForceTopButtons (bool $a_val)
 
 getForceTopButtons ()
 
 addItem ($a_item)
 
 removeItemByPostVar (string $a_post_var, bool $a_remove_unused_headers=false)
 
 getItemByPostVar (string $a_post_var)
 
 setItems (array $a_items)
 
 getItems ()
 
 getInputItemsRecursive ()
 returns a flat array of all input items including the possibly existing subitems recursively More...
 
 setDisableStandardMessage (bool $a_val)
 
 getDisableStandardMessage ()
 
 getHideLabels ()
 
 setHideLabels (bool $a_value=true)
 
 setValuesByArray (array $a_values, bool $a_restrict_to_value_keys=false)
 
 setValuesByPost ()
 
 checkInput ()
 
 getInput (string $a_post_var, bool $ensureValidation=true)
 Returns the input of an item, if item provides getInput method and as fallback the value of the HTTP-POST variable, identified by the passed postvar. More...
 
 addCommandButton (string $a_cmd, string $a_text, string $a_id="")
 
 getCommandButtons ()
 
 clearCommandButtons ()
 
 getContent ()
 
 insertItem ( $item, bool $a_sub_item=false)
 
 addAsyncOnloadCode (string $code)
 
 getHTML ()
 
 getHTMLAsync ()
 
 getFileUpload (string $a_field, ?string $a_index=null, ?string $a_sub_index=null)
 Get file upload data. More...
 
 hasFileUpload (string $a_field, ?string $a_index=null, ?string $a_sub_index=null)
 
 moveFileUpload (string $a_target_directory, string $a_field, ?string $a_target_name=null, ?string $a_index=null, ?string $a_sub_index=null)
 Move upload to target directory. More...
 
- Public Member Functions inherited from ilFormGUI
 setFormAction (string $a_formaction)
 
 getFormAction ()
 
 setTarget (string $a_target)
 
 getTarget ()
 
 setMultipart (bool $a_multipart)
 
 getMultipart ()
 
 setId (string $a_id)
 
 getId ()
 
 setName (string $a_name)
 
 getName ()
 
 setKeepOpen (bool $a_keepopen)
 
 getKeepOpen ()
 
 setOpenTag (bool $a_open)
 
 getOpenTag ()
 
 setCloseTag (bool $a_val)
 
 getCloseTag ()
 
 setPreventDoubleSubmission (bool $a_val)
 
 getPreventDoubleSubmission ()
 
 getHTML ()
 
 getContent ()
 

Data Fields

const COMMAND_BUTTON_PREFIX = 'assOrderingQuestionBtn_'
 

Protected Member Functions

 setAvailableCommandButtonIds ($availableCommandButtonIds)
 
 getAvailableCommandButtonIds ()
 
 renewOrderingElementInput (assOrderingQuestion $questionOBJ)
 
 buildCommandButtonId ($id)
 
 renewOrderingCommandButtons (assOrderingQuestion $questionOBJ)
 
- Protected Member Functions inherited from ilPropertyFormGUI
 getRequestedPostVar ()
 
 getFileHash ()
 
 hideRequired (string $a_type)
 
 appendOnloadCode (string $html)
 
 rebuildUploadedFiles ()
 

Protected Attributes

 $availableCommandButtonIds = null
 
- Protected Attributes inherited from ilPropertyFormGUI
bool $required_text = false
 
ilLanguage $lng
 
ilCtrl $ctrl
 
ilTemplate $tpl
 
ilObjUser $user = null
 
ilSetting $settings = null
 
string $mode = "std"
 
bool $check_input_called = false
 
bool $disable_standard_message = false
 
string $top_anchor = "il_form_top"
 
string $title = ''
 
string $titleicon = ""
 
string $description = ""
 
string $tbl_width = ""
 
bool $show_top_buttons = true
 
bool $hide_labels = false
 
bool $force_top_buttons = false
 
HTTP Services $http
 
Refinery Factory $refinery = null
 
ilGlobalTemplateInterface $global_tpl = null
 
 $onload_code = []
 
- Protected Attributes inherited from ilFormGUI
string $formaction = ""
 
bool $multipart = false
 
bool $keepopen = false
 
bool $opentag = true
 
string $id = ''
 
string $name = ''
 
string $target = ''
 
bool $prevent_double_submission = false
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

ilAssOrderingQuestionAuthoringFormGUI::__construct ( )

Member Function Documentation

◆ addSpecificOrderingQuestionCommandButtons()

ilAssOrderingQuestionAuthoringFormGUI::addSpecificOrderingQuestionCommandButtons ( assOrderingQuestion  $questionOBJ)

Definition at line 54 of file class.ilAssOrderingQuestionAuthoringFormGUI.php.

References ilFormGUI\$id, ilPropertyFormGUI\addCommandButton(), buildCommandButtonId(), assOrderingQuestionGUI\CMD_SWITCH_TO_PICTURESS, assOrderingQuestionGUI\CMD_SWITCH_TO_TERMS, assOrderingQuestion\isImageOrderingType(), and ILIAS\Repository\lng().

Referenced by renewOrderingCommandButtons().

54  : void
55  {
56  if ($questionOBJ->isImageOrderingType()) {
58  $label = $this->lng->txt("oq_btn_use_order_terms");
59  } else {
61  $label = $this->lng->txt("oq_btn_use_order_pictures");
62  }
63 
64  $id = $this->buildCommandButtonId($cmd);
65  $this->addCommandButton($cmd, $label, $id);
66  }
addCommandButton(string $a_cmd, string $a_text, string $a_id="")
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ buildCommandButtonId()

ilAssOrderingQuestionAuthoringFormGUI::buildCommandButtonId (   $id)
protected

Definition at line 99 of file class.ilAssOrderingQuestionAuthoringFormGUI.php.

References ilFormGUI\$id.

Referenced by __construct(), and addSpecificOrderingQuestionCommandButtons().

99  : string
100  {
101  return self::COMMAND_BUTTON_PREFIX . $id;
102  }
+ Here is the caller graph for this function:

◆ ensureReprintableFormStructure()

ilAssOrderingQuestionAuthoringFormGUI::ensureReprintableFormStructure ( assOrderingQuestion  $questionOBJ)

Definition at line 80 of file class.ilAssOrderingQuestionAuthoringFormGUI.php.

References renewOrderingCommandButtons(), and renewOrderingElementInput().

80  : void
81  {
82  $this->renewOrderingElementInput($questionOBJ);
83  $this->renewOrderingCommandButtons($questionOBJ);
84  }
+ Here is the call graph for this function:

◆ getAvailableCommandButtonIds()

ilAssOrderingQuestionAuthoringFormGUI::getAvailableCommandButtonIds ( )
protected

◆ getOrderingElementInputField()

ilAssOrderingQuestionAuthoringFormGUI::getOrderingElementInputField ( )

Definition at line 68 of file class.ilAssOrderingQuestionAuthoringFormGUI.php.

References ilPropertyFormGUI\getItemByPostVar(), and assOrderingQuestion\ORDERING_ELEMENT_FORM_FIELD_POSTVAR.

Referenced by prepareValuesReprintable().

69  {
70  return $this->getItemByPostVar(
72  );
73  }
getItemByPostVar(string $a_post_var)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ prepareValuesReprintable()

ilAssOrderingQuestionAuthoringFormGUI::prepareValuesReprintable ( assOrderingQuestion  $questionOBJ)

Definition at line 75 of file class.ilAssOrderingQuestionAuthoringFormGUI.php.

References getOrderingElementInputField().

75  : void
76  {
77  $this->getOrderingElementInputField()->prepareReprintable($questionOBJ);
78  }
+ Here is the call graph for this function:

◆ renewOrderingCommandButtons()

ilAssOrderingQuestionAuthoringFormGUI::renewOrderingCommandButtons ( assOrderingQuestion  $questionOBJ)
protected

Definition at line 104 of file class.ilAssOrderingQuestionAuthoringFormGUI.php.

References ilAssQuestionAuthoringFormGUI\addGenericAssessmentQuestionCommandButtons(), addSpecificOrderingQuestionCommandButtons(), and ilPropertyFormGUI\clearCommandButtons().

Referenced by ensureReprintableFormStructure().

104  : void
105  {
106  $this->clearCommandButtons();
107  $this->addSpecificOrderingQuestionCommandButtons($questionOBJ);
108  $this->addGenericAssessmentQuestionCommandButtons($questionOBJ);
109  }
addGenericAssessmentQuestionCommandButtons(assQuestion $questionOBJ)
addSpecificOrderingQuestionCommandButtons(assOrderingQuestion $questionOBJ)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ renewOrderingElementInput()

ilAssOrderingQuestionAuthoringFormGUI::renewOrderingElementInput ( assOrderingQuestion  $questionOBJ)
protected
Parameters
assOrderingQuestion$questionOBJ
Exceptions
ilTestQuestionPoolException

Definition at line 90 of file class.ilAssOrderingQuestionAuthoringFormGUI.php.

References assOrderingQuestion\buildOrderingElementInputGui(), assQuestion\getId(), ilPropertyFormGUI\getItemByPostVar(), assOrderingQuestion\initOrderingElementAuthoringProperties(), and ilAssQuestionAuthoringFormGUI\replaceFormItemByPostVar().

Referenced by ensureReprintableFormStructure().

90  : void
91  {
92  $replacingInput = $questionOBJ->buildOrderingElementInputGui();
93  $questionOBJ->initOrderingElementAuthoringProperties($replacingInput);
94  $dodgingInput = $this->getItemByPostVar($replacingInput->getPostVar());
95  $replacingInput->setElementList($dodgingInput->getElementList($questionOBJ->getId()));
96  $this->replaceFormItemByPostVar($replacingInput);
97  }
initOrderingElementAuthoringProperties(ilFormPropertyGUI $formField)
getItemByPostVar(string $a_post_var)
replaceFormItemByPostVar(ilFormPropertyGUI $replacingItem)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setAvailableCommandButtonIds()

ilAssOrderingQuestionAuthoringFormGUI::setAvailableCommandButtonIds (   $availableCommandButtonIds)
protected

Definition at line 44 of file class.ilAssOrderingQuestionAuthoringFormGUI.php.

References $availableCommandButtonIds.

Referenced by __construct().

44  : void
45  {
46  $this->availableCommandButtonIds = $availableCommandButtonIds;
47  }
+ Here is the caller graph for this function:

Field Documentation

◆ $availableCommandButtonIds

ilAssOrderingQuestionAuthoringFormGUI::$availableCommandButtonIds = null
protected

◆ COMMAND_BUTTON_PREFIX

const ilAssOrderingQuestionAuthoringFormGUI::COMMAND_BUTTON_PREFIX = 'assOrderingQuestionBtn_'

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