DeepLinkResponse
extends DeepLinkRequest
in package
This is a general purpose DeepLink class with no Tsugi-specific dependencies.
Deep Linking 2.0 spec: https://www.imsglobal.org/spec/lti-dl/v2p0
Table of Contents
Constants
- CONTENT_ITEMS : mixed = "https://purl.imsglobal.org/spec/lti-dl/claim/c...
- DATA_CLAIM : mixed = "https://purl.imsglobal.org/spec/lti-dl/claim/d...
- MESSAGE_ERRORLOG : mixed = "https://purl.imsglobal.org/spec/lti-dl/claim/e...
- MESSAGE_ERRORMSG : mixed = "https://purl.imsglobal.org/spec/lti-dl/claim/e...
- MESSAGE_LOG : mixed = "https://purl.imsglobal.org/spec/lti-dl/claim/log"
- MESSAGE_MSG : mixed = "https://purl.imsglobal.org/spec/lti-dl/claim/msg"
Properties
Methods
- __construct() : mixed
- acceptType() : mixed
- acceptType - Returns true if the string is in the accept_types
- addContentItem() : mixed
- addContentItem - Add an Content Item
- addContentItemExtended() : mixed
- addContentItemExtended - Add an Content Item
- addFileItem() : mixed
- addFileItem - Add an File Item
- addLtiLinkItem() : mixed
- addLtiLinkItem - Add an LTI Link Deep Link
- addLtiLinkItemExtended() : mixed
- addLtiLinkItemExtended - Add an LTI Link Content Item
- allowContentItem() : mixed
- allowContentItem - Returns true if we can return HTML Items
- allowImportItem() : mixed
- allowImportItem - Returns true if we can return IMS Common Cartridges
- allowLink() : mixed
- allowLink - Returns true if we can return HTML Items
- allowLtiLinkItem() : mixed
- allowLtiLinkItem - Returns true if we can return LTI Link Items "accept_types": ["link", "file", "html", "ltiResourceLink", "image"],
- allowMimetype() : mixed
- allowMimetype - Returns true if we can return LTI Link Items
- allowMultiple() : mixed
- allowMultiple - Returns true if we can return multiple items
- getClaim() : mixed
- getClaim - get a extension claim
- getContentItemSelection() : mixed
- Return the claims array to send back to the LMS
- returnUrl() : string
- returnUrl - Returns the deep_link_return_url
Constants
CONTENT_ITEMS
public
mixed
CONTENT_ITEMS
= "https://purl.imsglobal.org/spec/lti-dl/claim/content_items"
DATA_CLAIM
public
mixed
DATA_CLAIM
= "https://purl.imsglobal.org/spec/lti-dl/claim/data"
MESSAGE_ERRORLOG
public
mixed
MESSAGE_ERRORLOG
= "https://purl.imsglobal.org/spec/lti-dl/claim/errorlog"
MESSAGE_ERRORMSG
public
mixed
MESSAGE_ERRORMSG
= "https://purl.imsglobal.org/spec/lti-dl/claim/errormsg"
MESSAGE_LOG
public
mixed
MESSAGE_LOG
= "https://purl.imsglobal.org/spec/lti-dl/claim/log"
MESSAGE_MSG
public
mixed
MESSAGE_MSG
= "https://purl.imsglobal.org/spec/lti-dl/claim/msg"
Properties
$claim
public
mixed
$claim
$items
public
mixed
$items
= array()
$json
public
mixed
$json
Methods
__construct()
public
__construct(mixed $request) : mixed
Parameters
- $request : mixed
acceptType()
acceptType - Returns true if the string is in the accept_types
public
acceptType(mixed $type) : mixed
"accept_types": ["link", "file", "html", "ltiResourceLink", "image"],
Parameters
- $type : mixed
addContentItem()
addContentItem - Add an Content Item
public
addContentItem(mixed $url[, mixed $title = false ][, mixed $text = false ][, mixed $icon = false ][, mixed $fa_icon = false ][, mixed $additionalParams = array() ]) : mixed
Parameters
- $url : mixed
- $title : mixed = false
- $text : mixed = false
- $icon : mixed = false
- $fa_icon : mixed = false
- $additionalParams : mixed = array()
addContentItemExtended()
addContentItemExtended - Add an Content Item
public
addContentItemExtended([mixed $params = array() ]) : mixed
Parameters
- $params : mixed = array()
-
Key/Value pair of configurable options for content item (see addContentItem)
addFileItem()
addFileItem - Add an File Item
public
addFileItem(mixed $url[, mixed $title = false ][, mixed $additionalParams = array() ]) : mixed
Parameters
- $url : mixed
- $title : mixed = false
- $additionalParams : mixed = array()
Tags
addLtiLinkItem()
addLtiLinkItem - Add an LTI Link Deep Link
public
addLtiLinkItem(mixed $url[, mixed $title = false ][, mixed $text = false ][, mixed $icon = false ][, mixed $fa_icon = false ][, mixed $custom = false ][, mixed $scoreMaximum = false ][, mixed $resourceId = false ][, mixed $additionalParams = array() ]) : mixed
Parameters
- $url : mixed
-
The launch URL of the tool that is about to be placed
- $title : mixed = false
-
A plain text title of the content-item.
- $text : mixed = false
-
A plain text description of the content-item.
- $icon : mixed = false
-
An image URL of an icon
- $fa_icon : mixed = false
-
The class name of a FontAwesome icon
- $custom : mixed = false
-
An optional array of custom key / value pairs
- $scoreMaximum : mixed = false
-
The scoreMaximum if this is an assignment
- $resourceId : mixed = false
-
The resourceId for the item if it is an assignment
- $additionalParams : mixed = array()
addLtiLinkItemExtended()
addLtiLinkItemExtended - Add an LTI Link Content Item
public
addLtiLinkItemExtended([mixed $params = array() ]) : mixed
Parameters
- $params : mixed = array()
-
Key/Value pair of configurable options for content item (see addLtiLinkItem)
allowContentItem()
allowContentItem - Returns true if we can return HTML Items
public
allowContentItem() : mixed
allowImportItem()
allowImportItem - Returns true if we can return IMS Common Cartridges
public
allowImportItem() : mixed
allowLink()
allowLink - Returns true if we can return HTML Items
public
allowLink() : mixed
allowLtiLinkItem()
allowLtiLinkItem - Returns true if we can return LTI Link Items "accept_types": ["link", "file", "html", "ltiResourceLink", "image"],
public
allowLtiLinkItem() : mixed
allowMimetype()
allowMimetype - Returns true if we can return LTI Link Items
public
allowMimetype(mixed $Mimetype) : mixed
Parameters
- $Mimetype : mixed
allowMultiple()
allowMultiple - Returns true if we can return multiple items
public
allowMultiple() : mixed
getClaim()
getClaim - get a extension claim
public
getClaim(mixed $string[, mixed $default = null ]) : mixed
Parameters
- $string : mixed
- $default : mixed = null
Tags
getContentItemSelection()
Return the claims array to send back to the LMS
public
getContentItemSelection() : mixed
returnUrl()
returnUrl - Returns the deep_link_return_url
public
returnUrl() : string
Return values
string —The deep_link_return_url or false