ilLTIConsumerSettingsFormGUI Class Reference

Inheritance diagram for ilLTIConsumerSettingsFormGUI:

Collaboration diagram for ilLTIConsumerSettingsFormGUI:

Public Member Functions
	__construct (ilObjLTIConsumer $object, $formaction, $saveCommand, $cancelCommand)
	ilLTIConsumerSettingsFormGUI constructor. More...
	initObject (ilObjLTIConsumer $object)
Public Member Functions inherited from ilPropertyFormGUI
	__construct ()
	Constructor. More...
	executeCommand ()
	Execute command. More...
	setTableWidth ($a_width)
	Set table width. More...
	getTableWidth ()
	get table width More...
	setMode ($a_mode)
	Set Mode ('std', 'subform'). More...
	getMode ()
	Get Mode ('std', 'subform'). More...
	setTitle ($a_title)
	Set Title. More...
	getTitle ()
	Get Title. More...
	setTitleIcon ($a_titleicon)
	Set TitleIcon. More...
	getTitleIcon ()
	Get TitleIcon. More...
	setDescription ($a_val)
	Set description. More...
	getDescription ()
	Get description. More...
	setTopAnchor ($a_val)
	Set top anchor. More...
	getTopAnchor ()
	Get top anchor. More...
	setShowTopButtons ($a_val)
	Get show top buttons. More...
	getShowTopButtons ()
	Set show top buttons. More...
	setForceTopButtons ($a_val)
	Set force top buttons. More...
	getForceTopButtons ()
	Get force top buttons. More...
	addItem ($a_item)
	Add Item (Property, SectionHeader). More...
	removeItemByPostVar ($a_post_var, $a_remove_unused_headers=false)
	Remove Item. More...
	getItemByPostVar ($a_post_var)
	Get Item by POST variable. More...
	setItems ($a_items)
	Set Items. More...
	getItems ()
	Get Items. More...
	getInputItemsRecursive ()
	returns a flat array of all input items including the possibly existing subitems recursively More...
	setDisableStandardMessage ($a_val)
	Set disable standard message. More...
	getDisableStandardMessage ()
	Get disable standard message. More...
	getHideLabels ()
	Get a value indicating whether the labels should be hidden or not. More...
	setHideLabels ($a_value=true)
	Set a value indicating whether the labels should be hidden or not. More...
	setValuesByArray ($a_values, $a_restrict_to_value_keys=false)
	Set form values from an array. More...
	setValuesByPost ()
	Set form values from POST values. More...
	checkInput ()
	Check Post Input. More...
	getInput ($a_post_var, $ensureValidation=true)
	Returns the value of a HTTP-POST variable, identified by the passed id. More...
	addCustomProperty ( $a_title, $a_html, $a_info="", $a_alert="", $a_required=false)
	Add a custom property. More...
	addCommandButton ($a_cmd, $a_text, $a_id="")
	Add Command button. More...
	getCommandButtons ()
	Return all Command buttons. More...
	clearCommandButtons ()
	Remove all command buttons. More...
	getContent ()
	Get Content. More...
	insertItem ($item, $a_sub_item=false)
	getHTML ()
	Get HTML. More...
	getFileUpload ($a_field, $a_index=null, $a_sub_index=null)
	Get file upload data. More...
	hasFileUpload ($a_field, $a_index=null, $a_sub_index=null)
	Was any file uploaded? More...
	moveFileUpload ($a_target_directory, $a_field, $a_target_name=null, $a_index=null, $a_sub_index=null)
	Move upload to target directory. More...
Public Member Functions inherited from ilFormGUI
	setFormAction ($a_formaction)
	Set FormAction. More...
	getFormAction ()
	Get FormAction. More...
	setTarget ($a_target)
	Set Target. More...
	getTarget ()
	Get Target. More...
	setMultipart ($a_multipart)
	Set Enctype Multipart/Formdata true/false. More...
	getMultipart ()
	Get Enctype Multipart/Formdata true/false. More...
	setId ($a_id)
	Set Id. More...
	getId ()
	Get Id. More...
	setName ($a_name)
	Set Name. More...
	getName ()
	Get Name. More...
	setKeepOpen ($a_keepopen)
	Set Keep Form Tag Open. More...
	getKeepOpen ()
	Get Keep Form Tag Open. More...
	setOpenTag ($a_open)
	Enable/Disable Open Form Tag. More...
	getOpenTag ()
	Get Open Form Tag Enabled. More...
	setCloseTag ($a_val)
	Set close tag. More...
	getCloseTag ()
	Get close tag. More...
	setPreventDoubleSubmission ($a_val)
	Set prevent double submission. More...
	getPreventDoubleSubmission ()
	Get prevent double submission. More...
	getHTML ()
	Get HTML. More...
	getContent ()
	Get Content. More...

Protected Member Functions
	initForm ($formaction, $saveCommand, $cancelCommand)
Protected Member Functions inherited from ilPropertyFormGUI
	hideRequired ($a_type)
	rebuildUploadedFiles ()
	try to rebuild files More...

Protected Attributes
	$object
Protected Attributes inherited from ilPropertyFormGUI
	$lng
	$ctrl
	$tpl
	$user
	$settings
	$mode = "std"
	$check_input_called = false
	$disable_standard_message = false
	$top_anchor = "il_form_top"
	$titleicon = false
	$description = ""
	$tbl_width = false
	$show_top_buttons = true
	$hide_labels = false
	$force_top_buttons = false
Protected Attributes inherited from ilFormGUI
	$formaction
	$multipart = false
	$keepopen = false
	$opentag = true
	$id
	$name
	$prevent_double_submission = false

Detailed Description

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

Constructor & Destructor Documentation

__construct()

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

ilLTIConsumerSettingsFormGUI constructor.

Parameters

ilObjLTIConsumer	$object
	$formaction
	$saveCommand
	$cancelCommand

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

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

References ilFormGUI\$formaction, $object, ILIAS\GlobalScreen\Provider\__construct(), and initForm().

Here is the call graph for this function:

Member Function Documentation

initForm()

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

protected

Parameters

$formaction
$saveCommand
$cancelCommand

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

    {
        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($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()->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($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);
        
        
        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($this->object->getHighscoreMode());
            $highscore_table_own = new ilRadioOption($DIC->language()->txt('highscore_own_table'), 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'), 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'), 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($this->object->getHighscoreTopNum(null));
            $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);
        }
    }

References $DIC, ilFormGUI\$formaction, 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, ilFormGUI\setFormAction(), and ilPropertyFormGUI\setTitle().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

initObject()

ilLTIConsumerSettingsFormGUI::initObject

(

ilObjLTIConsumer

$object

)

Parameters

ilObjLTIConsumer

$object

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

    {
        $object->setTitle($this->getInput('title'));
        $object->setDescription($this->getInput('description'));
        $object->setOfflineStatus(!(bool) $this->getInput('online'));
        
        if ($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->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'));
            }
        }
    }

References $object, ilObjLTIConsumer\getHighscoreEnabled(), ilPropertyFormGUI\getInput(), ilObjLTIConsumer\getProvider(), ilObjLTIConsumer\getUseXapi(), ilObjLTIConsumer\setCustomLaunchSecret(), ilObject2\setDescription(), ilObjLTIConsumer\setHighscoreAchievedTS(), ilObjLTIConsumer\setHighscoreEnabled(), ilObjLTIConsumer\setHighscoreMode(), ilObjLTIConsumer\setHighscorePercentage(), ilObjLTIConsumer\setHighscoreTopNum(), ilObjLTIConsumer\setHighscoreWTime(), ilObjLTIConsumer\setLaunchMethod(), ilObject\setOfflineStatus(), ilObjLTIConsumer\setStatementsReportEnabled(), and ilObjLTIConsumer\setUseXapi().

Here is the call graph for this function:

Field Documentation

$object

ilLTIConsumerSettingsFormGUI::$object

protected

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

Referenced by __construct(), and initObject().

---

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

• Modules/LTIConsumer/classes/class.ilLTIConsumerSettingsFormGUI.php