class Launch

This captures all of the data associated with the LTI Launch.

Properties

$user Get the User associated with the launch.
$context Get the Context associated with the launch.
$link Get the Link associated with the launch.
$result Get the Result associated with the launch.
$pdox Return the PDOX connection used by Tsugi.
$output Return the output helper class.
$request_parms Must be an array equivalent to $_REQUEST. If this is present We do not assume access to $_POST or $_GET and we assume that we cannot use header() so the caller must
$current_url Must be a string that is the current called URL.
$session_object If present, it means all session management is above us.
$redirect_url If this is non-null when we return, the caller must redirect to a GET of the same URL.
$base_string Get the base string from the launch.
$error_message Get the error message if something went wrong with the setup (TBD)

Methods

session_get($key, $default = null)

Get a key from the session

session_put($key, $value)

Set a key in the session

session_forget($key)

Forget a key in the session

session_flush()

Flush the session

ltiParameterArray()

Pull a keyed variable from the LTI data in the current session with default

ltiParameter($varname, $default = false)

Pull a keyed variable from the LTI data in the current session with default

ltiParameterUpdate($varname, $value)

Update a keyed variable from the LTI data in the current session with default

ltiRawPostArray()

Return the original $_POST array

ltiRawParameter($varname, $default = false)

Pull a keyed variable from the original LTI post data in the current session with default

ltiCustomGet($varname, $default = false)

Pull out a custom variable from the LTIX session. Do not include the "custom_" prefix - this is automatic.

isSakai()

Indicate if this launch came from Sakai

isCanvas()

Indicate if this launch came from Canvas

isMoodle()

Indicate if this launch came from Moodle

isCoursera()

Indicate if this launch came from Coursera

newLaunch($send_name = true, $send_email = true)

set up parameters for an outbound launch from this launch

var_dump()

Dump out the internal data structures associated with the current launch. Best if used within a pre tag.

Details

at line 91
session_get($key, $default = null)

Get a key from the session

Parameters

$key
$default

at line 98
session_put($key, $value)

Set a key in the session

Parameters

$key
$value

at line 105
session_forget($key)

Forget a key in the session

Parameters

$key

at line 112
session_flush()

Flush the session

at line 119
ltiParameterArray()

Pull a keyed variable from the LTI data in the current session with default

at line 127
ltiParameter($varname, $default = false)

Pull a keyed variable from the LTI data in the current session with default

Parameters

$varname
$default

at line 137
ltiParameterUpdate($varname, $value)

Update a keyed variable from the LTI data in the current session with default

Parameters

$varname
$value

at line 147
ltiRawPostArray()

Return the original $_POST array

at line 155
ltiRawParameter($varname, $default = false)

Pull a keyed variable from the original LTI post data in the current session with default

Parameters

$varname
$default

at line 166
ltiCustomGet($varname, $default = false)

Pull out a custom variable from the LTIX session. Do not include the "custom_" prefix - this is automatic.

Parameters

$varname
$default

at line 173
isSakai()

Indicate if this launch came from Sakai

at line 182
isCanvas()

Indicate if this launch came from Canvas

at line 190
isMoodle()

Indicate if this launch came from Moodle

at line 199
isCoursera()

Indicate if this launch came from Coursera

at line 208
newLaunch($send_name = true, $send_email = true)

set up parameters for an outbound launch from this launch

Parameters

$send_name
$send_email

at line 249
var_dump()

Dump out the internal data structures associated with the current launch. Best if used within a pre tag.