Inheritance diagram for ilLTIConsumerSettingsFormGUI:

Collaboration diagram for ilLTIConsumerSettingsFormGUI:

Public Member Functions
	__construct (ilObjLTIConsumer $object, string $formaction, string $saveCommand, string $cancelCommand)
	ilLTIConsumerSettingsFormGUI constructor. More...

	initObject (ilObjLTIConsumer $object)

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 ()

Protected Member Functions
	initForm (string $formaction, string $saveCommand, string $cancelCommand)

Protected Member Functions inherited from ilPropertyFormGUI
	getRequestedPostVar ()

	getFileHash ()

	hideRequired (string $a_type)

	appendOnloadCode (string $html)

	rebuildUploadedFiles ()

	checkForRequiredField ()

Protected Attributes
ilObjLTIConsumer	$object

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

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

Constructor & Destructor Documentation

◆ __construct()

ilLTIConsumerSettingsFormGUI::__construct	(	ilObjLTIConsumer	$object,
		string	$formaction,
		string	$saveCommand,
		string	$cancelCommand
	)

ilLTIConsumerSettingsFormGUI constructor.

Definition at line 39 of file class.ilLTIConsumerSettingsFormGUI.php.

References $object, ILIAS\MetaData\Repository\Validation\Data\__construct(), and initForm().

     {
         $this->object = $object;
 
         parent::__construct();
 
         $this->initForm($formaction, $saveCommand, $cancelCommand);
     }

Here is the call graph for this function:

Member Function Documentation

◆ initForm()

ilLTIConsumerSettingsFormGUI::initForm	(	string	$formaction,
		string	$saveCommand,
		string	$cancelCommand
	)

protected

Definition at line 48 of file class.ilLTIConsumerSettingsFormGUI.php.

References $DIC, ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ilObjLTIConsumer\HIGHSCORE_SHOW_ALL_TABLES, ilObjLTIConsumer\HIGHSCORE_SHOW_OWN_TABLE, ilObjLTIConsumer\HIGHSCORE_SHOW_TOP_TABLE, ilObjLTIConsumer\LAUNCH_METHOD_EMBEDDED, ilObjLTIConsumer\LAUNCH_METHOD_NEW_WIN, ilObjLTIConsumer\LAUNCH_METHOD_OWN_WIN, ILIAS\Repository\object(), ilFormGUI\setFormAction(), ilRadioOption\setInfo(), ilFormPropertyGUI\setInfo(), ilFormPropertyGUI\setRequired(), ilTextAreaInputGUI\setRows(), and ilPropertyFormGUI\setTitle().

Referenced by __construct().

                                                                                                : void
     {
         global $DIC; /* @var \ILIAS\DI\Container $DIC */
         $DIC->language()->loadLanguageModule('lti');
         $this->setFormAction($formaction);
         $this->addCommandButton($saveCommand, $DIC->language()->txt('save'));
         $this->addCommandButton($cancelCommand, $DIC->language()->txt('cancel'));
 
         $this->setTitle($DIC->language()->txt('lti_settings_form'));
 
         $item = new ilNonEditableValueGUI($DIC->language()->txt('provider_info'));
         $item->setValue($this->object->getProvider()->getTitle());
         $item->setInfo(htmlspecialchars($this->object->getProvider()->getDescription()));
         $this->addItem($item);
 
         $item = new ilTextInputGUI($DIC->language()->txt('title'), 'title');
         $item->setSize(40);
         $item->setMaxLength(128);
         $item->setRequired(true);
         $item->setInfo($DIC->language()->txt('title_info'));
         $item->setValue($this->object->getTitle());
         $this->addItem($item);
 
         $item = new ilTextAreaInputGUI($DIC->language()->txt('description'), 'description');
         $item->setInfo($DIC->language()->txt('description_info'));
         $item->setRows(2);
         $item->setValue($this->object->getDescription());
         $this->addItem($item);
 
         $item = new ilCheckboxInputGUI($DIC->language()->txt('online'), 'online');
         $item->setInfo($DIC->language()->txt("online_info"));
         $item->setValue("1");
         if (!$this->object->getOfflineStatus()) {
             $item->setChecked(true);
         }
         $this->addItem($item);
 
         if ($this->object->getProvider()->getLtiVersion() == 'LTI-1p0' && $this->object->getProvider()->isProviderKeyCustomizable()) {
             $sectionHeader = new ilFormSectionHeaderGUI();
             $sectionHeader->setTitle($DIC->language()->txt('lti_con_prov_authentication'));
             $this->addItem($sectionHeader);
 
             $providerKeyInp = new ilTextInputGUI($DIC->language()->txt('lti_con_prov_key'), 'provider_key');
             $providerKeyInp->setValue($this->object->getCustomLaunchKey());
             $providerKeyInp->setRequired(true);
             $this->addItem($providerKeyInp);
 
             $providerSecretInp = new ilTextInputGUI($DIC->language()->txt('lti_con_prov_secret'), 'provider_secret');
             $providerSecretInp->setValue($this->object->getCustomLaunchSecret());
             $providerSecretInp->setRequired(true);
             $this->addItem($providerSecretInp);
         }
 
         if ($this->object->getProvider()->getHasOutcome()) {
             $sectionHeader = new ilFormSectionHeaderGUI();
             $sectionHeader->setTitle($DIC->language()->txt('learning_progress_options'));
             $this->addItem($sectionHeader);
             $masteryScore = new ilNumberInputGUI($DIC->language()->txt('mastery_score'), 'mastery_score');
             $masteryScore->setInfo($DIC->language()->txt('mastery_score_info'));
             $masteryScore->setSuffix('%');
             $masteryScore->allowDecimals(true);
             $masteryScore->setDecimals(2);
             $masteryScore->setMinvalueShouldBeGreater(false);
             $masteryScore->setMinValue(0);
             $masteryScore->setMaxvalueShouldBeLess(false);
             $masteryScore->setMaxValue(100);
             $masteryScore->setSize(4);
             $masteryScore->setValue((string) $this->object->getMasteryScorePercent());
             $this->addItem($masteryScore);
         }
 
         $item = new ilFormSectionHeaderGUI();
         $item->setTitle($DIC->language()->txt('lti_form_section_appearance'));
         $this->addItem($item);
 
         $item = new ilRadioGroupInputGUI($DIC->language()->txt('launch_method'), 'launch_method');
         $item->setRequired(true);
         $item->setValue($this->object->getLaunchMethod());
         $optOwnWindow = new ilRadioOption(
             $DIC->language()->txt('launch_method_own_win'),
             ilObjLTIConsumer::LAUNCH_METHOD_OWN_WIN
         );
         $optOwnWindow->setInfo($DIC->language()->txt('launch_method_own_win_info'));
         $item->addOption($optOwnWindow);
         $optAnyWindow = new ilRadioOption(
             $DIC->language()->txt('launch_method_new_win'),
             ilObjLTIConsumer::LAUNCH_METHOD_NEW_WIN
         );
         $optAnyWindow->setInfo($DIC->language()->txt('launch_method_new_win_info'));
         $item->addOption($optAnyWindow);
         $optEmbedded = new ilRadioOption(
             $DIC->language()->txt('launch_method_embedded'),
             ilObjLTIConsumer::LAUNCH_METHOD_EMBEDDED
         );
         $optEmbedded->setInfo($DIC->language()->txt('launch_method_embedded_info'));
         $item->addOption($optEmbedded);
         $this->addItem($item);
 
         $customParams = new ilTextAreaInputGUI($DIC->language()->txt('launch_custom_params'), 'custom_params');
         $customParams->setRows(6);
         $customParams->setValue($this->object->getCustomParams());
         $customParams->setInfo($DIC->language()->txt('lti_con_prov_custom_params_info'));
         $this->addItem($customParams);
 
         if ($this->object->getProvider()->getUseXapi()) {
             $item = new ilCheckboxInputGUI($DIC->language()->txt('use_xapi'), 'use_xapi');
             $item->setInfo($DIC->language()->txt("use_xapi_info"));
             $item->setValue("1");
             if ($this->object->getUseXapi()) {
                 $item->setChecked(true);
             }
 
             if (!strlen($this->object->getProvider()->getXapiActivityId())) {
                 $subitem = new ilTextInputGUI($DIC->language()->txt('activity_id'), 'activity_id');
                 $subitem->setSize(40);
                 $subitem->setMaxLength(128);
                 $subitem->setRequired(true);
                 $subitem->setInfo($DIC->language()->txt('activity_id_info'));
                 $subitem->setValue($this->object->getCustomActivityId());
                 $item->addSubItem($subitem);
             }
 
             $subitem = new ilCheckboxInputGUI($DIC->language()->txt('show_statements'), 'show_statements');
             $subitem->setInfo($DIC->language()->txt("show_statements_info"));
             $subitem->setValue("1");
             if ($this->object->isStatementsReportEnabled()) {
                 $subitem->setChecked(true);
             }
             $item->addSubItem($subitem);
 
             $highscore = new ilCheckboxInputGUI($DIC->language()->txt("highscore_enabled"), "highscore_enabled");
             $highscore->setValue("1");
             $highscore->setChecked($this->object->getHighscoreEnabled());
             $highscore->setInfo($DIC->language()->txt("highscore_description"));
             $highscore_tables = new ilRadioGroupInputGUI($DIC->language()->txt('highscore_mode'), 'highscore_mode');
             $highscore_tables->setRequired(true);
             $highscore_tables->setValue((string) $this->object->getHighscoreMode());
             $highscore_table_own = new ilRadioOption($DIC->language()->txt('highscore_own_table'), (string) ilObjLTIConsumer::HIGHSCORE_SHOW_OWN_TABLE);
             $highscore_table_own->setInfo($DIC->language()->txt('highscore_own_table_description'));
             $highscore_tables->addOption($highscore_table_own);
             $highscore_table_other = new ilRadioOption($DIC->language()->txt('highscore_top_table'), (string) ilObjLTIConsumer::HIGHSCORE_SHOW_TOP_TABLE);
             $highscore_table_other->setInfo($DIC->language()->txt('highscore_top_table_description'));
             $highscore_tables->addOption($highscore_table_other);
             $highscore_table_other = new ilRadioOption($DIC->language()->txt('highscore_all_tables'), (string) ilObjLTIConsumer::HIGHSCORE_SHOW_ALL_TABLES);
             $highscore_table_other->setInfo($DIC->language()->txt('highscore_all_tables_description'));
             $highscore_tables->addOption($highscore_table_other);
             $highscore->addSubItem($highscore_tables);
             $highscore_top_num = new ilNumberInputGUI($DIC->language()->txt("highscore_top_num"), "highscore_top_num");
             $highscore_top_num->setSize(4);
             $highscore_top_num->setRequired(true);
             $highscore_top_num->setMinValue(1);
             $highscore_top_num->setSuffix($DIC->language()->txt("highscore_top_num_unit"));
             $highscore_top_num->setValue((string) $this->object->getHighscoreTopNum(0));
             $highscore_top_num->setInfo($DIC->language()->txt("highscore_top_num_description"));
             $highscore->addSubItem($highscore_top_num);
             $highscore_achieved_ts = new ilCheckboxInputGUI($DIC->language()->txt("highscore_achieved_ts"), "highscore_achieved_ts");
             $highscore_achieved_ts->setValue("1");
             $highscore_achieved_ts->setChecked($this->object->getHighscoreAchievedTS());
             $highscore_achieved_ts->setInfo($DIC->language()->txt("highscore_achieved_ts_description"));
             $highscore->addSubItem($highscore_achieved_ts);
             $highscore_percentage = new ilCheckboxInputGUI($DIC->language()->txt("highscore_percentage"), "highscore_percentage");
             $highscore_percentage->setValue("1");
             $highscore_percentage->setChecked($this->object->getHighscorePercentage());
             $highscore_percentage->setInfo($DIC->language()->txt("highscore_percentage_description"));
             $highscore->addSubItem($highscore_percentage);
             $highscore_wtime = new ilCheckboxInputGUI($DIC->language()->txt("highscore_wtime"), "highscore_wtime");
             $highscore_wtime->setValue("1");
             $highscore_wtime->setChecked($this->object->getHighscoreWTime());
             $highscore_wtime->setInfo($DIC->language()->txt("highscore_wtime_description"));
             $highscore->addSubItem($highscore_wtime);
 
             $item->addSubItem($highscore);
             $this->addItem($item);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initObject()

ilLTIConsumerSettingsFormGUI::initObject ( ilObjLTIConsumer $object )

Definition at line 224 of file class.ilLTIConsumerSettingsFormGUI.php.

                                                         : void
     {
         $object->setTitle($this->getInput('title'));
         $object->setDescription($this->getInput('description'));
         $object->setOfflineStatus(!(bool) $this->getInput('online'));
 
         if ($object->getProvider()->getLtiVersion() == 'LTI-1p0' && $object->getProvider()->isProviderKeyCustomizable()) {
             $object->setCustomLaunchKey($this->getInput('provider_key'));
             $object->setCustomLaunchSecret($this->getInput('provider_secret'));
         }
 
         if ($object->getProvider()->getHasOutcome()) {
             $object->setMasteryScorePercent($this->getInput('mastery_score'));
         }
 
         $object->setLaunchMethod($this->getInput('launch_method'));
         $object->setCustomParams($this->getInput('custom_params'));
         $object->setUseXapi((bool) $this->getInput('use_xapi'));
         if ($object->getUseXapi()) {
             if (!strlen($this->object->getProvider()->getXapiActivityId())) {
                 $object->setCustomActivityId($this->getInput('activity_id'));
             }
             $object->setStatementsReportEnabled((bool) $this->getInput('show_statements'));
             $object->setHighscoreEnabled((bool) $this->getInput('highscore_enabled'));
             if ($object->getHighscoreEnabled()) {
                 // highscore settings
                 $object->setHighscoreEnabled((bool) $this->getInput('highscore_enabled'));
                 $object->setHighscoreAchievedTS((bool) $this->getInput('highscore_achieved_ts'));
                 $object->setHighscorePercentage((bool) $this->getInput('highscore_percentage'));
                 $object->setHighscoreWTime((bool) $this->getInput('highscore_wtime'));
                 $object->setHighscoreMode((int) $this->getInput('highscore_mode'));
                 $object->setHighscoreTopNum((int) $this->getInput('highscore_top_num'));
             }
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $object

ilObjLTIConsumer ilLTIConsumerSettingsFormGUI::$object

protected

Definition at line 34 of file class.ilLTIConsumerSettingsFormGUI.php.

Referenced by __construct().

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

Modules/LTIConsumer/classes/class.ilLTIConsumerSettingsFormGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ initForm()

◆ initObject()

Field Documentation

◆ $object