ilObjLTIAdministrationGUI Class Reference

Class ilObjLTIAdministrationGUI. More...

Inheritance diagram for ilObjLTIAdministrationGUI:

Collaboration diagram for ilObjLTIAdministrationGUI:

Public Member Functions
	__construct (?array $a_data, int $a_id, bool $a_call_by_reference=true, bool $a_prepare_output=true)
	executeCommand ()
	getType ()
	getAdminTabs ()
Public Member Functions inherited from ilObjectGUI
	getRefId ()
	setAdminMode (string $mode)
	getAdminMode ()
	getObject ()
	executeCommand ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	setCreationMode (bool $mode=true)
	If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...
	getCreationMode ()
	prepareOutput (bool $show_sub_objects=true)
	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...
	cancelObject ()
	cancel action and go back to previous page More...
	createObject ()
	create new object form More...
	editAvailabilityPeriodObject ()
	saveAvailabilityPeriodObject ()
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $obj, ?int $parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	addExternalEditFormCustom (ilPropertyFormGUI $form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...
	isVisible (int $ref_id, string $type)
	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...
	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...
	setColumnSettings (ilColumnGUI $column_gui)
	addToDeskObject ()
	removeFromDeskObject ()
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Protected Member Functions
	addProvidingSubtabs ()
	initSettingsForm (?ilPropertyFormGUI $form=null)
	getSettingsForm ()
	createLtiUserRole ()
	initConsumerForm (?ilPropertyFormGUI $form=null)
	getConsumerForm (string $a_mode='')
	editConsumer (?ilPropertyFormGUI $a_form=null)
	Edit consumer. More...
	createLTIConsumer ()
	Create new lti consumer. More...
	updateLTIConsumer ()
	Update lti consumer settings. More...
	deleteLTIConsumer ()
	Delete consumers. More...
	listConsumers ()
	List consumers. More...
	changeStatusLTIConsumer ()
	Change activation status. More...
	releasedObjects ()
	Show relases objects. More...
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	assignObject ()
	setTitleAndDescription ()
	createActionDispatcherGUI ()
	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...
	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	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 More...
	setAdminTabs ()
	set admin tabs More...
	setLocator ()
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator (bool $omit=true)
	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	getCreationFormsHTML (StandardForm|ilPropertyFormGUI|array $form)
	getTitleForCreationFormPage ()
	getCreationFormTitle ()
	initCreateForm (string $new_type)
	didacticTemplatesToForm ()
	initDidacticTemplate (ilPropertyFormGUI $form)
	retrieveAdditionalDidacticTemplateOptions ()
	addAdoptContentLinkToToolbar ()
	addImportButtonToToolbar ()
	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)
	parseDidacticTemplateVar (string $var, string $type)
	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	routeImportCmdObject ()
	importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)
	deleteUploadedImportFile (string $path_to_uploaded_file_in_temp_dir)
	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...
	setFormAction (string $cmd, string $form_action)
	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...
	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...
	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...
	getTabs ()
	overwrite in derived GUI class of your object type More...
	redirectToRefId (int $ref_id, string $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 ["ref_id"] value of the request More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	getCreatableObjectTypes ()
	buildAddNewItemElements (array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)
	buildGroup (string $create_target_class, array $obj_types_in_group, string $title, array $subtypes)

Private Attributes
ilLTIDataConnector	$dataConnector = null
int	$consumer_id = null

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode (int $ref_id, string $cmd="")
static	_gotoSharedWorkspaceNode (int $wsp_id)
Data Fields inherited from ilObjectGUI
const	ADMIN_MODE_NONE = ""
const	ADMIN_MODE_SETTINGS = "settings"
const	ADMIN_MODE_REPOSITORY = "repository"
const	UPLOAD_TYPE_LOCAL = 1
const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3
const	SUPPORTED_IMPORT_MIME_TYPES = [MimeType::APPLICATION__ZIP, MimeType::APPLICATION__X_ZIP_COMPRESSED]
Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service
ServerRequestInterface	$request
ilLocatorGUI	$locator
ilObjUser	$user
ilAccessHandler	$access
ilSetting	$settings
ilToolbarGUI	$toolbar
ilRbacAdmin	$rbac_admin
ilRbacSystem	$rbac_system
ilRbacReview	$rbac_review
ilObjectService	$object_service
ilObjectDefinition	$obj_definition
ilGlobalTemplateInterface	$tpl
ilTree	$tree
ilCtrl	$ctrl
ilErrorHandling	$error
ilLanguage	$lng
ilTabsGUI	$tabs_gui
ILIAS	$ilias
ArrayBasedRequestWrapper	$post_wrapper
RequestWrapper	$request_wrapper
Refinery	$refinery
ilFavouritesManager	$favourites
ilObjectCustomIconFactory	$custom_icon_factory
UIFactory	$ui_factory
UIRenderer	$ui_renderer
Filesystem	$temp_file_system
ilObject	$object = null
bool	$creation_mode = false
	$data
int	$id
bool	$call_by_reference = false
bool	$prepare_output
int	$ref_id
int	$obj_id
int	$maxcount
array	$form_action = []
array	$return_location = []
array	$target_frame = []
string	$tmp_import_dir
string	$sub_objects = ""
bool	$omit_locator = false
string	$type = ""
string	$admin_mode = self::ADMIN_MODE_NONE
int	$requested_ref_id = 0
int	$requested_crtptrefid = 0
int	$requested_crtcb = 0
string	$requested_new_type = ""
string	$link_params
string	$html = ""

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 30 of file class.ilObjLTIAdministrationGUI.php.

Constructor & Destructor Documentation

__construct()

ilObjLTIAdministrationGUI::__construct	(	?array	$a_data,
		int	$a_id,
		bool	$a_call_by_reference = true,
		bool	$a_prepare_output = true
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\int().

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

        if ($DIC->http()->wrapper()->query()->has("cid")) {
            $this->consumer_id = (int) $DIC->http()->wrapper()->query()->retrieve("cid", $DIC->refinery()->kindlyTo()->int());
        }
    }

Here is the call graph for this function:

Member Function Documentation

addProvidingSubtabs()

ilObjLTIAdministrationGUI::addProvidingSubtabs ( )

protected

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

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by getAdminTabs().

                                            : void
    {
        if ($this->rbac_system->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 ($this->rbac_system->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 call graph for this function:

Here is the caller graph for this function:

changeStatusLTIConsumer()

ilObjLTIAdministrationGUI::changeStatusLTIConsumer ( )

protected

Change activation status.

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

References ILIAS\Repository\ctrl(), ilLTIPlatform\fromExternalConsumerId(), and ILIAS\Repository\lng().

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

        $consumer = ilLTIPlatform::fromExternalConsumerId($this->consumer_id, $this->dataConnector);
        if ($consumer->getActive()) {
            $consumer->setActive(false);
            $msg = "lti_consumer_set_inactive";
        } else {
            $consumer->setActive(true);
            $msg = "lti_consumer_set_active";
        }
        $consumer->saveGlobalToolConsumerSettings($this->dataConnector);
        $this->tpl->setOnScreenMessage('success', $this->lng->txt($msg), true);

        $this->ctrl->redirect($this, 'listConsumers');
    }

Here is the call graph for this function:

createLTIConsumer()

ilObjLTIAdministrationGUI::createLTIConsumer ( )

protected

Create new lti consumer.

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

References ilObjectGUI\checkPermission(), ILIAS\Repository\ctrl(), getConsumerForm(), listConsumers(), ILIAS\Repository\lng(), and null.

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

        $form = $this->getConsumerForm();

        if ($form->checkInput()) {
            // $consumer = new ilLTIExternalConsumer();
            // $dataConnector = new ilLTIDataConnector();
            $consumer = new ilLTIPlatform(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((bool) $form->getInput('active'));
            $consumer->setRole((int) $form->getInput('role'));
            $consumer->saveGlobalToolConsumerSettings($this->dataConnector);

            $this->object->saveConsumerObjectTypes(
                $consumer->getExtConsumerId(),
                $form->getInput('types')
            );
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("lti_consumer_created"), true);
            $this->ctrl->redirect($this, 'listConsumers');
        }

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

Here is the call graph for this function:

createLtiUserRole()

ilObjLTIAdministrationGUI::createLtiUserRole ( )

protected

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

References listConsumers(), ILIAS\Repository\lng(), ilObjRole\MODE_UNPROTECTED_KEEP_LOCAL_POLICIES, and ROOT_FOLDER_ID.

                                          : void
    {
        $role = new ilObjRole();
        $role->setTitle("il_lti_global_role");
        $role->setDescription("This global role should only contain the permission 'read' for repository and categories. Do not rename this role.");
        $role->create();
        $this->rbac_admin->assignRoleToFolder($role->getId(), 8, 'y');
        $this->rbac_admin->setProtected(8, $role->getId(), 'y');
        $this->rbac_admin->setRolePermission($role->getId(), 'root', [3], 8);
        $this->rbac_admin->setRolePermission($role->getId(), 'cat', [3], 8);
        $this->rbac_admin->grantPermission($role->getId(), [3], ROOT_FOLDER_ID);
        $role->changeExistingObjects(
            ROOT_FOLDER_ID,
            ilObjRole::MODE_UNPROTECTED_KEEP_LOCAL_POLICIES,
            array('cat'),
            array()
        );

        $this->tpl->setOnScreenMessage('success', $this->lng->txt("lti_user_role_created"), true);
        $this->listConsumers();
    }

Here is the call graph for this function:

deleteLTIConsumer()

ilObjLTIAdministrationGUI::deleteLTIConsumer ( )

protected

Delete consumers.

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

References ILIAS\Repository\ctrl(), ilLTIPlatform\fromExternalConsumerId(), ILIAS\Repository\int(), and ILIAS\Repository\lng().

                                          : void
    {
        $consumer_id = 0;
        if ($this->request_wrapper->has('cid')) {
            $consumer_id = (int) $this->request_wrapper->retrieve('cid', $this->refinery->kindlyTo()->int());
        }

        if ($consumer_id == 0) {
            $this->ctrl->redirect($this, "listConsumers");
        }
        $consumer = ilLTIPlatform::fromExternalConsumerId($consumer_id, $this->dataConnector);
        $consumer->deleteGlobalToolConsumerSettings($this->dataConnector);
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("lti_consumer_deleted"), true);
        $this->ctrl->redirect($this, 'listConsumers');
    }

Here is the call graph for this function:

editConsumer()

ilObjLTIAdministrationGUI::editConsumer ( ?ilPropertyFormGUI  $a_form = null )

protected

Edit consumer.

Parameters

ilPropertyFormGUI

$a_form

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

References ILIAS\Repository\ctrl(), ilLTIPlatform\fromExternalConsumerId(), getConsumerForm(), and ILIAS\Repository\object().

                                                                      : void
    {
        $this->ctrl->setParameter($this, "cid", $this->consumer_id);

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

        $consumer = ilLTIPlatform::fromExternalConsumerId($this->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($this->consumer_id));
        }
        $this->tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

executeCommand()

ilObjLTIAdministrationGUI::executeCommand

(

)

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

References $GLOBALS, ILIAS\Repository\ctrl(), and ilObjectGUI\prepareOutput().

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

        $this->prepareOutput();

        switch ($next_class) {
            case 'ilpermissiongui':
                $GLOBALS['ilTabs']->activateTab('perm_settings');
                $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 86 of file class.ilObjLTIAdministrationGUI.php.

References addProvidingSubtabs(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

                                  : void
    {
        if ($this->rbac_system->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 ($this->ctrl->getCmdClass() == 'ilobjltiadministrationgui') {
                $this->addProvidingSubtabs();
            }
        }

        if ($this->rbac_system->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 ( string  $a_mode = '' )

protected

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

References ilLanguage\_lookupEntry(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilSelectInputGUI\setOptions().

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

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

        $form = new ilPropertyFormGUI();

        $ti_title = new ilTextInputGUI($this->lng->txt("title"), 'title');
        $ti_title->setRequired(true);
        $form->addItem($ti_title);
        $ti_description = new ilTextInputGUI($this->lng->txt("description"), 'description');
        $form->addItem($ti_description);
        $ti_prefix = new ilTextInputGUI($this->lng->txt("prefix"), 'prefix');
        $ti_prefix->setInfo($this->lng->txt("prefix_info"));
        $ti_prefix->setRequired(true);
        $form->addItem($ti_prefix);
        #$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 = [];
        $options = [];
        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);
        $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 = $this->lng->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);

        $cb_active = new ilCheckboxInputGUI($this->lng->txt('active'), 'active');
        $form->addItem($cb_active);

        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 148 of file class.ilObjLTIAdministrationGUI.php.

Referenced by initSettingsForm().

                                        : \ilPropertyFormGUI
    {
        $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 81 of file class.ilObjLTIAdministrationGUI.php.

                             : string
    {
        return "ltis";
    }

initConsumerForm()

ilObjLTIAdministrationGUI::initConsumerForm ( ?ilPropertyFormGUI  $form = null )

protected

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

References getConsumerForm().

                                                                        : void
    {
        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 138 of file class.ilObjLTIAdministrationGUI.php.

References getSettingsForm().

                                                                        : void
    {
        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.

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

References ilObject\_getIdsForTitle(), ilObjectGUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

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

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

        $this->tabs_gui->activateSubTab("consumers");
        $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 472 of file class.ilObjLTIAdministrationGUI.php.

                                        : void
    {
        $this->tabs_gui->activateSubTab('releasedObjects');

        $table = new ilLTIProviderReleasedObjectsTableGUI($this, 'releasedObjects', 'ltireleases');
        $table->init();
        $table->parse();

        $this->tpl->setContent($table->getHTML());
    }

updateLTIConsumer()

ilObjLTIAdministrationGUI::updateLTIConsumer ( )

protected

Update lti consumer settings.

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

References ilObjectGUI\checkPermission(), ILIAS\Repository\ctrl(), ilLTIPlatform\fromExternalConsumerId(), getConsumerForm(), listConsumers(), and ILIAS\Repository\lng().

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

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

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

        $consumer = ilLTIPlatform::fromExternalConsumerId($this->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((bool) $form->getInput('active'));
            $consumer->setRole((int) $form->getInput('role'));
            $consumer->saveGlobalToolConsumerSettings($this->dataConnector);
            $this->object->saveConsumerObjectTypes($this->consumer_id, $form->getInput('types'));

            $this->tpl->setOnScreenMessage('success', $this->lng->txt("lti_consumer_updated"), true);
        }
        $this->listConsumers();
    }

Here is the call graph for this function:

Field Documentation

$consumer_id

int ilObjLTIAdministrationGUI::$consumer_id = null

private

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

$dataConnector

ilLTIDataConnector ilObjLTIAdministrationGUI::$dataConnector = null

private

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

---

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

• components/ILIAS/LTIProvider/classes/class.ilObjLTIAdministrationGUI.php