ilObjLTIAdministrationGUI Class Reference

Class ilObjLTIAdministrationGUI. More...

Inheritance diagram for ilObjLTIAdministrationGUI:

Collaboration diagram for ilObjLTIAdministrationGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
	executeCommand ()
	getType ()
	getAdminTabs ()
Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...
	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...
	getCreationMode ()
	get creation mode More...
	prepareOutput ($a_show_subobjects=true)
	prepare output More...
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
	getHTML ()
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
	cancelDeleteObject ()
	cancel deletion of object More...
	cancelObject ()
	cancel action and go back to previous page public More...
	createObject ()
	create new object form More...
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	save object More...
	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	edit object More...
	addExternalEditFormCustom (ilPropertyFormGUI $a_form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...
	isVisible ($a_ref_id, $a_type)
	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...
	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...
	addToDeskObject ()
	removeFromDeskObject ()

Protected Member Functions
	addProvidingSubtabs ()
	initSettingsForm (ilPropertyFormGUI $form=null)
	getSettingsForm ()
	createLtiUserRole ()
	initConsumerForm (ilPropertyFormGUI $form=null)
	getConsumerForm ($a_mode='')
	editConsumer (ilPropertyFormGUI $a_form=null)
	Edit consumer type $ilCtrl type $tpl. More...
	createLTIConsumer ()
	Create new lti consumer. More...
	updateLTIConsumer ()
	Update lti consumer settings ilCtrl $ilCtrl. More...
	deleteLTIConsumer ()
	Delete consumers type $ilCtrl. More...
	listConsumers ()
	List consumers type $ilAccess type $ilToolbar. More...
	changeStatusLTIConsumer ()
	Change activation status type $ilCtrl. More...
	releasedObjects ()
	Show relases objects. More...
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	Get object service. More...
	assignObject ()
	setTitleAndDescription ()
	called by prepare output More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	insertHeaderAction ($a_list_gui)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	setTabs ()
	set admin tabs public More...
	setAdminTabs ()
	set admin tabs public More...
	setLocator ()
	set Locator More...
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator ($a_omit=true)
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm ($a_new_type)
	Init object creation form. More...
	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	Init object edit form. More...
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	Get values for edit form. More...
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm ($a_new_type)
	Init object import form. More...
	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...
	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...
	getTabs ()
	get tabs abstract method. More...
	__showButton ($a_cmd, $a_text, $a_target='')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...
	redirectToRefId ($a_ref_id, $a_cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current $_GET["ref_id"] value More...
	fillCloneTemplate ($a_tpl_varname, $a_type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Private Attributes
	$dataConnector = null
	Data connector object or string. More...

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...
Data Fields inherited from ilObjectGUI
const	COPY_WIZARD_NEEDS_PAGE = 1
	$objDefinition
	$tpl
	$tree
	$lng
	$data
	$object
	$ref_id
	$obj_id
	$maxcount
	$formaction
	$return_location
	$target_frame
	$tab_target_script
	$actions
	$sub_objects
	$omit_locator = false
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3
Protected Attributes inherited from ilObjectGUI
	$ilErr
	$locator
	$user
	$access
	$rbacsystem
	$settings
	$rbacreview
	$toolbar
	$tmp_import_dir
	$tabs_gui = null
	$ctrl
	$object_service
	$favourites

Detailed Description

Class ilObjLTIAdministrationGUI.

Author

Jesús López lopez.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

ilObjLTIAdministrationGUI: ilPermissionGUI ilObjLTIAdministrationGUI: ilLTIConsumerAdministrationGUI ilObjLTIAdministrationGUI: ilAdministrationGUI

Definition at line 20 of file class.ilObjLTIAdministrationGUI.php.

Constructor & Destructor Documentation

__construct()

ilObjLTIAdministrationGUI::__construct	(		$a_data,
			$a_id,
			$a_call_by_reference = true,
			$a_prepare_output = true
	)

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

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

    {
        $this->type = "ltis";
        parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
        $this->dataConnector = new ilLTIDataConnector();
        
        $GLOBALS['DIC']->language()->loadLanguageModule('lti');
    }

Here is the call graph for this function:

Member Function Documentation

addProvidingSubtabs()

ilObjLTIAdministrationGUI::addProvidingSubtabs ( )

protected

Definition at line 108 of file class.ilObjLTIAdministrationGUI.php.

References $DIC, and ilObjectGUI\$rbacsystem.

Referenced by getAdminTabs().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        $rbacsystem = $DIC->rbac()->system();

        if ($rbacsystem->checkAccess("visible,read", $this->object->getRefId())) {
            // currently no general settings.
            //                  $this->tabs_gui->addTab("settings",
            //                          $this->lng->txt("settings"),
            //                          $this->ctrl->getLinkTarget($this, "initSettingsForm"));

            $this->tabs_gui->addSubTab(
                "consumers",
                $this->lng->txt("consumers"),
                $this->ctrl->getLinkTarget($this, "listConsumers")
            );
        }
        if ($rbacsystem->checkAccess("visible,read", $this->object->getRefId())) {
            $this->tabs_gui->addSubTab(
                "releasedObjects",
                $this->lng->txt("lti_released_objects"),
                $this->ctrl->getLinkTarget($this, "releasedObjects")
            );
        }
    }

Here is the caller graph for this function:

changeStatusLTIConsumer()

ilObjLTIAdministrationGUI::changeStatusLTIConsumer ( )

protected

Change activation status type $ilCtrl.

Definition at line 472 of file class.ilObjLTIAdministrationGUI.php.

References $GLOBALS, $ilCtrl, and ilLTIToolConsumer\fromExternalConsumerId().

    {
        global $ilCtrl;

        $consumer_id = $_REQUEST["cid"];

        if (!$consumer_id) {
            $ilCtrl->redirect($this, "listConsumers");
        }

        $consumer = ilLTIToolConsumer::fromExternalConsumerId($consumer_id, $this->dataConnector);
        if ($consumer->getActive()) {
            $consumer->setActive(0);
            $msg = "lti_consumer_set_inactive";
        } else {
            $consumer->setActive(1);
            $msg = "lti_consumer_set_active";
        }
        $consumer->saveGlobalToolConsumerSettings($this->dataConnector);
        ilUtil::sendSuccess($this->lng->txt($msg), true);
        
        $GLOBALS['DIC']->ctrl()->redirect($this, 'listConsumers');
    }

Here is the call graph for this function:

createLTIConsumer()

ilObjLTIAdministrationGUI::createLTIConsumer ( )

protected

Create new lti consumer.

Definition at line 348 of file class.ilObjLTIAdministrationGUI.php.

References $GLOBALS, ilObjectGUI\checkPermission(), getConsumerForm(), and listConsumers().

    {
        $this->checkPermission("write");

        $form = $this->getConsumerForm();
        
        if ($form->checkInput()) {
            // $consumer = new ilLTIExternalConsumer();
            // $dataConnector = new ilLTIDataConnector();
            $consumer = new ilLTIToolConsumer(null, $this->dataConnector);
            $consumer->setTitle($form->getInput('title'));
            $consumer->setDescription($form->getInput('description'));
            $consumer->setPrefix($form->getInput('prefix'));
            $consumer->setLanguage($form->getInput('language'));
            $consumer->setActive($form->getInput('active'));
            $consumer->setRole($form->getInput('role'));
            $consumer->saveGlobalToolConsumerSettings($this->dataConnector);
            
            $this->object->saveConsumerObjectTypes(
                $consumer->getExtConsumerId(),
                $form->getInput('types')
            );
            ilUtil::sendSuccess($this->lng->txt("lti_consumer_created"), true);
            $GLOBALS['DIC']->ctrl()->redirect($this, 'listConsumers');
        }

        $form->setValuesByPost();
        $this->listConsumers();
        return;
    }

Here is the call graph for this function:

createLtiUserRole()

ilObjLTIAdministrationGUI::createLtiUserRole ( )

protected

Definition at line 206 of file class.ilObjLTIAdministrationGUI.php.

References $DIC, listConsumers(), and ilObjRole\MODE_UNPROTECTED_KEEP_LOCAL_POLICIES.

        {
        global $DIC;
        $rbacadmin = $DIC['rbacadmin'];
        // include_once './Services/AccessControl/classes/class.ilObjRole.php';
        $role = new ilObjRole();
        $role->setTitle("il_lti_global_role");
        $role->setDescription("This global role should only contain the permission 'read' for repository and categories.");
        $role->create();
        $rbacadmin->assignRoleToFolder($role->getId(), 8, 'y');
        $rbacadmin->setProtected(8, $role->getId(), 'y');
        $rbacadmin->setRolePermission($role->getId(), 'root', [3], 8);
        $rbacadmin->setRolePermission($role->getId(), 'cat', [3], 8);
        $rbacadmin->grantPermission($role->getId(), [3], ROOT_FOLDER_ID);
        $role->changeExistingObjects(
            ROOT_FOLDER_ID,
            ilObjRole::MODE_UNPROTECTED_KEEP_LOCAL_POLICIES,
            array('cat'),
            array());
        
                ilUtil::sendSuccess($this->lng->txt("lti_user_role_created"), true);
                $this->listConsumers();
        }

Here is the call graph for this function:

deleteLTIConsumer()

ilObjLTIAdministrationGUI::deleteLTIConsumer ( )

protected

Delete consumers type $ilCtrl.

Definition at line 417 of file class.ilObjLTIAdministrationGUI.php.

References $GLOBALS, $ilCtrl, and ilLTIToolConsumer\fromExternalConsumerId().

    {
        global $ilCtrl;

        $consumer_id = $_REQUEST['cid'];

        if (!$consumer_id) {
            $ilCtrl->redirect($this, "listConsumers");
        }
        $consumer = ilLTIToolConsumer::fromExternalConsumerId($consumer_id, $this->dataConnector);
        $consumer->deleteGlobalToolConsumerSettings($this->dataConnector);
        ilUtil::sendSuccess($this->lng->txt("lti_consumer_deleted"), true);
        $GLOBALS['DIC']->ctrl()->redirect($this, 'listConsumers');
    }

Here is the call graph for this function:

editConsumer()

ilObjLTIAdministrationGUI::editConsumer ( ilPropertyFormGUI  $a_form = null )

protected

Edit consumer type $ilCtrl type $tpl.

Parameters

ilPropertyFormGUI

$a_form

Definition at line 321 of file class.ilObjLTIAdministrationGUI.php.

References $ilCtrl, ilObjectGUI\$tpl, ilLTIToolConsumer\fromExternalConsumerId(), and getConsumerForm().

    {
        global $ilCtrl, $tpl;
        $consumer_id = $_REQUEST["cid"];
        $ilCtrl->setParameter($this, "cid", $consumer_id);

        if (!$consumer_id) {
            $ilCtrl->redirect($this, "listConsumers");
        }

        $consumer = ilLTIToolConsumer::fromExternalConsumerId($consumer_id, $this->dataConnector);
        if (!$a_form instanceof ilPropertyFormGUI) {
            $a_form = $this->getConsumerForm('edit');
            $a_form->getItemByPostVar("title")->setValue($consumer->getTitle());
            $a_form->getItemByPostVar("description")->setValue($consumer->getDescription());
            $a_form->getItemByPostVar("prefix")->setValue($consumer->getPrefix());
            $a_form->getItemByPostVar("language")->setValue($consumer->getLanguage());
            $a_form->getItemByPostVar("active")->setChecked($consumer->getActive());
            $a_form->getItemByPostVar("role")->setValue($consumer->getRole());
            $a_form->getItemByPostVar("types")->setValue($this->object->getActiveObjectTypes($consumer_id));
        }
        $tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

executeCommand()

ilObjLTIAdministrationGUI::executeCommand

(

)

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

References $GLOBALS, and ilObjectGUI\prepareOutput().

    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
        
        $this->prepareOutput();

        switch ($next_class) {
            case 'ilpermissiongui':
                $GLOBALS['ilTabs']->activateTab('perm_settings');
                require_once 'Services/AccessControl/classes/class.ilPermissionGUI.php';
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;

            case 'illticonsumeradministrationgui':
                $this->tabs_gui->activateTab('lti_consuming');
                $gui = new ilLTIConsumerAdministrationGUI();
                $this->ctrl->forwardCommand($gui);
                break;

            default:
                $this->tabs_gui->activateTab('lti_providing');
                if (!$cmd || $cmd == 'view') {
                    $cmd = 'listConsumers';
                } elseif ($cmd == 'createconsumer') {
                    $cmd = "initConsumerForm";
                }
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

getAdminTabs()

ilObjLTIAdministrationGUI::getAdminTabs

(

)

Definition at line 76 of file class.ilObjLTIAdministrationGUI.php.

References $DIC, ilObjectGUI\$rbacsystem, and addProvidingSubtabs().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        global $rbacsystem;

        if ($rbacsystem->checkAccess("visible,read", $this->object->getRefId())) {
            $this->tabs_gui->addTab(
                'lti_providing',
                $this->lng->txt("lti_providing_tab"),
                $this->ctrl->getLinkTarget($this, "listConsumers")
            );

            $this->tabs_gui->addTab(
                'lti_consuming',
                $this->lng->txt("lti_consuming_tab"),
                $this->ctrl->getLinkTargetByClass('ilLTIConsumerAdministrationGUI')
            );

            if ($DIC->ctrl()->getCmdClass() == 'ilobjltiadministrationgui') {
                $this->addProvidingSubtabs();
            }
        }

        if ($rbacsystem->checkAccess('edit_permission', $this->object->getRefId())) {
            $this->tabs_gui->addTab(
                "perm_settings",
                $this->lng->txt("perm_settings"),
                $this->ctrl->getLinkTargetByClass('ilpermissiongui', "perm")
            );
        }
    }

Here is the call graph for this function:

getConsumerForm()

ilObjLTIAdministrationGUI::getConsumerForm (   $a_mode = '' )

protected

Parameters

string

$a_mode

Returns

ilPropertyFormGUI

Definition at line 245 of file class.ilObjLTIAdministrationGUI.php.

References $GLOBALS, ilLanguage\_lookupEntry(), and ilFormPropertyGUI\setRequired().

Referenced by createLTIConsumer(), editConsumer(), initConsumerForm(), and updateLTIConsumer().

    {
        $this->tabs_gui->activateSubTab("consumers");

        require_once("Services/Form/classes/class.ilPropertyFormGUI.php");

        $form = new ilPropertyFormGUI();

        $ti_title = new ilTextInputGUI($this->lng->txt("title"), 'title');
        $ti_title->setRequired(true);
        $ti_description = new ilTextInputGUI($this->lng->txt("description"), 'description');
        $ti_prefix = new ilTextInputGUI($this->lng->txt("prefix"), 'prefix');
        $ti_prefix->setRequired(true);
        #$ti_key = new ilTextInputGUI($this->lng->txt("lti_consumer_key"), 'key');
        #$ti_key->setRequired(true);
        #$ti_secret = new ilTextInputGUI($this->lng->txt("lti_consumer_secret"), 'secret');
        #$ti_secret->setRequired(true);

        $languages = $this->lng->getInstalledLanguages();
        $array_lang = array();
        foreach ($languages as $lang_key) {
            $array_lang[$lang_key] = ilLanguage::_lookupEntry($lang_key, "meta", "meta_l_" . $lang_key);
        }

        $si_language = new ilSelectInputGUI($this->lng->txt("language"), "language");
        $si_language->setOptions($array_lang);
        
        $cb_active = new ilCheckboxInputGUI($this->lng->txt('active'), 'active');

        $form->addItem($cb_active);
        $form->addItem($ti_title);
        $form->addItem($ti_description);
        $form->addItem($ti_prefix);
        #$form->addItem($ti_key);
        #$form->addItem($ti_secret);
        $form->addItem($si_language);

        // object types
        $cb_obj_types = new ilCheckboxGroupInputGUI($this->lng->txt("act_lti_for_obj_type"), 'types');

        $valid_obj_types = $this->object->getLTIObjectTypes();
        foreach ($valid_obj_types as $obj_type) {
            $object_name = $GLOBALS['DIC']->language()->txt('objs_' . $obj_type);
            $cb_obj_types->addOption(new ilCheckboxOption($object_name, $obj_type));
        }
        $form->addItem($cb_obj_types);

        // test roles
        $roles = $this->object->getLTIRoles();
        foreach ($roles as $role_id => $role_name) {
            $options[$role_id] = $role_name;
        }
        $si_roles = new ilSelectInputGUI($this->lng->txt("gbl_roles_to_users"), 'role');
        $si_roles->setOptions($options);
        $form->addItem($si_roles);

        if ($a_mode == 'edit') {
            $form->setFormAction($this->ctrl->getFormAction($this, 'editLTIConsumer'));
            $form->setTitle($this->lng->txt("lti_edit_consumer"));
            $form->addCommandButton("updateLTIConsumer", $this->lng->txt("save"));
        } else {
            $form->setFormAction($this->ctrl->getFormAction($this, 'createLTIConsumer'));
            $form->setTitle($this->lng->txt("lti_create_consumer"));
            $form->addCommandButton("createLTIConsumer", $this->lng->txt("save"));
            $form->addCommandButton('listConsumers', $this->lng->txt('cancel'));
        }

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSettingsForm()

ilObjLTIAdministrationGUI::getSettingsForm ( )

protected

Definition at line 144 of file class.ilObjLTIAdministrationGUI.php.

Referenced by initSettingsForm().

    {
        require_once("Services/Form/classes/class.ilPropertyFormGUI.php");

        $form = new ilPropertyFormGUI();
        /*
        $form->setFormAction($this->ctrl->getFormAction($this,'saveSettingsForm'));
        $form->setTitle($this->lng->txt("lti_settings"));

        // object types
        $cb_obj_types = new ilCheckboxGroupInputGUI($this->lng->txt("act_lti_for_obj_type"), 'types');

        $valid_obj_types = $this->object->getLTIObjectTypes();
        foreach($valid_obj_types as $obj_type_id => $obj_name)
        {
            $cb_obj_types->addOption(new ilCheckboxOption($obj_name, $obj_type_id));
        }
        $objs_active = $this->object->getActiveObjectTypes();
        $cb_obj_types->setValue($objs_active);
        $form->addItem($cb_obj_types);

        // test roles
        $roles = $this->object->getLTIRoles();
        foreach($roles as $role_id => $role_name)
        {
            $options[$role_id] = $role_name;
        }
        $si_roles = new ilSelectInputGUI($this->lng->txt("gbl_roles_to_users"), 'roles');
        $si_roles->setOptions($options);
        $si_roles->setValue($this->object->getCurrentRole());
        $form->addItem($si_roles);

        $form->addCommandButton("saveSettingsForm", $this->lng->txt("save"));
        */
        return $form;
    }

Here is the caller graph for this function:

getType()

ilObjLTIAdministrationGUI::getType

(

)

Definition at line 71 of file class.ilObjLTIAdministrationGUI.php.

    {
        return "ltis";
    }

initConsumerForm()

ilObjLTIAdministrationGUI::initConsumerForm ( ilPropertyFormGUI  $form = null )

protected

Definition at line 233 of file class.ilObjLTIAdministrationGUI.php.

References getConsumerForm().

    {
        if (!($form instanceof ilPropertyFormGUI)) {
            $form = $this->getConsumerForm();
        }
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

initSettingsForm()

ilObjLTIAdministrationGUI::initSettingsForm ( ilPropertyFormGUI  $form = null )

protected

Definition at line 134 of file class.ilObjLTIAdministrationGUI.php.

References getSettingsForm().

    {
        if (!($form instanceof ilPropertyFormGUI)) {
            $form = $this->getSettingsForm();
        }
        $this->tabs_gui->activateSubTab("settings");
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

listConsumers()

ilObjLTIAdministrationGUI::listConsumers ( )

protected

List consumers type $ilAccess type $ilToolbar.

Definition at line 438 of file class.ilObjLTIAdministrationGUI.php.

References ilObject\_getIdsForTitle(), and ilObjectGUI\checkPermissionBool().

Referenced by createLTIConsumer(), createLtiUserRole(), and updateLTIConsumer().

    {
        global $ilAccess, $ilToolbar;

        if ($this->checkPermissionBool('write')) {
            $ilToolbar->addButton(
                $this->lng->txt('lti_create_consumer'),
                $this->ctrl->getLinkTarget($this, 'createconsumer')
            );
            if (ilObject::_getIdsForTitle("il_lti_global_role", "role", false) == false) {
                $ilToolbar->addButton(
                    $this->lng->txt('lti_create_lti_user_role'),
                    $this->ctrl->getLinkTarget($this, 'createLtiUserRole')
                );
                $ilToolbar->addText($this->lng->txt('lti_user_role_info'));
            }
                        
        }

        $this->tabs_gui->activateSubTab("consumers");

        include_once "Services/LTI/classes/Consumer/class.ilLTIConsumerTableGUI.php";
        $tbl = new ilObjectConsumerTableGUI(
            $this,
            "listConsumers"
        );
        $tbl->setEditable($this->checkPermissionBool('write'));
        $this->tpl->setContent($tbl->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

releasedObjects()

ilObjLTIAdministrationGUI::releasedObjects ( )

protected

Show relases objects.

Definition at line 499 of file class.ilObjLTIAdministrationGUI.php.

References $GLOBALS.

    {
        $GLOBALS['DIC']->tabs()->activateSubTab('releasedObjects');
        
        $table = new ilLTIProviderReleasedObjectsTableGUI($this, 'releasedObjects', 'ltireleases');
        $table->init();
        $table->parse();
        
        $GLOBALS['DIC']->ui()->mainTemplate()->setContent($table->getHTML());
    }

updateLTIConsumer()

ilObjLTIAdministrationGUI::updateLTIConsumer ( )

protected

Update lti consumer settings ilCtrl $ilCtrl.

Definition at line 383 of file class.ilObjLTIAdministrationGUI.php.

References $ilCtrl, ilObjectGUI\checkPermission(), ilLTIToolConsumer\fromExternalConsumerId(), getConsumerForm(), and listConsumers().

    {
        global $ilCtrl;

        $this->checkPermission("write");

        $consumer_id = $_REQUEST["cid"];
        if (!$consumer_id) {
            $ilCtrl->redirect($this, "listConsumers");
        }

        $ilCtrl->setParameter($this, "cid", $consumer_id);

        $consumer = ilLTIToolConsumer::fromExternalConsumerId($consumer_id, $this->dataConnector);
        $form = $this->getConsumerForm('edit');
        if ($form->checkInput()) {
            $consumer->setTitle($form->getInput('title'));
            $consumer->setDescription($form->getInput('description'));
            $consumer->setPrefix($form->getInput('prefix'));
            $consumer->setLanguage($form->getInput('language'));
            $consumer->setActive($form->getInput('active'));
            $consumer->setRole($form->getInput('role'));
            $consumer->saveGlobalToolConsumerSettings($this->dataConnector);
            $this->object->saveConsumerObjectTypes($consumer_id, $form->getInput('types'));

            ilUtil::sendSuccess($this->lng->txt("lti_consumer_updated"), true);
        }
        $this->listConsumers();
    }

Here is the call graph for this function:

Field Documentation

$dataConnector

mixed ilObjLTIAdministrationGUI::$dataConnector = null

private

Data connector object or string.

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

---

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

• Services/LTI/classes/class.ilObjLTIAdministrationGUI.php