Course_LtiController Class Reference

Inheritance diagram for Course_LtiController:

Public Member Functions
	__construct (\Trails\Dispatcher $dispatcher)
	before_filter (&$action, &$args)
	index_action ()
	select_tool_action ()
	select_tool_redirect_action ()
	consent_action (string $deployment_id)
	iframe_action (string $deployment_id)
	config_action ()
	save_config_action ()
	move_action (string $deployment_id, string $direction)
	delete_action ($position)
	add_link_action ()
	select_link_action ($deployment_id='')
	process_select_link_action ($deployment_id='')
	save_link_action ($tool_id)
	getLtiLink ($lti_data)
	profile_action ($id)
	outcome_action ($id)
	grades_action ()
	export_grades_action ()
Public Member Functions inherited from StudipController
	__construct (\Trails\Dispatcher $dispatcher)
	before_filter (&$action, &$args)
	injectResponse (Psr\Http\Message\ResponseInterface $response)
	perform ($unconsumed_path)
	after_filter ($action, $args)
	validate_args (&$args, $types=null)
	url_for ($to='')
	link_for ($to='')
	redirect ($to)
	relocate ($to)
	rescue ($exception)
	render_json ($data)
	render_csv ($data, $filename=null, $delimiter=';', $enclosure='"')
	render_file (string $file, ?string $filename=null, ?string $content_type=null, string $content_disposition='attachment', ?Closure $callback=null)
	render_temporary_file (string $file, ?string $filename=null, ?string $content_type=null, string $content_disposition='attachment', ?Closure $callback=null)
	render_form (\Studip\Forms\Form $form)
	render_vue_app (\Studip\VueApp $app)
	relay ($to_uri)
	relayWithRedirect (... $args)
	perform_relayed ($unconsumed)
	render_template ($template_name, $layout=null)
	render_template_as_string ($template, $layout=null)
	__call ($method, $arguments)
	has_action ($action)
	action_url ($action)
	action_link ($action)
	validate_datetime ($datetime, $format='H:i')
	render_spreadsheet (array $header, array $data, string $format, string $filename, ?string $filepath=null)
Public Member Functions inherited from Controller
	__construct (Dispatcher $dispatcher)
	erase_response ()
	get_response ()
	perform ($unconsumed)
	extract_action_and_args ($string)
	default_action_and_args ()
	map_action ($action)
	before_filter (&$action, &$args)
	after_filter ($action, $args)
	does_not_understand ($action, $args)
	redirect ($to)
	render_text ($text=' ')
	render_nothing ()
	render_action ($action)
	get_default_template ($action)
	render_template ($template_name, $layout=null)
	get_template_factory ()
	get_assigned_variables ()
	set_layout ($layout)
	url_for ($to)
	set_status ($status, $reason_phrase=null)
	set_content_type ($type)
	rescue ($exception)
	respond_to ($ext)

Additional Inherited Members
Protected Member Functions inherited from StudipController
	render_pdf (TCPDF $pdf, $filename, $inline=false)
	controller_path ()
	getBodyElementIdForControllerAndAction ($unconsumed_path)
Protected Attributes inherited from StudipController
	$with_session = false
	$allow_nobody = true
	$_autobind = false
Protected Attributes inherited from Controller
Dispatcher	$dispatcher
Response	$response
bool	$performed = false
Template string null	$layout = null

Detailed Description

course/lti.php - LTI consumer API for Stud.IP

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Author

Elmar Ludwig http://www.gnu.org/licenses/gpl-2.0.html GPL version 2

Constructor & Destructor Documentation

__construct()

__construct

(

\Trails\Dispatcher

$dispatcher

)

Member Function Documentation

add_link_action()

add_link_action

(

)

Select a tool for adding a block via ContentItemSelectionRequest.

before_filter()

before_filter	(	&	$action,
		&	$args
	)

Callback function being called before an action is executed.

config_action()

config_action

(

)

Edit the course settings.

consent_action()

consent_action

(

string

$deployment_id

)

delete_action()

delete_action

(

$position

)

Delete an LTI content block.

Parameters

int

$position

block position

export_grades_action()

export_grades_action

(

)

Export grades from the gradebook in CSV format.

getLtiLink()

getLtiLink

(

$lti_data

)

Return an LtiLink object for the configured LTI content block.

Parameters

LtiDeployment

$lti_data

data of LTI content block

Returns

LtiLink LTI link representation

grades_action()

grades_action

(

)

Display the (simple) LTI grade book.

iframe_action()

iframe_action

(

string

$deployment_id

)

Display the launch form for a tool as an iframe.

index_action()

index_action

(

)

Display the list of LTI content blocks.

move_action()

move_action	(	string	$deployment_id,
		string	$direction
	)

Moves an LTI deployment in a course either up or down.

Parameters

string	$deployment_id	The ID of the deployment to be moved.
string	$direction	'up' for moving the deployment upwards or 'down' for downwards.

outcome_action()

outcome_action

(

$id

)

Handle outcome service callback request by the LTI tool.

Parameters

int

$id

link id

process_select_link_action()

process_select_link_action

(

$deployment_id = ''

)

profile_action()

profile_action

(

$id

)

Return the LTI consumer profile in standard JSON format.

Parameters

int

$id

link id

save_config_action()

save_config_action

(

)

Save the course settings.

save_link_action()

save_link_action

(

$tool_id

)

Create a new LTI content block for the specified tool id.

Parameters

int

$tool_id

tool id

select_link_action()

select_link_action

(

$deployment_id = ''

)

Dispatch a ContentItemSelectionRequest to a specified LTI tool.

select_tool_action()

select_tool_action

(

)

select_tool_redirect_action()

select_tool_redirect_action

(

)

---

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

• app/controllers/course/lti.php