Screens of the repository object type lti. More...

Inheritance diagram for ilObjLTIToolGUI:

Collaboration diagram for ilObjLTIToolGUI:

Public Member Functions
	getType ()
	Functions that must be overwritten. More...

	executeCommand ()

	create ()
	Offers the tools the user may pick and, with the permission to define tools, a form for one of their own. More...

	save ()
	Creates the object for the tool of the request. More...

Public Member Functions inherited from ilObject2GUI
	__construct (int $id=0, int $id_type=self::REPOSITORY_NODE_ID, int $parent_node_id=0)

	executeCommand ()
	execute command More...

	getIdType ()

	delete ()
	Display delete confirmation form (repository/workspace switch) More...

	confirmedDelete ()
	Delete objects (repository/workspace switch) More...

	getHTML ()

	withReferences ()
	Final/Private declaration of unchanged parent methods. 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)

	isVisible (int $ref_id, string $type)

	setColumnSettings (ilColumnGUI $column_gui)

	view ()
	view object content (repository/workspace switch) More...

	getType ()
	Functions that must be overwritten. More...

	create ()
	CRUD. More...

	save ()

	edit ()

	update ()

	cancel ()

	putObjectInTree (ilObject $obj, ?int $parent_node_id=null)
	Add object to tree at given position. More...

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)

Static Public Member Functions
static	_goto (string $a_target)
	Permanent link of an object: it opens with the permission to read, its info screen with the permission to see it only. More...

Static Public Member Functions inherited from ilObject2GUI
static	handleAfterSaveCallback (ilObject $obj, ?int $callback_ref_id)
	After creation callback. More...

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
const string	CMD_LAUNCH = 'launch'

const string	CMD_DELIVER_CERTIFICATE = 'deliverCertificate'

const string	CMD_SELECT_CONTENT = 'selectContent'

const string	ORIGIN_PARAM = 'origin_ref_id'

Data Fields inherited from ilObject2GUI
const	OBJECT_ID = 0

const	REPOSITORY_NODE_ID = 1

const	WORKSPACE_NODE_ID = 2

const	REPOSITORY_OBJECT_ID = 3

const	WORKSPACE_OBJECT_ID = 4

const	PORTFOLIO_OBJECT_ID = 5

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 Member Functions
	setTabs ()

	saveOwnTool ()
	Stores a tool of the user and creates the object for it. More...

	registerTool ()
	Registers a tool of the user through LTI Advantage Dynamic Registration: the registration page of the tool opens in an iframe, and the object is created once the tool says it is done. More...

	finishRegistration ()
	Creates the object for the tool a registration of the user stored. More...

	selectContent ()
	Picks the content of new objects in a tool that offers Deep Linking, from an object of the tool: the objects are created next to it, as earlier releases did. More...

	startDeepLinking ()
	Content of the iframe: starts the Deep Linking request at the tool. More...

	finishDeepLinking ()
	Where the tool posts the content the user picked, inside the iframe: an object is created for each resource link, and the whole window goes on to the settings of the object, or to the container when there are several. More...

	deliverCertificate ()
	The certificate of the current user, once they have one. More...

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	The header offers the certificate of the current user, once they have one. More...

	infoScreen ()
	The command the info action of the listing calls. More...

	launch ()

Protected Member Functions inherited from ilObject2GUI
	afterConstructor ()
	Do anything that should be done after constructor in here. More...

	assignObject ()
	create object instance as internal property (repository/workspace switch) More...

	getAccessHandler ()

	setLocator ()
	set Locator More...

	deleteConfirmedObjects ()
	Delete objects (workspace specific) This should probably be moved elsewhere as done with RepUtil. More...

	setTitleAndDescription ()

	omitLocator (bool $omit=true)

	getTargetFrame (string $cmd, string $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...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	showPossibleSubObjects ()
	show possible sub objects (pull down menu) 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...

	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...

	setTabs ()
	create tabs (repository/workspace switch) More...

	getReturnLocation (string $cmd, string $location="")
	Deprecated functions. More...

	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...

	showActions ()

	getTabs ()
	@abstract overwrite in derived GUI class of your object type More...

	addLocatorItems ()
	Functions to be overwritten. More...

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $node_id=null)

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

	redrawHeaderAction ()
	Updating icons after ajax call. 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 ()
	@abstract 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 Member Functions
	addReportTabs ()
	The reports on what users did in the tool, each one only where the tool provides its data. More...

	getReports ()
	The reports, by tab, with their GUI and whether the user may see them. More...

	assertReportAccess (string $tab)

	trackReadEvent ()
	Opening an object counts as reading it, which the learning progress takes into account. More...

	renderCreation (?Form $own_form=null, ?Form $registration_form=null)
	The ways of creating an object, one section each, with the first one open. More...

	showDeepLinking (ilLTITool $tool, string $custom_params='')
	The iframe the tool shows its content in for the user to pick. More...

	buildRegistrationForm ()

	buildToolSelection ()

	buildOwnTool (?Form $form)
	Each LTI version has its own form, because they authenticate the tool differently. More...

	buildVersionControl (string $active)

	buildOwnToolForm ()

	getOwnToolAction ()

	getRequestedVersion ()

	createOrSelectContent (ilLTITool $tool, string $custom_params='')
	A tool that offers Deep Linking lets the user pick the content of the objects first. More...

	createToolObject (ilLTITool $tool, string $title, string $description, string $custom_params)

	getSettingsLink (ilObjLTITool $object)

	getStaticLink (int $ref_id)

	getContainerRefId ()
	The container a new object is created in. More...

	assertCreationAccess ()

	getDeepLinkingState ()

	getOriginRefId ()
	The object whose tool settings the content is picked from, 0 on the creation screen. More...

	isContentAvailable ()
	Launching needs the object online and a tool that is still available. More...

	configureInfoScreen (ilInfoScreenGUI $info)
	What the info screen tells about the tool is what a user needs to judge the data it receives. More...

	getToolIdParameter ()

	getStringParameter (string $name)

	getIntParameter (string $name)

	assertOwnToolCreationAccess ()

	getLTIObject ()

Private Attributes
const string	CMD_SAVE_OWN_TOOL = 'saveOwnTool'

const string	CMD_REGISTER_TOOL = 'registerTool'

const string	CMD_FINISH_REGISTRATION = 'finishRegistration'

const string	REGISTRATION_PARAM = 'registration'

const string	REGISTRATION_FRAME_ID = 'il_lti_registration_frame'

const string	CMD_START_DEEP_LINKING = 'startDeepLinking'

const string	CMD_FINISH_DEEP_LINKING = 'finishDeepLinking'

const string	DEEP_LINKING_PARAM = 'deep_linking'

const string	VERSION_PARAM = 'version'

const string	TAB_CONTENT = 'tab_content'

const string	TAB_INFO = 'tab_info'

const string	TAB_SETTINGS = 'tab_settings'

const string	TAB_STATEMENTS = 'tab_statements'

const string	TAB_RANKING = 'tab_scoring'

const string	TAB_GRADEBOOK = 'tab_grade_synchronization'

const string	TAB_LEARNING_PROGRESS = 'learning_progress'

const string	TAB_METADATA = 'meta_data'

const string	TAB_PERMISSIONS = 'id_permissions'

Additional Inherited Members
Protected Attributes inherited from ilObject2GUI
ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilCtrl	$ctrl

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ilFavouritesManager	$favourites

ilErrorHandling	$error

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilToolbarGUI	$toolbar

Factory	$refinery

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

int	$request_ref_id

int	$id_type

int	$parent_id

string	$type

string	$html

int	$object_id

int	$node_id = null

array	$creation_forms = []

	$access_handler

Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service

GlobalHttpState	$http

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

CustomIconFactory	$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

Screens of the repository object type lti.

The object is created for one tool, which cannot be changed afterwards, and opening it launches that tool.

Author: Saúl Díaz sdiaz.nosp@m.@sur.nosp@m.labs..nosp@m.com

Definition at line 45 of file class.ilObjLTIToolGUI.php.

Member Function Documentation

◆ _goto()

static ilObjLTIToolGUI::_goto ( string $a_target )

static

Permanent link of an object: it opens with the permission to read, its info screen with the permission to see it only.

Exceptions

ilCtrlException

Definition at line 82 of file class.ilObjLTIToolGUI.php.

                                                  : void
    {
        global $DIC;
 
        $access = $DIC->access();
        $lng = $DIC->language();
        $error = $DIC['ilErr'];
        $ref_id = (int) explode('_', $a_target)[0];
 
        if ($ref_id > 0 && $access->checkAccess('read', '', $ref_id)) {
            // a link to the object may open in an iframe of another site, an embedded LTI 1.1 launch for one,
            // which only keeps the session with a SameSite=None cookie, as in earlier releases
            ilLTISessionCookie::allowCrossSite();
            $DIC->ctrl()->setTargetScript('ilias.php');
            $DIC->ctrl()->setParameterByClass(self::class, 'ref_id', $ref_id);
            $DIC->ctrl()->redirectByClass([ilRepositoryGUI::class, self::class]);
        }
 
        if ($ref_id > 0 && $access->checkAccess('visible', '', $ref_id)) {
            ilObjectGUI::_gotoRepositoryNode($ref_id, 'infoScreen');
        }
 
        if ($ref_id > 0 && $access->checkAccess('read', '', ROOT_FOLDER_ID)) {
            $DIC->ui()->mainTemplate()->setOnScreenMessage(
                'info',
                sprintf($lng->txt('msg_no_perm_read_item'), ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id))),
                true
            );
            ilObjectGUI::_gotoRepositoryRoot();
        }
 
        $error->raiseError($lng->txt('msg_no_perm_read_lm'), $error->FATAL);
    }

References ilObject2GUI\$access, $DIC, ilObject2GUI\$error, ilObject2GUI\$lng, ilObjectGUI\$ref_id, ilObjectGUI\_gotoRepositoryNode(), ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilLTISessionCookie\allowCrossSite(), ilRBACAccessHandler\checkAccess(), ILIAS\Repository\int(), ilErrorHandling\raiseError(), ROOT_FOLDER_ID, and ilLanguage\txt().

Here is the call graph for this function:

◆ addReportTabs()

ilObjLTIToolGUI::addReportTabs ( )

private

The reports on what users did in the tool, each one only where the tool provides its data.

Exceptions

ilCtrlException
ilObjectException

Definition at line 273 of file class.ilObjLTIToolGUI.php.

                                    : void
    {
        foreach ($this->getReports() as $tab => [$class, $available]) {
            if ($available) {
                $this->tabs_gui->addTab($tab, $this->lng->txt($tab), $this->ctrl->getLinkTargetByClass($class));
            }
        }
    }

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

Referenced by setTabs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assertCreationAccess()

ilObjLTIToolGUI::assertCreationAccess ( )

private

Definition at line 935 of file class.ilObjLTIToolGUI.php.

                                           : void
    {
        if (!$this->checkPermissionBool('create', '', $this->getType())) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->MESSAGE);
        }
    }

References ilObject2GUI\checkPermissionBool(), getType(), and ILIAS\Repository\lng().

Referenced by finishDeepLinking(), selectContent(), and startDeepLinking().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assertOwnToolCreationAccess()

ilObjLTIToolGUI::assertOwnToolCreationAccess ( )

private

Definition at line 1043 of file class.ilObjLTIToolGUI.php.

                                                  : void
    {
        if (!ilObjLTIAdministrationAccess::hasOwnToolCreationAccess()) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
    }

References ilObjLTIAdministrationAccess\hasOwnToolCreationAccess(), and ILIAS\Repository\lng().

Referenced by finishRegistration(), registerTool(), and saveOwnTool().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assertReportAccess()

ilObjLTIToolGUI::assertReportAccess ( string $tab )

private

Exceptions

ilObjectException

Definition at line 305 of file class.ilObjLTIToolGUI.php.

                                                    : void
    {
        if (!$this->getReports()[$tab][1]) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
    }

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildOwnTool()

ilObjLTIToolGUI::buildOwnTool ( ?Form $form )

private

Each LTI version has its own form, because they authenticate the tool differently.

The control on top switches between them.

Parameters

Form | null $form

Returns: array

Exceptions

ilCtrlException

Definition at line 785 of file class.ilObjLTIToolGUI.php.

                                              : array
    {
        $version = $this->getRequestedVersion();
        $content = [$this->buildVersionControl($version)];
 
        $notice = ilLTIToolForm::getDeprecationNotice($this->ui_factory, $this->lng, $version);
        if ($notice !== null) {
            $content[] = $notice;
        }
 
        $content[] = $form ?? $this->buildOwnToolForm()->getForm(
            $this->getOwnToolAction(),
            $this->lng->txt('lti_add_own_provider')
        );
 
        return $content;
    }

References $version, buildOwnToolForm(), buildVersionControl(), ilLTIToolForm\getDeprecationNotice(), getOwnToolAction(), getRequestedVersion(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ buildOwnToolForm()

ilObjLTIToolGUI::buildOwnToolForm ( )

private

Definition at line 824 of file class.ilObjLTIToolGUI.php.

                                       : ilLTIToolForm
    {
        return new ilLTIToolForm(
            $this->lng,
            $this->ui_factory,
            $this->refinery,
            $this->user,
            0,
            $this->getRequestedVersion()
        );
    }

References getRequestedVersion(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

Referenced by buildOwnTool(), and saveOwnTool().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildRegistrationForm()

ilObjLTIToolGUI::buildRegistrationForm ( )

private

Exceptions

ilCtrlException

Definition at line 681 of file class.ilObjLTIToolGUI.php.

                                            : Form
    {
        $field = $this->ui_factory->input()->field();
        // the tool of the last row of the selection must not end up in the action of this form
        $this->ctrl->setParameter($this, 'tool_id', null);
 
        return $this->ui_factory->input()->container()->form()->standard(
            $this->ctrl->getFormAction($this, self::CMD_REGISTER_TOOL),
            [
                'url' => $field->url($this->lng->txt('lti_con_prov_dyn_reg_url'), $this->lng->txt('lti_con_prov_dyn_reg_url_info'))
                    ->withRequired(true),
                'params' => $field->text($this->lng->txt('lti_con_prov_dyn_reg_params'), $this->lng->txt('lti_con_prov_dyn_reg_params_info')),
            ]
        )->withSubmitLabel($this->lng->txt('add'));
    }

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

Referenced by finishRegistration(), and registerTool().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildToolSelection()

ilObjLTIToolGUI::buildToolSelection ( )

private

Exceptions

ilCtrlException

Definition at line 769 of file class.ilObjLTIToolGUI.php.

                                         : array
    {
        $table = ilLTIToolTable::forSelection($this, 'save');
        $filter = $table->getFilter($this->ctrl->getLinkTarget($this, 'create'));
 
        return [$filter, $table->getTable($filter)];
    }

References ILIAS\Repository\ctrl(), and ilLTIToolTable\forSelection().

Here is the call graph for this function:

◆ buildVersionControl()

ilObjLTIToolGUI::buildVersionControl ( string $active )

private

Exceptions

ilCtrlException

Definition at line 806 of file class.ilObjLTIToolGUI.php.

                                                        : Component
    {
        // the tool of the last row of the selection must not end up in the links of this control
        $this->ctrl->setParameter($this, 'tool_id', null);
 
        $labels = ilLTITool::getVersionLabels($this->lng);
        $actions = [];
        foreach ($labels as $version => $label) {
            $this->ctrl->setParameter($this, self::VERSION_PARAM, $version);
            $actions[$label] = $this->ctrl->getLinkTarget($this, 'create');
        }
        $this->ctrl->setParameter($this, self::VERSION_PARAM, $active);
 
        return $this->ui_factory->viewControl()
            ->mode($actions, $this->lng->txt('lti_con_version'))
            ->withActive($labels[$active]);
    }

References $version, ILIAS\Repository\ctrl(), ilLTITool\getVersionLabels(), and ILIAS\Repository\lng().

Referenced by buildOwnTool().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ configureInfoScreen()

ilObjLTIToolGUI::configureInfoScreen ( ilInfoScreenGUI $info )

private

What the info screen tells about the tool is what a user needs to judge the data it receives.

Exceptions

ilObjectException

Definition at line 973 of file class.ilObjLTIToolGUI.php.

                                                               : void
    {
        if (!$this->checkPermissionBool('visible') && !$this->checkPermissionBool('read')) {
            $this->error->raiseError($this->lng->txt('msg_no_perm_read'), $this->error->MESSAGE);
        }
 
        $object = $this->getLTIObject();
        $tool = $object->getTool();
 
        if ($tool->getUrl() === '') {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('lti_provider_not_set_msg'));
        } elseif ($tool->getAvailability() === ilLTITool::AVAILABILITY_NONE) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('lti_provider_not_avail_msg'));
        }
 
        $info->enablePrivateNotes();
        $info->enableNews($this->checkPermissionBool('read'));
        $info->enableNewsEditing(false);
        if ($this->checkPermissionBool('write') && new ilSetting('news')->get('enable_rss_for_internal')) {
            $info->setBlockProperty('news', 'settings', 'true');
            $info->setBlockProperty('news', 'public_notifications_option', 'true');
        }
 
        $info->addMetaDataSections($object->getId(), 0, $object->getType());
 
        if ($tool->hasOutcome() && (ilLPObjSettings::_lookupDBMode($object->getId()) ?? ilLPObjSettings::LP_MODE_DEACTIVATED) !== ilLPObjSettings::LP_MODE_DEACTIVATED) {
            $info->addSection($this->lng->txt('lti_info_learning_progress_section'));
            $info->addProperty($this->lng->txt('mastery_score'), round(100 * $object->getMasteryScore(), 2) . ' %');
        }
 
        $info->addSection($this->lng->txt('lti_info_privacy_section'));
        $info->addProperty($this->lng->txt('lti_con_prov_url'), $tool->getUrl());
        $info->addProperty(
            $this->lng->txt('conf_privacy_name'),
            $this->lng->txt('conf_privacy_name_' . ilObjCmiXapiGUI::getPrivacyNameString($tool->getPrivacyName()))
        );
        $info->addProperty(
            $this->lng->txt('conf_privacy_ident'),
            $this->lng->txt('conf_privacy_ident_' . ilObjCmiXapiGUI::getPrivacyIdentString($tool->getPrivacyIdent()))
        );
        if ($tool->isExternal()) {
            $info->addProperty(
                $this->lng->txt('lti_info_external_provider_label'),
                $this->lng->txt('lti_info_external_provider_info')
            );
        }
        if ($tool->getUseXapi()) {
            $info->addProperty($this->lng->txt('lti_con_prov_xapi_launch_url'), $tool->getXapiLaunchUrl());
        }
    }

References $info, ilObjectGUI\$object, ilLPObjSettings\_lookupDBMode(), ilInfoScreenGUI\addProperty(), ilLTITool\AVAILABILITY_NONE, ilObject2GUI\checkPermissionBool(), ilInfoScreenGUI\enableNewsEditing(), ilInfoScreenGUI\enablePrivateNotes(), ilObject\getId(), getLTIObject(), ilObjCmiXapiGUI\getPrivacyIdentString(), ilObjCmiXapiGUI\getPrivacyNameString(), ilObject\getType(), ILIAS\Repository\lng(), and ilLPObjSettings\LP_MODE_DEACTIVATED.

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ilObjLTIToolGUI::create ( )

Offers the tools the user may pick and, with the permission to define tools, a form for one of their own.

There is no title to fill in: an object is named after its tool.

Exceptions

ilCtrlException

Reimplemented from ilObject2GUI.

Definition at line 336 of file class.ilObjLTIToolGUI.php.

                            : void
    {
        if (!$this->checkPermissionBool('create', '', $this->getType())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        $this->renderCreation();
    }

References ilObject2GUI\checkPermissionBool(), getType(), ILIAS\Repository\lng(), and renderCreation().

Referenced by executeCommand(), and save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createOrSelectContent()

ilObjLTIToolGUI::createOrSelectContent	(	ilLTITool	$tool,
		string	$custom_params = `''`
	)

private

A tool that offers Deep Linking lets the user pick the content of the objects first.

Otherwise the object carries the title and the description of its tool, as there is nothing else to name it after.

Parameters

string $custom_params the custom parameters of the object, in the format of its settings

Exceptions

ilCtrlException
ilMDServicesException
RandomException

Definition at line 863 of file class.ilObjLTIToolGUI.php.

                                                                                       : void
    {
        if ($tool->offersDeepLinking()) {
            $this->showDeepLinking($tool, $custom_params);
            return;
        }
 
        $object = $this->createToolObject($tool, '', '', $custom_params);
 
        // a new object is offline and named after its tool, so its settings are where it is finished
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('object_added'), true);
        $this->ctrl->redirectToURL($this->getSettingsLink($object));
    }

References ilObjectGUI\$object, createToolObject(), ILIAS\Repository\ctrl(), getSettingsLink(), ILIAS\Repository\lng(), ilLTITool\offersDeepLinking(), and showDeepLinking().

Referenced by finishRegistration(), save(), and saveOwnTool().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createToolObject()

ilObjLTIToolGUI::createToolObject	(	ilLTITool	$tool,
		string	$title,
		string	$description,
		string	$custom_params
	)

private

Parameters

string	$title	the title of the object, the one of the tool when empty
string	$description	the description of the object, used with its title only

Exceptions

ilMDServicesException

Definition at line 882 of file class.ilObjLTIToolGUI.php.

                                                                                                                 : ilObjLTITool
    {
        $object = new ilObjLTITool();
        $object->setType($this->getType());
        $object->processAutoRating();
        $object->setTitle($title !== '' ? $title : $tool->getTitle());
        $object->setDescription($title !== '' ? $description : $tool->getDescription());
        $object->setToolId($tool->getId());
        $object->setMasteryScore($tool->getMasteryScore());
        $object->setCustomParams($custom_params);
        $object->create();
        $object->createMetaData();
        $object->syncKeywordsFromTool();
 
        $this->ctrl->setParameter($this, 'new_type', '');
        // putObjectInTree() places the one object of a creation screen and keeps its node, Deep Linking creates several
        $this->node_id = 0;
        $this->putObjectInTree($object);
 
        return $object;
    }

References ilObjectGUI\$object, ilObject\create(), ilObject\createMetaData(), ILIAS\Repository\ctrl(), ilLTITool\getDescription(), ilLTITool\getId(), ilLTITool\getMasteryScore(), ilLTITool\getTitle(), getType(), ilObject\processAutoRating(), ilObject2GUI\putObjectInTree(), ilObject\setDescription(), ilObject\setTitle(), and ilObject\setType().

Referenced by createOrSelectContent(), and finishDeepLinking().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deliverCertificate()

ilObjLTIToolGUI::deliverCertificate ( )

protected

The certificate of the current user, once they have one.

Exceptions

ilCtrlException

Definition at line 702 of file class.ilObjLTIToolGUI.php.

                                           : void
    {
        if (!new ilCertificateDownloadValidator()->isCertificateDownloadable($this->user->getId(), $this->object->getId())) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
            $this->ctrl->redirectByClass(ilInfoScreenGUI::class, 'showSummary');
        }
 
        $this->lng->loadLanguageModule('cert');
        new ilCertificatePdfAction(
            new ilPdfGenerator(new ilUserCertificateRepository()),
            new ilCertificateUtilHelper(),
            $this->lng->txt('error_creating_certificate_pdf')
        )->downloadPdf($this->user->getId(), $this->object->getId());
    }

References ILIAS\Repository\ctrl(), ilCertificatePdfAction\downloadPdf(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjLTIToolGUI::executeCommand ( )

Exceptions

ilCtrlException
ilObjectException

Reimplemented from ilObject2GUI.

Definition at line 120 of file class.ilObjLTIToolGUI.php.

                                    : void
    {
        $this->lng->loadLanguageModule('lti');
        $this->prepareOutput();
        $this->trackReadEvent();
 
        switch ($this->ctrl->getNextClass($this)) {
            case strtolower(ilCommonActionDispatcherGUI::class):
                $this->ctrl->forwardCommand(ilCommonActionDispatcherGUI::getInstanceFromAjaxCall());
                break;
 
            case strtolower(ilLTIToolLaunchGUI::class):
                $this->checkPermission('read');
                $this->tabs_gui->activateTab(self::TAB_CONTENT);
                $this->ctrl->forwardCommand(new ilLTIToolLaunchGUI($this->getLTIObject()));
                break;
 
            case strtolower(ilInfoScreenGUI::class):
                $this->tabs_gui->activateTab(self::TAB_INFO);
                $info = new ilInfoScreenGUI($this);
                $this->configureInfoScreen($info);
                $this->ctrl->forwardCommand($info);
                break;
 
            case strtolower(ilLTIToolXapiStatementsGUI::class):
                $this->assertReportAccess(self::TAB_STATEMENTS);
                $this->tabs_gui->activateTab(self::TAB_STATEMENTS);
                $this->ctrl->forwardCommand(new ilLTIToolXapiStatementsGUI($this->getLTIObject()));
                break;
 
            case strtolower(ilLTIObjectRankingGUI::class):
                $this->assertReportAccess(self::TAB_RANKING);
                $this->tabs_gui->activateTab(self::TAB_RANKING);
                $this->ctrl->forwardCommand(new ilLTIObjectRankingGUI($this->getLTIObject()));
                break;
 
            case strtolower(ilLTIObjectGradebookGUI::class):
                $this->assertReportAccess(self::TAB_GRADEBOOK);
                $this->tabs_gui->activateTab(self::TAB_GRADEBOOK);
                $this->ctrl->forwardCommand(new ilLTIObjectGradebookGUI($this->getLTIObject()));
                break;
 
            case strtolower(ilLearningProgressGUI::class):
                if (!ilObjLTIToolAccess::hasLearningProgressAccess($this->getLTIObject())) {
                    $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
                }
                $this->tabs_gui->activateTab(self::TAB_LEARNING_PROGRESS);
                $this->ctrl->forwardCommand(new ilLearningProgressGUI(
                    ilLearningProgressBaseGUI::LP_CONTEXT_REPOSITORY,
                    $this->object->getRefId()
                ));
                break;
 
            case strtolower(ilObjectMetaDataGUI::class):
                $this->checkPermission('write');
                $this->tabs_gui->activateTab(self::TAB_METADATA);
                $this->ctrl->forwardCommand(new ilObjectMetaDataGUI($this->getLTIObject()));
                break;
 
            case strtolower(ilLTIObjectSettingsGUI::class):
                $this->checkPermission('write');
                $this->tabs_gui->activateTab(self::TAB_SETTINGS);
                $this->ctrl->forwardCommand(new ilLTIObjectSettingsGUI($this->getLTIObject()));
                break;
 
            case strtolower(ilLTIToolSettingsGUI::class):
                $this->checkPermission('write');
                $this->tabs_gui->activateTab(self::TAB_SETTINGS);
                new ilLTIObjectSettingsGUI($this->getLTIObject())->addSubTabs();
                $this->ctrl->forwardCommand(new ilLTIToolSettingsGUI($this->getLTIObject()));
                break;
 
            case strtolower(ilPermissionGUI::class):
                $this->tabs_gui->activateTab(self::TAB_PERMISSIONS);
                $this->ctrl->forwardCommand(new ilPermissionGUI($this));
                break;
 
            default:
                $cmd = $this->ctrl->getCmd(self::CMD_LAUNCH);
                // an object without content to launch opens on its info screen
                if ($cmd === self::CMD_LAUNCH && $this->object instanceof ilObjLTITool && !$this->isContentAvailable()) {
                    $this->ctrl->redirectByClass(ilInfoScreenGUI::class, 'showSummary');
                }
                match ($cmd) {
                    self::CMD_LAUNCH => $this->launch(),
                    'create' => $this->create(),
                    'save' => $this->save(),
                    'cancel' => $this->cancelCreation(),
                    'infoScreen' => $this->infoScreen(),
                    'redrawHeaderAction' => $this->redrawHeaderActionObject(),
                    self::CMD_DELIVER_CERTIFICATE => $this->deliverCertificate(),
                    self::CMD_SAVE_OWN_TOOL => $this->saveOwnTool(),
                    self::CMD_REGISTER_TOOL => $this->registerTool(),
                    self::CMD_FINISH_REGISTRATION => $this->finishRegistration(),
                    self::CMD_SELECT_CONTENT => $this->selectContent(),
                    self::CMD_START_DEEP_LINKING => $this->startDeepLinking(),
                    self::CMD_FINISH_DEEP_LINKING => $this->finishDeepLinking(),
                    default => $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE),
                };
        }
    }

References $info, ilLTIObjectSettingsGUI\addSubTabs(), assertReportAccess(), ilObjectGUI\cancelCreation(), ilObject2GUI\checkPermission(), configureInfoScreen(), create(), ILIAS\Repository\ctrl(), deliverCertificate(), finishDeepLinking(), finishRegistration(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), getLTIObject(), ilObjLTIToolAccess\hasLearningProgressAccess(), infoScreen(), isContentAvailable(), launch(), ILIAS\Repository\lng(), ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY, ILIAS\Repository\object(), ilObject2GUI\prepareOutput(), ilObjectGUI\redrawHeaderActionObject(), registerTool(), save(), saveOwnTool(), selectContent(), startDeepLinking(), and trackReadEvent().

Here is the call graph for this function:

◆ finishDeepLinking()

ilObjLTIToolGUI::finishDeepLinking ( )

protected

Where the tool posts the content the user picked, inside the iframe: an object is created for each resource link, and the whole window goes on to the settings of the object, or to the container when there are several.

Exceptions

ilCtrlException
ilMDServicesException
RandomException
ResponseSendingException

Definition at line 620 of file class.ilObjLTIToolGUI.php.

                                          : never
    {
        global $DIC;
 
        $this->assertCreationAccess();
 
        $response = ilLTIAdvantagePlatformDeepLinking::receive(
            $this->getDeepLinkingState(),
            $this->user->getId(),
            $this->getContainerRefId(),
            $DIC
        );
        $this->ctrl->setParameter($this, 'new_type', $this->getType());
        $create_url = $this->ctrl->getLinkTarget($this, 'create');
 
        if ($response === null) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('lti_deep_linking_failed'), true);
            ilLTIAdvantagePlatformDeepLinking::sendTopRedirect($create_url);
        }
 
        // what the tool tells the user, as the LTI standard defines it
        foreach (['message' => 'info', 'error' => 'failure'] as $key => $type) {
            if ($response[$key] !== '') {
                $this->tpl->setOnScreenMessage($type, htmlspecialchars($response[$key], ENT_QUOTES), true);
            }
        }
        if ($response['items'] === []) {
            if ($response['error'] === '') {
                $message = $this->lng->txt('lti_deep_linking_no_content');
                if ($response['message'] !== '') {
                    $message = htmlspecialchars($response['message'], ENT_QUOTES) . ' ' . $message;
                }
                $this->tpl->setOnScreenMessage('info', $message, true);
            }
            ilLTIAdvantagePlatformDeepLinking::sendTopRedirect($create_url);
        }
 
        $objects = [];
        foreach ($response['items'] as $item) {
            $objects[] = $this->createToolObject(
                $response['tool'],
                $item['title'],
                $item['description'],
                implode(';', array_filter([$response['custom_params'], $item['custom_params']]))
            );
        }
 
        $DIC->logger()->forComponent('lti')->info('LTI Deep Linking of the tool {tool_id}: {count} objects created in {ref_id}', [
            'tool_id' => $response['tool']->getId(),
            'count' => count($objects),
            'ref_id' => $this->getContainerRefId(),
        ]);
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('object_added'), true);
        ilLTIAdvantagePlatformDeepLinking::sendTopRedirect(
            count($objects) > 1 ? $this->getStaticLink($this->getContainerRefId()) : $this->getSettingsLink($objects[0])
        );
    }

References $DIC, $message, $response, ilObject2GUI\$type, assertCreationAccess(), createToolObject(), ILIAS\Repository\ctrl(), getContainerRefId(), getDeepLinkingState(), ILIAS\Survey\Mode\getId(), getSettingsLink(), getStaticLink(), getType(), ILIAS\Repository\lng(), ilLTIAdvantagePlatformDeepLinking\receive(), ilLTIAdvantagePlatformDeepLinking\sendTopRedirect(), and ILIAS\Repository\user().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ finishRegistration()

ilObjLTIToolGUI::finishRegistration ( )

protected

Creates the object for the tool a registration of the user stored.

Exceptions

ilCtrlException
ilMDServicesException

Definition at line 505 of file class.ilObjLTIToolGUI.php.

                                           : void
    {
        global $DIC;
 
        $this->assertOwnToolCreationAccess();
 
        $registered = ilLTIAdvantagePlatformRegistration::finish(
            $this->getStringParameter(self::REGISTRATION_PARAM),
            $this->user->getId()
        );
        if ($registered === null) {
            $DIC->logger()->forComponent('lti')->warning('LTI Advantage Dynamic Registration of a tool not finished: the tool did not register, or not for the user {usr_id}', [
                'usr_id' => $this->user->getId(),
            ]);
            $this->ctrl->setParameter($this, 'new_type', $this->getType());
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('lti_dyn_reg_failed'));
            $this->renderCreation(null, $this->buildRegistrationForm());
            return;
        }
 
        [$tool, $custom_params] = $registered;
        $this->createOrSelectContent($tool, $custom_params);
    }

References $DIC, assertOwnToolCreationAccess(), buildRegistrationForm(), createOrSelectContent(), ILIAS\Repository\ctrl(), ilLTIAdvantagePlatformRegistration\finish(), getStringParameter(), getType(), ILIAS\Repository\lng(), renderCreation(), and ILIAS\Repository\user().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getContainerRefId()

ilObjLTIToolGUI::getContainerRefId ( )

private

The container a new object is created in.

Definition at line 930 of file class.ilObjLTIToolGUI.php.

                                        : int
    {
        return (int) $this->parent_id;
    }

References ilObject2GUI\$parent_id.

Referenced by finishDeepLinking(), and showDeepLinking().

Here is the caller graph for this function:

◆ getDeepLinkingState()

ilObjLTIToolGUI::getDeepLinkingState ( )

private

Definition at line 942 of file class.ilObjLTIToolGUI.php.

                                          : string
    {
        return $this->getStringParameter(self::DEEP_LINKING_PARAM);
    }

References getStringParameter().

Referenced by finishDeepLinking(), and startDeepLinking().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIntParameter()

ilObjLTIToolGUI::getIntParameter ( string $name )

private

Definition at line 1036 of file class.ilObjLTIToolGUI.php.

                                                  : int
    {
        return $this->request_wrapper->has($name)
            ? $this->request_wrapper->retrieve($name, $this->refinery->kindlyTo()->int())
            : 0;
    }

References ILIAS\Repository\refinery().

Referenced by getOriginRefId(), and getToolIdParameter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLTIObject()

ilObjLTIToolGUI::getLTIObject ( )

private

Exceptions

ilObjectException

Definition at line 1053 of file class.ilObjLTIToolGUI.php.

                                   : ilObjLTITool
    {
        if (!$this->object instanceof ilObjLTITool) {
            throw new ilObjectException('no LTI object given');
        }
 
        return $this->object;
    }

References ilObjectGUI\$object.

Referenced by configureInfoScreen(), executeCommand(), getReports(), isContentAvailable(), and launch().

Here is the caller graph for this function:

◆ getOriginRefId()

ilObjLTIToolGUI::getOriginRefId ( )

private

The object whose tool settings the content is picked from, 0 on the creation screen.

Definition at line 950 of file class.ilObjLTIToolGUI.php.

                                     : int
    {
        return $this->getIntParameter(self::ORIGIN_PARAM);
    }

References getIntParameter().

Referenced by showDeepLinking().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOwnToolAction()

ilObjLTIToolGUI::getOwnToolAction ( )

private

Exceptions

ilCtrlException

Definition at line 839 of file class.ilObjLTIToolGUI.php.

                                       : string
    {
        $this->ctrl->setParameter($this, self::VERSION_PARAM, $this->getRequestedVersion());
 
        return $this->ctrl->getFormAction($this, self::CMD_SAVE_OWN_TOOL);
    }

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

Referenced by buildOwnTool(), and saveOwnTool().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getReports()

ilObjLTIToolGUI::getReports ( )

private

The reports, by tab, with their GUI and whether the user may see them.

The reports on what users did need the permission to read the object.

Returns: array

Exceptions

ilObjectException

Definition at line 289 of file class.ilObjLTIToolGUI.php.

                                 : array
    {
        $object = $this->getLTIObject();
        $read = $this->checkPermissionBool('read');
 
        return [
            self::TAB_STATEMENTS => [ilLTIToolXapiStatementsGUI::class, $read && ilObjLTIToolAccess::hasStatementsAccess($object)],
            self::TAB_RANKING => [ilLTIObjectRankingGUI::class, $read && ilObjLTIToolAccess::hasRankingAccess($object)],
            self::TAB_GRADEBOOK => [ilLTIObjectGradebookGUI::class, $read && $object->getTool()->isGradeSynchronization()],
            self::TAB_LEARNING_PROGRESS => [ilLearningProgressGUI::class, ilObjLTIToolAccess::hasLearningProgressAccess($object)],
        ];
    }

References ilObjectGUI\$object, ilObject2GUI\checkPermissionBool(), getLTIObject(), ilObjLTIToolAccess\hasLearningProgressAccess(), ilObjLTIToolAccess\hasRankingAccess(), and ilObjLTIToolAccess\hasStatementsAccess().

Referenced by addReportTabs(), and assertReportAccess().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRequestedVersion()

ilObjLTIToolGUI::getRequestedVersion ( )

private

Definition at line 846 of file class.ilObjLTIToolGUI.php.

                                          : string
    {
        $version = $this->getStringParameter(self::VERSION_PARAM);
 
        return $version === ilLTITool::VERSION_1P1 ? ilLTITool::VERSION_1P1 : ilLTITool::VERSION_ADVANTAGE;
    }

References $version, getStringParameter(), ilLTITool\VERSION_1P1, and ilLTITool\VERSION_ADVANTAGE.

Referenced by buildOwnTool(), buildOwnToolForm(), and getOwnToolAction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSettingsLink()

ilObjLTIToolGUI::getSettingsLink ( ilObjLTITool $object )

private

Exceptions

ilCtrlException

Definition at line 907 of file class.ilObjLTIToolGUI.php.

                                                          : string
    {
        $this->ctrl->setParameterByClass(ilLTIObjectSettingsGUI::class, 'ref_id', $object->getRefId());
 
        return $this->ctrl->getLinkTargetByClass(
            [ilObjLTIToolGUI::class, ilLTIObjectSettingsGUI::class],
            ilLTIObjectSettingsGUI::CMD_SHOW
        );
    }

References ilObjectGUI\$object, ilLTIObjectSettingsGUI\CMD_SHOW, ILIAS\Repository\ctrl(), and ilObject\getRefId().

Referenced by createOrSelectContent(), and finishDeepLinking().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStaticLink()

ilObjLTIToolGUI::getStaticLink ( int $ref_id )

private

Definition at line 917 of file class.ilObjLTIToolGUI.php.

                                               : string
    {
        global $DIC;
 
        return (string) $DIC['static_url']->builder()->build(
            ilObject::_lookupType($ref_id, true),
            new ReferenceId($ref_id)
        );
    }

References $DIC, ilObjectGUI\$ref_id, and ilObject\_lookupType().

Referenced by finishDeepLinking(), and showDeepLinking().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStringParameter()

ilObjLTIToolGUI::getStringParameter ( string $name )

private

Definition at line 1029 of file class.ilObjLTIToolGUI.php.

                                                     : string
    {
        return $this->request_wrapper->has($name)
            ? $this->request_wrapper->retrieve($name, $this->refinery->kindlyTo()->string())
            : '';
    }

References ILIAS\Repository\refinery().

Referenced by finishRegistration(), getDeepLinkingState(), and getRequestedVersion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getToolIdParameter()

ilObjLTIToolGUI::getToolIdParameter ( )

private

Definition at line 1024 of file class.ilObjLTIToolGUI.php.

                                         : int
    {
        return $this->getIntParameter('tool_id');
    }

References getIntParameter().

Referenced by save(), and selectContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getType()

ilObjLTIToolGUI::getType ( )

Functions that must be overwritten.

Reimplemented from ilObject2GUI.

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

                             : string
    {
        return 'lti';
    }

Referenced by assertCreationAccess(), create(), createToolObject(), finishDeepLinking(), finishRegistration(), registerTool(), renderCreation(), save(), saveOwnTool(), showDeepLinking(), and startDeepLinking().

Here is the caller graph for this function:

◆ infoScreen()

ilObjLTIToolGUI::infoScreen ( )

protected

The command the info action of the listing calls.

Exceptions

ilCtrlException

Definition at line 750 of file class.ilObjLTIToolGUI.php.

                                   : void
    {
        $this->ctrl->redirectByClass(ilInfoScreenGUI::class, 'showSummary');
    }

References ILIAS\Repository\ctrl().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initHeaderAction()

ilObjLTIToolGUI::initHeaderAction	(	?string	$sub_type = `null`,
		?int	$sub_id = `null`
	)

protected

The header offers the certificate of the current user, once they have one.

Exceptions

ilCtrlException

Reimplemented from ilObject2GUI.

Definition at line 722 of file class.ilObjLTIToolGUI.php.

                                                                                      : ?ilObjectListGUI
    {
        $header_action = parent::initHeaderAction($sub_type, $sub_id);
        if ($header_action === null || $this->creation_mode
            || !new ilCertificateDownloadValidator()->isCertificateDownloadable($this->user->getId(), $this->object->getId())) {
            return $header_action;
        }
 
        $this->lng->loadLanguageModule('certificate');
        $link = $this->ctrl->getLinkTarget($this, self::CMD_DELIVER_CERTIFICATE);
        $header_action->addCustomCommand($link, 'download_certificate');
        $header_action->addHeaderIcon(
            'cert_icon',
            ilUtil::getImagePath('standard/icon_cert.svg'),
            $this->lng->txt('download_certificate'),
            null,
            null,
            $link
        );
 
        return $header_action;
    }

References ILIAS\Repository\ctrl(), ilUtil\getImagePath(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ isContentAvailable()

ilObjLTIToolGUI::isContentAvailable ( )

private

Launching needs the object online and a tool that is still available.

Exceptions

ilObjectException

Definition at line 960 of file class.ilObjLTIToolGUI.php.

                                         : bool
    {
        $object = $this->getLTIObject();
 
        return !$object->getOfflineStatus()
            && $object->getTool()->getAvailability() !== ilLTITool::AVAILABILITY_NONE;
    }

References ilObjectGUI\$object, ilLTITool\AVAILABILITY_NONE, getLTIObject(), and ilObject\getOfflineStatus().

Referenced by executeCommand(), and setTabs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ launch()

ilObjLTIToolGUI::launch ( )

protected

Exceptions

ilCtrlException
ilObjectException

Definition at line 759 of file class.ilObjLTIToolGUI.php.

                               : void
    {
        $this->checkPermission('read');
        $this->tabs_gui->activateTab(self::TAB_CONTENT);
        $this->ctrl->forwardCommand(new ilLTIToolLaunchGUI($this->getLTIObject()));
    }

References ilObject2GUI\checkPermission(), ILIAS\Repository\ctrl(), and getLTIObject().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ registerTool()

ilObjLTIToolGUI::registerTool ( )

protected

Registers a tool of the user through LTI Advantage Dynamic Registration: the registration page of the tool opens in an iframe, and the object is created once the tool says it is done.

A tool that does not say so is taken as done when the user says it is.

Exceptions

ilCtrlException
RandomException

Definition at line 441 of file class.ilObjLTIToolGUI.php.

                                     : void
    {
        $this->assertOwnToolCreationAccess();
 
        $this->ctrl->setParameter($this, 'new_type', $this->getType());
        $form = $this->buildRegistrationForm()->withRequest($this->request);
        $data = $form->getData();
        if ($data === null) {
            $this->renderCreation(null, $form);
            return;
        }
 
        global $DIC;
 
        try {
            [$registration, $url] = ilLTIAdvantagePlatformRegistration::start(
                (string) $data['url'],
                trim((string) $data['params']),
                $this->user->getId()
            );
        } catch (ilException $e) {
            $DIC->logger()->forComponent('lti')->error($e->getMessage());
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('lti_dyn_reg_failed'));
            $this->renderCreation(null, $form);
            return;
        }
 
        $DIC->logger()->forComponent('lti')->debug('LTI Advantage Dynamic Registration of the tool at {url} started', ['url' => (string) $data['url']]);
        $this->ctrl->setParameter($this, self::REGISTRATION_PARAM, $registration);
        $finish_url = $this->ctrl->getLinkTarget($this, self::CMD_FINISH_REGISTRATION);
        $this->ctrl->setParameter($this, self::REGISTRATION_PARAM, null);
 
        $this->tpl->setTitleIcon(ilObject::getIconForType($this->getType()));
        $this->tpl->setTitle($this->lng->txt('lti_dynamic_registration'));
        $this->tabs_gui->setBackTarget($this->lng->txt('cancel'), $this->ctrl->getLinkTarget($this, 'create'));
        $this->tpl->addOnLoadCode(
            'window.addEventListener("message", function (event) {'
            . 'var frame = document.getElementById("' . self::REGISTRATION_FRAME_ID . '");'
            . 'if (frame && event.source === frame.contentWindow && event.data'
            . ' && event.data.subject === "org.imsglobal.lti.close") {'
            . 'window.location.assign(' . json_encode($finish_url, JSON_UNESCAPED_SLASHES) . ');'
            . '}});'
        );
        global $DIC;
        $this->tpl->setContent($this->ui_renderer->render([
            $this->ui_factory->messageBox()->info($this->lng->txt('lti_dyn_reg_running'))->withButtons([
                $this->ui_factory->button()->standard($this->lng->txt('lti_dyn_reg_finish'), $finish_url),
            ]),
            ilLTIAdvantagePlatformLaunchRenderer::buildIframe(
                self::REGISTRATION_FRAME_ID,
                $url,
                $this->lng->txt('lti_dynamic_registration'),
                600,
                $DIC
            ),
        ]));
    }

References ilObjectGUI\$data, $DIC, Vendor\Package\$e, assertOwnToolCreationAccess(), ilLTIAdvantagePlatformLaunchRenderer\buildIframe(), buildRegistrationForm(), ILIAS\Repository\ctrl(), ilObject\getIconForType(), getType(), ILIAS\Repository\lng(), renderCreation(), ilLTIAdvantagePlatformRegistration\start(), and ILIAS\Repository\user().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderCreation()

ilObjLTIToolGUI::renderCreation	(	?Form	$own_form = `null`,
		?Form	$registration_form = `null`
	)

private

The ways of creating an object, one section each, with the first one open.

The section of an own tool opens instead once it has been used, that is when its form comes back with errors or when the LTI version has been switched.

Exceptions

ilCtrlException

Definition at line 352 of file class.ilObjLTIToolGUI.php.

                                                                                            : void
    {
        $this->ctrl->saveParameter($this, 'crtptrefid');
        $this->ctrl->saveParameter($this, 'crtcb');
        $this->ctrl->setParameter($this, 'new_type', $this->getType());
        $this->tpl->setTitleIcon(ilObject::getIconForType($this->getType()));
        $this->tpl->setTitle($this->lng->txt('obj_' . $this->getType()));
        $this->tabs_gui->setBackTarget($this->lng->txt('cancel'), $this->ctrl->getLinkTargetByClass(static::class, 'cancel'));
        $this->tpl->addCss('./assets/css/lti_creation.css');
 
        $accordion = new ilAccordionGUI();
        $accordion->setBehaviour(ilAccordionGUI::FIRST_OPEN);
        $accordion->setContentClass('il-lti-creation');
        // the section a user works in stays open, which is also what lets a section be forced open
        $accordion->setId('lti_create');
        $accordion->setUseSessionStorage(true);
        $accordion->addItem(
            $this->lng->txt($this->getType() . '_select_provider'),
            $this->ui_renderer->render($this->buildToolSelection())
        );
 
        if (ilObjLTIAdministrationAccess::hasOwnToolCreationAccess()) {
            $accordion->addItem(
                $this->lng->txt('lti_dynamic_registration'),
                $this->ui_renderer->render($registration_form ?? $this->buildRegistrationForm()),
                $registration_form !== null
            );
            $accordion->addItem(
                $this->lng->txt('lti_custom_new'),
                $this->ui_renderer->render($this->buildOwnTool($own_form)),
                $own_form !== null || $this->request_wrapper->has(self::VERSION_PARAM)
            );
        }
 
        $this->tpl->setContent($accordion->getHTML());
    }

References ILIAS\Repository\ctrl(), ilAccordionGUI\FIRST_OPEN, ilObject\getIconForType(), getType(), ilObjLTIAdministrationAccess\hasOwnToolCreationAccess(), and ILIAS\Repository\lng().

Referenced by create(), finishRegistration(), registerTool(), and saveOwnTool().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilObjLTIToolGUI::save ( )

Creates the object for the tool of the request.

Exceptions

ilCtrlException
ilMDServicesException

Reimplemented from ilObject2GUI.

Definition at line 395 of file class.ilObjLTIToolGUI.php.

                          : void
    {
        if (!$this->checkPermissionBool('create', '', $this->getType())) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->MESSAGE);
        }
 
        $tool = new ilLTITool($this->getToolIdParameter());
        if (!$tool->isSelectableBy($this->user->getId())) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('lti_no_provider_selected'));
            $this->create();
            return;
        }
 
        $this->createOrSelectContent($tool);
    }

References ilObject2GUI\checkPermissionBool(), create(), createOrSelectContent(), getToolIdParameter(), getType(), and ILIAS\Repository\lng().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveOwnTool()

ilObjLTIToolGUI::saveOwnTool ( )

protected

Stores a tool of the user and creates the object for it.

Exceptions

ilCtrlException
ilMDServicesException

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

                                    : void
    {
        $this->assertOwnToolCreationAccess();
 
        $this->ctrl->setParameter($this, 'new_type', $this->getType());
        $form = $this->buildOwnToolForm();
        $with_errors = $form->save($this->getOwnToolAction(), $this->request, true);
 
        if ($with_errors !== null) {
            $this->renderCreation($with_errors);
            return;
        }
 
        $this->createOrSelectContent(new ilLTITool($form->getSavedId()));
    }

References assertOwnToolCreationAccess(), buildOwnToolForm(), createOrSelectContent(), ILIAS\Repository\ctrl(), getOwnToolAction(), getType(), and renderCreation().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ selectContent()

ilObjLTIToolGUI::selectContent ( )

protected

Picks the content of new objects in a tool that offers Deep Linking, from an object of the tool: the objects are created next to it, as earlier releases did.

Exceptions

ilCtrlException
RandomException

Definition at line 536 of file class.ilObjLTIToolGUI.php.

                                      : void
    {
        $this->assertCreationAccess();
 
        $tool = new ilLTITool($this->getToolIdParameter());
        if (!$tool->isSelectableBy($this->user->getId()) || !$tool->offersDeepLinking()) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        $this->showDeepLinking($tool);
    }

References assertCreationAccess(), getToolIdParameter(), ILIAS\Repository\lng(), and showDeepLinking().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTabs()

ilObjLTIToolGUI::setTabs ( )

protected

Exceptions

ilCtrlException
ilObjectException

Reimplemented from ilObject2GUI.

Definition at line 226 of file class.ilObjLTIToolGUI.php.

                                : void
    {
        if (!$this->object instanceof ilObjLTITool) {
            parent::setTabs();
            return;
        }
 
        if ($this->checkPermissionBool('read') && $this->isContentAvailable()) {
            $this->tabs_gui->addTab(
                self::TAB_CONTENT,
                $this->lng->txt(self::TAB_CONTENT),
                $this->ctrl->getLinkTarget($this, self::CMD_LAUNCH)
            );
        }
 
        $this->tabs_gui->addTab(
            self::TAB_INFO,
            $this->lng->txt(self::TAB_INFO),
            $this->ctrl->getLinkTargetByClass(ilInfoScreenGUI::class, 'showSummary')
        );
 
        if ($this->checkPermissionBool('write')) {
            $this->tabs_gui->addTab(
                self::TAB_SETTINGS,
                $this->lng->txt(self::TAB_SETTINGS),
                $this->ctrl->getLinkTargetByClass(ilLTIObjectSettingsGUI::class, ilLTIObjectSettingsGUI::CMD_SHOW)
            );
        }
 
        $this->addReportTabs();
 
        if ($this->checkPermissionBool('write')) {
            $metadata_link = new ilObjectMetaDataGUI($this->object)->getTab();
            if ($metadata_link !== null && $metadata_link !== '') {
                $this->tabs_gui->addTab(self::TAB_METADATA, $this->lng->txt(self::TAB_METADATA), $metadata_link);
            }
        }
 
        parent::setTabs();
    }

References addReportTabs(), ilObject2GUI\checkPermissionBool(), ilLTIObjectSettingsGUI\CMD_SHOW, ilObjectMetaDataGUI\getTab(), isContentAvailable(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ showDeepLinking()

ilObjLTIToolGUI::showDeepLinking	(	ilLTITool	$tool,
		string	$custom_params = `''`
	)

private

The iframe the tool shows its content in for the user to pick.

Exceptions

ilCtrlException
RandomException

Definition at line 554 of file class.ilObjLTIToolGUI.php.

                                                                                 : void
    {
        global $DIC;
 
        $this->ctrl->setParameter($this, 'new_type', $this->getType());
        $this->ctrl->setParameter($this, 'tool_id', null);
        $this->ctrl->setParameter(
            $this,
            self::DEEP_LINKING_PARAM,
            ilLTIAdvantagePlatformDeepLinking::start($tool, $this->getContainerRefId(), $this->user->getId(), $custom_params)
        );
        $frame_url = $this->ctrl->getLinkTarget($this, self::CMD_START_DEEP_LINKING);
        $this->ctrl->setParameter($this, self::DEEP_LINKING_PARAM, null);
 
        $origin_ref_id = $this->getOriginRefId();
        $cancel_url = $origin_ref_id > 0
            ? $this->getStaticLink($origin_ref_id)
            : $this->ctrl->getLinkTarget($this, 'create');
 
        $this->tpl->setTitleIcon(ilObject::getIconForType($this->getType()));
        $this->tpl->setTitle($tool->getTitle());
        $this->tabs_gui->setBackTarget($this->lng->txt('cancel'), $cancel_url);
        $this->tpl->setContent($this->ui_renderer->render([
            $this->ui_factory->messageBox()->info($this->lng->txt('lti_deep_linking_running')),
            ilLTIAdvantagePlatformLaunchRenderer::buildFrame($frame_url, $tool->getTitle(), 600, $DIC),
        ]));
    }

References $DIC, ilLTIAdvantagePlatformLaunchRenderer\buildFrame(), ILIAS\Repository\ctrl(), getContainerRefId(), ilObject\getIconForType(), getOriginRefId(), getStaticLink(), ilLTITool\getTitle(), getType(), ILIAS\Repository\lng(), ilLTIAdvantagePlatformDeepLinking\start(), and ILIAS\Repository\user().

Referenced by createOrSelectContent(), and selectContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ startDeepLinking()

ilObjLTIToolGUI::startDeepLinking ( )

protected

Content of the iframe: starts the Deep Linking request at the tool.

Exceptions

ilCtrlException
RandomException
ResponseSendingException

Definition at line 589 of file class.ilObjLTIToolGUI.php.

                                         : never
    {
        global $DIC;
 
        $this->assertCreationAccess();
 
        $state = $this->getDeepLinkingState();
        $this->ctrl->setParameter($this, 'new_type', $this->getType());
        $this->ctrl->setParameter($this, self::DEEP_LINKING_PARAM, $state);
        $return_url = ilLTIEndpoint::getBaseUrl() . '/'
            . $this->ctrl->getLinkTarget($this, self::CMD_FINISH_DEEP_LINKING);
 
        ilLTIAdvantagePlatformDeepLinking::sendRequestPage(
            $state,
            $this->user->getId(),
            $this->getContainerRefId(),
            $return_url,
            $DIC
        );
    }

References $DIC, assertCreationAccess(), ILIAS\Repository\ctrl(), ilLTIEndpoint\getBaseUrl(), getDeepLinkingState(), getType(), ilLTIAdvantagePlatformDeepLinking\sendRequestPage(), and ILIAS\Repository\user().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ trackReadEvent()

ilObjLTIToolGUI::trackReadEvent ( )

private

Opening an object counts as reading it, which the learning progress takes into account.

Definition at line 315 of file class.ilObjLTIToolGUI.php.

                                     : void
    {
        if ($this->creation_mode || !$this->object instanceof ilObjLTITool) {
            return;
        }
 
        ilChangeEvent::_recordReadEvent(
            $this->object->getType(),
            $this->object->getRefId(),
            $this->object->getId(),
            $this->user->getId()
        );
        ilLPStatusWrapper::_updateStatus($this->object->getId(), $this->user->getId());
    }

References ilChangeEvent\_recordReadEvent(), ilLPStatusWrapper\_updateStatus(), and ILIAS\Repository\object().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ CMD_DELIVER_CERTIFICATE

const string ilObjLTIToolGUI::CMD_DELIVER_CERTIFICATE = 'deliverCertificate'

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

Referenced by ilObjLTIToolListGUI\getProperties().

◆ CMD_FINISH_DEEP_LINKING

const string ilObjLTIToolGUI::CMD_FINISH_DEEP_LINKING = 'finishDeepLinking'

private

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

◆ CMD_FINISH_REGISTRATION

const string ilObjLTIToolGUI::CMD_FINISH_REGISTRATION = 'finishRegistration'

private

Definition at line 54 of file class.ilObjLTIToolGUI.php.

◆ CMD_LAUNCH

const string ilObjLTIToolGUI::CMD_LAUNCH = 'launch'

Definition at line 47 of file class.ilObjLTIToolGUI.php.

Referenced by ilObjLTIToolAccess\_getCommands().

◆ CMD_REGISTER_TOOL

const string ilObjLTIToolGUI::CMD_REGISTER_TOOL = 'registerTool'

private

Definition at line 53 of file class.ilObjLTIToolGUI.php.

◆ CMD_SAVE_OWN_TOOL

const string ilObjLTIToolGUI::CMD_SAVE_OWN_TOOL = 'saveOwnTool'

private

Definition at line 52 of file class.ilObjLTIToolGUI.php.

◆ CMD_SELECT_CONTENT

const string ilObjLTIToolGUI::CMD_SELECT_CONTENT = 'selectContent'

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

Referenced by ilLTIToolSettingsGUI\addSelectContentButton().

◆ CMD_START_DEEP_LINKING

const string ilObjLTIToolGUI::CMD_START_DEEP_LINKING = 'startDeepLinking'

private

Definition at line 57 of file class.ilObjLTIToolGUI.php.

◆ DEEP_LINKING_PARAM

const string ilObjLTIToolGUI::DEEP_LINKING_PARAM = 'deep_linking'

private

Definition at line 59 of file class.ilObjLTIToolGUI.php.

◆ ORIGIN_PARAM

const string ilObjLTIToolGUI::ORIGIN_PARAM = 'origin_ref_id'

Definition at line 50 of file class.ilObjLTIToolGUI.php.

Referenced by ilLTIToolSettingsGUI\addSelectContentButton().

◆ REGISTRATION_FRAME_ID

const string ilObjLTIToolGUI::REGISTRATION_FRAME_ID = 'il_lti_registration_frame'

private

Definition at line 56 of file class.ilObjLTIToolGUI.php.

◆ REGISTRATION_PARAM

const string ilObjLTIToolGUI::REGISTRATION_PARAM = 'registration'

private

Definition at line 55 of file class.ilObjLTIToolGUI.php.

◆ TAB_CONTENT

const string ilObjLTIToolGUI::TAB_CONTENT = 'tab_content'

private

Definition at line 61 of file class.ilObjLTIToolGUI.php.

◆ TAB_GRADEBOOK

const string ilObjLTIToolGUI::TAB_GRADEBOOK = 'tab_grade_synchronization'

private

Definition at line 66 of file class.ilObjLTIToolGUI.php.

◆ TAB_INFO

const string ilObjLTIToolGUI::TAB_INFO = 'tab_info'

private

Definition at line 62 of file class.ilObjLTIToolGUI.php.

◆ TAB_LEARNING_PROGRESS

const string ilObjLTIToolGUI::TAB_LEARNING_PROGRESS = 'learning_progress'

private

Definition at line 67 of file class.ilObjLTIToolGUI.php.

◆ TAB_METADATA

const string ilObjLTIToolGUI::TAB_METADATA = 'meta_data'

private

Definition at line 68 of file class.ilObjLTIToolGUI.php.

◆ TAB_PERMISSIONS

const string ilObjLTIToolGUI::TAB_PERMISSIONS = 'id_permissions'

private

Definition at line 69 of file class.ilObjLTIToolGUI.php.

◆ TAB_RANKING

const string ilObjLTIToolGUI::TAB_RANKING = 'tab_scoring'

private

Definition at line 65 of file class.ilObjLTIToolGUI.php.

◆ TAB_SETTINGS

const string ilObjLTIToolGUI::TAB_SETTINGS = 'tab_settings'

private

Definition at line 63 of file class.ilObjLTIToolGUI.php.

◆ TAB_STATEMENTS

const string ilObjLTIToolGUI::TAB_STATEMENTS = 'tab_statements'

private

Definition at line 64 of file class.ilObjLTIToolGUI.php.

◆ VERSION_PARAM

const string ilObjLTIToolGUI::VERSION_PARAM = 'version'

private

Definition at line 60 of file class.ilObjLTIToolGUI.php.

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

components/ILIAS/LTI/classes/Object/class.ilObjLTIToolGUI.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _goto()

◆ addReportTabs()

◆ assertCreationAccess()

◆ assertOwnToolCreationAccess()

◆ assertReportAccess()

◆ buildOwnTool()

◆ buildOwnToolForm()

◆ buildRegistrationForm()

◆ buildToolSelection()

◆ buildVersionControl()

◆ configureInfoScreen()

◆ create()

◆ createOrSelectContent()

◆ createToolObject()

◆ deliverCertificate()

◆ executeCommand()

◆ finishDeepLinking()

◆ finishRegistration()

◆ getContainerRefId()

◆ getDeepLinkingState()

◆ getIntParameter()

◆ getLTIObject()

◆ getOriginRefId()

◆ getOwnToolAction()

◆ getReports()

◆ getRequestedVersion()

◆ getSettingsLink()

◆ getStaticLink()

◆ getStringParameter()

◆ getToolIdParameter()

◆ getType()

◆ infoScreen()

◆ initHeaderAction()

◆ isContentAvailable()

◆ launch()

◆ registerTool()

◆ renderCreation()

◆ save()

◆ saveOwnTool()

◆ selectContent()

◆ setTabs()

◆ showDeepLinking()

◆ startDeepLinking()

◆ trackReadEvent()

Field Documentation

◆ CMD_DELIVER_CERTIFICATE

◆ CMD_FINISH_DEEP_LINKING

◆ CMD_FINISH_REGISTRATION

◆ CMD_LAUNCH

◆ CMD_REGISTER_TOOL

◆ CMD_SAVE_OWN_TOOL

◆ CMD_SELECT_CONTENT

◆ CMD_START_DEEP_LINKING

◆ DEEP_LINKING_PARAM

◆ ORIGIN_PARAM

◆ REGISTRATION_FRAME_ID

◆ REGISTRATION_PARAM

◆ TAB_CONTENT

◆ TAB_GRADEBOOK

◆ TAB_INFO

◆ TAB_LEARNING_PROGRESS

◆ TAB_METADATA

◆ TAB_PERMISSIONS

◆ TAB_RANKING

◆ TAB_SETTINGS

◆ TAB_STATEMENTS

◆ VERSION_PARAM