Inheritance diagram for ilLTIConsumeProviderFormGUI:

Collaboration diagram for ilLTIConsumeProviderFormGUI:

Public Member Functions
	__construct (ilLTIConsumeProvider $provider)
	ilLTIConsumeProviderFormGUI constructor. More...

	isAdminContext ()

	setAdminContext (bool $adminContext)

	initForm ($formaction, $saveCmd, $cancelCmd)

	initProvider (ilLTIConsumeProvider $provider)

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 Attributes
	$provider

	$adminContext = false

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

Additional Inherited Members
Protected Member Functions inherited from ilPropertyFormGUI
	hideRequired ($a_type)

	rebuildUploadedFiles ()
	try to rebuild files More...

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilLTIConsumeProviderFormGUI::__construct ( ilLTIConsumeProvider $provider )

ilLTIConsumeProviderFormGUI constructor.

Parameters

ilLTIConsumeProvider $provider

Definition at line 30 of file class.ilLTIConsumeProviderFormGUI.php.

    {
        parent::__construct();
        
        $this->provider = $provider;
    }

References $provider, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ initForm()

ilLTIConsumeProviderFormGUI::initForm	(	$formaction,
		$saveCmd,
		$cancelCmd
	)

Parameters

$formaction
$saveCmd
$cancelCmd

Definition at line 58 of file class.ilLTIConsumeProviderFormGUI.php.

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        $lng = $DIC->language();
        
        $this->setFormAction($formaction);
        $this->addCommandButton($saveCmd, $lng->txt('save'));
        $this->addCommandButton($cancelCmd, $lng->txt('cancel'));
        
        if ($this->provider->getId()) {
            $this->setTitle($lng->txt('lti_form_provider_edit'));
        } else {
            $this->setTitle($lng->txt('lti_form_provider_create'));
        }
        
        $titleInp = new ilTextInputGUI($lng->txt('lti_con_prov_title'), 'title');
        $titleInp->setValue($this->provider->getTitle());
        $titleInp->setRequired(true);
        $this->addItem($titleInp);
        
        $descInp = new ilTextInputGUI($lng->txt('lti_con_prov_description'), 'description');
        $descInp->setValue($this->provider->getDescription());
        $this->addItem($descInp);
        
        $iconInp = new ilImageFileInputGUI($lng->txt('lti_con_prov_icon'), 'icon');
        $iconInp->setInfo($lng->txt('obj_tile_image_info'));
        $iconInp->setSuffixes(ilLTIConsumeProviderIcon::getSupportedFileExtensions());
        $iconInp->setUseCache(false);
        if ($this->provider->hasProviderIcon() && $this->provider->getProviderIcon()->exists()) {
            $iconInp->setImage($this->provider->getProviderIcon()->getAbsoluteFilePath());
        } else {
            $iconInp->setImage('');//todo default image?
        }
        $this->addItem($iconInp);
        
        if ($this->isAdminContext()) {
            $availabilityInp = new ilRadioGroupInputGUI($lng->txt('lti_con_prov_availability'), 'availability');
            $availabilityInp->setValue($this->provider->getAvailability());
            $availabilityInp->setRequired(true);
            $optionCreate = new ilRadioOption(
                $lng->txt('lti_con_prov_availability_create'),
                ilLTIConsumeProvider::AVAILABILITY_CREATE
            );
            $availabilityInp->addOption($optionCreate);
            $optionCreate = new ilRadioOption(
                $lng->txt('lti_con_prov_availability_existing'),
                ilLTIConsumeProvider::AVAILABILITY_EXISTING
            );
            $availabilityInp->addOption($optionCreate);
            $optionCreate = new ilRadioOption(
                $lng->txt('lti_con_prov_availability_non'),
                ilLTIConsumeProvider::AVAILABILITY_NONE
            );
            $availabilityInp->addOption($optionCreate);
            $this->addItem($availabilityInp);
        }
        
        
        $sectionHeader = new ilFormSectionHeaderGUI();
        $sectionHeader->setTitle($lng->txt('lti_con_prov_authentication'));
        $this->addItem($sectionHeader);
        
        
        $providerUrlInp = new ilTextInputGUI($lng->txt('lti_con_prov_url'), 'provider_url');
        $providerUrlInp->setValue($this->provider->getProviderUrl());
        $providerUrlInp->setRequired(true);
        $this->addItem($providerUrlInp);
        //Abfrage ob Key und secret von Objekterstellern eingegeben werden soll
        $item = new ilCheckboxInputGUI($lng->txt('lti_con_prov_provider_key_global'), 'provider_key_global');
        $item->setValue("1");
        if (!$this->provider->isProviderKeyCustomizable()) {
            $item->setChecked(true);
        }
        $item->setInfo($lng->txt('lti_con_prov_provider_key_global_info'));
 
        $providerKeyInp = new ilTextInputGUI($lng->txt('lti_con_prov_key'), 'provider_key');
        $providerKeyInp->setValue($this->provider->getProviderKey());
        $providerKeyInp->setRequired(true);
        $item->addSubItem($providerKeyInp);
        
        $providerSecretInp = new ilTextInputGUI($lng->txt('lti_con_prov_secret'), 'provider_secret');
        $providerSecretInp->setValue($this->provider->getProviderSecret());
        $providerSecretInp->setRequired(true);
        $item->addSubItem($providerSecretInp);
        
        $this->addItem($item);
 
        //privacy-settings
 
        $sectionHeader = new ilFormSectionHeaderGUI();
        $sectionHeader->setTitle($lng->txt('lti_con_prov_privacy_settings'));
        $this->addItem($sectionHeader);
        
        $item = new ilRadioGroupInputGUI($DIC->language()->txt('conf_privacy_ident'), 'privacy_ident');
        $op = new ilRadioOption(
            $DIC->language()->txt('conf_privacy_ident_il_uuid_user_id'),
            ilLTIConsumeProvider::PRIVACY_IDENT_IL_UUID_USER_ID
        );
        $op->setInfo($DIC->language()->txt('conf_privacy_ident_il_uuid_user_id_info'));
        $item->addOption($op);
        $op = new ilRadioOption(
            $DIC->language()->txt('conf_privacy_ident_il_uuid_login'),
            ilLTIConsumeProvider::PRIVACY_IDENT_IL_UUID_LOGIN
        );
        $op->setInfo($DIC->language()->txt('conf_privacy_ident_il_uuid_login_info'));
        $item->addOption($op);
        $op = new ilRadioOption(
            $DIC->language()->txt('conf_privacy_ident_il_uuid_ext_account'),
            ilLTIConsumeProvider::PRIVACY_IDENT_IL_UUID_EXT_ACCOUNT
        );
        $op->setInfo($DIC->language()->txt('conf_privacy_ident_il_uuid_ext_account_info'));
        $item->addOption($op);
        $op = new ilRadioOption(
            $DIC->language()->txt('conf_privacy_ident_il_uuid_SHA256'),
            ilCmiXapiLrsType::PRIVACY_IDENT_IL_UUID_SHA256
        );
        $op->setInfo($DIC->language()->txt('conf_privacy_ident_il_uuid_SHA256_info'));
        $item->addOption($op);
        $op = new ilRadioOption(
            $DIC->language()->txt('conf_privacy_ident_real_email'),
            ilLTIConsumeProvider::PRIVACY_IDENT_REAL_EMAIL
        );
        $op->setInfo($DIC->language()->txt('conf_privacy_ident_real_email_info'));
        $item->addOption($op);
        $item->setValue($this->provider->getPrivacyIdent());
        $item->setInfo(
            $DIC->language()->txt('conf_privacy_ident_info') . ' ' . ilCmiXapiUser::getIliasUuid()
        );
        $item->setRequired(false);
        $this->addItem($item);
        
        $item = new ilRadioGroupInputGUI($DIC->language()->txt('conf_privacy_name'), 'privacy_name');
        $op = new ilRadioOption($DIC->language()->txt('conf_privacy_name_none'), ilLTIConsumeProvider::PRIVACY_NAME_NONE);
        $op->setInfo($DIC->language()->txt('conf_privacy_name_none_info'));
        $item->addOption($op);
        $op = new ilRadioOption($DIC->language()->txt('conf_privacy_name_firstname'), ilLTIConsumeProvider::PRIVACY_NAME_FIRSTNAME);
        $op->setInfo($DIC->language()->txt('conf_privacy_name_firstname_info'));
        $item->addOption($op);
        $op = new ilRadioOption($DIC->language()->txt('conf_privacy_name_lastname'), ilLTIConsumeProvider::PRIVACY_NAME_LASTNAME);
        $op->setInfo($DIC->language()->txt('conf_privacy_name_lastname_info'));
        $item->addOption($op);
        $op = new ilRadioOption($DIC->language()->txt('conf_privacy_name_fullname'), ilLTIConsumeProvider::PRIVACY_NAME_FULLNAME);
        $op->setInfo($DIC->language()->txt('conf_privacy_name_fullname_info'));
        $item->addOption($op);
        $item->setValue($this->provider->getPrivacyName());
        $item->setInfo($DIC->language()->txt('conf_privacy_name_info'));
        $item->setRequired(false);
        $this->addItem($item);
        
        $includeUserImage = new ilCheckboxInputGUI($lng->txt('lti_con_prov_inc_usr_pic'), 'inc_usr_pic');
        $includeUserImage->setInfo($lng->txt('lti_con_prov_inc_usr_pic_info'));
        $includeUserImage->setChecked($this->provider->getIncludeUserPicture());
        $this->addItem($includeUserImage);
 
        $item = new ilCheckboxInputGUI($lng->txt('lti_con_prov_external_provider'), 'is_external_provider');
        $item->setValue("1");
        if ($this->provider->IsExternalProvider()) {
            $item->setChecked(true);
        }
        $item->setInfo($lng->txt('lti_con_prov_external_provider_info'));
        $this->addItem($item);
 
 
        $sectionHeader = new ilFormSectionHeaderGUI();
        $sectionHeader->setTitle($lng->txt('lti_con_prov_learning_progress_options'));
        $this->addItem($sectionHeader);
        $item = new ilCheckboxInputGUI($lng->txt('lti_con_prov_has_outcome_service'), 'has_outcome_service');
        $item->setValue("1");
        if ($this->provider->getHasOutcome()) {
            $item->setChecked(true);
        }
        $item->setInfo($lng->txt('lti_con_prov_has_outcome_service_info'));
        $masteryScore = new ilNumberInputGUI($lng->txt('lti_con_prov_mastery_score_default'), 'mastery_score');
        $masteryScore->setInfo($lng->txt('lti_con_prov_mastery_score_default_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->provider->getMasteryScorePercent());
        $item->addSubItem($masteryScore);
        $this->addItem($item);
        
        
        $sectionHeader = new ilFormSectionHeaderGUI();
        $sectionHeader->setTitle($lng->txt('lti_con_prov_launch_options'));
        $this->addItem($sectionHeader);
 
        $item = new ilCheckboxInputGUI($lng->txt('lti_con_prov_use_provider_id'), 'use_provider_id');
        $item->setValue("1");
        if ($this->provider->getUseProviderId()) {
            $item->setChecked(true);
        }
        $item->setInfo($lng->txt('lti_con_prov_use_provider_id_info'));
        
        $this->addItem($item);
        
        $item = new ilCheckboxInputGUI($lng->txt('lti_con_prov_always_learner'), 'always_learner');
        $item->setValue("1");
        if ($this->provider->getAlwaysLearner()) {
            $item->setChecked(true);
        }
        $item->setInfo($lng->txt('lti_con_prov_always_learner_info'));
        $this->addItem($item);
 
        $item = new ilCheckboxInputGUI($lng->txt('lti_con_prov_use_xapi'), 'use_xapi');
        $item->setValue("1");
        if ($this->provider->getUseXapi()) {
            $item->setChecked(true);
        }
        $item->setInfo($lng->txt('lti_con_prov_use_xapi_info'));
        
        $subitem = new ilTextInputGUI($lng->txt('lti_con_prov_xapi_launch_url'), 'xapi_launch_url');
        $subitem->setValue($this->provider->getXapiLaunchUrl());
        $subitem->setInfo($lng->txt('lti_con_prov_xapi_launch_url_info'));
        $subitem->setRequired(true);
        $subitem->setMaxLength(255);
        $item->addSubItem($subitem);
 
        $subitem = new ilTextInputGUI($lng->txt('lti_con_prov_xapi_launch_key'), 'xapi_launch_key');
        $subitem->setValue($this->provider->getXapiLaunchKey());
        $subitem->setInfo($lng->txt('lti_con_prov_xapi_launch_key_info'));
        $subitem->setRequired(true);
        $subitem->setMaxLength(64);
        $item->addSubItem($subitem);
 
        $subitem = new ilTextInputGUI($lng->txt('lti_con_prov_xapi_launch_secret'), 'xapi_launch_secret');
        $subitem->setValue($this->provider->getXapiLaunchSecret());
        $subitem->setInfo($lng->txt('lti_con_prov_xapi_launch_secret_info'));
        $subitem->setRequired(true);
        $subitem->setMaxLength(64);
        $item->addSubItem($subitem);
    
        $subitem = new ilTextInputGUI($lng->txt('lti_con_prov_xapi_activity_id'), 'xapi_activity_id');
        $subitem->setValue($this->provider->getXapiActivityId());
        $subitem->setInfo($lng->txt('lti_con_prov_xapi_activity_id_info'));
        $subitem->setMaxLength(128);
        $item->addSubItem($subitem);
        
        $this->addItem($item);
 
        $item = new ilTextAreaInputGUI($lng->txt('lti_con_prov_custom_params'), 'custom_params');
        $item->setValue($this->provider->getCustomParams());
        $item->setRows(6);
        $item->setInfo($lng->txt('lti_con_prov_custom_params_info'));
        $this->addItem($item);
 
        $sectionHeader = new ilFormSectionHeaderGUI();
        $sectionHeader->setTitle($lng->txt('lti_con_prov_group_options'));
        $this->addItem($sectionHeader);
        
        $item = new ilTextInputGUI($lng->txt('lti_con_prov_keywords'), 'keywords');
        $item->setValue($this->provider->getKeywords());
        $item->setInfo($lng->txt('lti_con_prov_keywords_info'));
        $item->setMaxLength(1000);
        $this->addItem($item);
        
        $category = new ilRadioGroupInputGUI($DIC->language()->txt('lti_con_prov_category'), 'category');
        $category->setInfo($DIC->language()->txt('lti_con_prov_category_info'));
        $category->setValue($this->provider->getCategory());
        $category->setRequired(true);
        foreach (ilLTIConsumeProvider::getCategoriesSelectOptions() as $value => $label) {
            $category->addOption(new ilRadioOption($label, $value));
        }
        $this->addItem($category);
 
        $sectionHeader = new ilFormSectionHeaderGUI();
        $sectionHeader->setTitle($lng->txt('lti_con_prov_hints'));
        $this->addItem($sectionHeader);
 
        $remarksInp = new ilTextAreaInputGUI($lng->txt('lti_con_prov_remarks'), 'remarks');
        $remarksInp->setValue($this->provider->getRemarks());
        $remarksInp->setRows(6);
        $this->addItem($remarksInp);
    }

Here is the call graph for this function:

◆ initProvider()

ilLTIConsumeProviderFormGUI::initProvider ( ilLTIConsumeProvider $provider )

Definition at line 337 of file class.ilLTIConsumeProviderFormGUI.php.

    {
        $provider->setTitle($this->getInput('title'));
        $provider->setDescription($this->getInput('description'));
        
        $provider->setProviderIconUploadInput($this->getItemByPostVar('icon'));
        
        
        $provider->setHasOutcome((bool) $this->getInput('has_outcome_service'));
        $provider->setMasteryScorePercent($this->getInput('mastery_score'));
        
        if ($this->isAdminContext()) {
            $provider->setAvailability($this->getInput('availability'));
        }
        
        if ($this->getInput('provider_key_global') == 1) {
            $provider->setProviderKeyCustomizable(false);
            $provider->setProviderKey($this->getInput('provider_key'));
            $provider->setProviderSecret($this->getInput('provider_secret'));
        } else {
            $provider->setProviderKeyCustomizable(true);
        }
        $provider->setPrivacyIdent($this->getInput('privacy_ident'));
        $provider->setPrivacyName($this->getInput('privacy_name'));
        $provider->setIncludeUserPicture((bool) $this->getInput('inc_usr_pic'));
        $provider->setIsExternalProvider((bool) $this->getInput('is_external_provider'));
        
        $provider->setAlwaysLearner((bool) $this->getInput('always_learner'));
        
        $provider->setUseProviderId((bool) $this->getInput('use_provider_id'));
        $provider->setXapiActivityId($this->getInput('xapi_activity_id'));
        
        $provider->setUseXapi((bool) $this->getInput('use_xapi'));
        $provider->setXapiLaunchUrl($this->getInput('xapi_launch_url'));
        $provider->setXapiLaunchKey($this->getInput('xapi_launch_key'));
        $provider->setXapiLaunchSecret($this->getInput('xapi_launch_secret'));
        $provider->setCustomParams($this->getInput('custom_params'));
        $provider->setKeywords($this->getInput('keywords'));
        
        if ($provider->isValidCategory($this->getInput('category'))) {
            $provider->setCategory($this->getInput('category'));
        }
        
        if (null !== $this->getInput('provider_url')) {
            $provider->setProviderUrl($this->getInput('provider_url'));
        }
        if ($provider->isProviderKeyCustomizable()) {
            $provider->setProviderKey($this->getInput('provider_key'));
            $provider->setProviderSecret($this->getInput('provider_secret'));
        }
        $provider->setRemarks($this->getInput('remarks'));
    }

Here is the call graph for this function:

◆ isAdminContext()

ilLTIConsumeProviderFormGUI::isAdminContext ( )

Returns: bool

Definition at line 40 of file class.ilLTIConsumeProviderFormGUI.php.

                                     : bool
    {
        return $this->adminContext;
    }

References $adminContext.

Referenced by initForm(), and initProvider().

Here is the caller graph for this function:

◆ setAdminContext()

ilLTIConsumeProviderFormGUI::setAdminContext ( bool $adminContext )

Parameters

bool $adminContext

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

    {
        $this->adminContext = $adminContext;
    }

References $adminContext.

Field Documentation

◆ $adminContext

ilLTIConsumeProviderFormGUI::$adminContext = false

protected

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

Referenced by isAdminContext(), and setAdminContext().

◆ $provider

ilLTIConsumeProviderFormGUI::$provider

protected

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

Referenced by __construct(), and initProvider().

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

Modules/LTIConsumer/classes/class.ilLTIConsumeProviderFormGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ initForm()

◆ initProvider()

◆ isAdminContext()

◆ setAdminContext()

Field Documentation

◆ $adminContext

◆ $provider